Create Helm plugin procedures

Plugin procedures can be used in procedure steps, process steps, and pipeline tasks, allowing you to orchestrate third-party tools at the appropriate time in your component, application process, or pipeline.

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.

Delete Release

Deletes a release from Kubernetes. It removes all of the resources associated with the last release of the chart.

Input parameters

Table 1. Delete Release input parameters
Parameter	Description
Configuration name	Required. The previously defined configuration for the plugin.
Release name	Required. The release name.
Options	The options to pass to the Helm executable. For example, `--option-name[=parameter]`.
Action on error	Required. Ignores errors if they are expected. For example, if a repository is already present or an item to be deleted does not exist.
Error value	A pattern that triggers the Action on error condition.
Result property sheet	Required. Results are saved into this property/property sheet.

Output parameters

Table 2. Delete Release output parameters
Parameter	Description
deleteRelease	STDOUT after successfully completing the command.

Install Chart

Installs a chart archive.

Input parameters

Table 3. Install Chart input parameters
Parameter	Description
Configuration name	Required. The previously defined configuration for the plugin.
Release name	Required. The name of the release to deploy.
Chart	Required. Specifies the chart to install. The following methods can be used: Chart reference: `stable/mariadb` Path to a packaged chart: `./nginx-1.2.3.tgz` Path to an unpacked chart directory: `./nginx` Absolute URL: `https://example.com/charts/nginx-1.2.3.tgz` Chart reference and repo url: `--repo https://example.com/charts/ nginx`
Options	The options to pass to the Helm executable. For example, `--option-name[=parameter]`.
Values	Specify the content for a YAML file that will be passed to the command.
Result property sheet	Required. Results are saved into this property/property sheet.

Output parameters

Table 4. Install Chart output parameters
Parameter	Description
installChart	STDOUT after successfully completing the command.

Rollback Release

Rolls back a release to a previous revision.

Input parameters

Table 5. Rollback Release input parameters
Parameter	Description
Configuration name	Required. The previously defined configuration for the plugin.
Release name	Required. The release name.
Revision number	Required. A revision (version) number of the release.
Options	The options to pass to the Helm executable. For example, `--option-name[=parameter]`.
Result property sheet	Required. Results are saved into this property/property sheet.

Output parameters

Table 6. Rollback Release output parameters
Parameter	Description
rollbackRelease	STDOUT after successfully completing the command.

Run Custom Command

Run any Helm command.

Input parameters

Table 7. Run Custom Command input parameters
Parameter	Description
Configuration name	Required. The previously defined configuration for the plugin.
Command	Required. The name of the command.
Arguments	Arguments to pass to the Helm executable for the command.
Options	The options to pass to the Helm executable. For example, `--option-name[=parameter]`.
Values	Specify the content for a YAML file that will be passed to the command.
Action on error	Required. Allows ignoring errors when they are expected. For example, the repository is already present or an item to delete does not exist.
Error value	A pattern that triggers the Action on error condition.
Result property sheet	Required. Results are saved into this property/property sheet.

Output parameters

Table 8. Run Custom Command output parameters
Parameter	Description
runCustomCommand	STDOUT after successfully completing the command.

Upgrade Release

Upgrades a release to a specified version of a chart and/or updates chart values.

Input parameters

Table 9. Upgrade Release input parameters
Parameter	Description
Configuration name	Required. The previously defined configuration for the plugin.
Release name	Required. The release name.
Chart	Required. Specifies the chart to install. The following methods can be used: Chart reference: `stable/mariadb` Path to a packaged chart: `./nginx-1.2.3.tgz` Path to an unpacked chart directory: `./nginx` Absolute URL: `https://example.com/charts/nginx-1.2.3.tgz` Chart reference and repo url: `--repo https://example.com/charts/ nginx`
Options	The options to pass to the Helm executable. For example, `--option-name[=parameter]`.
Values	Specify the content for a YAML file that will be passed to the command.
Result property sheet	Required. Results are saved into this property/property sheet.

Output parameters

Table 10. Upgrade Release output parameters
Parameter	Description
upgradeRelease	STDOUT after successfully completing the command.