macaw application

cfxDimensions Platform Application Management:

macaw application command provides very comprehensive CLI options to view, provision, de-provision or delete, start or stop application services. Additionally, it allows user to invoke application APIs using this command line. This provides an ability to create automated scripts to provision, de-provision or upgrade application services using Macaw CLI interface.

Below step is a pre-requisite to use macaw application and to execute API calls using CLI.

Run the below command to generate an API key for Platform admin user and the generated API key is stored inside platform.cfg file which will be used while making API calls from CLI.

Use --insecure option as shown below when the cfxDimensions platform is NOT deployed with CA signed certificates. --insecure option works with self-signed certificates which are installed by default during cfxDimensions platform setup and configuration.

macaw platform --insecure access-key-gen --user --password macaw1234 --store-config
macaw platform access-key-gen --help

usage: macaw platform access-key-gen [-h] [--debug] --user USER --password
                                     PASSWORD [--store-config]

optional arguments:
  -h, --help           show this help message and exit
  --debug              Enable debug logs
  --user USER          User for whom the access-key is to be generated
  --password PASSWORD  Password to use for login during access-key generation
  --store-config       Store the generated access key into the platform

Below command lists the available published catalog of application blue-prints for cfxDimensions platform.

macaw application --insecure catalog

The available application blue-prints for cfxDimensions platform is categorized into 'Groups'. Below are available groups.

  • Production

  • QA

  • Demo (Deprecated)

  • Datasets (Deprecated)

  • Individual Services (Deprecated)

For production deployments, user need to pick the catalog of application blue-prints from Production group. QA group is primarily used for Demos, Release Candidate version or POCs

Below command lists the Production group catalog which has currently available GA (general available) releases for cfxAIA, cfxOIA, cfxGenie and cfxPulse (deprecated) applications.

macaw application --insecure catalog --group Production

To list the configuration properties of a published blue-print of an application (cfxAIA, cfxOIA, cfxGenie and cfxPulse (deprecated)), execute the below command. It requires blue-print id as an input which can be obtained from above command. (macaw application --insecure catalog)

macaw application --insecure show-blueprint <blue-print-id>

Below command shows, currently deployed cfxDimensions applications and their status. It includes application ID, blue-print name, application service name & status and on which service node it is running etc...

macaw application --insecure status

When multiple cfxDimensions applications are installed, below command can be used to view specific application information. It requires application id as an argument which can be found in 'macaw application status' command output.

macaw application --insecure status --app-id <app-id>

Below commands can be used to stop or start a specific application service. (It requires application id as an argument which can be found in 'macaw application status' command output.)

macaw application --insecure stop <appid>
macaw application --insecure start <appid>

Below command provide configuration information of a currently deployed cfxDimensions applications. It requires application ID as an argument to show the configuration. (Please refer 'macaw application status' command output.)

macaw application --insecure show-config <appid>

To delete/un-install a deployed cfxDimensions application, below command can be executed.

macaw application delete CLI operation is a disruptive operation. It is recommended to take full system backup in Production environment before this command can be executed.

macaw application --insecure delete <appid>

Last updated