Skip to main content
Version: Deploy 23.3

Cloud Foundry plugin

This topic describes the Deploy Cloud Foundry plugin, which supports creating spaces, deploying applications, creating routes, binding services, and using manifest files.

For more information about the Deploy Cloud Foundry plugin requirements and the configuration items (CIs) that the plugin supports, see the Cloud Foundry Plugin Reference.

Using the Deploy Cloud Foundry plugin​

The Deploy Cloud Foundry plugin can push and remove applications on a Cloud Foundry organization. To use the plugin:

  1. Download the Deploy Cloud Foundry plugin ZIP from the distribution site.
  2. Unpack the plugin inside the XL_DEPLOY_SERVER_HOME/plugins/ directory.
  3. Restart Deploy.

Create the Cloud Foundry organization​

To create a Cloud Foundry organization in Deploy:

  1. Under Infrastructure, create a cloudFoundry.Organization CI.
  2. Specify the following properties:
    • Organization Name: Organization name on the Cloud Foundry server.
    • API Endpoint: API endpoint of Cloud Foundry server (example: api.run.pivotal.io).
    • Username: User name to use for authentication.
    • Password: Password to use for authentication.

Provision a Cloud Foundry space​

To provision a new Cloud Foundry space:

  1. Under Applications, create an application (udm.Application) and a deployment package (udm.DeploymentPackage).
  2. Under the deployment package, create a cloudFoundry.SpaceSpec CI.
  3. Specify the Space Name to use. If not provided, the CI name will be used as the space name.

Alternatively, you can use a space that already exists in Cloud Foundry by creating a cloudFoundry.Space CI under the cloudFoundry.Organization CI (in Infrastructure).

Push an application to Cloud Foundry​

To push an application to Cloud Foundry:

  1. Under Applications, create an application (udm.Application) and a deployment package (udm.DeploymentPackage).
  2. Under the deployment package, create a cloudFoundry.AppSpec CI. Specify the following required properties:
    • App Name: Application name to use.
    • Build Pack: Build pack to use (example: Java, Go, Binary, and so on). To specify a custom build pack, fill in the Custom Build Pack URL property instead.

Configure Cloud Foundry services​

To configure Cloud Foundry services:

  1. Under Applications, create an application (udm.Application) and a deployment package (udm.DeploymentPackage).
  2. Under the deployment package, create a cloudFoundry.Services CI.
  3. Specify the Service Type.

Push an application to Cloud Foundry using a manifest​

To push an application to Cloud Foundry:

  1. Under Applications, create an application (udm.Application) and a deployment package (udm.DeploymentPackage).
  2. Under the deployment package, create a cloudFoundry.ManifestModuleSpec CI.
  3. In the File property, specify a ZIP file that contains the manifest file and artifacts required to create the application.