AWS CDK 개발 환경 구축하기
이 문서는 AWS CDK 개발 환경 구축에 대한 글이다. AWS CDK 는 코드로 AWS 자원을 관리하게 해주는 것으로 Infrastructure As Code 에 부합한다. 이를 사용하기 위해서는 환경 구축이 필수이기에 이를 기록한다.
구축 환경
AWS CDK 는 몇가지 언어를 지원 한다. 나는 Python 을 사용할 것임으로 Python 관련된 설정도 필수다. 그런데, Python 을 사용해보면 알겠지만 Windows 플랫폼 보다는 Unix 스타일의 플랫폼이 적합하다는 것을 알게 된다. 따라서 구축 환경은 다음과 같이 정했다.
- OS: Mint Linux 19.3 Tricia XFCE
- Python3
한가지 더 있다. Python3 을 사용할 경우에 AWS SDK 등을 모두 설치해야 한다. 하지만 Python 은 캡슐화를 지원한다. Virtualenv 가 바로 그것인데, 모든 것을 Virtualenv 환경으로 구축을 할 예정이다.
PreRequirement
이제 본격적으로 구축을 해보자. 이를 위해서 필수 프로그램이 필요한데, 이는 다음과 같다.
- npm (Node)
이는 다음의 URL 을 명시되어 있다.
Node, npm 설치
npm 을 기반으로 한다고 문서에 나와 있다. 따라서 npm 을 설치해 줘야 한다. npm 은 Node.js 기반이며 Node.js 를 설치하는 방법은 다양하지만 이전에 이에 대해서 기술한 문서가 이미 있기에 다음을 참고 했다.
주의할 것은 AWS 의 문서에 나와 있다시피 LTS 버전을 설치해줘야 한다. AWS 문서에 나와 있듯이 CDK 를 설치해 준다.
|
1 2 3 4 5 |
]$ npm install -g aws-cdk /home/systemv/.nvm/versions/node/v12.15.0/bin/cdk -> /home/systemv/.nvm/versions/node/v12.15.0/lib/node_modules/aws-cdk/bin/cdk + aws-cdk@1.23.0 added 234 packages from 227 contributors in 11.018s ]$ cdk --version |
Python3 환경 구축
Python3 에도 필요한 것이 있는데, distutils 패키지 이다. 이것은 우분투 패키지로 설치를 해줘야 한다. 다음과 같이 설치를 해준다.
|
1 |
]# apt install python3-distutils |
이것을 설치해야지만 python3 을 로컬 계정에서 환경을 구축할 수 있다. 다음과 같이 pip 를 설치해 준다.
|
1 2 3 |
]$ wget https://bootstrap.pypa.io/get-pip.py ]$ python3 get-pip.py --user ]$ .local/bin/pip3 install virtualenv |
virtualenv 를 설치하고 난 후에 이제 캡슐환경을 만들어준다. 그냥 .python3 으로 만들어준다.
|
1 2 3 4 5 6 7 8 9 |
]$ virtualenv .python3 ]$ .local/bin/virtualenv .python3 Using base prefix '/usr' New python executable in /home/systemv/.python3/bin/python3 Also creating executable in /home/systemv/.python3/bin/python Installing setuptools, pip, wheel... done. ]$ source .python3/bin/activate (.python3) $ |
여기서 이제 AWS CLI 와 기타 몇가지를 함께 설치해준다. 이는 Python3 에 패키지로 존재함으로 pip 명령어를 이용해서 설치하면 된다.
|
1 |
(.python3) $ pip install awscli aws-toolkit aws-sam-cli |
이로써 필수 프로그램 설치는 다 됐다.
VS Code 설정
이제 Editor 설정을 해야 한다. VS Code 라면 AWS CDK 를 사용하는데 부족함이 없다. 데스크탑 리눅스를 사용함으로 VS Code 에서 우분투 패키지를 다운로드해 설치하면 된다.
Color Themes
좋은 Color Themes 가독성을 높여줘 프로그래밍을 하는데 많은 도움이 된다. 내가 주로 사용하는 Color Themes 는 다음과 같다.
- Ayu
- Primal
물론, 이건 지극히 개인적인 것임으로 검색을 통해서 자신에게 맞는 Color Themes 를 찾으면 된다.
Python Extension 설정
VS Code 가 Python 을 지원하도록 해야 한다. 이를 위해서 Python Extension 을 설치하고 다음과 같이 설정을 해준다. 그리고 다음과 같이 pip 를 이용해서 프로그램을 설치해준다.
|
1 |
(.python3) $ pip install pycodestyle pydocstyle pylint pytest autopep8 black cfn-lint |
AWS Toolkit for Visual Studio Code
AWS Tookit Extension 을 설치해 준다. 별도의 설정은 해주지 않아도 된다.
Indenticator, indent-rainbow
Python, Yaml 문법의 특성상 Indent 를 기반으로 문법 체크를 하는데 이 Extension이 도움이 된다.
Sort lines
라인을 알파벳 순, 숫자순으로 정렬을 해준다.
vscode-cfn-lint
cfn 는 CloudFormation 을 말한다. CloudFormation 문법을 체크해 준다.
YAML Support by Red Hat
CloudFormation 은 YAML 문법을 따른다. 이 문법을 체크해 준다.
Cloudformation YAML snippets for VS Code
코딩을 할때에 필요한 코드 조작을 넣어준다.
Better Comments
주석에 색깔을 입혀서 가독성을 높여준다.
이렇게 설치한 Extension 에 대한 설정값은 다음과 같다.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
{ "workbench.colorTheme": "Ayu Mirage", "workbench.iconTheme": "material-icon-theme", "python.venvPath": "~/.python3", "python.testing.pytestEnabled": true, "python.venvFolders": [ ".python3" ], "python.pythonPath": "~/.python3/bin/python3", "python.autoComplete.extraPaths": [ "~/.python3/lib/python3.6", "~/.python3/lib/python3.6/site-packages" ], "python.formatting.provider": "black", "python.formatting.blackArgs": [ "--line-length", "100" ], "editor.formatOnSave": true, "python.linting.pylintEnabled": true, "python.linting.lintOnSave": true, "python.linting.enabled": true, "indenticator.inner.showHighlight": true, "indentRainbow.includedLanguages": [], "indentRainbow.excludedLanguages": [ "plaintext" ], "indentRainbow.updateDelay": 100, "cfnLint.path": "~/.python3/bin/cfn-lint", "yaml.validate": false, "yaml.customTags": [ "!And", "!And sequence", "!If", "!If sequence", "!Not", "!Not sequence", "!Equals", "!Equals sequence", "!Or", "!Or sequence", "!FindInMap", "!FindInMap sequence", "!Base64", "!Join", "!Join sequence", "!Cidr", "!Ref", "!Sub", "!Sub sequence", "!GetAtt", "!GetAZs", "!ImportValue", "!ImportValue sequence", "!Select", "!Select sequence", "!Split", "!Split sequence" ] } |
AWS Credential 세팅
Python3 에 가상환경에서 aws configure 명령어를 이용해서 접속을 위한 credential 을 만들어준다.
|
1 2 3 4 5 |
(.python3) ]$ aws configure --profile AWS Access Key ID [None]: ********************* AWS Secret Access Key [None]: ****************************** Default region name [None]: ap-northeast-2 Default output format [None]: |
이로써 AWS CDK 를 위한 VS Code 설정을 기술했다. 정답은 없다. 개인적으로 사용하는 설정을 기반으로 보다 좋은 방법, 환경을 위한 설정이 있을 것이다.