Skip to content

Cloud Foundry - Process Steps

Table of Contents

Bind Service

Bind a CF service instance onto a CF application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application NameStringName of the application to bind the service to.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
Service nameStringName of the service to be bound.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

CF Auto-Configure

Discover and configure all organizations and spaces for each organization into a resource tree in DevOps Deploy.

NameTypeDescriptionRequired
Cloud Foundry APIStringThe url of the Cloud Foundry API endpoint.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordStringThe password to authenticate with the Cloud Foundry server.No
Cloud Foundry UsernameStringThe username to authenticate with the Cloud Foundry server.No
ResourceStringThe Resource being configuredNo
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No

CF Discovery

This step will discover if Cloud Foundry is on an agent by checking common installation paths.If it is, it will assign the role to the resource and set the command path property.

NameTypeDescriptionRequired
API EndpointStringProvide the API Endpoint if the config.json file does not exist or is not configured correctly on the agent to be used during discovery.No
CF_HOME DirectoryStringFull path to your CF_HOME directory for installation verification. Not required if the property is a system environment variable.No
Override CF CLI PathStringProvide the full path to the cf executable file to override the auto discovery path.No
ResourceStringThe Resource being configuredNo

Create Domain

Create a domain in an org.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringName of the domain owning the route.Yes
OrganizationStringThe name of the organization where the application will be deployed.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Create Route

Create a url route in a space.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringName of the domain owning the route.Yes
HostnameStringThe hostname within the domain for the url route.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Create Service

Create a new Cloud Foundry Service.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
Service nameStringName of the service.Yes
Service planStringService plan.Yes
Service typeStringType of service.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Create Subdomain

Create a subdomain in an org.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringName of the domain i.e. domain.org of subdomain myapp.domain.org.Yes
OrganizationStringThe name of the organization where the application will be deployed.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No
SubdomainStringName of the subdomain i.e. myapp of myapp.domain.org.Yes

Create or Update User-Provided Service

Create or update a user-provided service instance.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
CredentialsStringCredentials, in JSON format, to be exposed in the VCAP_SERVICES environment variable for bound applications. A full file path may also be specified. Example: {username:admin, password:pa55woRD}`` Windows users must escape each double quote with a backslash.Yes
Log Drain URLStringURL to which logs for bound applications will be streamed.No
OrganizationStringThe name of the organization where the application will be deployed.Yes
Route Service URLStringURL to which requests for bound routes will be forwarded. Scheme for this URL must be https. Note: This feature was added in Cloud Foundry CLI v6.16.0.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)Yes
User-Provided ServiceStringThe name of the user-provided serviceYes

Delete App

Delete an application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application nameStringName of the application.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Delete mapped routesBooleanAlso delete any mapped routes.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Delete Domain

Delete a domain.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringName of the domain to remove.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Delete Route

Delete a route.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringName of the domain owning the route.No
HostnameStringThe hostname within the domain for the url route.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Delete Service

Delete a Cloud Foundry Service.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
Service nameStringName of the service.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Delete Subdomain

Delete a subdomain.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringName of the domain i.e. domain.org of myapp.domain.org.Yes
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No
SubdomainStringName of the subdomain i.e. myapp of myapp.domain.org.Yes

Execute CF Script

Execute a CF script. The context will be setup with the authenticated user and target space. cf.command line will be available to the script.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
ArgumentsStringArguments to be passed to the script, separated by spaces.No
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
ScriptStringEach command needs to be on a new line.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Execute CF bash file

Execute a bash file. The context will be setup with the authenticated user and target space. CF command line will be available to the bash script. The sh command must be available from the command line.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
ArgumentsStringArguments to be passed to the script, separated by spaces.No
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
ScriptStringPath to the cf.bash file.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Map Route

Add a url route to an application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application nameStringName of the application.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringThe domain to use. (e.g. example.com).Yes
HostnameStringThe hostname within the domain for the url route.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Push Application

Push application with or without a manifest file. If a manifest file is found then properties are used as overrides.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application NameStringThe name of the application to use when deployed. Required if not using a manifest.No
Application PathStringName of zip file or other file to push. If this file isnt in your working directory you must specify a full file path. (Otherwise just the name of the file e.g. myApp.zip)No
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Custom buildpackStringCustom buildpack by name (e.g. my-buildpack) or GIT URL (e.g. https://github.com/heroku/heroku-buildpack-play.git).No
Disk limitStringThe disk limit (e.g. 256M, 1024M, 1G).No
DomainStringSet a custom domain to be used when deploying the application.No
Manifest fileStringName of the manifest file. If this file isnt in your working directory you must specify a full file path. (Otherwise just the name of the file e.g. manifest.xml)No
Memory limitStringThe memory limit (e.g., 256M, 1024M, 1G).No
No hostnameBooleanMap the root domain to this application.No
No manifestBooleanIgnore the manifest file if one exists.No
No routeBooleanDoes not create a URL route for the application if selected. Manually create and map a route later.No
No startBooleanDoes not start the application if selected.No
Number of instancesStringThe number of instances of the application that will be created.No
OrganizationStringThe name of the organization where the application will be deployed.No
Random routeBooleanCreate a random route for this app.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No
StackStringStack to use (a stack is a pre-built file system, including an operating system, that can run apps).No
Sub-domainStringDefine a sub-domain for your application. This is useful to ensure that the URL route for the application is unique within the domain.No
TimeoutStringMaximum time (in seconds) to wait for application start, other server side timeouts may apply.No

Restart App

Restart an application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application nameStringName of the application.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Start App

Start an application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application nameStringName of the application.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Stop App

Stop an application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application nameStringName of the application.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Unbind Service

Unbind a CF Service from a cf.application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application nameStringName of the application.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
OrganizationStringThe name of the organization where the application will be deployed.No
Service nameStringName of the service.Yes
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Unmap Route

Remove a url route to an application.

NameTypeDescriptionRequired
APIStringA url of the target Cloud Foundry system, such as http://api.ng.bluemix.net.Yes
Application nameStringName of the application.Yes
CF_HOMEStringSet the CF_HOME variable to explicitly define the location of the config.json file. A new CF_HOME will be used for each step if not specified.No
Cloud Foundry CLI PathStringThe path to the cf command line script.No
Cloud Foundry PasswordPasswordThe password of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
Cloud Foundry UserStringThe user name of the account that will interact with Cloud Foundry system. Property is required unless authenticated outside of DevOps Deploy.No
DomainStringThe domain to use. (e.g. example.com).Yes
HostnameStringThe hostname within the domain for the url route.No
OrganizationStringThe name of the organization where the application will be deployed.No
Skip SSL ValidationBooleanIf checked, SSL validation will be skipped.No
SpaceStringThe name of the space within the organization that the application will be deployed. (e.g some-space)No

Roles in the CloudFoundry plug-in

The plug-in adds these roles automatically to resources. You cannot add these roles manually.

CloudFoundryApp

Role for resources that represents a Cloud Foundry application within an organization and space in a Cloud Foundry instance.

NameTypeDescriptionReference
cf.appStringThe Name of the Cloud Foundry application.${p:resource/cf.app}

CloudFoundryController

Role for resources that represents a Cloud Controller in a Cloud Foundry instance.

NameTypeDescriptionReference
cf.apiStringThe url of the Cloud Foundry API endpoint.${p:resource/cf.api}
cf.commandPathStringThe path to the directory where the cf command line executable resides. You may reference this property as cf.commandPath.${p:resource/cf.commandPath}
cf.passwordPasswordThe Cloud Foundry password to use.${p:resource/cf.password}
cf.usernameStringThe Cloud Foundry username.${p:resource/cf.username}

CloudFoundryOrganization

Role for resources that represents a Cloud Foundry organization in a Cloud Foundry instance.

NameTypeDescriptionReference
cf.orgStringThe Name of the Cloud Foundry organization.${p:resource/cf.org}

CloudFoundrySpace

Role for resources that represents a Cloud Foundry space within an organization in a Cloud Foundry instance.

NameTypeDescriptionReference
cf.spaceStringThe Name of the Cloud Foundry space.${p:resource/cf.space}