DslDeploy plugin

Artifact Name

Required. The name of your artifact.

Artifact Version

The version of the artifact you want to deploy. If empty, the latest version is deployed. NOTE: Use an empty version only in your Dev environment. In higher environments, it’s recommended that you use a specific version that has been tested in lower environments.

Server Pool or Resource

Required. The name of the pool or resource where the artifact will be retrieved. The DSL is evaluated on the server so all system actions, such as file reads, will be evaluated on a server node.

Default value is local.

Retrieve on All server nodes

Required (By default, is set to false). Use this option when running in a cluster with a local workspace, as the artifact version needs to be retrieved on all nodes (as the system pick a random server node for each action). Use alongside a resource pool covering all server node agents for the parameter above.

Default is false

Overwrite mode

Select to enable overwrite mode. If the object exists, all attributes and child objects are overwritten by the values in the DSL files.

Directory Path

Required. The location of the DSL code on your Dev CloudBees CD/RO server.

Server Pool or Resource

Required. The name of the pool or resource where the artifact will be retrieved. Use . if you have retrieved in your workspace.

Overwrite mode

Select to enable overwrite mode. If the object exists, all attributes and child objects are overwritten by the values in the DSL files.

Additional argument(s)

For evalDsl calls, additional arguments such as --timeout or --debug. Values used in --timeout are used as timeouts for ectool, evalDsl, and the job step time out used to import the DSL.

Ignore failures

Ignore failures during import of DSL files.

Local mode

Do not send files to the server with help of clientFiles argument of the evalDsl operation in local mode.

Include objects

New line separated list of paths to objects to synchronize.

If set, only these objects are synchronized. If empty, all available objects are synchronized.

Examples:

Exclude objects

New line separated list of paths to exclude (See Include objects for examples). Exclude nothing by default.

Project Name

Name of the project to install.

Project directory

The location of the project DSL code on your Dev CloudBees CD/RO server.

Overwrite mode

Select to enable overwrite mode. If the object exists, all attributes and child objects are overwritten by the values in the DSL files.

Additional argument(s)

For evalDsl calls, additional arguments such as --timeout or --debug. Values used in --timeout are used as timeouts for ectool, evalDsl, and the job step time out used to import the DSL.

Directory path

Required. Folder where the code is generated.

Server Pool or Resource

Required. Server pool to use for a cluster setup.

Object Type

Required. Object type to generate DSL for.

Object Name

Required. Object name to generate DSL for.

Suppress Nulls

Exclude from the generated DSL properties with null value.

Suppress Defaults

Exclude from the generated DSL properties with default value.

Suppress Parent

Exclude from the generated DSL properties referred to object parent.

Include ACLs

Include in ACLs for objects.

Include All Children

Include in the generated DSL all object children. If True, the value of the Include Children parameter is ignored.

Include children

A comma-separated list of object children the DSL should be generated for.

Include Children in Same File

Include in the generated DSL all object children. If True, the value of the Include Children parameter is ignored.

Children in Different Files

A comma-separated list of patterns to include, like pipelines, procedures.*, applications.applicationTiers.components

Server Resource

Required. The resource where the DSL files are checked out from Git and imported to the CloudBees CD/RO server.

Destination Directory

Required. The directory on the resource where the source tree is created and from where the DSL files are read to be imported in CloudBees CD/RO server.

Relative path to DSL files

If the DSL files are not located at the top-level in the repository, then specify the relative path to the directory containing the DSL files within the repository.

Cleanup?

This option will delete the destination directory with the source tree after the job execution.

Overwrite mode

Select to enable overwrite mode. If the object exists, all attributes and child objects are overwritten by the values in the DSL files.

Configuration

Required. The name of a saved SCM configuration.

Git repository

Required. The URL to the repository to pull from, for example git://server/repo.git.

Commit Hash

The Commit Hash to update the index.

Remote Branch

The name of the Git branch to use, for example my_feature.

Clone?

This option will clone a repository into a newly created directory.

Overwrite?

This option will overwrite a repository if it already exists.

Depth

Create a shallow clone with a history truncated to the specified number of revisions.

Tag

Provide the name of a specific tag to check out after the clone command.

Ignore failures

Ignore failures during import of DSL files.

Local mode

Do not send files to the server with help of clientFiles argument of the evalDsl operation in local mode.

Additional DSL Arguments

Additional argument for evalDsl call.

Server Pool or Resource

Required. The resource or one of the pool resources where the DSL files are checked out from Git and imported to the CloudBees CD/RO server.

Destination Directory

Required. The directory on the resource where the source tree is created and the DSL files are stored.

Relative path to DSL files

If the DSL files are not located at the top level in the repository, then specify the relative path to the directory containing the DSL files within the repository. For example, scripts/dsls where the DSL files are located in the following sub-directories in the repository scripts/dsls/projects and scripts/dsls/resources.

Cleanup?

This option deletes the destination directory with the source tree after the job execution.

Overwrite mode

Select to enable overwrite mode. If the object exists, all attributes and child objects are overwritten by the values in the DSL files.

Configuration

Required. EC-Git configuration name.

Git repository

Required. URL to the repository to pull from. For example, git://server/repo.git.

Remote Branch

The name of the Git branch to use. For example, experimental.

Ignore failures

Ignore failures during import of DSL files.

Local mode

Do not send files to the server with help of clientFiles argument of the evalDsl operation in local mode. Available only if the destination directory is accessible from the CloudBees CD/RO server. In a clustered deployment, all CloudBees CD/RO server nodes must have access to this directory.

Additional DSL arguments

Additional argument(s) for the evalDsl call. For example, --timeout or --debug. Values used in --timeout are used as timeouts for ectool, evalDsl, and the job step timeout used to import the DSL.

Include objects

New line separated list of paths to objects to synchronize.

If set, only these objects are synchronized. If empty, all available objects are synchronized.

Examples:

Exclude objects

New line separated list of paths to exclude (See Include objects for examples). Exclude nothing by default.

Incremental import

Select to only import the incremental changes that have occurred since the previous run of the procedure. When selected, the previous run’s commit ID is compared to the current commit ID in the Git repository and a change list is created. This can potentially reduce the import time because the entire DSL file structure is not re-imported from the Git repository each time the procedure runs.