OpenStack CLI 클라이언트(python-openstackclient)를 로컬에서 직접 개발하고 디버깅하기 위한 VSCode 환경 구축 방법 (+근데 윈도우 환경을 곁들인...)
이 게시물을 읽고 계신다면, 분명 주위에서 파이참을 사용하라고 권유했을거고 당신의 윈도우 환경에 안타까움을 표했을겁니다...
그럼에도 불구하고 꿋꿋하게 환경세팅을 하려고 제 게시물을 읽고 있는 당신에게 경의를 표하며... 지금이라도 주변의 말을 들으세요
참고) 본격적인 포스팅에 앞서 윈도우 명령어 앞엔 🪟으로 기입하겠습니다
[환경세팅을 하기에 앞서, 간략한 사전 지식 및 전체 흐름]
- 클라우드 컴퓨팅은 원격지의 리소스를 API 호출을 통해 제어합니다.
사용자는 웹 대시보드(GUI)를 사용할 수도 있지만,
개발 생산성과 자동화를 위해 CLI(Command Line Interface) 도구인python-openstackclient를 사용
-> 마치 쿠버네티스의 kubectl과 비슷한 역할이랄까
- 해당 프로젝트는 파이썬을 사용합니다. 그러므로 의존성 문제를 예방하기 위해 가상환경을 사용합니다 -> 시스템 전역에 패키지 설정하면^^.....
버전 충돌쇼
-> 정리하자면 가상환경(내방) > 라이브러리 모음집 설치 > 구동
① 소스코드 clone
자신의 작업 디렉토리에 python-openstackclient 코드를 clone 받습니다.
git clone https://opendev.org/openstack/python-openstackclient
② clouds.yaml 생성
python-openstackclient를 clone 받은 위치에 아래 내용으로 clouds.yaml 파일을 생성합니다.
clouds:
my-cloud:
auth:
auth_url: http://<ip>/identity
username: "admin" # 할당 받은 값 넣으세요
password: "1234" # 할당 받은 값 넣으세요
project_name: "admin" # 할당 받은 값 넣으세요
user_domain_name: "Default"
project_domain_name: "Default"
region_name: "RegionOne"
interface: "public"
identity_api_version: "3"③ Visual Studio Code에서 python-openstackclient 폴더 열기
visual studio code를 이용할 경우, IDE로서의 기능보다 코드를 분석하고 수정하는 용도로 주로 활용하게 됩니다. 따라서, openstackclient 실행과 로그 분석은 터미널에서 합니다.
code내에서 터미널을 열고 작업을 이어갑니다.
vscode 자체를 관리자 권한으로 설치하면 git bash도 관리자 권한으로 내부에서 사용가능하다고 Reddit에 토론기록이 남아있긴한데,
그 누구도 성공적인 시도였다는 후기가 없다옆에 git bash 관리자 권한으로 열어서 작업하는 걸 추천 드립니다
④ virtualenv 생성 (가상 환경 만들고 만든 환경에 들어가기)
python3->python: 윈도우 환경에서는 python 명령어가 3.x 버전을 가리키는 기본 실행 파일명이므로 교체
.venv/bin/activate->.venv/Scripts/activate: 윈도우 파이썬 가상 환경은 실행 파일(Script)을 bin이 아닌 Scripts 디렉토리에 저장
아래 명령어로 virtualenv를 생성합니다.
python3 -m venv .venv
🪟python -m venv .venv
그리고 virtualenv 를 활성화합니다.
source .venv/bin/activate
🪟source .venv/Scripts/activate -> ex) 이게 가상환경(내 방) 가는 길인거다
정상적으로 활성화되었다면 다음과 같이 터미널에 표시됩니다.
⑤ python-openstackclient 의 의존 라이브러리 설치하기
pip3->pip: 리눅스와 달리 윈도우 가상 환경(.venv/Scripts)에는 pip3.exe 파일이 생성되지 않는 경우가 많습니다.
이제 의존 라이브러리를 설치합니다.
아래 명령어로 의존 라이브러리를 설치합니다.
pip3 install -r requirements.txt -> 실행용
🪟pip install -r requirements.txt
pip3 install -r test-requirements.txt -> 테스트나 코드 품질 검사용
🪟pip install -r test-requirements.txt
⑥ python-openstackclient를 develop 모드로 설치하기
이제 virtualenv 에 python-openstackclient 자체를 설치합니다.
일반적으로 파이썬 코드를 받아 설치할 때는 python setup.py install을 이용하지만, 개발을
위해서는 아래 명령어로 develop 모드로 설치해아 합니다.
python3 setup.py develop
🪟python setup.py develop
⑦ openstack server list 실행해보기
python-openstackclient의 main 함수는 openstackclient/shell.py 에 있습니다.
하지만 PyCharm 과 다르게 우리는 openstackclient를 virtualenv에 설치했으므로 openstack
명령어를 그대로 사용해도 됩니다.
아래 명령어로 결과를 확인해봅니다.
openstack server list --os-cloud my-cloud
이 때 인스턴스 이름은 testinstance계정명 으로 된 것이 나와야합니다.
여기까지 되었다면 openstackclient 코드를 개발할 준비가 완료되었습니다.
