⚙️
Integrated Digital Engineering on AWS
  • 🚀First Time Users
    • What is IDEA?
    • Install IDEA
      • Pre-Requisites
      • Standard Installation
    • Access your IDEA cluster
      • APIs
      • Virtual Desktops (Linux/Windows)
      • Web Interface
      • SSH
    • File Browser
    • Let's get started
    • Cluster operations
      • Uninstall IDEA
      • 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)
  • 🤖Modules
    • What is a module?
    • Virtual Desktop Interfaces
    • HPC Workloads
    • Cluster Manager
    • Shared Storage
  • 👑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
  1. Developer Portal

IDEA CLI utility

PreviousHigh Level OverviewNextDeveloper Onboarding

Last updated 2 years ago

idea-admin.sh utility is designed to simplify your interaction with your IDEA environment. With this simple tool, you can install a new environment, delete an existing cluster, update the configuration of a live environment or even retrieve the connection endpoints of your deployment via simple 1-liner commands. See some examples below:

  • Install a new cluster: quick-setup ( Install IDEA)

  • Generate an empty values_files.yml that can be used as base skeleton for your upcoming installation: quick-setup-help

  • Delete an existing environment: delete

  • Retrieve connection endpoints: show-connection-info

  • Run integration test for all modules: run-integration-tests

  • Update your cluster configuration via config ( Update IDEA configuration (idea-admin.sh config))

  • Patch an existing cluster via patch ( Patch IDEA module (idea-admin.sh patch))

  • Upgrade backend component via deploy ( Update IDEA backend resource (idea-admin.sh deploy))

  • Manage additional FileSystems easily via shared-storage ( )

  about                    print IDEA release version info
  bootstrap                bootstrap cluster
  build-bootstrap-package  build bootstrap package for a module
  cdk                      cdk app
  check-cluster-status     check status for all applicable cluster endpoints
  config                   configuration management options
  delete-cluster           delete cluster
  deploy                   deploy modules
  directoryservice         directory service utilities
  list-modules             list all modules for a cluster
  patch                    patch application module with the current release
  quick-setup              Install a new cluster
  quick-setup-help         display quick-setup help
  run-integration-tests    run integration tests for a module
  shared-storage           shared-storage options
  show-connection-info     print cluster connection information
  sso                      single sign-on configuration options
  support                  support options
  upload-packages          upload applicable packages for a module
  utils                    cluster configuration utilities

Always use -h at the end of your command to list all available options

🛠️
Storage Management