Patch IDEA module (idea-admin.sh patch)
Use the Patch command if you have updated the codebase of one of your module (e.g: developed new API, updated a function/class). Refer to Update IDEA configuration (idea-admin.sh config) for other types of updates.
To patch/update one IDEA module, run the following idea-admin.sh patch <MODULE_NAME>
command.
Pre-Requisite
You must have completed your Developer Onboarding and generated the local dist
archives by running invoke clean build package
You also must be running this command on a system that has the permission to upload objects into the s3 bucket created during the CDK bootstrap phase.
Workflow
IDEA admin clones the latest IDEA codebase locally. Onboard to Developer Onboardingand run
invoke clean build package
to create the latestdist
archivesIDEA admin triggers
idea-admin.sh patch <MODULE> --aws-region <REGION> --cluster-name <CLUSTER_NAME>
idea-admin.sh will retrieve the latest
dist
archive(s) (inside thedist
folder generated during theinvoke clean build
package command)idea-admin.sh will upload the
dist
file(s) to the S3 bucket created by thecdk bootstrap
command during the installation of IDEAidea-admin.sh will trigger AWS System Manager (SSM)
AWS SSM triggers a
run-command
on the EC2 machine running the IDEA module you are planning to updateEC2 machine will download the
dist
archive(s) from S3, install it and then restart the relevant IDEA services
Example: Updating the cluster-manager
module of a running IDEA environment
cluster-manager
module of a running IDEA environmentinvoke clean build package
can take some time as IDEA will generate the dist
builds for all modules. You can speed up the process by manually specify which package you want to build by specify the package name:
invoke devtool.build -m <MODULE>
Last updated