DEV Community: Carlos A R Cardoso

Creating a local environment to develop on AWS CDK using Docker and VSCode

Carlos A R Cardoso — Tue, 09 Mar 2021 23:14:12 +0000

Containers are humanity's greatest invention after the transistor, and anyone who disagrees is wrong. They make life easier, which even complicates. When you realize, you're already finding an excuse to use it where you shouldn't.

Exaggerations aside, I think that is not the case here. I intend to show in this brief tutorial how to use them to create a local environment ready to develop your apps and stacks based on AWS CDK - Cloud Development Kit. We are not going to create the resources on AWS. That is not the goal. We will prepare the environment to start your development.

About AWS CDK

Anchored in the concept of infrastructure as code (IaC), the AWS CDK allows you to create resources in the AWS cloud, using languages such as Python, Java, JavaScript, C #, or TypeScript. If you already use CloudFormation or Terraform, it's worth checking out and adding to your toolbox.

Recently collaborating on data lakes implementation projects in the AWS cloud, I have been using the CDK as an IaC tool to automate the creation of resources and environment, whether in roles, jobs glue, or lake formation configurations creation. I can't imagine a life doing it manually on the console.

Has anyone ever worked or works like this?

Why containers?

You could indeed install AWS CDK and its prerequisites directly on your PC's operating system. However, I believe that the method suggested in this tutorial is faster. Also, you could use this method to facilitate the version upgrade or even to create and maintain several simultaneous CDK environments, in different versions, without one version interfering or impacting the other.

Believe me, almost every day, AWS releases a new version.

Finally, part of this method could be adapted and used in a CI / CD pipeline.

It's a big deal ;)

Hands on

All the steps described in this tutorial were performed on Ubuntu 20.04, but this is not a prerequisite. Adapting a few steps and installing the software packages in the required version, you can use another S.O. of your preference.

Without further ado, let's get this environment ready to "Hello World"!

Prerequisites

Before performing step 1, you will need Git, Docker, VSCode, and AWS-CLI installed. If you don't have these applications yet, I suggest following the official links below. The idea is simple.

With Git, we will download the source code for our AWS-CDK Docker container image.

Git

With Docker, we will create the image and start the container.

Docker

With VSCode, we will connect to the container to develop our applications.

VSCode

With AWS-CLI, you can set up your AWS account and get the environment ready to deploy your application in the cloud. Remember that for that, of course, you will need an AWS account.

AWS-CLI

Creating the image of the Docker container with AWS CDK

On the operating system, open the terminal and run the following command to download the source code

sudo git clone https://github.com/contino/docker-aws-cdk.git

Go to the docker-aws-cdk folder and open the Dockerfile file for editing.

cd docker-aws-cdk && sudo gedit Dockerfile

In the first lines, find the section containing the variable ENV AWS_CDK_VERSION and change it to the desired version number. As I write this tutorial, the current version is 1.91.0.

The file line should look like this:

ENV AWS_CDK_VERSION=1.91.0

Save and clode the file.

You can edit and customize this Dockerfile in several other ways, as needed. Take a look at the project repository for more information.

To create the image of the container run:

sudo docker build -t contino/aws-cdk:1.91.0 .

Now it's time to start our service. Run the command:

sudo docker run -itd -v ~/.aws:/root/.aws -v /home/projeto:/home/projeto --name aws_cdk contino/aws-cdk:1.90.0 bash

where:

-v ~/.aws:/root/.aws : maps the AWS credentials from the local machine to the container. For this step, you must configure your credentials after installing the AWS-CLI. Although it is not essential for this tutorial since we will not perform any deployment, I recommend following it to leave your environment ready.

-v /home/projeto:/home/projeto : maps the local project directory to a project directory internal to the container. Here you can change the name of the local folder as needed. Pay attention to the path names to locate the project on your local machine and in the container.

To check if the container is running and that the CDK is installed in the desired version, execute:

sudo docker exec aws_cdk cdk --version

Connecting VSCode to our AWS-CDK environment

Open VSCode and install the python extensions and remote-containers:

ms-vscode-remote.remote-containers
ms-python.python

With the extensions installed, we will connect the VSCode to our container.

Click the green icon in the bottom left corner of the screen.

A menu will appear in the center of the screen, next to the title bar.

Select the Attach to Running Container option and click on the container name.

A new VSCode session connected to the aws_cdk container will open.

Starting the project

In the top menu, click on Terminal and New Terminal.
Navigate to the project folder.

cd /home/projeto/

Start a new Python CDK project.

cdk init app --language python

Run the command below to check the created project structure.

ls -la

You can also browse your container or project folders through the VSCode interface. From the main menu, click File and Open Folder.

Type the path, example /home and click OK. The folder hierarchy should be displayed in the left pane.

You now have the structure of an AWS-CDK Python project. If this is your first contact, I recommend following the official Developer Guide to understand the concepts and build your first stack.

Wrapping up

Disconnect the VSCode from the container by clicking on the green icon in the lower left corner and on the Close Remote Connection option.

At the terminal of the operational system, end the execution of the container with the command:

sudo docker stop aws_cdk

See you next time!

Criando um ambiente local para desenvolver em AWS CDK usando Docker e VSCode

Carlos A R Cardoso — Tue, 02 Mar 2021 14:36:00 +0000

Containers, como os do Docker, são a maior invenção da humanidade depois do transistor, e quem não concordar está errado. Facilitam tando a vida que até complica. Quando você vê, já tá arrumando desculpa prá usar onde não deve.

Exageros à parte, acho que não é o nosso caso aqui. Pretendo mostrar nesse breve tutorial como usá-los para criar um ambiente local pronto para desenvolver seus apps e stacks baseadas em AWS CDK — Cloud Development Kit.

Aqui não vamos criar os recursos na AWS, não é esse o objetivo. Iremos preparar o ambiente para que você inicie seu desenvolvimento.

Sobre o AWS CDK

Ancorado no conceito de infraestrutura como código (IaC), o AWS CDK permite que você crie recursos na nuvem da AWS usando linguagens como Python, Java, JavaScript, C# e TypeScript. Se você já usa o CloudFormation ou Terraform, vale a pena dar uma conferida e incrementar sua caixa de ferramentas.

Colaborando recentemente em projetos de implementação de datalakes na cloud AWS, tenho usado o CDK como ferramenta de IaC para automatizar a criação dos recursos e ambiente, seja na criação de roles, jobs glue ou configurações do lake formation. Não dá prá imaginar a vida fazendo isso manualmente pela console.

Será que alguém já trabalhou ou trabalha assim ?

Por que usar containers ?

É verdade que você poderia instalar o AWS CDK e seus pré-requisitos diretamente no sistema operacional do seu PC. Porém creio que, além de mais rápido, o método sugerido nesse tutorial pode ser usado para facilitar o upgrade de versão (acredite, quase todo dia a AWS solta uma versão nova), ou mesmo criar e manter vários ambientes simultâneos da CDK, em diferentes versões, sem que uma versão interfira ou impacte na outra. Por fim, parte desse método poderia ser adaptada e aproveitada em um pipeline de CI/CD.

Só vi vantagens ;)

Mão na massa

Só para constar, todos os passos descritos nesse tutorial foram executados no Ubuntu 20.04, porém isso não é um pré-requisito. Você pode utilizar outro S.O. de sua preferência, adaptando alguns passos e instalando os pacotes de software na versão necessária.
Sem mais, vamos deixar esse ambiente pronto para o “Hello World”.

Pré-requisitos

Antes do passo 1, você vai precisar do Git, Docker, VSCode e AWS-CLI instalados. Se ainda não tem esses caras, sugiro seguir os links oficiais abaixo. A ideia é muito simples.

Com o Git, vamos baixar os fontes para imagem do nosso container Docker com AWS-CDK.

Com o Docker, vamos criar a imagem e “levantar” o container.

Docker

Com o VSCode, vamos nos conectar ao container para desenvolver nossas aplicações.

VSCode

Com o AWS-CLI, você poderá configurar sua conta AWS e deixar o ambiente pronto para executar o deploy da sua aplicação na cloud. Lembrando que para isso, claro, você precisará de uma conta AWS.

AWS-CLI

Criando a imagem do container Docker com AWS CDK

No sistema operacional, abra o terminal e execute o comando a seguir para baixar os fontes:

sudo git clone https://github.com/contino/docker-aws-cdk.git

Acesse a pasta docker-aws-cdk e abra o arquivo Dockerfile para edição.

cd docker-aws-cdk && sudo gedit Dockerfile

Logo nas primeiras linhas, localize o trecho contendo a variável ENV AWS_CDK_VERSION e altere para o número da versão desejada. Enquanto escrevo esse tutorial, a versão atual é a 1.91.0.

Logo, a linha do arquivo deve ficar assim:

ENV AWS_CDK_VERSION=1.91.0

Salve e feche o arquivo.

Você pode editar e customizar esse Dockerfile em vários outros aspectos, conforme sua necessidade. Dê uma olhada no repositório do projeto para mais informações.

Para criar a imagem do container execute:

sudo docker build -t contino/aws-cdk:1.91.0 .

Agora é hora de iniciar nosso serviço. Execute o comando:

sudo docker run -itd -v ~/.aws:/root/.aws -v /home/projeto:/home/projeto --name aws_cdk contino/aws-cdk:1.90.0 bash

onde:

-v ~/.aws:/root/.aws : mapeia as credenciais AWS da maquina local para o container. Para esse passo, suas credenciais devem ser configuradas após instalação do AWS-CLI. Apesar de não ser essencial para esse tutorial, visto que não iremos executar nenhum deploy, recomendo segui-lo para deixar seu ambiente em ponto de bala.

-v /home/projeto:/home/projeto : mapeia o diretório local do projeto para um diretório de projeto interno ao container. Aqui você pode alterar o nome do diretório local conforme sua necessidade, tendo atenção aos nomes para localizar o projeto tanto em sua maquina local quanto no container.

Para conferir se o container está em execução, e que o CDK está instalado na versão desejada, execute:

sudo docker exec aws_cdk cdk --version

Conectando o VSCode ao nosso ambiente AWS-CDK

Abra o VSCode e instale as extensões python e remote-containers:

ms-vscode-remote.remote-containers
ms-python.python

Com as extensões instaladas, vamos conectar o VSCode ao nosso container.

Clique no ícone verde do canto inferior esquerdo da tela. Será exibido um menu no centro da tela, próximo à barra de título.

Selecione a opção Attach to Running Container e clique no nome do container.

Uma nova sessão do VSCode, conectada ao container aws_cdk , será aberta.

Iniciando o projeto

No menu superior, clique em Terminal e New Terminal.

Navegue até a pasta "projeto".

cd /home/projeto/

Inicie um novo projeto CDK em Python.

cdk init app --language python

Execute o comando abaixo para verificar a estrutura de projeto criada.

ls -la

Você pode ainda navegar nas pastas do seu container e projeto pela interface do VSCode. No menu principal, clique em File e Open Folder.

Digite o path, exemplo /home e clique em OK. A hierarquia de pastas deve ser exibida no painel esquerdo.

Você agora tem o esqueleto de um projeto AWS-CDK Python. Caso seja seu primeiro contato, recomendo seguir o Developer Guide oficial para entender os conceitos e construir sua primeira stack.

Encerrando os trabalhos

Desconecte o VSCode do container, clicando no ícone verde do canto inferior esquerdo e na opção Close Remote Connection.

No terminal do sitema operacional, finalize a execução do container com o comando:

sudo docker stop aws_cdk

Até a próxima!