A shell is a program that provides an interface to the services of the operating system either through a command-line interface (CLI) or graphical user interface (GUI). For either interface, the primary purpose of the shell is to call or start another program. Shells frequently have more capabilities such as viewing the contents of directories. The Shell plugin for HCL Accelerate allow you to include running a shell as part of a release task.
The Shell plugin allows allows for running a shell script as part of the release process.
This plugin includes one or more steps, click Steps for step details and properties.
This plugin requires HCL Accelerate version 2.0.x or later.
To use the Shell plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. If necessary, load the plugin into the HCL Accelerate container, from the user interface, click Settings > Integrations > Plugins. On the Plugins page, locate the plugin and click Load Plugin.
To create an instance, locate the plugin on the Plugins page and click Install. The plugin is now listed below those plugins to be installed and available for integration. After the integration is complete, the Execute Shell automation task is available for use in a release process.
See the Automation Tasks tab for information on using automation tasks.
There are two methods to integrate the plugin:
The JSON file contains the information for creating a value stream and integrating with the xx server. The following table describes the information for the creating a HCL Accelerate value stream map.
The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.
Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.
| Name | Description | Required | Property Name |
|---|---|---|---|
| NA | The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. | No | image |
| Integration Name | An assigned name to the value stream. | Yes | name |
| Logging Level | The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. | No | loggingLevel |
| NA | List of plugin configuration properties. Enclose the properties within braces. | Yes | properties |
| The name of the tenant. | Yes | tenant_id | |
| NA | Unique identifier assigned to the plugin. The value for the Shell plugin is ucv-ext-shell |
Yes | type |
| Name | Type | Description | Required | Property Name |
|---|---|---|---|---|
| User Access Key | Secure | The access token secret for oauth authentication. Used to communicate with HCL Accelerate. | Yes | ucvAccessKey |
The following process steps are available in the Shell plugin.
Runs a shell script.
| Name | Description | Required |
|---|---|---|
| Name | The name of the step. | No |
| Description | A description of the step. | No |
| Shell Script | The shell script to run in the task. | Yes |
Complete the following steps to include the plugin in a release process.
Uploaded: 04-Apr-2024 11:52
docker pull hclcr.io/accelerate/ucv-ext-shell:0.0.34
Uploaded: 06-May-2022 08:39
docker pull hclcr.io/accelerate/ucv-ext-shell:0.0.31
Uploaded: 08-Feb-2021 08:55
docker pull hclcr.io/accelerate/ucv-ext-shell:0.0.7
Summary
Usage
Configuration Properties
Automation Tasks
