Cloud Foundry Plugin Reference 10.0.x
The XL Deploy Cloud Foundry plugin enables XL Deploy to work with Cloud Foundry Web Services.
This document contains information that is specific to this version of the plugin. For information about plugin features, refer to Introduction to the XL Deploy Cloud Foundry plugin. For general information about provisioning, refer to Provisioning through XL Deploy.
Requirements
- XL Deploy 8.0.0 or later
- User credentials for accessing Cloud Foundry Web Services
Release notes
Cloud Foundry plugin 10.0.0
Bug fixes
- [ENG-3708] - Fixed the version Okio library conflict between xld plugins
Cloud Foundry plugin 9.5.0
Improvements
- [XLINT-791] - Allowed specifying a complete path to the manifest file
Cloud Foundry plugin 9.0.0
Improvements
- [XLINT-678] - Change cloudFoundry.AppSpec not to be mandatory
Cloud Foundry plugin 8.6.0
New features
- [XLINT-320] - Implement Discovery, CI for Domain and Route and AdminTask (Create and Delete)
- [XLINT-490] - Enhance discoveries for spaces and applications; add route and bound services.
Improvements
- [XLINT-160] - Cloud Foundry plugin: improve logging
Bugs
- [XLINT-504] - XL Deploy - Cloud Foundry plugin not able to create multiple applications
Cloud Foundry plugin 8.0.0
New features
- [DEPL-12841] - Push an application to CloudFoundry
- [DEPL-12846] - Create a service
- [DEPL-12845] - Create a route
- [DEPL-13051] - Add manifest support
- [DEPL-13052] - Support rolling update
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| cloudFoundry.AppSpec | Description unavailable (deployable) |
| cloudFoundry.ManifestModuleSpec | Description unavailable (deployable) |
| cloudFoundry.ServicesSpec | Description unavailable (deployable) |
| cloudFoundry.SpaceSpec | Specification for a Cloudfoundry Space. |
Deployeds
| CI | Description |
|---|---|
| cloudFoundry.App | Description unavailable |
| cloudFoundry.ManifestModule | Description unavailable |
| cloudFoundry.Services | Description unavailable |
| cloudFoundry.Space | Cloudfoundry Space. |
Containers
| CI | Description |
|---|---|
| cloudFoundry.InspectableContainer | Description unavailable |
| cloudFoundry.Organization | Description unavailable |
| cloudFoundry.Space | Cloudfoundry Space. |
Other Configuration Items
| CI | Description |
|---|---|
| cloudFoundry.BoundService | Description unavailable |
| cloudFoundry.BoundServiceSpec | Description unavailable (deployable) |
| cloudFoundry.Route | Description unavailable |
| cloudFoundry.RouteSpec | Description unavailable (deployable) |
| cloudFoundry.ServiceKeys | Description unavailable |
| cloudFoundry.ServiceKeysSpec | Description unavailable (deployable) |
Configuration Item Details
cloudFoundry.App
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Children | ||
|---|---|---|
|
|
| |
|
List of bound services.
|
||
|
|
| |
|
List of routes.
|
| Public properties | ||
|---|---|---|
|
|
|
appName: STRING
|
|
Application name to be used.
|
||
|
|
|
appId: STRING
|
|
Application Id
|
||
|
|
|
buildPack: ENUM [Binary, Go, HWC, Java, .Net, NGINX, Node.js, PHP, Python, R, Ruby, Staticfile, Custom]
|
|
Build pack to be used.
|
||
|
|
|
customBuildPackURL: STRING
|
|
Provide custom build pack URL.
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
hostname: STRING
|
|
Hostname (subdomain) to use in route, defaults to app name. Not applicable if 'No Route' property is set
|
||
|
|
|
instances: INTEGER = 1
|
|
Number of instances to run.
|
||
|
|
|
memory: INTEGER = 512
|
|
The maximum amount of memory that each instance of your app can consume.
|
||
|
|
|
noRoute: BOOLEAN
|
|
If true, does not create any route.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
|
randomRoute: BOOLEAN = true
|
|
If true, creates a unique random route. Not applicable if 'No Route' property is set.
|
||
|
|
|
rollingUpdate: BOOLEAN
|
|
Support rolling update feature.
|
||
|
|
|
urls: LIST_OF_STRING
|
|
Urls to access the application
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
cloudFoundry.AppSpec
| Type Hierarchy | udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
| Children | ||
|---|---|---|
|
|
| |
|
List of bound services.
|
||
|
|
| |
|
List of routes.
|
| Public properties | ||
|---|---|---|
|
|
|
appName: STRING
|
|
Application name to be used. (string)
|
||
|
|
|
buildPack: STRING
|
|
Build pack to be used. (enum) values(Binary, Go, HWC, Java, .Net, NGINX, Node.js, PHP, Python, R, Ruby, Staticfile, Custom)
|
||
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
customBuildPackURL: STRING
|
|
Provide custom build pack URL. (string)
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
hostname: STRING
|
|
Hostname (subdomain) to use in route, defaults to app name. Not applicable if 'No Route' property is set (string)
|
||
|
|
|
instances: STRING
|
|
Number of instances to run. (integer) default(1)
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
memory: STRING
|
|
The maximum amount of memory that each instance of your app can consume. (integer) default(512)
|
||
|
|
|
noRoute: STRING
|
|
If true, does not create any route. (boolean) default(false)
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
preScannedPlaceholders: BOOLEAN
|
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
|
proxySettings:
CI<credentials.ProxySettings>
|
|
Proxy Settings for artifact location
|
||
|
|
|
randomRoute: STRING
|
|
If true, creates a unique random route. Not applicable if 'No Route' property is set. (boolean) default(true)
|
||
|
|
|
rollingUpdate: STRING
|
|
Support rolling update feature. (boolean)
|
||
|
|
|
scanPlaceholders: BOOLEAN
|
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
appId: STRING
|
|
Application Id
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
||
|
|
|
delimiters: STRING = {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
||
|
|
|
urls: LIST_OF_STRING
|
|
Urls to access the application
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| rescanArtifacts |
delegate = rescanArtifact |
No description. |
cloudFoundry.BoundService
| Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.EmbeddedDeployedContainer>
|
|
The (embedded) deployed which contains this embedded deployed.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.EmbeddedDeployable>
|
|
The embedded deployable that this embedded deployed is derived from.
|
||
|
|
|
parameters: MAP_STRING_STRING
|
|
List of properties.
|
||
|
|
|
serviceInstanceName: STRING
|
|
Service instance name.
|
cloudFoundry.BoundServiceSpec
| Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployable |
Description unavailable (deployable)
| Public properties | ||
|---|---|---|
|
|
|
parameters: MAP_STRING_STRING
|
|
List of properties. (map_string_string)
|
||
|
|
|
serviceInstanceName: STRING
|
|
Service instance name. (string)
|
cloudFoundry.InspectableContainer
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
| Interfaces | udm.Container, udm.Taggable |
Description unavailable
| Public properties | ||
|---|---|---|
|
|
|
inspectionScript: STRING
|
|
Inspection Script
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
cloudFoundry.ManifestModule
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
manifestFileName: STRING = manifest.yml
|
|
Either the manifest file name (if the manifest file is in the base directory of the package), or the path to the manifest file, such as 'package/app/manifest.yml'.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
cloudFoundry.ManifestModuleSpec
| Type Hierarchy | udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable |
Description unavailable (deployable)
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
credentials:
CI<credentials.Credentials>
|
|
Credentials of the URI.
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
manifestFileName: STRING
|
|
Either the manifest file name (if the manifest file is in the base directory of the package), or the path to the manifest file, such as 'package/app/manifest.yml'. (string) default(manifest.yml)
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
preScannedPlaceholders: BOOLEAN
|
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
|
proxySettings:
CI<credentials.ProxySettings>
|
|
Proxy Settings for artifact location
|
||
|
|
|
scanPlaceholders: BOOLEAN = true
|
|
Whether to scan this artifact to replace placeholders when it is imported
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
|
|
Regular expression that matches file names of text files
|
||
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
||
|
|
|
delimiters: STRING = {{ }}
|
|
The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| rescanArtifacts |
delegate = rescanArtifact |
No description. |
cloudFoundry.Organization
| Type Hierarchy | cloudFoundry.InspectableContainer >> udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.Taggable |
Description unavailable
| Public properties | ||
|---|---|---|
|
|
|
apiEndpoint: STRING
|
|
API endpoint of cloudFoundry server.
|
||
|
|
|
organizationName: STRING
|
|
Organization name on cloudFoundry server.
|
||
|
|
|
password: STRING
|
|
Password
|
||
|
|
|
username: STRING
|
|
Username
|
||
|
|
|
ignoreSsl: BOOLEAN
|
|
If true, self signed certificates will not be checked.
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Hidden properties | ||
|---|---|---|
|
|
|
inspectionScript: STRING = cf/discovery/discover-spaces.py
|
|
Inspection Script
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| checkConnection |
delegate = jythonScript, script = cf/check-organization-connection.py |
Check connection. |
cloudFoundry.Route
| Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.EmbeddedDeployedContainer>
|
|
The (embedded) deployed which contains this embedded deployed.
|
| Public properties | ||
|---|---|---|
|
|
|
domainName: STRING
|
|
Domain name.
|
||
|
|
|
deployable:
CI<udm.EmbeddedDeployable>
|
|
The embedded deployable that this embedded deployed is derived from.
|
||
|
|
|
hostName: STRING
|
|
Hostname.
|
||
|
|
|
path: STRING
|
|
Context path.
|
||
|
|
|
port: INTEGER
|
|
Port number (tcp).
|
||
|
|
|
randomPort: BOOLEAN
|
|
Whether to use random port (tcp).
|
||
|
|
|
url: STRING
|
|
Url to access the route
|
cloudFoundry.RouteSpec
| Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployable |
Description unavailable (deployable)
| Public properties | ||
|---|---|---|
|
|
|
domainName: STRING
|
|
Domain name. (string)
|
||
|
|
|
hostName: STRING
|
|
Hostname. (string)
|
||
|
|
|
path: STRING
|
|
Context path. (string)
|
||
|
|
|
port: STRING
|
|
Port number (tcp). (integer)
|
||
|
|
|
randomPort: STRING
|
|
Whether to use random port (tcp). (boolean) default(false)
|
||
|
|
|
url: STRING
|
|
Url to access the route (string)
|
cloudFoundry.ServiceKeys
| Type Hierarchy | udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.EmbeddedDeployedContainer>
|
|
The (embedded) deployed which contains this embedded deployed.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.EmbeddedDeployable>
|
|
The embedded deployable that this embedded deployed is derived from.
|
||
|
|
|
parameters: MAP_STRING_STRING
|
|
List of properties.
|
||
|
|
|
serviceKeyName: STRING
|
|
Name of the service key.
|
cloudFoundry.ServiceKeysSpec
| Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.EmbeddedDeployable |
Description unavailable (deployable)
| Public properties | ||
|---|---|---|
|
|
|
parameters: MAP_STRING_STRING
|
|
List of properties. (map_string_string)
|
||
|
|
|
serviceKeyName: STRING
|
|
Name of the service key. (string)
|
cloudFoundry.Services
| Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Description unavailable
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Children | ||
|---|---|---|
|
|
| |
|
List of service keys.
|
| Public properties | ||
|---|---|---|
|
|
|
serviceName: STRING
|
|
The name of the service.
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
parameters: MAP_STRING_STRING
|
|
List of properties.
|
||
|
|
|
planName: STRING
|
|
The level of resources or features for the same service.
|
||
|
|
|
serviceInstanceName: STRING
|
|
Instance name for the service
|
||
|
|
|
serviceTags: LIST_OF_STRING
|
|
List of tags.
|
||
|
|
|
timeout: INTEGER
|
|
Connection timeout in seconds.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
cloudFoundry.ServicesSpec
| Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Description unavailable (deployable)
| Children | ||
|---|---|---|
|
|
| |
|
List of service keys.
|
| Public properties | ||
|---|---|---|
|
|
|
parameters: MAP_STRING_STRING
|
|
List of properties. (map_string_string)
|
||
|
|
|
planName: STRING
|
|
The level of resources or features for the same service. (string)
|
||
|
|
|
serviceInstanceName: STRING
|
|
Instance name for the service (string)
|
||
|
|
|
serviceName: STRING
|
|
The name of the service. (string)
|
||
|
|
|
serviceTags: LIST_OF_STRING
|
|
List of tags. (list_of_string)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
timeout: STRING
|
|
Connection timeout in seconds. (integer)
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
cloudFoundry.Space
| Type Hierarchy | udm.BaseDeployedContainer >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Taggable |
Cloudfoundry Space.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
spaceName: STRING
|
|
Space name. Default: Name of this CI
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
cloudFoundry.SpaceSpec
| Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Specification for a Cloudfoundry Space.
| Public properties | ||
|---|---|---|
|
|
|
spaceName: STRING
|
|
Space name. Default: Name of this CI (string)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container. (set_of_string)
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|