HELM-CDA CLI Sync Tool

This tool is shipped with the helm.exe file and leverages it for parsing chart and building dependencies.

Important! Update the Helm Configuration Filesto use a different helm binary.

Parameters

• connection.url

  CDA url.

  Mandatory: yes

  Shortcut: url

  Example: http://10.0.0.10/cda

• connection.username

  CDA full user name.

  Mandatory: yes

  Shortcut: u

  Default: AUTOMIC/100/AUTOMIC/AUTOMIC

• connection.password

  CDA password.

  Mandatory: yes

  Shortcut: pw

• folder

  Name of the folder where the entities are to be stored.

  Shortcut: f

• (optional) chartFile

  Path to the config yaml file containing default values to be used in case the command line arguments are not defined.

  Shortcut: f

• (optional) chartLocation

  Path to the chart file.

  Default: Component dynamic property /chart_location

• (optional) applicationData.name

  Name of the Application to synchronize.

  Default: If not defined, the chart name is used.

  Important! You can specify the application name by using the following parameter: --set application.name=<new_app_name>. This command only supports the path to an unpacked chart directory.

  Shortcut: a

• applicationData.type

  Type of Application to be created.

  Shortcut: at

• applicationData.typeVersion

  Version of the application.

• component.containertype

  Type of the container Component to be created.

  Shortcut: ct

• component.charttype

  Type of chart Component to be created.

  Shortcut: cct

• package.type

  Type of the Package to be created

  Shortcut: pt

• workflow.name

  Name of the deployment Workflow to be created.

  Shortcut: w

• workflow.type

  Type of the Workflow to be created.

  Shortcut: wt

Sync Commands

Init Command

helm2rm init [options]

• To generate a sync_config.yaml file with the default values in the current directory, use the following command:

  helm2rm init

• Path

  To define the path where the sync_config file should be created, use the path option.

  • Values: -p, --path
  • Example: helm2rm init [-p=<syncConfigFilePath>]

• Help

  To display the help message, use the help option.

  • Values: -h, --help
  • Example: helm2rm init [-h]

Sync Command

helm2rm sync [-h] [--set=<values>] [-f=<configFile>] <Chart>

• File

  To synchronize all options defined in the sync_config file, use the file option.

  • Values: -f, --file
  • Example: helm2rm sync --file sync_config.yaml

• Set

  • Value: --set
  • Examples:

    • To synchronize the content without specifying the values defined in the sync_config file, use the set option.

      Note: Undefined parameters are populated with default values (for example, name or folder name).

      helm2rm sync --set connection.url=http://myserver/cda,connection.username=AUTOMIC/100/AUTOMIC/AUTOMIC,connection.password=changeit,application.name=sample_app C:\charts\mychart\

    • To synchronize the options defined in the sync_config file and specify some values directly, use both the set and the file options.

      helm2rm sync --file sync_config.yaml --set application.name=sample_app,application.type="Helm"

• Help

  To display the help message, use the help option.

  • Values: -h, --help
  • Example: helm2rm sync [-h]

Examples

• Sync chart to Component (one Application and one Component is created by default)

  helm2rm sync -a myappname C:\charts\stable\wordpress

• Sync chart to Application (one Application and Components mapped to the chart containers are created)

  helm2rm sync -m application -a myappname C:\charts\stable\wordpress