Skip to main content

Update Plan


1. Overview

The Update Plan action allows you to change your instance's GPU or CPU configuration to scale resources up or down based on your workload requirements.

DetailDescription
PrerequisiteThe instance must be in a Stopped state before updating the plan.
API SupportAn instance plan can be updated using an API request. Refer to the Update Instance API documentation for request parameters and examples.

2. When to Use

ScenarioDescription
Scale UpWhen your workload has grown and requires more compute resources.
Scale DownWhen you want to scale down to reduce costs during low-demand periods.

It is recommended to follow these steps to safely update your instance plan.

Step 1: Save Image (Backup)

Before making any changes, create a backup of your current environment.

  1. Ensure the instance is in a Running state.
  2. Navigate to the instance and click Save Image.
  3. Wait for the image to be saved successfully.

This ensures you can roll back to your current environment if needed.

Step 2: Stop the Instance

Stop the instance from the Actions menu and wait until it reaches a Stopped state.

Step 3: Update the Plan

  1. Click Update Plan from the Actions menu.
  2. Select your desired GPU or CPU configuration.
  3. Click Confirm to apply the changes.

The instance will briefly show a Waiting status before returning to a Running state.

Step 4: Restore Image (If Needed)

Once the instance is running again, restore your saved image if you need to restore your previous environment.


Best Practices for Updating Plans

Save Image first

Always create a Save Image before updating the plan. This gives you a rollback point if anything goes wrong during or after the upgrade.

Workspace volumes

Attached workspace volumes remain intact after the plan upgrade. No data loss occurs during the plan upgrade process.

Verify after update

Verify instance health after completing the update before resuming workloads to confirm the new configuration is active.

Rollback capability

If the new plan does not meet expectations, use the saved image to restore your previous environment on the updated instance.