OpenStack SDK/CLI 기여을 위한 개발환경 세팅 방법(Mac)

[JaeseongShin]

개발환경 세팅(Windows)

OpenStack에 기여하기 위한 개발환경 세팅 과정입니다.

아래와 같은 패키지를 사용합니다.

• Python >= 3.11
• pip >= 24.0
• VScode >= 1.102.0

기본 패키지 설치(Python, pip, VScode)

Python

Download Python
해당 링크로 이동한 뒤, Python 버전을 선택합니다.

선택하여 들어온 후, 내 OS에 맞는 인스톨러를 선택하여 다운로드 합니다.

설치 프로그램을 실행하여 설치합니다.

설치가 완료된 후 터미널을 통해 python 명령어가 정상적으로 실행되는지 확인합니다.

pip 설치

pip는 Python에서 사용하는 패키지 매니저로 Linux의 apt, dnf나 Mac의 Homebrew, Windows 의 choco와 비슷한 기능을 합니다.

기본적으로 python이 설치되어 있는 환경에서 설치가 가능합니다.

설치 스크립트를 다운로드 받은 후 터미널에서 명령어로 실행시키게 되면 설치가 완료됩니다.

python get-pip.py

설치가 완료되면 아래와 같이 pip 명령어를 사용할 수 있습니다.

VScode 설치

VScode는 Microsoft에서 개발한 텍스트 에디터로 여러 extension을 활용하여 IDE처럼 활용이 가능합니다.

VScode 설치

위 링크로 접속하여 자신의 OS(Windows)에 맞는 파일을 다운로드 하여 설치합니다.

설치가 완료된 후, VScode를 실행하면 아래와 같은 화면이 나오게 됩니다.

이후 개발환경 세팅을 위해 아래와 같은 순서로 작업 환경(폴더) 를 열어줍니다.

파일 → 폴더 열기 → (폴더 선택 화면에서)폴더 선택

폴더를 선택하게 되면 좌측 탭에 열린 폴더가 보이게 됩니다.

Python 가상환경 만들기(venv)

venv는 Python의 가상 환경을 만들어 주는 모듈입니다.

프로젝트별로 독립적인 Python 환경을 구성하여, 라이브러리 충돌 문제를 해결하고 개발 환경을 깔끔하게 유지하는 데 도움을 줍니다.

Python 3.3 이상에서 표준 라이브러리로 제공됩니다.

OpenStack 개발환경 구성을 위해 가상환경을 만듭니다.

터미널을 열어 아래와 같은 명령어를 입력합니다(터미널은 VScode에서 열거나 windows의 기본 터미널을 활용합니다).

(폴더의 경로는 각자가 다를 수 있기 때문에 폴더 경로를 확인하여 명령어를 입력합니다)

python -m venv OCA-OpenStack

명령어를 입력하면 OCA-OpenStack 이라는 폴더가 생성됩니다.

편의를 위해 VScode에서 OCA-OpenStack 폴더를 열어 작업을 진행합니다.

VScode에서 venv 가상환경을 활용하기 위해서는 인터프리터 설정을 진행 해 주어야 합니다.

아래 과정을 통해 venv 가상환경에 구성된 Python을 활용할 수 있도록 설정해 줍니다.

1. command + shift + p 를 입력하여 VScode 설정 창 진입
2. 검색창에 interpreter를 입력하여 Python: 인터프리터 선택 을 찾은 뒤 선택
   
3. 생성한 venv 경로를 확인하여 인터프리터 선택
   

해당 과정을 거치면, 기존에 설치되어 있는 python이 아닌 venv에 생성되어 있는 python으로 코드를 실행시킬 수 있습니다.

모든 과정이 완료되면 VScode에서 터미널을 열어 아래 과정을 진행합니다.

프로젝트 Clone

개발환경을 만들기 위해서 다음의 3개 프로젝트를 클론 받아 진행합니다

• python-openstackclient

git clone https://opendev.org/openstack/python-openstackclient

• osc-lib

git clone https://opendev.org/openstack/osc-lib

• openstacksdk

git clone https://opendev.org/openstack/openstacksdk

실행환경 패키지 설치

Clone받은 패키지를 실행시키기 위한 필수 패키지를 설치합니다.

VScode에서

1. 아래 명령어를 통해 필수 패키지를 설치합니다.

pip install -r python-openstackclient/requirements.txt
pip install -r python-openstackclient/test-requirements.txt

2. 각 Clone받은 디렉토리로 이동하여 아래 명령어를 실행시킵니다.

# python-openstackclient 디렉토리에서
python setup.py develop

# openstacksdk 디렉토리에서
python setup.py develop

# osc-lib 디렉토리에서
python setup.py develop

VScode 에서 디버깅을 위한 parameters 와 Environment variables 설정하기

• 실행 및 디버그(아이콘) → launch.json 파일 만들기를 선택합니다.
  

  

• Python Debugger → 인수를 사용하는 Python 파일 을 선택합니다.
  

  
  
  
  

• 생성된 launch.json 파일을 수정합니다.

  • 여기서 args 부분을 수정하고 env 항목을 만들어 줍니다.
    • arg는 openstack 명령어의 인자값을 넣어줍니다. (예: server list / image list)
    • env는 인증을 위한 파라미터를 넣어줍니다.
      
      
    • 설정해야 하는 값은 아래와 같습니다.

Name	Value
OS_PROJECT_NAME	admin
OS_TENANT_NAME	admin
OS_USERNAME	admin
OS_PASSWORD	devstack 설치할 때 설정한 password
OS_REGION_NAME	RegionOne
OS_IDENTITY_API_VERSION	3
OS_AUTH_TYPE	password
OS_AUTH_URL	http://$/identity
OS_USER_DOMAIN_ID	default
OS_PROJECT_DOMAIN_ID	default
OS_VOLUME_API_VERSION	3

• python-openstackclient/openstackclient 내의 shell.py파일을 좌클릭하여 연 뒤 f5를 누르게 되면 디버깅이 정상적으로 이뤄집니다.