Example development environment using Cloud9 and CodeCommit

This tutorial will guide you through setting up a example development environment for RFDK.

Warning

The development environment this creates is intended to serve as a starting point. This development environment is not suitable for all organizations and security policies. Please make sure you understand the implications of creating this environment.

Creating this example might result in charges to your AWS account. These include possible charges for services such as Amazon EC2 and CodeCommit. For more information, see Amazon EC2 Pricing and AWS CodeCommit Pricing.

You will:

1. Step 1: Create an AWS CodeCommit repository

2. Step 2: Create an AWS Cloud9 environment

3. Step 3: Encrypt Cloud9 EBS volume

4. Step 4: Increase storage capacity (optional)

5. Step 5: Configure Cloud9 for use with CodeCommit

6. Step 6: Clone the AWS CodeCommit repository

Prerequisites

Before beginning this tutorial, you will need to:

• Create an AWS account

• Create an IAM user with least-privilege that has the ability to:

  • Use AWS CodeCommit - The AWSCodeCommitPowerUser AWS Managed Policy can serve as a starting point, but it is recommended to use a minimally permissive IAM policy for production environments.

  • List and resize EBS volumes - This is granted with the ec2:DescribeVolumes and ec2:ModifyVolume actions. These can be granted in an inline policy statement.

  • Deploy your CDK application - Permissions vary depending on the code in the CDK application, and ultimately the CloudFormation resources you create/update/destroy. The RFDK makes use of CDK’s grant feature which effectively requires administrator access. The AdministratorAccess AWS Managed Policy can be used. The credentials for this IAM user should be secured and managed carefully. If these credentials are compromised, your AWS account could be mis-used without limitation.

• Onboard to CDK

Step 1: Create an AWS CodeCommit repository

First, we need a highly-available and secure code repository for managing the source code of our RFDK application. For this development environment, we will use an AWS CodeCommit repository.

Follow the AWS CodeCommit’s documentation to create an AWS CodeCommit repository. Take note of the repository name chosen for the remainder of this guide.

Step 2: Create an AWS Cloud9 environment

Next, we will create an AWS Cloud9 environment that we will use for development. Specifically, we will create an EC2 Cloud9 environment. This type of Cloud9 environment means that Cloud9 will manage the lifecycle of the EC2 instance that hosts Cloud9. The instance is automatically started when opening the Cloud9 IDE and stopped when the IDE is idle or unused to save costs.

Follow the AWS Cloud9 documentation for Creating an environment. Use the following values when creating the Cloud9 environment:

Cloud 9 Environment Creation Values
Field	Value
Name	A desired name for your environment
Description	An optional description for your environment
Environment type	Create a new no-ingress EC2 instance for environment (access via Systems Manager)
Instance type	t3.small
Platform	Amazon Linux 2
Cost-saving setting	After four hours

Once you’ve created the environment, the browser will navigate to the Cloud9 IDE for the newly created environment. The Cloud9 IDE connects to the EC2 instance that hosts the environment and can be used to edit files and create terminal sessions. Now is a good time to familiarize yourself with the Cloud9 IDE.

One important user interface element is the console at the bottom of the screen which will appear as a tab named bash - "ip-.... This panel provides an interactive terminal session where you can run arbitrary shell commands. You can toggle it being open or closed with the F6 keyboard shortcut.

By default, Cloud9 EC2 environments come preconfigured with almost all of the required Prerequisites for working with RFDK, except for the version of NodeJS. We recommend using the [LTS release](https://nodejs.org/en/about/releases/) of NodeJS, which can be installed and configured with the following commands:

nvm install 14
echo "nvm use 14" >> ~/.bash_profile

Step 3: Encrypt Cloud9 EBS volume

Follow the instructions to encrypt the EBS volume used by the Cloud9 EC2 instance.

Step 4: Increase storage capacity (optional)

Note

This step is only required if you plan to stage and build Deadline container images. See Deadline Container Images for more details. If you do not have a specific need to build your own container images, you can skip this step.

By default, AWS Cloud9 creates a 10GB EBS volume for the root file-system of the EC2 instance hosting the Cloud9 environment. RFDK requires more storage for staging and building the Deadline container images. Follow the instructions to Resize an Amazon EBS volume used by an environment. For RFDK development, we recommend a minimum size of 40GB.

Step 5: Configure Cloud9 for use with CodeCommit

In this step, we configure git on our Cloud9 environment to use the AWS CLI credential helper. This uses Cloud9’s managed temporary credentials that are associated with the IAM user connected to the IDE. To configure this, run the following commands:

git config --global credential.helper '!aws codecommit credential-helper $@'
git config --global credential.UseHttpPath true

For more details, see Step 2: Configure the AWS CLI Credential Helper On Your AWS Cloud9 EC2 Development Environment in Integrate AWS Cloud9 with AWS CodeCommit in the AWS CodeCommit User Guide.

Step 6: Clone the AWS CodeCommit repository

In this step, we clone the CodeCommit repo created in Step 1: Create an AWS CodeCommit repository into your Cloud9 environment.

1. From the Cloud9 IDE, ensure the console panel is open. If not, press the F6 key to toggle it.

2. Run the following commands substituting my_repo_name with the CodeCommit repository name created in step 1.

   # Replace the value on the right-hand side with repository name from step 1
   CC_REPO_NAME=my_repo_name
               

   aws codecommit get-repository \
     --repository-name ${CC_REPO_NAME} \
     --query repositoryMetadata.cloneUrlHttp \
     --output text \
     | xargs git clone

Next steps

Now that you have a example RFDK development environment, you are ready to Build your first RFDK app. You can also review the following additional resources:

• Learn more about git

• Read the AWS Cloud9 User Guide