Cloud Foundry Plugin Reference 8.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 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

    CIDescription
    cloudFoundry.AppSpec Description unavailable (deployable)
    cloudFoundry.ManifestModuleSpec Description unavailable (deployable)
    cloudFoundry.ServicesSpec Description unavailable (deployable)
    cloudFoundry.SpaceSpec Specification for a Cloudfoundry Space.

    Deployeds

    CIDescription
    cloudFoundry.App Description unavailable
    cloudFoundry.ManifestModule Description unavailable
    cloudFoundry.Services Description unavailable
    cloudFoundry.Space Cloudfoundry Space.

    Containers

    CIDescription
    cloudFoundry.Organization Description unavailable
    cloudFoundry.Space Cloudfoundry Space.

    Other Configuration Items

    CIDescription
    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
     
     
    boundServices: SET_OF_CI<cloudFoundry.BoundService>
    List of bound services.
     
     
    routes: SET_OF_CI<cloudFoundry.Route>
    List of routes.
      Public properties
     
     
    appName: STRING
    Application name to be used.
     
     
    buildPack: ENUM [Binary, Go, Java, .Net, Node.js, PHP, Python, Ruby, Staticfile, Custom]
    Build pack to be used.
     
     
    appId: STRING
    Application Id
     
     
    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
     
     
    boundServices: SET_OF_CI<cloudFoundry.BoundServiceSpec>
    List of bound services.
     
     
    routes: SET_OF_CI<cloudFoundry.RouteSpec>
    List of routes.
      Public properties
     
     
    appName: STRING
    Application name to be used. (string)
     
     
    buildPack: STRING
    Build pack to be used. (enum) values(Binary, Go, Java, .Net, Node.js, PHP, Python, Ruby, Staticfile, Custom)
     
     
    checksum: STRING
    The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
     
     
    customBuildPackURL: STRING
    Provide custom build pack URL. (string)
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    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)
     
     
    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)
     
     
    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
     
     
    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
     
     
    urls: LIST_OF_STRING
    Urls to access the application

    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.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
    Main manifest file name.
     
     
    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.
     
     
    excludeFileNamesRegex: STRING
    Regular expression that matches file names that must be excluded from scanning
     
     
    fileUri: STRING
    The URI pointing to the (remote) location of the file this artifact represents
     
     
    manifestFileName: STRING
    Main manifest file name. (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)
     
     
    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
     
     
    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

    cloudFoundry.Organization

    Type Hierarchy 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.
    Control taskParameter CIAttributesDescription
    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
     
     
    serviceKeys: SET_OF_CI<cloudFoundry.ServiceKeys>
    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
     
     
    serviceKeys: SET_OF_CI<cloudFoundry.ServiceKeysSpec>
    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.
    Copyright 2019. XebiaLabs, Inc. All rights reserved