Cloud Foundry is an open-source, multi-cloud application platform as a service.
Plugin Version 1.6.1.2020102201
Revised on May 19, 2020
Plugin procedures
| In the CloudBees CD UI, from the Home page, open the Main Menu, and click Admin > Plugins to open the Plugin Manager. |
| For all parameter descriptions below, required parameters are shown in bold italics. |
Plugin configuration
Plugin configurations are sets of parameters that apply across some or all of the plugin’s procedures. They are intended to reduce repetition of common values, create predefined sets of parameters for end users, and to securely store credentials where needed. Each configuration is given a unique name that is entered in designated parameters on procedures that use them.
Plugin configurations are created by going to the CloudBees CD . On the right side of the line for the specific plugin, there is a Configure link, which opens the Configuration page.
| Parameter | Description |
|---|---|
Configuration |
Provide a unique name for the configuration, keeping in mind that you may need to create additional configurations over time. |
Description |
Provide some description for configuration. |
API endpoint |
Provide the API endpoint to your Cloud Foundry installation, e.g. api.mycloud.com. |
Organization |
Provide the name of the organization, e.g. myorg. An org is a development account that an individual or multiple collaborators can own and use. All collaborators access an org with user accounts. Collaborators in an org share a resource quota plan, applications, services availability, and custom domains. For more information, see Orgs. |
Space |
Provide the space name, e.g. test. Every application and service are scoped to a space. Each org contains at least one space. A space provides users with access to a shared location for application development, deployment, and maintenance. Each space role applies only to a particular space. For more info, see Spaces. |
Username and password |
Username: Provide the user name CloudBees CD uses to communicate with the Cloud Foundry server. Password: Provide the password for the specified Username. Retype Password: Retype the password specified. |
Debug level |
Provide the level of log messages verbosity. Info by default. |
Create or update application
Creates a new application or recreates the existing one and pushes application content from the specified directory. If the application with the specified name exists, it will be deleted and created anew.
For more information, see Deploy an Application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be pushed. |
Application path |
Path to app directory or to a zip file of the contents of the app directory. E.g. /tmp/hello-spring-cloud/target/hello-spring-cloud-0.0.1.BUILD-SNAPSHOT.jar. |
Hostname |
Hostname (e.g. my-subdomain). Will be used for route creation. |
Disk limit |
Disk limit (e.g. 256M, 1024M, 1G). |
Memory limit |
Memory limit (e.g. 256M, 1024M, 1G). |
Route path |
Path for the route. E.g. my-sample-app. |
Random route? |
Create a random route for this app. |
Instances |
Number of instances. |
Startup command |
Startup command, set to null to reset to default start command. |
Domain |
Domain (e.g. example.com). |
Buildpack |
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). |
Endpoint property name |
Property name for saving application endpoint. |
Start application? |
If checked, the application will be started after the deployment. |
Push application
Pushes application files to the server. This procedure does not delete the application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be pushed. |
Application path |
Path to app directory or to a zip file of the contents of the app directory |
Hostname |
Hostname (e.g. my-subdomain) |
Disk limit |
Disk limit (e.g. 256M, 1024M, 1G) |
Memory limit |
Memory limit (e.g. 256M, 1024M, 1G) |
Route path |
Path for the route |
Random route? |
Create a random route for this app |
Instances |
Number of instances |
Startup command |
Startup command, set to null to reset to default start command |
Domain |
Domain (e.g. example.com). |
Buildpack |
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' |
Endpoint property name |
Property name for saving application endpoint. |
Start application? |
If checked, the application will be started after the deployment. |
Blue-green deploy
Deploys and redeploys the application with reduced downtime. For this, a new application is created, then routes and services are bound to the new application, then the old application is deleted.
For more information about blue-green deploy, see Using Blue-Green Deployment to Reduce Downtime and Risk
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be pushed. |
Application path |
Path to app directory or to a zip file of the contents of the app directory |
Hostname |
Hostname (e.g. my-subdomain) |
Disk limit |
Disk limit (e.g. 256M, 1024M, 1G) |
Memory limit |
Memory limit (e.g. 256M, 1024M, 1G) |
Route path |
Path for the route |
Random route? |
Create a random route for this app |
Instances |
Number of instances |
Startup command |
Startup command, set to null to reset to default start command |
Domain |
Domain (e.g. example.com). |
Buildpack |
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' |
Endpoint property name |
Property name for saving application endpoint. |
Start application? |
If checked, the application will be started after the deployment. |
Start application
Starts the specified application.
The first time you deploy an application, cloud foundry uses the buildpack start command by default. To override these defaults, provide the Startup Command option.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be started. |
Stop application
Stops the specified application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be stopped. |
Restage application
Restage the specified application.
Restaging your application stops your application and restages it, by compiling a new droplet and starting it. Restage your application if you have changed the environment in a way that affects your staging process, such as setting an environment variable that the buildpack consumes. The staging process has access to environment variables, so the environment can affect the contents of the droplet.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be restaged. |
Restart application
Restarts the specified application.
Restarting your application stops your application and restarts it with the already compiled droplet. A droplet is a tarball that includes:
-
stack
-
buildpack
-
application source code
The Diego cell unpacks, compiles, and runs a droplet on a container. Restart your application to refresh the application’s environment after actions such as binding a new service to the application or setting an environment variable that only the application consumes. However, if your environment variable is consumed by the buildpack in addition to the application, then you must restage the application for the change to take effect.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be restarted. |
Set environment variables
Sets environment variables for the specified application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to set environment variables for. |
Variables |
Environment variables in JSON format, e.g. \{"MYVAR": "VALUE"} |
Delete application
Deletes the specified application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application to be deleted. |
Get application
Gets the info about the specified application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
A name for the application. |
Property name |
Property name for the retrieved application data. |
List applications
Lists applications on the Cloud Foundry server.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Property name |
Property name for saving applications list. |
Create or update service
Creates a new Service Instance or updates the existing one.
Cloud Foundry offers a marketplace of services, from which users can provision reserved resources on-demand. Examples of resources services provide include databases on a shared or dedicated server, or accounts on a SaaS application. These resources are known as service instances and the systems that deliver and operate these resources are known as Services. Think of a service as a factory that delivers service instances.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Service name |
A name for service to be created, e.g. APIConnect. |
Service instance name |
Service instance name, e.g. my service. |
Service plan |
Service plan, e.g. Silver. |
Parameters as JSON |
Optionally provide service-specific configuration parameters in a valid JSON object in-line. |
Tags |
List of tags, comma-separated. |
Bind service
Depending on the service, binding a service instance to your application may deliver credentials for the service instance to the application. See the Delivering Service Credentials to an Application topic for more information. Binding a service instance to an application may also trigger application logs to be streamed to the service instance. For more information, see Streaming Application Logs to Log Management Services.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Service instance name |
Service instance name. |
Application name |
Application name. |
Unbind service
Unbinds the specified service instance from the application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Service instance name |
Service instance name. |
Application name |
Application name. |
Delete service
Deletes the specified service instance.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Service instance name |
Service instance name. |
Create route
Creates a new route.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Domain |
Domain for the route. |
Hostname |
Hostname for the HTTP route (required for shared domains). |
Path |
Path for the HTTP route. |
Port |
Hostname for the HTTP route (required for shared domains). |
Random port? |
If checked, a random port will be created. |
Map route
Maps a route to an application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
Application name |
Domain |
Domain for the route. |
Hostname |
Hostname for the HTTP route (required for shared domains). |
Path |
Path for the HTTP route. |
Port |
Hostname for the HTTP route (required for shared domains). |
Random port? |
If checked, a random port will be created. |
Unmap route
Unmaps a route from an application.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Application name |
Application name |
Domain |
Domain for the route. |
Hostname |
Hostname for the HTTP route (required for shared domains). |
Path |
Path for the HTTP route. |
Port |
Hostname for the HTTP route (required for shared domains). |
Delete route
Deletes the specified route.
| Parameter | Description |
|---|---|
Configuration name |
Previously defined configuration name. |
Space |
A space provides users with access to a shared location for application development, deployment, and maintenance. Will be taken from the config, if defined. |
Domain |
Domain for the route. |
Hostname |
Hostname for the HTTP route (required for shared domains). |
Path |
Path for the HTTP route. |
Port |
Hostname for the HTTP route (required for shared domains). |