v2.3

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.

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/v2.3.0/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.

  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 support@codeocean.com 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

For the deployment to be completed successfully, your hostmaster/system administrator must approve the SSL certificate. 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

You must have access to one of these email addresses. The deployment will eventually fail if you are unable to log in or if you direct someone else to log in to approve the certificate request.

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.

For more information and examples, see Use Email to Validate Domain Ownership in the ACM documentation.

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.

PreviousPrerequisitesNextDeployment Parameters

Last updated