An output only resource capable of running lots of Cloud Foundry cli commands.
api
: Required. The address of the Cloud Controller in the Cloud Foundry deployment.username
: Required. The username used to authenticate.password
: Required. The password used to authenticate.skip_cert_check
: Optional. Check the validity of the CF SSL cert. Defaults tofalse
.org
: Optional. Sets the default organization to target (can be overridden in the params config).space
: Optional. Sets the default space to target (can be overridden in the params config).
resource_types:
- name: cf-cli-resource
type: docker-image
source:
repository: pivotalpa/cf-cli-resource
tag: latest
resources:
- name: cf-env
type: cf-cli-resource
source:
api: https://api.local.pcfdev.io
username: admin
password: admin
skip_cert_check: true
This resource is capable of running single commands in separate put
steps:
- put: cf-create-org
resource: cf-env
params:
command: create-org
org: myorg
- put: cf-create-space
resource: cf-env
params:
command: create-space
org: myorg
space: myspace
or they can be combined in a single put
step:
- put: cf-create-org-and-space
resource: cf-env
params:
commands:
- command: create-org
org: myorg
- command: create-space
org: myorg
space: myspace
And, of course, if you have your org
and space
defined in the source
config,
it gets even simpler:
- put: cf-create-org-and-space
resource: cf-env
params:
commands:
- command: create-org
- command: create-space
Run cf command(s) on a Cloud Foundry installation.
Create an org
org
: Optional. The organization to create (required if not set in the source config)
- put: cf-create-org
resource: cf-env
params:
command: create-org
org: myorg
Delete an org
org
: Optional. The organization to create (required if not set in the source config)
- put: cf-delete-org
resource: cf-env
params:
command: delete-org
org: myorg
Create a space
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)
- put: cf-create-space
resource: cf-env
params:
command: create-space
org: myorg
space: myspace
Delete a space
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)
- put: cf-delete-space
resource: cf-env
params:
command: delete-space
org: myorg
space: myspace
Create a new user
username
: Required. The user to createpassword
: Optional. The password (must specify eitherpassword
ororigin
)origin
: Optional. The authentication origin (e.g. ldap, provider-alias) (must specify eitherpassword
ororigin
)
Create a user with credentials:
- put: prepare-env
resource: cf-env
params:
command: create-user
username: j.smith@example.com
password: S3cr3t
Create an LDAP user:
- put: prepare-env
resource: cf-env
params:
command: create-user
username: j.smith@example.com
origin: ldap
Bulk create users from a csv file
file
: Required. The csv file containing the users
- put: prepare-env
resource: cf-env
params:
command: create-users-from-file
file: somepath/users.csv
The format of the bulk load file:
Username | Password | Org | Space | OrgManager | BillingManager | OrgAuditor | SpaceManager | SpaceDeveloper | SpaceAuditor |
---|---|---|---|---|---|---|---|---|---|
user1 | S3cr3t | org1 | dev | x | x | x | x | x | x |
user2 | org2 | dev | x | x | x | x | |||
user3 | S3cr3t | org3 | dev | x | x | ||||
user3 | S3cr3t | org3 | test | x | x |
Notes:
- The file must include the header row
- The file must be in comma separated value format
- You can specify the user more than once to assign multiple orgs/spaces
- If you omit the Org, no org or space roles will be assigned
- If you omit the Space, no space roles will be assigned
Delete a user
username
: Required. The user to delete
- put: prepare-env
resource: cf-env
params:
command: delete-user
username: j.smith@example.com
Create a service instance
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)service
: Required. The marketplace service name to createplan
: Required. The service plan name to createservice_instance
: Required. The name to give the service instanceconfiguration
: Optional. Valid JSON object containing service-specific configuration parameters, provided either in-line or in a file. For a list of supported configuration parameters, see documentation for the particular service offering.tags
: Optional. User provided tagstimeout
: Optional. Max wait time for service creation, in seconds. Defaults to600
(10 minutes)wait_for_service
: Optional. Wait for the asynchronous service to start. Defaults tofalse
.
- put: cf-create-service
resource: cf-env
params:
command: create-service
service: p-config-server
plan: standard
service_instance: my-config-server
configuration: '{"count":3}'
tags: 'list, of, tags'
timeout: 300
wait_for_service: true
Wait for a service instance to start
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)service_instance
: Required. The service instance to wait fortimeout
: Optional. Max wait time for service creation, in seconds. Defaults to600
(10 minutes)
- put: cf-wait-for-service
resource: cf-env
params:
command: wait-for-service
service_instance: my-config-server
timeout: 300
Delete a service instance
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)service_instance
: Required. The service instance to delete
- put: cf-delete-service
resource: cf-env
params:
command: delete-service
service_instance: my-config-server
Bind a service instance to an app
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)app_name
: Required. The application to bind the service toservice_instance
: Required. The service instance to bind to the applicationconfiguration
: Optional. Valid JSON object containing service-specific configuration parameters, provided either in-line or in a file. For a list of supported configuration parameters, see documentation for the particular service offering.
- put: cf-bind-service
resource: cf-env
params:
command: bind-service
app_name: myapp-ui
service_instance: mydb
configuration: '{"permissions":"read-only"}'
Push a new app or sync changes to an existing app
NOTE: A manifest can be used to specify values for required parameters. Any parameters specified will override manifest values.
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)app_name
: Required. The name of the applicationhostname
: Optional. Hostname (e.g. my-subdomain)memory
: Optional. Memory limit (e.g. 256M, 1024M, 1G)disk_quota
: Optional. Disk limit (e.g. 256M, 1024M, 1G)instances
: Optional. Number of instancespath
: Optional. Path to app directory or to a zip file of the contents of the app directorybuildpack
: Optional. Custom buildpack by name (e.g. my-buildpack) or Git URL (e.g. 'https://github.com/cloudfoundry/java-buildpack.git') or Git URL with a branch or tag (e.g. 'https://github.com/cloudfoundry/java-buildpack.git#v3.3.0' for 'v3.3.0' tag). To use built-in buildpacks only, specify 'default' or 'null'manifest
: Optional. Path to manifestno_start
: Optional. Do not start an app after pushing. Defaults tofalse
.
- put: cf-push
resource: cf-env
params:
command: push
app_name: myapp-ui
hostname: myapp
memory: 512M
disk_quota: 1G
instances: 1
path: path/to/myapp-*.jar
buildpack: java_buildpack
manifest: path/to/manifest.yml
no_start: true
Push a single app using the autopilot plugin.
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)manifest
: Required. Path to a application manifest file.path
: Optional. Path to the application to push. If this isn't set then it will be read from the manifest instead.current_app_name
: Optional. This should be the name of the application that this will re-deploy over. If this is set the resource will perform a zero-downtime deploy.environment_variables
: Optional. Environment variable key/value pairs to add to the manifest.
- put: cf-zero-downtime-push
resource: cf-env
params:
command: zero-downtime-push
manifest: path/to/manifest.yml
path: path/to/myapp-*.jar
current_app_name: myapp-ui
environment_variables:
key: value
key2: value2
Start an app
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)app_name
: Required. The name of the applicationstaging_timeout
: Optional. Max wait time for buildpack staging, in minutesstartup_timeout
: Optional. Max wait time for app instance startup, in minutes
- put: cf-start
resource: cf-env
params:
command: start
app_name: myapp-ui
staging_timeout: 15
startup_timeout: 5
Delete an app
org
: Optional. The organization to create (required if not set in the source config)space
: Optional. The space to create (required if not set in the source config)app_name
: Required. The name of the applicationdelete_mapped_routes
: Optional. Delete any mapped routes. Defaults tofalse
.
- put: cf-delete
resource: cf-env
params:
command: delete
app_name: myapp-ui
delete_mapped_routes: true