Integrated Digital Engineering on AWS
  • 🚀First Time Users
    • What is IDEA?
    • Install IDEA
      • Pre-Requisites
      • Standard Installation
    • Access your IDEA cluster
      • Web Interface
      • Virtual Desktops (Linux/Windows)
      • SSH
      • APIs
    • File Browser
    • Let's get started
    • Cluster operations
      • Update IDEA cluster
        • Patch IDEA module (idea-admin.sh patch)
        • Update IDEA configuration (idea-admin.sh config)
        • Update IDEA backend resource (idea-admin.sh deploy)
        • Full IDEA Upgrade (idea-admin.sh upgrade-cluster)
      • Uninstall IDEA
  • 🤖Modules
    • What is a module?
    • Virtual Desktop Interfaces
      • User Documentation
        • Create a virtual desktop (Linux/Windows)
        • Stop/Delete/Hibernate a virtual desktop
        • Modify a virtual desktop
        • Share a virtual desktop
        • Virtual desktop scheduling
      • Admin Documentation
        • Dashboard
        • Sessions
        • Virtual Desktop Images (Software Stacks)
        • Permissions management
      • Technical
        • APIs
    • HPC Workloads
      • User Documentation
        • Submit a job
        • Script Workbench
        • Control my jobs
        • Supported EC2 parameters
        • Job Storage
        • Troubleshooting
          • My job is not starting
      • Admin Documentation
        • Queue Profiles
        • Create Web Based Job Submission Workflows
        • Configure Floating License resources
    • Cluster Manager
      • Users Management
      • Groups Management
      • Projects Management
      • Data Sharing Between Users
      • APIs
      • Cluster Status
      • Email Templates
    • Shared Storage
      • Storage Management
  • 👑Best Practices
    • Analytics
      • OpenSearch
        • Configure your OpenSearch
        • Create your own analytics visualizations
    • Budget
      • Review your AWS spend
      • Control your AWS spend
      • Set up budget per project
    • Security
      • Backup IDEA environment
  • 🧱Architecture
    • High Level Overview
  • 🛠️Developer Portal
    • IDEA CLI utility
    • Developer Onboarding
  • 🚨Help and Support
    • FAQ
    • Raise a bug
Powered by GitBook
On this page
  • Full Cluster Upgrade
  • Overview
  • Usage
  • Examples
  • Troubleshooting
  1. First Time Users
  2. Cluster operations
  3. Update IDEA cluster

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

PreviousUpdate IDEA backend resource (idea-admin.sh deploy)NextUninstall IDEA

Last updated 10 hours ago

🚀