Storage-service

한국어(KR) | English

빠른 시작

Docker

컨테이너 생성

docker-compose up -d

위의 명령어를 입력해 docker image 생성 후 컨테이너를 생성합니다.

이후 storage-service 컨테이너를 재시작 하도록 합니다.

재시작의 이유는 mysql server가 정상적으로 시작하기 전에 storage-service 가 연결을 시도하면서 문제가 발생하기 때문입니다. 영구적인 해결방법은 아니지만 개발 환경에서는 이와 같이 대처하도록 합니다.

컨테이너 삭제

docker-compose down

위의 명령어를 입력해 컨테이너를 삭제합니다.

API 요청

ping

http://localhost:3004/api/v1/default/ping

기타

Notion 내부의 api-gateway 문서 내 File 하위 부분을 참고하세요

환경 변수

docker-compose.yml 파일 내부의 environment 부분에 명시 되어있습니다.

개요

Belf 서비스에서 사용되는 파일 등의 정적 데이터를 관리하는 서비스입니다.

특이사항

1. 실제 파일 데이터가 저장되는 경로
   1. dev
      1. Pycharm, Visual Studio Code: 프로젝트 디렉토리 경로 + Config/local/upload_config.json 파일의 STORAGE_SERVICE_UPLOAD_PATH 값
      2. docker: docker-compose.yml 내부의 STORAGE_SERVICE_UPLOAD_PATH 환경 변수 값
   2. QA/production
      1. K8S: STORAGE_SERVICE_UPLOAD_PATH 환경 변수 값

Stack

1. Python:v3.9(이상)
2. Sanic web framework
3. Tortoise ORM
4. MySql:v5.7.16
5. VSCode
6. Pycharm
7. docker

Belf 공식 개발 환경은 VSCode 이지만, 언어 특성상 편의를 위해 Pycharm을 사용 했습니다. VSCode 실행도 별 문제 없음을 확인 했습니다. 관련 내용은 빠른 시작 하위의 VSCode 부분을 참고하세요.

Python 패키지 오류를 이유로 개발 OS로 Unix 계열인 MacOS, Linux 등을 추천하며 Windows 인 경우 WSL2 + VSCode 사용을 추천합니다.

docker는 단순 테스트를 위한 Stack입니다. 실 서비스는 K8S 통해서 Azure 클라우드에서 제공됩니다.

시작

공통

1. oauth 서비스의 mysql 서비스를 구동하거나, docker-compose.yml 파일에서 mysql 서비스만 구동해 DB를 띄워두세요.

VSCode

1. storage-service 디렉토리를 열어줍니다.
2. python3 -m venv venv 명령어를 이용해 python3.9 가상 환경을 생성합니다.
3. pip install -r requirements.txt 명령어를 사용해 Python 패키지를 설치합니다.
4. 좌측의 벌레 모양 버튼을 눌러 디버깅 창으로 진입합니다.
5. Sanic:main.py 값을 드롭 박스에서 선택 후 상단의 초록 화살표 버튼을 클릭해 디버깅을 실행합니다.

VSCode 터미널(쉘)에서 python --version 명령어로 python 버전을 확인하거나, 유닉스 계열의 OS 에서 which python 명령어를 시용해 2번에서 생성한 venv 경로가 정상적으로 잡히는지 확인이 가능합니다.

2번에서 venv 라는 이름으로 python3.9 가상 환경을 생성 한 경우 새로운 shell 창을 VSCode 내부에서 실행 했을 때 자동으로 python 명령어의 경로가 venv 으로 잡힙니다. 관련 설정은 ./vscode/settings.json 내부에 존재합니다.

VSCode 에서 3번의 디버깅 설정 관련 내용은 프로젝트 ./vscode/launch.json 내부에 존재합니다.

4번은 python main.py 명령어와 동일합니다.

Pycharm

1. 프로젝트 디렉토리를 Pycharm을 사용해서 열어줍니다.
2. 상단 우측의 초록색 벌레 모양과 화살표 모양 좌측에 있는 프로젝트 시작 프리셋을 클릭 한 다음 Edit Configurations 내부로 들어갑니다.
3. script path 항목으로 storage-service 내부의 main.py 파일을 선택 해 줍니다.
4. Python interpreter 항목에 python3.9 이상의 python 인터프리터가 존재하지 않는 경우 Pycharm 기능을 사용해 생성 후 선택 합니다.
5. pip install -r requirements.txt 명령어를 사용해 Python 패키지를 설치합니다.
6. 실행 환경 설정 저장 후 해당 설정을 2번 프리셋 선택 창에서 선택 한 다음 상단 우측의 벌레 모양 아이콘을 클릭해서 디버깅 환경으로 진입합니다.

Pycharm 개발 환경 상단의 View-Tool Windows-Python Console 을 클릭해서 python -version 등의 명령어로 Pycharm 에서 인식한 python 버전 및 python 명령어 경로를 확인할 수 있습니다.

환경 변수

환경 변수 표 범례

구성 요소	설명
Variable	환경 변수 이름
dev	환경 변수가 개발 환경에서 사용되는지 여부
qa/prod	환경 변수가 qa, production 환경에서 사용되는지 여부
Default value	시스템 환경 변수를 사용해 환경 변수를 정하지 않았을 때 기본적으로 적용되는 값
Example	환경 변수 값으로 들어갈 수 있는 예시의 나열
Explanation	환경 변수에 대한 설명

환경 변수 표

Variable	dev	qa/prod	Default value	Example	Explanation
STORAGE_SERVICE_IS_PROD	🚫	✅		true	K8S 배포 환경인지 구분하기 위한 값입니다.
STORAGE_SERVICE_PORT	✅	🚫	8000	8000, 3004	HTTP listen port를 설정하기 위한 값입니다.
STORAGE_SERVICE_SSL	🚫	🚫	""		SSL 설정을 위한 값입니다.(미사용)
STORAGE_SERVICE_ACCESS_LOG	✅	✅	true	true, false	Log 사용 여부 설정을 위한 값입니다.
STORAGE_SERVICE_IS_USING_DOCKER	✅	🚫	true	true	Docker 사용해 로컬 구동 여부를 설정을 위한 값입니다.
STORAGE_SERVICE_UPLOAD_PATH	✅	✅	/upload	/upload, /mnt/mount/azure/files/storage	로컬 개발환경용 상대경로나, Azure Files와 mount될 directory 전체 경로를 입력합니다.
STORAGE_SERVICE_DB_HOST	✅	✅	127.0.0.1	127.0.0.1, host.docker.internal	접속할 Master DB의 IP 혹은 URL 설정을 위한 값입니다.
STORAGE_SERVICE_DB_PORT	✅	✅	3306	3306, 3307	접속할 Master DB의 Port 설정을 위한 값입니다.
STORAGE_SERVICE_DB_NAME	✅	✅	belf	belf	접속할 DB의 DB Name 설정을 위한 값입니다.
STORAGE_SERVICE_DB_USER	✅	✅	root	root	접속할 DB의 User Name 설정을 위한 값입니다.
STORAGE_SERVICE_DB_PASSWORD	✅	✅	example	example	접속할 DB의 User Password 설정을 위한 값입니다.

간단 테스트

./test/index.html 을 Chrome 등을 통하여 열고 간단한 테스트 진행이 가능하도록 추가함.

선행사항

Local 환경에서는 3004 번으로 Storage Service 가 열려있어야하며, 3001 번으로 OAuth Server 가 연결되어있어야한다. ( Gin 포함 )

테스트 방법

1. 테스트를 원하는 서버를 선택한 후 로그인 테스트를 진행하여 정상적으로 로그인이 가능한지 확인한다.
2. 파일을 업로드 한 후 요청을 보내본다. 성공시 하단 로그에 상세 정보가 찍히며, 자동으로 file_id input 필드가 채워진다.
3. 파일의 정보요청, 삭제, 이미지 다운로드, 그 외 서버의 스펙 요청등이 간단하게 가능하다.