Pipelines enables creation of user-defined resources to extend the Pipelines DSL.
Resources typically contain information needed for a step in a pipeline to execute and can also be used to store information produced by a step.
Extension resources enable Pipelines users to extend the Pipelines DSL by specifying their own resource types. When loaded into Pipelines, these user-defined resources can be used in any pipeline just like any other resource in the Pipelines DSL. In this way, teams and organizations can create and share their own re-usable, custom resource types for frequently used information in their pipelines.
Extension resources are defined within a namespace, to ensure that all resources in the set have unique names.
Extension resources are versioned, and can be invoked in pipelines by their semantic version number to ensure compatibility.
Files
Extension resource definitions must be stored in a subdirectory path of the form: resources/<namespace>/<resourceTypeName>.
namespace
is the namespace for the set of extension sets. This parent subdirectory may contain multiple step definition subdirectories.resourceTypeName
is the namedtype
of resource. Must be alphabetic characters only, and is case-sensitive. The subdirectory can hold the following files to define the resource.
File | Description | Required/Optional |
---|---|---|
| Syntax model for the resource. | Required |
and/or
| Shell script to execute when named in a step's | Optional |
and/or
| Shell script to execute when named in a step's | Optional |
| Documentation for the custom resource. | Optional |
| Icon graphic to represent the resource type in the interactive diagram. If not provided, Pipelines will use the default icon for the resource. | Optional |
Extension resrouce definitions are loaded from the source repository when it is configured in the Pipelines UI as an extension source.
Note
For information on administering extension sources and extension version lifecycle staging, see Managing Pipelines Extensions.
Syntax Model
This is the syntax model for the resource.
resourceModel.yml
description: <string> # User can provide an optional description platforms: # optional - os: Linux - os: Windows configuration: # array of properties <property name string>: type: <data type> # required required: <boolean> # optional immutable: <boolean> # optional: field value cannot/can be changed validate: # optional <validation specifiction> allowedIntegrationTypes: <string> # optional # more property definitions userDefinedDataType: # array of data type definitions - type: <string> # Defines a new data type configuration: - <string>: # Specifies a property of the data type type: <data type> # required required: <boolean> # optional validate: # optional <validation specifiction> allowedIntegrationTypes: <string> # optional # more data type property definitions
Tags
You can define the following tags in the resourceModel.yml
file.
description
A user-friendly description of the resource's function that will be available for display in the Pipelines UI. This is optional.
platforms
Defines the operating system for the node. Linux and Windows operating systems are supported.
This tag is optional and Linux is the default operating system when this tag is not specified.
Tag | Description of usage | Required/Optional |
---|---|---|
| Specifies the operating system. Linux and Windows are supported. | Optional |
os Examples Expand source
platforms: # optional - os: Linux - os: Windows
configuration
Begins a block of property definitions. Each property definition begins with the name of the property (letters only, case-sensitive), followed by these subordinate tags:
Tag | Description of usage | Required/Optional |
---|---|---|
| Specifies an inbuilt or user-defined data type. | Required |
| When set as Default is | Optional |
| When set to | Optional |
| Begins a validation specification block. | Optional |
configuration Examples Expand source
configuration: gitProvider: type: Integration required: true immutable: true # Once the resource is created, it is immutable validate: isIntegrationType: SCM # Check to see what are the integration types and publish the list as well allowedIntegrationTypes: [GitHub, GitLab] # Allow only these types of integrations fileName: type: String immutable: true # Once the resource is created, it is immutable validate: notContains: 'bar' editors: type: String[] validate: isRegex: ["^[a-z]+$",'i'] # Each element in array is validated with this fileDtTm: type: Date scanInterval: type: Int validate: min: 1 max: 60 creds: type: Credential # User-defined data type
userDefinedDataType
Begins a set of data type definitions. User-defined data types specify property types with validation rules, and can be used as type values.
Tag | Description of Usage | Required/Optional |
---|---|---|
| String that identifies this user-defined type. Must conform to alpha validation (letters only). | Required |
| Begins a block of property definitions. | Required |
Each property definition begins with the name of the property (letters only, case-sensitive), followed by these subordinate tags:
Tag | Description of Usage | Required/Optional |
---|---|---|
| String that identifies an inbuilt or user-defined data type property. | Required |
| When set as Default is | Optional |
| Begins a validation specification block. | Optional |
userDefinedDataType Example Expand source
userDefinedDataType: - type: Credential # User-defined data type configuration: - userName: # first property type: String required: true validate: isRegex: ["^[a-z]+$",'i'] # RegExp from a string - password: # second property type: String validate: isRegex: ["^[a-z]+$",'i']
Shell Scripts
An extension resource definition may include optional shell scripts to be executed when the resource is used in a step as an input or output. These may be useful for:
Additional validation of properties
Testing for a property value to trigger a conditional action
onInput.sh
When present in the resource definition's repository directory, the onInput.sh
shell script will be executed whenever the resource is named among the step's inputResources
.
onInput.sh
test_input() { echo "onInput Executed" echo "resource name: $1" } execute_command "test_input %%context.resourceName%%"
onOutput.sh
When present in the resource definition's repository directory, the onOutput.sh
shell script will be executed whenever the resource is named among the step's OutputResources.
onOutput.sh
test_output() { echo "onOutput Executed" echo "resource name: $1" } execute_command "test_output %%context.resourceName%%"