The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
cfyAzureArm
: Create Azure ARM DeploymentcfyAnsible
: Run Ansible PlaybookcfyCloudFormation
: Create CloudFormation StackcreateCloudifyEnv
: Create Cloudify EnvironmentdeleteCloudifyBlueprint
: Delete Cloudify BlueprintdeleteCloudifyEnv
: Delete Cloudify EnvironmentexecuteCloudifyWorkflow
: Execute Cloudify WorkflowcfyKubernetes
: Create Kubernetes ResourcescfyOutputsToInputs
: Convert Cloudify Environment Outputs/Capabilities to InputscfyTerraform
: Apply Terraform ModuleuploadCloudifyBlueprint
: Upload Cloudify BlueprintuploadCloudifyBlueprint
: Upload Cloudify Pluginwrap([$class: 'CloudifyBuildWrapper'])
: Cloudify EnvironmentcfyAzureArm
: Create Azure ARM DeploymentazureCredentialsId
(optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
location
(optional)
The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location
Cloudify secret will be used.
String
parameters
(optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString
(optional)
String
parametersFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
resourceGroupName
(optional)
Name of resource group to create for the template.
String
templateFile
(optional)
Workspace-relative path of the ARM template file.
String
tenant
(optional)
String
cfyAnsible
: Run Ansible PlaybookadditionalArgs
(optional)
String
ansibleEnvVars
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugLevel
(optional)
int
debugOutput
(optional)
boolean
deploymentId
(optional)
String
echoEnvData
(optional)
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
String
optionsConfig
(optional)
String
playbookPath
(optional)
String
remergeSources
(optional)
boolean
runData
(optional)
String
savePlaybook
(optional)
boolean
scpExtraArgs
(optional)
String
sensitiveKeys
(optional)
String
sftpExtraArgs
(optional)
String
sourcePath
(optional)
String
sources
(optional)
String
sshCommonArgs
(optional)
String
sshExtraArgs
(optional)
String
startAtTask
(optional)
String
tenant
(optional)
String
timeout
(optional)
int
cfyCloudFormation
: Create CloudFormation StackawsCredentialsId
(optional)
The ID of the credentials to use when accessing AWS. Parameters' expansion is supported when using freestyle jobs.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
parameters
(optional)
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString
(optional)
String
parametersFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
regionName
(optional)
AWS region to use. If not specified, the value of the aws_region_name
secret is used.
String
stackName
(optional)
Name of the new stack.
String
templateBody
(optional)
String
templateBucketName
(optional)
String
templateFile
(optional)
String
templateResourceName
(optional)
String
templateUrl
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
String
tenant
(optional)
String
createCloudifyEnv
: Create Cloudify EnvironmentCreates a topology from an environment blueprint.
The "Output File" parameter denotes where the new environment's outputs will be written to. Later build steps can inspect this file in order to grab information pertinent to them (such as IP addresses, user names and so forth).
All input fields support standard Jenkins parameters' expansion. For example, the string ${app_name}
will be expanded, in runtime, to the value of a build parameter called app_name
.
For explanation about the format of the outputs file, refer to the help tooltip for that parameter.
blueprintId
(optional)
Unique identifier for the created deployment.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
Identifies the blueprint to create a deployment off.
String
echoInputs
(optional)
boolean
echoOutputs
(optional)
boolean
inputs
(optional)
A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file
" parameter.
String
inputsFile
(optional)
A path (relative to the workspace root) to a YAML/JSON file containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs
" parameter.
String
mapping
(optional)
If specified, this YAML/JSON will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping file" is provided.
String
mappingFile
(optional)
If specified, this YAML/JSON file will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping" is provided.
String
outputFile
(optional)
Name of file into which the deployment's outputs and capabilities will be written. The file will be a JSON, adhering to the following format:
{ "outputs": <outputs_dictionary>, "capabilities": <capabilities_dictionary> }
String
skipInstall
(optional)
install
workflow.
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
deleteCloudifyBlueprint
: Delete Cloudify BlueprintblueprintId
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
deleteCloudifyEnv
: Delete Cloudify EnvironmentcredentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deleteBlueprintIfLast
(optional)
If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
boolean
deploymentId
(optional)
String
ignoreFailure
(optional)
If checked, then failures during the removal of the environment will be ignored.
boolean
skipUninstall
(optional)
uninstall
workflow.
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
executeCloudifyWorkflow
: Execute Cloudify WorkflowcredentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
String
executionParameters
(optional)
Parameters to pass to the execution, in YAML/JSON format.
String
printLogs
(optional)
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
waitForCompletion
(optional)
boolean
workflowId
(optional)
The ID of the workflow to execute.
String
cfyKubernetes
: Create Kubernetes ResourcesallowNodeRedefinition
(optional)
boolean
apiKeyCredentialsId
(optional)
The ID of the credentials entry that contains the API key.
This parameter is optional; the API key may also be provided through "API options", however this method is preferred.
If provided, then this credentials entry must either be of type "text" or "file". In the latter case, the file is read as-is and the resultant string is used as the API credentials.
String
apiKeyFile
(optional)
Path to file, relative to the Jenkins workspace, containing the API key.
This parameter is optional, as the API key may be provided by other means.
String
caCert
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
definition
(optional)
java.util.Map<java.lang.String, java.lang.Object>
definitionAsString
(optional)
String
definitionFile
(optional)
String
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
gcpCredentialsFile
(optional)
A YAML/JSON file containing GCP service account details, to use for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should follow the same layout as described in the "GCP Credentials ID" parameter.
String
gcpCredentialsId
(optional)
The ID of the credentials to be used for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should be the ID of either a string-type or file-type credentials entry, with the standard GCP service account YAML/JSON syntax:
{ "type": "...", "project_id": "...", "private_key_id": "...", "private_key": "...", "client_email": "...", "client_id": "...", "auth_uri": "...", "token_uri": "...", "auth_provider_x509_cert_url": "...", "client_x509_cert_url": "..." }
String
k8sDebug
(optional)
boolean
k8sMaster
(optional)
String
namespace
(optional)
namespace
value in the options
field, if exists.
String
options
(optional)
java.util.Map<java.lang.String, java.lang.Object>
optionsAsString
(optional)
String
optionsFile
(optional)
String
skipSslVerification
(optional)
boolean
sslCertFile
(optional)
String
sslKeyFile
(optional)
String
tenant
(optional)
String
validateStatus
(optional)
boolean
cfyOutputsToInputs
: Convert Cloudify Environment Outputs/Capabilities to InputsThis step maps outputs and capabilities, of an environment created by Cloudify, into inputs of another deployment.
This step takes two inputs:
The format of the mapping JSON is as follows:
{ "outputs": { "<output_name>": "<input_name>", "<output_name>": "<input_name>", ... }, "capabilities": { "<capability_name>": "<input_name>", "<capability_name>": "<input_name>", ... } }
At the end, a file will be generated, containing a JSON compatible with Cloudify's standard "Deployment Inputs" structure, namely:
{ "<input_name>": "<intput_value>", "<input_name>": "<intput_value>", ...
For example, if the "outputs file" is as follows:
{ "outputs": { "endpoint": "10.0.0.130", "username": "centos" }, "capabilities": { "public_key": "/tmp/public_key" } }
And the mapping is as follows:
{ "outputs": { "username": "app_username" }, "capabilities": { "public_key": "app_data" } }
Then the resultant inputs file will be as follows:
{ "app_username": "centos", "app_data": "/tmp/public_key" }
credentialsId
(optional)
String
inputsLocation
(optional)
Path to the inputs file to be created.
String
mapping
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
String
mappingLocation
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
String
outputsLocation
(optional)
Location of the outputs JSON file, containing outputs and capabilities of another deployment. The file must be in the following format:
{ "outputs": { "<output_name>": "<output_value>", "<output_name>": "<output_value>", ... }, "capabilities": { "<capability_name>": "<capability_value>", "<capability_name>": "<capability_value>", ... } }
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
cfyTerraform
: Apply Terraform ModulecredentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
environmentVariables
(optional)
java.util.Map<java.lang.String, java.lang.String>
environmentVariablesAsString
(optional)
YAML/JSON containing environment variables to pass to the Terraform process. The provided string will be expanded for environment variables (${VAR_NAME}
).
String
environmentVariablesFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing environment variables to pass to the Terraform process.
String
executable
(optional)
Path, on Cloudify Manager, of the Terraform executable. If omitted, the value of the terraform_executable
Cloudify secret will be used.
String
pluginsDirectory
(optional)
Path, on Cloudify Manager, of Terraform's plugins directory. If omitted, the value of the terraform_plugins_dir
Cloudify secret will be used.
String
storageDirectory
(optional)
Path, on Cloudify Manager, of Terraform's storage directory. If omitted, the value of the terraform_storage_dir
Cloudify secret will be used.
String
templateUrl
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
String
tenant
(optional)
String
variables
(optional)
java.util.Map<java.lang.String, java.lang.Object>
variablesAsString
(optional)
YAML/JSON containing variables to pass to the Terraform template. The provided string will be expanded for environment variables (${VAR_NAME}
).
String
variablesFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
uploadCloudifyBlueprint
: Upload Cloudify BlueprintUse this step to upload a blueprint to Cloudify Manager.
Two paramters are mandatory:
In addition, exactly one of the following parameters is mandatory:
If you provide a blueprint's root directory, then the entire directory contents are packaged into a blueprint archive.
archivePath
(optional)
String
archiveUrl
(optional)
String
blueprintId
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
mainFileName
(optional)
String
rootDirectory
(optional)
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
uploadCloudifyBlueprint
: Upload Cloudify PlugincredentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
outputLocation
(optional)
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
wagonLocation
(optional)
String
yamlLocation
(optional)
plugin.yaml
file of the plugin.
String
wrap([$class: 'CloudifyBuildWrapper'])
: Cloudify EnvironmentApplies a Cloudify "Wrapper" around this job:
blueprintArchiveUrl
(optional)
URL to the blueprint's archive.
String
blueprintId
(optional)
For newly uploaded blueprints, this will be the new blueprint's ID.
For existing blueprints, this should be the existing blueprint's ID.
String
blueprintMainFile
(optional)
The name of the YAML file that is to be considered the blueprint's main YAML.
In order to use an existing blueprint, leave this field blank.
String
blueprintRootDirectory
(optional)
The path, relative to the build's workspace, to the new blueprint's root.
In order to use an existing blueprint, leave this field blank.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
ID of the deployment to create.
String
echoInputs
(optional)
boolean
echoOutputs
(optional)
boolean
ignoreFailureOnTeardown
(optional)
boolean
inputs
(optional)
Inputs to pass to the new deployment, in YAML/JSON format.
Inputs provided here will be merged with inputs provided through a file.
String
inputsLocation
(optional)
A path, relative to the workspace's root, to a YAML/JSON file containing inputs for the new deployment.
Inputs provided here will be merged with inputs provided through text.
String
outputsLocation
(optional)
A path, relative to the workspace's root, to a JSON file that will contain the outputs and capabilities of the new deployment.
If not provided, the file won't be created.
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.