Update

Update node group size

cortex cluster scale --node-group <node-group-name> --min-instances <min-instances> --max-instances <max-instances>

Upgrade to a newer version

# spin down your cluster
cortex cluster down --name <name> --region <region>

# update your CLI to the latest version
pip install --upgrade cortex

# confirm version
cortex version

# spin up your cluster
cortex cluster up cluster.yaml

Upgrade without downtime

In production environments, you can upgrade your cluster without downtime if you have a backend service or DNS in front of your Cortex cluster:

1. Spin up a new cluster. For example: cortex cluster up new-cluster.yaml --configure-env cortex2 (this will create a CLI environment named cortex2 for accessing the new cluster).

2. Re-deploy your APIs in your new cluster. For example, if the name of your CLI environment for your existing cluster is cortex, you can use cortex get --env cortex to list all running APIs in your cluster, and re-deploy them in the new cluster by running cortex deploy --env cortex2 for each API. Alternatively, you can run cortex cluster export --name <previous_cluster_name> --region <region> to export the API specifications for all of your running APIs, change directories the folder that was exported, and run cortex deploy --env cortex2 <file_name> for each API that you want to deploy in the new cluster.

3. Route requests to your new cluster.

   • If you are using a custom domain: update the A record in your Route 53 hosted zone to point to your new cluster's API load balancer.

   • If you have a backend service which makes requests to Cortex: update your backend service to make requests to the new cluster's endpoints.

   • If you have a self-managed API Gateway in front of your Cortex cluster: update the routes to use new cluster's endpoints.

4. Spin down your previous cluster. If you updated DNS settings, wait 24-48 hours before spinning down your previous cluster to allow the DNS cache to be flushed.

5. You may now rename your new CLI environment name if you'd like (e.g. to rename it back to "cortex": cortex env rename cortex2 cortex)