Automic Automation Helm Plugin

The Automic Automation Help Plugin is an optional tool to monitor the progress of an AAKE installation/ugrade process. This topic explains how to use it.

Note: This Helm Plugin works with Linux and can be used from a Linux CLI. If you use a Windows CLI, you might not be able to run all upgrade commands from it and might have to run them directly in Linux.

This page includes the following:

Installing the Helm Plugin

If you want to use the Automic Automation Helm plugin to manage and monitor the AAKE installation/upgrade process, you must install it first. The Helm plugin is not necessary, though. You can also install/upgrade AAKE without it. You can use the plugin both during the first installation of AAKE and for its upgrade. The Automic Automation Helm plugin requires the Helm Kubernetes Packagemanager.

Use the following commands to install the Helm plugin:

tar zxvf automic-automation-plugin-<version>.tgz

helm plugin install automic-automation-plugin-<version>

The following commands allow you to check the status of the update:

update updated the instance in the current namespace
status show the status of the instance in the current namespace
logs show the logs of the operator

Example

To monitor the installation use the plugin with the following command:

$ helm automic-automation status

Once the installation is complete the status is provisioned, the target and current versions should match the desired version. If this is not the case, check the Troubleshooting section of README.md file found in the Helm chart.

Using the Helm Plugin

There are different Helm commands that allow you to check the progress of your installation and/or update.

For example:

Get the status of the instance in the current namespace (including information about the expected manual actions)

helm automic-automation status
Continue with the update

Although it is not necessary to pause the install/upgrade process (for example, to wait for the database update), you may want to stop the process. You do it in the operator section of the values.yaml file by specifying true or false in the pauseOnUpgrade parameter. If you configure it to pause the installation/upgrade process, you can then continue with it by entering the following command:

helm automic-automation update --continue
Abort the current update

helm automic-automation update --abort
Retry the current update

helm automic-automation update --retry
Get help with the plugin commands available

helm automic-automation help
Get help with a specific command

helm automic-automation <command> help