Enterprise deployment reference

3 minute read

CloudBees enterprise platform deployment actions provide inputs for deploying with Ansible, Argo Workflows, Heroku, Octopus, OpenShift, Spinnaker, Tosca, and SSH. Use this reference alongside Deploy with enterprise platforms and Execute remote deployment commands.

Ansible

The cloudbees-io/ansible-run-job action runs an Ansible playbook via Ansible AWX or Ansible Automation Platform (AAP).

Table 1. Input details
Input name Data type Required? Description

url

String

Yes

The URL of Ansible AWX or AAP that has the REST APIs exposed.

token

String

Yes

An API token generated with the appropriate read or write access.

job_template_name

String

Required only if workflow_job_template_name is not specified.

The name of the job template with the Ansible playbook.

workflow_job_template_name

String

Required only if job_template_name is not specified.

The name of the workflow job template for the workflow configured on AWX or AAP.

Argo Workflows

The cloudbees-io/argocd-run-workflow action runs an Argo Workflows workflow for managing and executing complex workflows in Kubernetes.

Table 2. Input details
Input name Data type Required? Description

url

String

Yes

The Argo Workflows server URL.

token

String

Yes

The Argo Workflows token.

namespace

String

Yes

The Argo Workflows namespace.

workflow-name

String

Yes

The Argo Workflows name.

parameters

JSON

No

Any additional parameters, formatted as JSON data in key/value pairs.

Heroku

The cloudbees-io/heroku-run-job action triggers Heroku APIs to build and deploy your application and fetches stdout logs as output.

Table 3. Input details
Input name Data type Required? Description

token

String

Yes

The Heroku API token generated with read or write access.

application_name

String

Yes

The Heroku application name, which is a unique identifier for the application environment where the build occurs.

repository_name

String

Yes

The name of the repository where the source code resides.

private_repository_personal_access_token

String

Yes

The personal access token to clone the source repository.

Octopus

The cloudbees-io/octopus-run-project action delivers software with Octopus Deploy.

Table 4. Input details
Input name Data type Required? Description

url

String

Yes

The Octopus Deploy server URL.

token

String

Yes

The Octopus Deploy token.

space-name

String

Yes

The Octopus Deploy space name.

release

String

Yes

The Octopus Deploy release version.

environment-name

String

Yes

The Octopus Deploy environment name.

channel-name

String

No

The Octopus Deploy channel name.

OpenShift

The cloudbees-io/openshift-invoke-deployment action triggers Red Hat OpenShift to build and deploy your application and fetches stdout logs as output.

Table 5. Input details
Input name Data type Required? Description

url

String

Yes

The OpenShift cluster URL.

token

String

Yes

The OpenShift API token. Must have read/write access.

project_name

String

Yes

The OpenShift project name, a unique identifier for the application environment when building and deployment occurs.

repository_name

String

Yes

The source code repository name.

repository_config_yaml_paths

String

Yes

The paths to the configuration files required to build and deploy the application, listed in deployment order.

Spinnaker

The cloudbees-io/spinnaker-run-pipeline action deploys your application with Spinnaker.

Table 6. Input details
Input name Data type Required? Description

url

String

Yes

The Spinnaker server URL.

token

String

Yes

The Spinnaker token.

app-name

String

Yes

The application name in Spinnaker.

pipeline-name

String

Required only if webhook-url is not specified.

The Spinnaker pipeline name for the requested application.

webhook-url

String

Required only if pipeline-name is not specified.

The Spinnaker webhook URL for the requested application.

parameters

JSON

No

Any additional parameters, formatted as JSON data in key/value pairs.

Tosca

The cloudbees-io/tosca-run-job action executes a Tricentis Tosca cloud playlist.

Table 7. Input details
Input name Data type Required? Description

tosca_cloud_base_url

String

Yes

The Tosca cloud URL.

tosca_auth_url

String

Yes

The URL of the authorization server (available in the Swagger UI).

client_id

String

Yes

The Tosca cloud API client ID.

client_secret

String

Yes

The Tosca cloud API token.

playlist_name

String

Yes

The name of the playlist to be executed.

workspace

String

Yes

The name of the workspace.

SSH

The cloudbees-io/ssh-deploy-actions action connects to a remote server and executes commands via SSH.

Table 8. Input details
Input name Data type Required? Description

host

String

Yes

SSH host address.

username

String

Yes

The SSH username.

script

String

Yes

The commands to be executed.

key-path

String

Required only if password is not specified.

The path to the SSH private key file.

password

String

Required only if key-path is not specified.

The SSH password.

port

String

No

SSH port number. Default is 22.

passphrase

String

No

The SSH key passphrase.