Upgrade Code Ocean

Learn how to upgrade your Code Ocean Version

Overview

Upgrading a Code Ocean VPC deployment to a new version is performed by simply updating the CloudFormation stack with a new CloudFormation template.

Prerequisites

1. If you have a backup stack configured, please follow the upgrade procedure for the backup stack using the latest CloudFormation backup stack template version prior to upgrading the linked primary deployment.

2. If you are using a least privileged IAM role to update your CloudFormation stack, make sure to first update your least privileged IAM role. Learn more.

Enable Maintenance Mode

Before you start the CloudFormation update of your Code Ocean VPC stack, it's required that all active sessions are saved and there are no ongoing computations.

Putting the system in maintenance mode restricts user access to the system, while performing essential tasks prior to a system update, including stopping running computations, stopping system and AWS Batch jobs, and terminating worker instances.

To minimize disruption, notify users in advance, and consider using the user banner message to communicate this effectively. Learn more.

1. From the Code Ocean VPC Admin Panel, click System Maintenance

2. Click on Enable Maintenance Mode

The system will provide progress information on the maintenance mode steps. When the steps are complete, the system is ready and you can then proceed with the CloudFormation upgrade. Once the upgrade is complete, the system will automatically disable maintenance mode. Alternatively, you can manually disable maintenance mode at any time by clicking Disable Maintenance Mode.

The maintenance mode is introduced in v3.1, so if you are upgrading from version < 3.1, please follow this guide to manually stop the activity on AWS before updating the CFN Stack.

Update the CloudFormation Stack

Upgrading Code Ocean is done by updating the CloudFormation stack you've created upon deployment :

On the next screen, select Replace current template, then Amazon S3 URL, and specify the CloudFormation template URL. You can find the URL in Step 1 - Specify the template section, or use a URL you've received from our support team:

Click Next when you are done.

Specify Stack Details

The Analytics RDS Instance Allocated Storage parameter must be verified during upgrades, as the RDS instance storage can scale up automatically. The parameter should be adjusted accordingly to prevent upgrade failures.

Stack's Parameters will be set to the values that have been set upon the latest upgrade/deployment, or to their recommended defaults. Please visit the Deployment Parameters page for the full list of parameters and their purpose. Please contact our support or email [email protected] if you have any questions or you need help regarding parameters values.

Click Next.

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.

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 Update stack to start the deployment.

After you click on Update stack, you will be redirected to the stack screen where you can follow the progress of your stack update under the Events tab.

Upgrade Completion

When the stack update is finished, the state of the CloudFormation stack will turn into UPDATE_COMPLETE .