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 : String
(optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
echoEnvData : boolean
(optional)
If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
location : String
(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.
parameters
(optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString : String
(optional)
parametersFile : String
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
resourceGroupName : String
(optional)
Name of resource group to create for the template.
templateFile : String
(optional)
Workspace-relative path of the ARM template file.
tenant : String
(optional)
cfyAnsible
: Run Ansible PlaybookadditionalArgs : String
(optional)
ansibleEnvVars : String
(optional)
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugLevel : int
(optional)
debugOutput : boolean
(optional)
deploymentId : String
(optional)
echoEnvData : boolean
(optional)
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
optionsConfig : String
(optional)
playbookPath : String
(optional)
remergeSources : boolean
(optional)
runData : String
(optional)
savePlaybook : boolean
(optional)
scpExtraArgs : String
(optional)
sensitiveKeys : String
(optional)
sftpExtraArgs : String
(optional)
sourcePath : String
(optional)
sources : String
(optional)
sshCommonArgs : String
(optional)
sshExtraArgs : String
(optional)
startAtTask : String
(optional)
tenant : String
(optional)
timeout : int
(optional)
cfyCloudFormation
: Create CloudFormation StackawsCredentialsId : String
(optional)
The ID of the credentials to use when accessing AWS. Parameters' expansion is supported when using freestyle jobs.
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(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.
echoEnvData : boolean
(optional)
If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
parameters
(optional)
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString : String
(optional)
parametersFile : String
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
regionName : String
(optional)
AWS region to use. If not specified, the value of the aws_region_name
secret is used.
stackName : String
(optional)
Name of the new stack.
templateBody : String
(optional)
templateBucketName : String
(optional)
templateFile : String
(optional)
templateResourceName : String
(optional)
templateUrl : String
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
tenant : String
(optional)
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 : String
(optional)
Unique identifier for the created deployment.
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
Identifies the blueprint to create a deployment off.
echoInputs : boolean
(optional)
echoOutputs : boolean
(optional)
inputs : String
(optional)
A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file
" parameter.
inputsFile : String
(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.
mapping : String
(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.
mappingFile : String
(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.
outputFile : String
(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> }
skipInstall : boolean
(optional)
install
workflow.
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
deleteCloudifyBlueprint
: Delete Cloudify BlueprintblueprintId : String
(optional)
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
deleteCloudifyEnv
: Delete Cloudify EnvironmentcredentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deleteBlueprintIfLast : boolean
(optional)
If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
deploymentId : String
(optional)
ignoreFailure : boolean
(optional)
If checked, then failures during the removal of the environment will be ignored.
skipUninstall : boolean
(optional)
uninstall
workflow.
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
executeCloudifyWorkflow
: Execute Cloudify WorkflowcredentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
executionParameters : String
(optional)
Parameters to pass to the execution, in YAML/JSON format.
printLogs : boolean
(optional)
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
waitForCompletion : boolean
(optional)
workflowId : String
(optional)
The ID of the workflow to execute.
cfyKubernetes
: Create Kubernetes ResourcesallowNodeRedefinition : boolean
(optional)
apiKeyCredentialsId : String
(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.
apiKeyFile : String
(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.
caCert : String
(optional)
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
definition
(optional)
java.util.Map<java.lang.String, java.lang.Object>
definitionAsString : String
(optional)
definitionFile : String
(optional)
deploymentId : String
(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.
echoEnvData : boolean
(optional)
If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
gcpCredentialsFile : String
(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.
gcpCredentialsId : String
(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": "..." }
k8sDebug : boolean
(optional)
k8sMaster : String
(optional)
namespace : String
(optional)
namespace
value in the options
field, if exists.
options
(optional)
java.util.Map<java.lang.String, java.lang.Object>
optionsAsString : String
(optional)
optionsFile : String
(optional)
skipSslVerification : boolean
(optional)
sslCertFile : String
(optional)
sslKeyFile : String
(optional)
tenant : String
(optional)
validateStatus : boolean
(optional)
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 : String
(optional)
inputsLocation : String
(optional)
Path to the inputs file to be created.
mapping : String
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
mappingLocation : String
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
outputsLocation : String
(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>", ... } }
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
cfyTerraform
: Apply Terraform ModulecredentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(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.
echoEnvData : boolean
(optional)
If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
environmentVariables
(optional)
java.util.Map<java.lang.String, java.lang.String>
environmentVariablesAsString : String
(optional)
YAML/JSON containing environment variables to pass to the Terraform process. The provided string will be expanded for environment variables (${VAR_NAME}
).
environmentVariablesFile : String
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing environment variables to pass to the Terraform process.
executable : String
(optional)
Path, on Cloudify Manager, of the Terraform executable. If omitted, the value of the terraform_executable
Cloudify secret will be used.
pluginsDirectory : String
(optional)
Path, on Cloudify Manager, of Terraform's plugins directory. If omitted, the value of the terraform_plugins_dir
Cloudify secret will be used.
storageDirectory : String
(optional)
Path, on Cloudify Manager, of Terraform's storage directory. If omitted, the value of the terraform_storage_dir
Cloudify secret will be used.
templateUrl : String
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
tenant : String
(optional)
variables
(optional)
java.util.Map<java.lang.String, java.lang.Object>
variablesAsString : String
(optional)
YAML/JSON containing variables to pass to the Terraform template. The provided string will be expanded for environment variables (${VAR_NAME}
).
variablesFile : String
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
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 : String
(optional)
archiveUrl : String
(optional)
blueprintId : String
(optional)
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
mainFileName : String
(optional)
rootDirectory : String
(optional)
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
uploadCloudifyBlueprint
: Upload Cloudify PlugincredentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
outputLocation : String
(optional)
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
wagonLocation : String
(optional)
yamlLocation : String
(optional)
plugin.yaml
file of the plugin.
wrap([$class: 'CloudifyBuildWrapper'])
: Cloudify EnvironmentApplies a Cloudify "Wrapper" around this job:
blueprintArchiveUrl : String
(optional)
URL to the blueprint's archive.
blueprintId : String
(optional)
For newly uploaded blueprints, this will be the new blueprint's ID.
For existing blueprints, this should be the existing blueprint's ID.
blueprintMainFile : String
(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.
blueprintRootDirectory : String
(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.
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
ID of the deployment to create.
echoInputs : boolean
(optional)
echoOutputs : boolean
(optional)
ignoreFailureOnTeardown : boolean
(optional)
inputs : String
(optional)
Inputs to pass to the new deployment, in YAML/JSON format.
Inputs provided here will be merged with inputs provided through a file.
inputsLocation : String
(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.
outputsLocation : String
(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.
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
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.