Helm Configuration Files

The Helm tool contains two configuration files:

  • The config.yaml file, which contains the path to the helm.exe file
  • The sync_config.yaml file, which contains the configuration parameters for your Kubernetes deployment.

This page includes the following:

File Location

  • The config.yaml file is stored in the includes\cli-required\conf folder.
  • The sync_config.yaml file is located in the src\main\resources folder

config.yaml Configuration Parameters

  • helmExecutablePath 

    Path to the directory where the helm.exe file is stored.

    Notes:

    • This path points to the default location of the folder where the helm.exe file is stored in a local installation of Helm.
    • The path can be absolute or relative (to the jar dir)
    • Delete the default value to use the Helm configured in the PATH environment variable.

    Default: libs

sync_config.yaml Configuration Parameters

  • connection

    • url(required): 

      Absolute url to the Release Manager.

      Default: empty

    • username (required)

      Default: 100/AUTOMIC/AUTOMIC

      Important! If the Release Manager has more than one client, the system must be specified. For example: AUTOMIC/100/USERNAME/DEPARTMENT

    • password (required)

      Default: empty

  • folder

    Default: DEFAULT

  • application

    Parameters related to the CDA Application.

    Note: if application.name is not set, the chart name is used instead.

    • name

      Default: empty

    • folder
    • type: Generic
  • artifactSource

    Parameters related to the Artifact Source. See: Working with Artifact Sources

    • name: HelmSource
    • type: Helm
  • parentComponent

    • type: Helm Chart
  • nestedComponent

    • type: Helm Chart Container
  • deploymentPackage

    • type: Helm
    • chartLocation:

      Dynamic property of the Component. It is used to install/upgrade the chart from the Target agent. If the value is not set, the property is prompted when executing the Workflow.

      Default:empty

  • workflow

    • name: deploy
    • type: Install