CloudFormation Deployment

Learn how to deploy Code Ocean via CloudFormation.

When you have completed prerequisites and have hosting domain information handy, you can continue deploying Code Ocean via AWS CloudFormation. Visit AWS CloudFormation's website for more information.

The deployment takes about 40 minutes to complete.

Usually Code Ocean CloudFormation stack is being managed by AWS account admins. However, if you wish to manage you Code Ocean CloudFormation stack using a least privileged CloudFormation deployment role, you can find it here.

Create CloudFormation Stack

Code Ocean deployment is publicly available via AWS S3. Go to AWS CloudFormation -> Stacks -> Create stack or follow this link, to autofill all the fields, to start creating a deployment stack in CloudFormation, with Code Ocean's latest release template.

The following steps are consistent with the steps of creating a stack in AWS CloudFormation.

Step 1 - Specify the template

1. Choose Template is ready in the Prerequisite section.

2. Choose Amazon S3 URL in the Specify template section.

3. Enter https://codeocean-vpc.s3.amazonaws.com/templates/v3.1.8/codeocean.template.yaml

4. Click Next.

Step 2 - Specify stack details

Most configuration parameters are set to the recommended defaults.

1. Choose a name for the deployment stack, the default will be codeocean (Please note that the name cannot start with aws).

2. Set DNS name to codeocean.

3. Set DNS Root Domain to the hosting domain (e.g. [company].com). Visit Prerequisites if you need more information.
4. Set Availability Zone 1 and Availability Zone 2 for the VPC

5. Scroll to the bottom and click Next.

Stack Parameters are set by default to their recommended values for the default internet-facing deployment type. Please visit Deployment Parameters page for the full list of parameters and their purpose. Note that there are some changes required according to AWS region and/or deployment type.

Please contact our support or email [e-mail] if you have any questions or you need help regarding parameters values.

Step 3 - Configure stack options (optional)

You can specify tags (key-value pairs) for resources in your stack and set advanced options.

Click Next when you are done.

Visit the Resource tag page on AWS for more information about specifying tags.

Visit the AWS CloudFormation stack options page on AWS for more information about advanced options.

Step 4 - Review

1. Review and assure that all the details are correct.

2. Check the box to acknowledge that CloudFormation might create IAM resources.

3. Click Create Stack to start the deployment.

After you click on Create Stack, you will be redirected to the stack screen where you can follow the progress of your stack deployment :

SSL Certificate Approval

This section applies only to deployments that use Email Validation to provision an ACM SSL certificate. When using DNS Validation, the SSL Certificate will be approved automatically.

For more information, please refer to the SSL Certificate Validation section.

For the deployment to be completed successfully, you or your IT administrator must approve the SSL certificate request. You will receive an email from AWS asking you to approve the certificate.

This email will be sent to the following email addresses:

• administrator@your_domain_name

• hostmaster@your_domain_name

• postmaster@your_domain_name

• webmaster@your_domain_name

• admin@your_domain_name

To approve the certificate request:

1. Choose the Amazon Certificate Approvals link in the email.

2. Click I Approve on the page you get directed to.

Deployment Completion

When the deployment is finished, the state of the CloudFormation stack will turn into CREATE_COMPLETE .

Post Deployment

Subscribing to AWS Alarms

We recommend subscribing to AWS Alarms, to prevent system issues. To subscribe and learn more about alarms, navigate to the Alarms help page.