Back to Top
Add Chart Repository
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.RepositoryAddTask |
| Category | Helm |
Add Repository on the target host.
Description
Add Chart Repository on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| repoCAFile | java.lang.String | true | Optional, verify certificates of HTTPS-enabled servers using this CA bundle file when connecting to the remote repository (if required). | |
| repoCertFile | java.lang.String | true | Optional, identify HTTPS client using this SSL certificate file when connecting to the remote repository (if required). | |
| repoKeyFile | java.lang.String | true | Optional, identify HTTPS client using this SSL key file when connecting to the remote repository (if required). | |
| repoName | java.lang.String | stable | false | The name of the Chart repository to add. |
| repoPassword | java.lang.String | true | Optional, the password to use to authenticate when connecting to the remote repository (if required). | |
| repoURL | java.lang.String | https://kubernetes-charts.storage.googleapis.com/ | false | The URL of the chart repository to add. |
| repoUsername | java.lang.String | true | Optional, the username to use to authenticate when connecting to the remote repository (if required). | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Get Version
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.VersionGetTask |
| Category | Helm |
Get the version of Helm on the target host.
Description
Get the version of Helm on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| outputParameter | java.lang.String | ${helmVersion} | true | The name of the output parameter, which can pass the return value from the task. The task output will be the script output value. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${helmVersion}. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Install Chart Release
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.ReleaseInstallTask |
| Category | Helm |
Install Chart on the target host.
Description
Install Chart Release on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| atomic | java.lang.Boolean | false | true | Optional, enable this to set the installation process deletes the installation on failure. The wait will be set automatically if atomic is used. |
| chartName | java.lang.String | false | The name of the chart to install. This could be empty if Generate Name is set in true. | |
| chartVersion | java.lang.String | true | Optional, set the exact chart version to use. If this is not specified, the latest version is used. | |
| createNamespace | java.lang.Boolean | false | true | Optional, enable this to create the release namespace if not present. |
| dependencyUpdate | java.lang.Boolean | false | true | Optional, enable this to run helm dependency update before installing the chart. |
| description | java.lang.String | true | Optional, add custom description of the release to install. | |
| dryRun | java.lang.Boolean | false | true | Optional, enable this to simulate an install. |
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| generateName | java.lang.Boolean | false | true | Optional, enable this to generate the name (and omit the name). |
| noHooks | java.lang.Boolean | false | true | Optional, enable this to prevent hooks from running during install. |
| releaseName | java.lang.String | true | The name of the release to install. Leave empty if generate name is set in true. | |
| replace | java.lang.Boolean | false | true | Optional, enable this to re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production. |
| repoCAFile | java.lang.String | true | Optional, verify certificates of HTTPS-enabled servers using this CA bundle file when connecting to the remote repository (if required). | |
| repoCertFile | java.lang.String | true | Optional, identify HTTPS client using this SSL certificate file when connecting to the remote repository (if required). | |
| repoKeyFile | java.lang.String | true | Optional, identify HTTPS client using this SSL key file when connecting to the remote repository (if required). | |
| repoPassword | java.lang.String | true | Optional, the password to use to authenticate when connecting to the remote repository (if required). | |
| repoURL | java.lang.String | true | Optional, the URL of the chart repository to install. | |
| repoUsername | java.lang.String | true | Optional, the username to use to authenticate when connecting to the remote repository (if required). | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| templateName | java.lang.String | true | Optional, set the template used to name the release to install. | |
| values | java.lang.String | true | Optional, the set of values of the chart to install. (can specify multiple or separate values with commas: key1=val1,key2=val2) | |
| valuesFile | java.lang.String | true | Optional, set the values file in YAML format of the chart to install. | |
| verify | java.lang.Boolean | false | true | Optional, enable this to verify the package before using it. |
| wait | java.lang.Boolean | false | true | Optional, enable this to wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as timeout. |
| waitTimeout | java.lang.String | 5m0s | true | Optional, time to wait for any individual Kubernetes operation (like Jobs for hooks). |
Back to Top
List Chart Releases
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.ReleaseListTask |
| Category | Helm |
List Releases on the target host.
Description
List Chart Releases on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| outputFormat | java.util.List | table | true | The output format type for repositories list. |
| outputParameter | java.lang.String | ${listResult} | true | The name of the output parameter, which can pass the return value from the task. The task output will be the script output value. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${listResult}. |
| quietOutput | java.lang.Boolean | false | true | Optional, enable this to output short (quiet) listing format. |
| resultFilter | java.lang.String | true | Optional, set the filter value based on regular expression. Any releases that match the expression will be included in the results. | |
| resultMax | java.lang.String | 256 | true | Optional, maximum number of releases to fetch (default 256). |
| resultOffset | java.lang.String | 0 | true | Optional, set the value to offset from start value the result. |
| reverseOrder | java.lang.Boolean | false | true | Optional, enable this to reverse the sort order. |
| showAll | java.lang.Boolean | false | true | Optional, enable this to show all releases without any filter applied. |
| showAllNamespace | java.lang.Boolean | false | true | Optional, enable this to list releases across all namespaces. |
| showDeployed | java.lang.Boolean | false | true | Optional, enable this to show deployed releases. If no other is specified, this will be automatically enabled. |
| showFailed | java.lang.Boolean | false | true | Optional, enable this to show failed releases. |
| showPending | java.lang.Boolean | false | true | Optional, enable this to show pending releases. |
| showSuperseded | java.lang.Boolean | false | true | Optional, enable this to show superseded releases. |
| showUninstalled | java.lang.Boolean | false | true | Optional, enable this to show uninstalled releases (if uninstall keep history feature was used). |
| showUninstalling | java.lang.Boolean | false | true | Optional, enable this to show releases that are currently being uninstalled. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| sortByDate | java.lang.Boolean | false | true | Optional, enable this to sort by release date. |
Back to Top
List Chart Repositories
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.RepositoryListTask |
| Category | Helm |
List Repositories on the target host.
Description
List Chart Repositories on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| outputFormat | java.util.List | table | true | The output format type for repositories list. |
| outputParameter | java.lang.String | ${listResult} | true | The name of the output parameter, which can pass the return value from the task. The task output will be the script output value. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${listResult}. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Remove Chart Repository
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.RepositoryRemoveTask |
| Category | Helm |
Remove Repository on the target host.
Description
Remove Chart Repository on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| repoName | java.lang.String | stable | false | The name of the Chart repository to remove. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Uninstall Chart Release
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.ReleaseUninstallTask |
| Category | Helm |
Uninstall Chart on the target host.
Description
Uninstall Chart Release on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| description | java.lang.String | true | Optional, add custom description. | |
| dryRun | java.lang.Boolean | false | true | Optional, enable this to simulate an uninstall. |
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| keepHistory | java.lang.Boolean | false | true | Optional, enable this to remove all associated parameters and mark the release as deleted, but retain the release history. |
| noHooks | java.lang.Boolean | false | true | Optional, enable this to prevent hooks from running during uninstallation. |
| releaseName | java.lang.String | false | The name of the release to uninstall. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| waitTimeout | java.lang.String | 5m0s | true | Optional, time to wait for any individual Kubernetes operation (like Jobs for hooks). |
Back to Top
Update Chart Repositories
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovisioner.helm.tasks.RepositoryUpdateTask |
| Category | Helm |
Update Repositories on the target host.
Description
Update Chart Repositories on the target host.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| failOnError | java.lang.Boolean | true | false | This task will not fail the job on error if set to false. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |