Create Helm plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Helm plugin configuration parameters

Table 1. EC-Helm plugin configuration parameters
Parameter Description

Configuration name

Required. The name for the created configuration.


The description for the configuration.

Helm executable path

Required. An absolute or relative path to the Helm executable.

Kubectl executable path

The absolute path to the kubectl executable. Kubectl is only used as a fallback option to retrieve pod information in the microservice deployment when the Helm-generated manifest cannot be parsed with the current Perl YAML libraries. If the value is empty, the executable is looked up in the PATH environment variable.

Helm version

Required. The version of the Helm client. The actual version is checked via Check Connection.


The options to pass to the Helm executable. For example, --option-name[=parameter].

Config file

The configuration file that should be used.

  • Default: The default configuration file, /home/user/.kube/config.

  • Use existing: Use an existing file via a specified path.

  • Create new: Create a new temporary file with specific content.

Config file location

The path to a kubectl configuration file. For example:

  • /home/user/.kube/config

  • $[/myEnvironment/clusters/kub-cluster/kubeconfigpath]

Config file content

The content of the kubectl configuration file to use to connect to the cluster.

Kubeconfig context

Context used by Kubectl to run against the cluster.

Check connection resource

The resource that is used to check the connection.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.