CI Reference

Configuration Item Overview

Deployables

CI	Description
helm.Chart	Base Deployable used for Deployment of Helm Charts
helm.ChartWithNamespace	Installs a helm chart with namespace.

Deployeds

CI	Description
helm.K8SRelease	Helm K8S Release extends the base deployed for Helm Deployment.
helm.K8SReleaseWithNamespace	Helm K8S Release with create Namespace.
helm.OpenshiftRelease	Helm Openshift Release.
helm.Release	Helm Release is the base deployed which can be extended for Helm Deployment.

Containers

CI	Description
helm.Client	Helm Client used of Specifying the Helm Container Details.

Other Configuration Items

CI	Description
helm.AppliedConfigFile	Helm Applied Config File.
helm.AppliedOrderedConfigFile	Helm Applied Config File.
helm.ConfigFile	Helm Applied Config File. (deployable)
helm.OrderedConfigFile	Helm Applied Config File. (deployable)
helm.Repository	Helm repository configuration

Configuration Item Details

helm.AppliedConfigFile

Type Hierarchy	udm.EmbeddedDeployedArtifact >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.DerivedArtifact, udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Helm Applied Config File.

		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.
		fileEncodingType: STRING
		File Encoding Type
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>

---

helm.AppliedOrderedConfigFile

Type Hierarchy	udm.EmbeddedDeployedArtifact >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.DerivedArtifact, udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Helm Applied Config File.

		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.
		fileEncodingType: STRING
		File Encoding Type
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | yaml | txt | yml | json )
		Text File Names Regex

---

helm.Chart

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Base Deployable used for Deployment of Helm Charts

		Children
		configurationFiles: SET_OF_CI<helm.ConfigFile>
		Configuration Files
		orderedConfigurationFiles: LIST_OF_CI<helm.OrderedConfigFile>
		Ordered Configuration Files

		Public properties
		chartName: STRING
		repoName/chartName when add repository is selected, else chartName
		chartVersion: STRING
		Chart Version
		addRepository: BOOLEAN = true
		If the repo should be added. If false, chart will be pulled from remote repo using repositoryUrl
		chartEncodingType: STRING
		Chart Encoding Type
		inputVariables: MAP_STRING_STRING
		Input variables to be used in the Helm configuration.
		password: STRING
		Password
		repositoryUrl: STRING
		Helm Repo details should be configured here or as part of Helm Client
		secretInputVariables: MAP_STRING_STRING
		Secret input simple (int,string) variables to be used in the Helm configuration.
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		testRelease: BOOLEAN = true
		Test Release
		updateRepositories: BOOLEAN = true
		if true the helm repo will be updated
		username: STRING
		Username

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

helm.ChartWithNamespace

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Installs a helm chart with namespace.

		Children
		configurationFiles: SET_OF_CI<helm.ConfigFile>
		Configuration Files
		orderedConfigurationFiles: LIST_OF_CI<helm.OrderedConfigFile>
		Ordered Configuration Files

		Public properties
		addRepository: STRING
		If the repo should be added. If false, chart will be pulled from remote repo using repositoryUrl (boolean) default(true)
		chartEncodingType: STRING
		Chart Encoding Type (string)
		chartName: STRING
		repoName/chartName when add repository is selected, else chartName (string)
		chartVersion: STRING
		Version of the helm chart (string)
		inputVariables: MAP_STRING_STRING
		Input variables to be used in the Helm configuration. (map_string_string)
		namespace: STRING
		Name of the namespace to be created. (string)
		password: STRING
		Password (string)
		repositoryUrl: STRING
		url for the Helm repository (string)
		secretInputVariables: MAP_STRING_STRING
		Secret input simple (int,string) variables to be used in the Helm configuration. (map_string_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		testRelease: STRING
		Test Release (boolean) default(true)
		updateRepositories: STRING
		if true the helm repo will be updated (boolean) default(true)
		username: STRING
		Username (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

helm.Client

Type Hierarchy	generic.Container >> generic.BaseGenericContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, generic.GenericContainer, overthere.HostContainer, udm.Taggable

Helm Client used of Specifying the Helm Container Details.

		Parent
		host: CI<overthere.Host>
		Host upon which the container resides

		Public properties
		home: STRING = /usr/local/bin
		Home
		caFile: STRING
		Ca File
		debug: BOOLEAN
		Debug
		envVars: MAP_STRING_STRING
		Environment variables for container
		forceUpdate: BOOLEAN = true
		In Helm v3.3.2 and later, default behavior is not to update an existing repo if it exists. Use this to update existing repo or uncheck if helm version is less than 3.3.2
		helmConfig: STRING
		Location of your Helm config. Overrides $HELM-HOME
		helmHost: STRING
		Address of Tiller. Overrides $HELM-HOST *** ONLY NEEDED FOR HELM V2***
		helmRepo: CI<helm.Repository>
		Reference of Helm Repo Configuration Obj
		insecureConnection: BOOLEAN
		Insecure Connection
		kubeConfig: STRING
		Absolute path of the kubeconfig file to be used
		kubeContext: STRING
		Name of the kubeconfig context to use
		password: STRING
		Password
		showDiff: BOOLEAN
		While Upgrade, Shows the Difference between the current and previous Helm Releases. Note: Requires Helm Diff Plugin to be installed.
		showK8sYamlPreview: BOOLEAN
		While Deployment,Shows the Converted Kubernetes YAML in Preview.
		stopStartRestartConnection: CI<overthere.Host>
		If set, the connection settings to use to connect to the target system to execute start, stop, restart etc. operations for the container.
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.
		useClusterConfiguration: BOOLEAN
		Mark it if you want to use cluster configuration instead of using kube config file.
		username: STRING
		Username
		version: ENUM [2, 3] = 3
		Version

		Hidden properties
		restartOrder: INTEGER = 90
		The order of the restart container step in the step list.
		restartWaitTime: INTEGER
		The time to wait in seconds for a container restart action.
		startOrder: INTEGER = 90
		The order of the start container step in the step list.
		startWaitTime: INTEGER
		The time to wait in seconds for a container start action.
		stopOrder: INTEGER = 10
		The order of the stop container step in the step list.
		stopWaitTime: INTEGER
		The time to wait in seconds for a container stop action.
		inspectClasspathResources: SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript: STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources: SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		restartClasspathResources: SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the restart script.
		restartScript: STRING
		Classpath to the script used to restart the generic container.
		restartTemplateClasspathResources: SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the restart script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		startClasspathResources: SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the start script.
		startScript: STRING
		Classpath to the script used to start the generic container.
		startTemplateClasspathResources: SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the start script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		stopClasspathResources: SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the stop script.
		stopScript: STRING
		Classpath to the script used to stop the generic container.
		stopTemplateClasspathResources: SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the stop script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

---

helm.ConfigFile

Type Hierarchy	udm.EmbeddedDeployableArtifact >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.EmbeddedDeployable, udm.SourceArtifact

Helm Applied Config File. (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
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		fileEncodingType: STRING
		File Encoding Type (string)
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		proxySettings: CI<credentials.ProxySettings>
		Credentials
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | yaml | txt | yml | json )
		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

---

helm.K8SRelease

Type Hierarchy	helm.Release >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Helm K8S Release extends the base deployed for Helm Deployment.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		configurationFiles: SET_OF_CI<helm.AppliedConfigFile>
		Configuration Files
		orderedConfigurationFiles: LIST_OF_CI<helm.AppliedOrderedConfigFile>
		Ordered Configuration Files

		Public properties
		chartName: STRING
		repoName/chartName when add repository is selected, else chartName
		chartVersion: STRING
		Chart Version
		addRepository: BOOLEAN = true
		If the repo should be added. If false, chart will be pulled from remote repo using repositoryUrl
		chartEncodingType: STRING
		Chart Encoding Type
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		inputVariables: MAP_STRING_STRING
		Input variables to be used in the Helm configuration.
		password: STRING
		Password
		repositoryUrl: STRING
		url for the Helm repository
		secretInputVariables: MAP_STRING_STRING
		Secret input simple (int,string) variables to be used in the Helm configuration.
		testRelease: BOOLEAN = true
		Test Release
		updateRepositories: BOOLEAN = true
		if true the helm repo will be updated
		username: STRING
		Username

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

helm.K8SReleaseWithNamespace

Type Hierarchy	helm.Release >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Helm K8S Release with create Namespace.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		configurationFiles: SET_OF_CI<helm.AppliedConfigFile>
		Configuration Files
		orderedConfigurationFiles: LIST_OF_CI<helm.AppliedOrderedConfigFile>
		Ordered Configuration Files

		Public properties
		chartName: STRING
		repoName/chartName when add repository is selected, else chartName
		chartVersion: STRING
		Version of the helm chart
		namespace: STRING
		Name of the namespace to be created.
		addRepository: BOOLEAN = true
		If the repo should be added. If false, chart will be pulled from remote repo using repositoryUrl
		chartEncodingType: STRING
		Chart Encoding Type
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		inputVariables: MAP_STRING_STRING
		Input variables to be used in the Helm configuration.
		password: STRING
		Password
		repositoryUrl: STRING
		url for the Helm repository
		secretInputVariables: MAP_STRING_STRING
		Secret input simple (int,string) variables to be used in the Helm configuration.
		testRelease: BOOLEAN = true
		Test Release
		updateRepositories: BOOLEAN = true
		if true the helm repo will be updated
		username: STRING
		Username

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

helm.OpenshiftRelease

Type Hierarchy	helm.Release >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Helm Openshift Release.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		configurationFiles: SET_OF_CI<helm.AppliedConfigFile>
		Configuration Files
		orderedConfigurationFiles: LIST_OF_CI<helm.AppliedOrderedConfigFile>
		Ordered Configuration Files

		Public properties
		chartName: STRING
		repoName/chartName when add repository is selected, else chartName
		chartVersion: STRING
		Chart Version
		addRepository: BOOLEAN = true
		If the repo should be added. If false, chart will be pulled from remote repo using repositoryUrl
		chartEncodingType: STRING
		Chart Encoding Type
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		inputVariables: MAP_STRING_STRING
		Input variables to be used in the Helm configuration.
		password: STRING
		Password
		repositoryUrl: STRING
		url for the Helm repository
		secretInputVariables: MAP_STRING_STRING
		Secret input simple (int,string) variables to be used in the Helm configuration.
		testRelease: BOOLEAN = true
		Test Release
		updateRepositories: BOOLEAN = true
		if true the helm repo will be updated
		username: STRING
		Username

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

helm.OrderedConfigFile

Type Hierarchy	udm.EmbeddedDeployableArtifact >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.EmbeddedDeployable, udm.SourceArtifact

Helm Applied Config File. (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
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		fileEncodingType: STRING
		File Encoding Type (string)
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		proxySettings: CI<credentials.ProxySettings>
		Credentials
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported

		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
		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

---

helm.Release

Virtual Type
Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Helm Release is the base deployed which can be extended for Helm Deployment.

		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.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

helm.Repository

Type Hierarchy	udm.Configuration >> udm.BaseConfigurationItem

Helm repository configuration

		Public properties
		repositoryUrl: STRING
		url for the Helm repository
		password: STRING
		Password to use when authenticating with the registry.
		username: STRING
		Helm repository user name.

---