Full IDEA Upgrade (idea-admin.sh upgrade-cluster)

Full Cluster Upgrade

Overview

The upgrade-cluster command combines multiple steps that were previously separate into a single operation:

  1. Updating the base OS configuration

  2. Updating infrastructure AMIs

  3. Backing up and regenerating global settings

  4. Deploying all modules with the --upgrade flag

Usage

The basic syntax for the upgrade command is:

./idea-admin.sh upgrade-cluster [OPTIONS] [MODULES...]

If no modules are specified, all modules will be upgraded automatically.

Required Parameters

  • --cluster-name: Name of your IDEA cluster

  • --aws-region: AWS region where the cluster is deployed

Optional Parameters

  • MODULES: List of modules to upgrade (e.g., cluster, metrics, scheduler, etc.). If not specified, all modules will be upgraded.

  • --base-os: New base OS to upgrade to. If not specified, defaults to amazonlinux2023. Supported options are:

    • amazonlinux2023 (default)

    • rhel8

    • rhel9

    • rocky8

    • rocky9

  • --aws-profile: AWS profile to use for the operation

  • --termination-protection: Set CloudFormation stack termination protection (default: true)

  • --force-build-bootstrap: Re-build bootstrap package even if directory exists

  • --rollback/--no-rollback: Enable/disable stack rollback on failure (default: true)

  • --optimize-deployment: Deploy applicable stacks in parallel to speed up the process

  • --force: Skip all confirmation prompts

  • --skip-global-settings-update: Skip the global settings update if you've already done it

  • --module-set: Name of the module set to use (default: default)

  • --deployment-id: UUID to identify the deployment

Examples

Full Upgrade to Default Base OS (Amazon Linux 2023)

The simplest way to upgrade all infrastructure components:

./idea-admin.sh upgrade-cluster \
  --aws-region us-east-2 \
  --cluster-name idea-test1 \
  --aws-profile default

Full Upgrade with Explicit Base OS

Explicitly specify the base OS (same as default):

./idea-admin.sh upgrade-cluster --base-os amazonlinux2023 \
  --aws-region us-east-2 \
  --cluster-name idea-test1 \
  --aws-profile default

Upgrade Only Specific Modules

To upgrade only the scheduler and cluster-manager components:

./idea-admin.sh upgrade-cluster scheduler cluster-manager \
  --base-os amazonlinux2023 \
  --aws-region us-east-2 \
  --cluster-name idea-test1 \
  --aws-profile default

Skip Global Settings Update

If you've already updated global settings and want to skip that step:

./idea-admin.sh upgrade-cluster --skip-global-settings-update \
  --aws-region us-east-2 \
  --cluster-name idea-test1 \
  --aws-profile default

Optimize for Speed (experimental)

Use parallel deployment where possible:

./idea-admin.sh upgrade-cluster --base-os amazonlinux2023 \
  --optimize-deployment \
  --aws-region us-east-2 \
  --cluster-name idea-test1 \
  --aws-profile default

Troubleshooting

If the upgrade fails during the pre-upgrade configuration stage:

  1. Make sure your values.yml file correctly reflects your desired configuration

  2. Verify AMI IDs are available in your target region

If the upgrade fails during deployment:

  1. Check the CloudFormation console for error details

  2. Fix any issues and retry with the same command

  3. Use --no-rollback to prevent stack rollback for easier debugging

Last updated