OpenShift Plugin Reference 7.2.x
The XL Deploy OpenShift plugin enables XL Deploy to work with Red Hat OpenShift v3 cloud PaaS. The plugin uses the kubernetes and openshift API libraries to communicate with OpenShift. For information about the plugin features, refer to Introduction to the XL OpenShift plugin.
Requirements
- XL Deploy 6.2.0 or later
- A valid OpenShift account and a user with admin rights associated to it
xld-kubernetes-plugin7.2.0
Important: To use the XL Deploy OpenShift plugin with XL Deploy 7.1.0 or earlier, you must download the Jython jar file and replace jython-standalone-2.7.0.XXX.jar under the lib directory of the XL Deploy installation with it. This is not required for XL Deploy 7.2.0 or later.
Important: The XL Deploy OpenShift plugin 7.2.0 no longer supports individual YAML CIs for Pod, Development, Image Stream, and so on. Instead, there is single CI for YAML configurations, which supports all types of OpenShift configurations. This is a breaking change; you must delete and recreate packages when upgrading from 7.1.0 to 7.2.0
Release notes
XL Deploy OpenShift plugin 7.2.0
New features
- [DEPL-12119] - Deploy/Undeploy k8s Pod using CI
- [DEPL-12128] - Deploy/Undeploy k8s Deployment Config using CI
- [DEPL-12198] - Single CI for YAML-based configurations
XL Deploy OpenShift plugin 7.1.0
New features
- Deploy/Undeploy Build Config
- Deploy/Undeploy Deployment Config
- Deploy/Undeploy Image Stream
- Deploy/Undeploy Pod
- Deploy/Undeploy Route
- Deploy/Undeploy Service
- Deploy/Undeploy List of items
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| openshift.AbstractK8sResource | OpenShift Abstract Resource Template (deployable) |
| openshift.K8sResource | OpenShift Generic Resource Template (deployable) |
| openshift.ProjectSpec | Specification for an OpenShift project. |
Deployeds
| CI | Description |
|---|---|
| openshift.AbstractK8sResourceFile | OpenShift Abstract Resource Template |
| openshift.K8sResourceFile | OpenShift Generic Resource Template |
| openshift.Project | OpenShift Project. |
Containers
| CI | Description |
|---|---|
| openshift.Project | OpenShift Project. |
| openshift.Server | OpenShift server |
Configuration Item Details
openshift.AbstractK8sResource
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.SourceArtifact, udm.Taggable |
OpenShift Abstract Resource Template (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
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
scanPlaceholders: BOOLEAN = true
|
|
Whether to scan this artifact for 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 = .+\.( json | yml | yaml )
|
|
Regular expression that matches file names of text files
|
||
|
|
|
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
|
openshift.AbstractK8sResourceFile
| Virtual Type | |
|---|---|
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
OpenShift Abstract Resource Template
| 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.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
openshift.K8sResource
| Type Hierarchy | openshift.AbstractK8sResource >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.SourceArtifact, udm.Taggable |
OpenShift Generic Resource Template (deployable)
| Public properties | ||
|---|---|---|
|
|
|
checksum: STRING
|
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
|
createOrder: STRING
|
|
Create Order (integer) default(65)
|
||
|
|
|
destroyOrder: STRING
|
|
Destroy Order (integer) default(47)
|
||
|
|
|
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
|
||
|
|
|
modifyOrder: STRING
|
|
Modify Order (integer) default(65)
|
||
|
|
|
placeholders: SET_OF_STRING
|
|
Placeholders detected in this artifact
|
||
|
|
|
scanPlaceholders: BOOLEAN = true
|
|
Whether to scan this artifact for 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 = .+\.( json | yml | yaml )
|
|
Regular expression that matches file names of text files
|
||
|
|
|
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
|
openshift.K8sResourceFile
| Type Hierarchy | openshift.AbstractK8sResourceFile >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
OpenShift Generic Resource Template
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
createOrder: INTEGER = 65
|
|
Create Order
|
||
|
|
|
destroyOrder: INTEGER = 47
|
|
Destroy Order
|
||
|
|
|
modifyOrder: INTEGER = 65
|
|
Modify Order
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
openshift.Project
| Type Hierarchy | k8s.BasePodContainer >> udm.BaseProvisionedContainer >> udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Taggable |
OpenShift Project.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Children | ||
|---|---|---|
|
|
|
provisioners:
LIST_OF_CI<udm.AppliedProvisioner>
|
|
A list of provisioners associated with the instance.
|
| Public properties | ||
|---|---|---|
|
|
|
ordinal: INTEGER
|
|
The index of the cardinality amount created provisioneds.
|
||
|
|
|
projectName: STRING
|
|
Project Name
|
||
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
description: STRING
|
|
Description
|
||
|
|
|
projectDisplayName: STRING
|
|
Project Display Name
|
| Hidden properties | ||
|---|---|---|
|
|
|
containerHelper: STRING = xld.openshift.project.helper.ProjectHelper
|
|
Container Helper
|
openshift.ProjectSpec
| Type Hierarchy | udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Provisionable, udm.Taggable |
Specification for an OpenShift project.
| Children | ||
|---|---|---|
|
|
|
provisioners:
LIST_OF_CI<udm.Provisioner>
|
|
A list of provisioners associated with the instance.
|
| Public properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
||
|
|
|
cardinality: STRING = 1
|
|
Number of instances to launch.
|
||
|
|
|
description: STRING
|
|
Description (string)
|
||
|
|
|
projectDisplayName: STRING
|
|
Project Display Name (string)
|
||
|
|
|
projectName: STRING
|
|
Project Name (string)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
openshift.Server
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.Taggable |
OpenShift server
| Public properties | ||
|---|---|---|
|
|
|
openshiftToken: STRING
|
|
Openshift Token
|
||
|
|
|
serverUrl: STRING
|
|
Url of the OpenShift server
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
||
|
|
|
verifyCertificates: BOOLEAN = true
|
|
Validate certificates?
|
| Hidden properties | ||
|---|---|---|
|
|
|
clientFactory: STRING = xld.openshift.factories.client_factory.OpenShiftClientFactory
|
|
Client Factory
|
| Control task | Parameter CI | Attributes | Description |
|---|---|---|---|
| checkConnection |
delegate = jythonScript, script = xld/openshift/check_connection.py |
Verify the connection to the Openshift Cloud. |