Puppet Plugin Manual 25.1.x
The XL Deploy Puppet plugin uses the Puppet provisioning tool to install modules and manifests on hosts.
This document provides information that is specific to this version of the Puppet plugin. For general information about the plugin, refer to Introduction to the XL Deploy Puppet plugin.
Requirements
- XL Deploy 6.0.0 or later
- Puppet 3.4.3 (Unix)
Limitations
- The plugin does not support deployments on Microsoft Windows-based hosts
- The plugin only supports deployment on stand-alone Puppet
- The plugin does not support Puppet master and Puppet agent node configuration
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| puppet.Manifest | Puppet manifest file applied on the host. |
| puppet.ManifestFolder | Puppet manifest folder applied on the host. |
| puppet.Module | Puppet module installed from Puppet Forge. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache. |
| puppet.TarBallModule | Puppet module installed from a tarball archive file. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache. |
Deployeds
| CI | Description |
|---|---|
| puppet.AppliedManifest | Puppet manifest file applied on the host. |
| puppet.AppliedManifestFolder | Puppet manifest folder applied on the host. |
| puppet.InstalledModule | Puppet module installed from Puppet Forge. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache. |
| puppet.InstalledTarBallModule | Puppet module installed from a tarball archive file. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache. |
Configuration Item Details
puppet.AppliedManifest
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Puppet manifest file applied on the host.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
applyOnNoop: BOOLEAN
|
|
Apply the manifest on NOOP state.
|
||
|
|
|
applyOrder: INTEGER = 50
|
|
Order at which the puppet provisioning of the manifest should happen.
|
||
|
|
|
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>
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
puppet.AppliedManifestFolder
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Puppet manifest folder applied on the host.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
manifestFile: STRING
|
|
Manifest file name; for example, init.pp.
|
||
|
|
|
manifestPath: STRING
|
|
Location of the manifest folder as an absolute path or as a path relative to the uploaded folder artifact.
|
||
|
|
|
applyOnNoop: BOOLEAN
|
|
Apply the manifests on NOOP state.
|
||
|
|
|
applyOrder: INTEGER = 50
|
|
Order at which the Puppet provisioning of the manifest should happen.
|
||
|
|
|
debug: BOOLEAN
|
|
Enable debug mode.
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
hieraConfig: STRING
|
|
Location of the Hiera configuration file as an absolute path or as a path relative to the uploaded folder artifact.
|
||
|
|
|
modulePath: STRING
|
|
Location of the module directory as an absolute path or as a path relative to the uploaded folder artifact.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
|
trace: BOOLEAN
|
|
Enable trace mode.
|
||
|
|
|
verbose: BOOLEAN
|
|
Enable verbose mode.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
puppet.InstalledModule
| Type Hierarchy | udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployed, udm.EmbeddedDeployedContainer |
Puppet module installed from Puppet Forge. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
debug: BOOLEAN
|
|
Enable debug mode.
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
force: BOOLEAN
|
|
Force overwrite of existing module, if any. Implies --force.
|
||
|
|
|
ignoreDependencies: BOOLEAN
|
|
Do not attempt to install dependencies. Implied by --ignore-dependencies.
|
||
|
|
|
installOrder: INTEGER = 50
|
|
Order at which the Puppet module should be installed.
|
||
|
|
|
moduleName: STRING
|
|
Name of the module to be installed. This is not required if Module name is same as module name.
|
||
|
|
|
uninstallOrder: INTEGER = 49
|
|
Order at which the installed Puppet module should be uninstalled.
|
||
|
|
|
version: STRING
|
|
Version of the module to install from Puppet Forge.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
puppet.InstalledTarBallModule
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Puppet module installed from a tarball archive file. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
debug: BOOLEAN
|
|
Enable debug mode.
|
||
|
|
|
deployable:
CI<udm.Deployable>
|
|
The deployable that this deployed is derived from.
|
||
|
|
|
installOrder: INTEGER = 50
|
|
Order at which the Puppet module should be installed.
|
||
|
|
|
moduleName: STRING
|
|
Name of the module to be installed. This is not required if TarBallModule name is same as module name.
|
||
|
|
|
placeholders: MAP_STRING_STRING
|
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
||
|
|
|
uninstallOrder: INTEGER = 49
|
|
Order at which the installed Puppet module should be uninstalled.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
puppet.Manifest
| Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Puppet manifest file applied on the host.
| Public properties | ||
|---|---|---|
|
|
|
applyOnNoop: STRING
|
|
Apply the manifest on NOOP state. (boolean) default(false)
|
||
|
|
|
applyOrder: STRING
|
|
Order at which the puppet provisioning of the manifest should happen. (integer) default(50)
|
||
|
|
|
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
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
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.
|
||
|
|
|
textFileNamesRegexToTranscode: 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 to transcode to EBCDIC
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(properties | pp)
|
|
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
|
puppet.ManifestFolder
| Type Hierarchy | udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable |
Puppet manifest folder applied on the host.
| Public properties | ||
|---|---|---|
|
|
|
applyOnNoop: STRING
|
|
Apply the manifests on NOOP state. (boolean) default(false)
|
||
|
|
|
applyOrder: STRING
|
|
Order at which the Puppet provisioning of the manifest should happen. (integer) default(50)
|
||
|
|
|
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.
|
||
|
|
|
debug: STRING
|
|
Enable debug mode. (boolean) default(false)
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
hieraConfig: STRING
|
|
Location of the Hiera configuration file as an absolute path or as a path relative to the uploaded folder artifact. (string)
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
manifestFile: STRING
|
|
Manifest file name; for example, init.pp. (string)
|
||
|
|
|
manifestPath: STRING
|
|
Location of the manifest folder as an absolute path or as a path relative to the uploaded folder artifact. (string)
|
||
|
|
|
modulePath: STRING
|
|
Location of the module directory as an absolute path or as a path relative to the uploaded folder artifact. (string)
|
||
|
|
|
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.
|
||
|
|
|
textFileNamesRegexToTranscode: 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 to transcode to EBCDIC
|
||
|
|
|
trace: STRING
|
|
Enable trace mode. (boolean) default(false)
|
||
|
|
|
verbose: STRING
|
|
Enable verbose mode. (boolean) default(false)
|
| Hidden properties | ||
|---|---|---|
|
|
|
textFileNamesRegex: STRING = .+\.(properties | pp)
|
|
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
|
puppet.Module
| Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Deployable, udm.Taggable |
Puppet module installed from Puppet Forge. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache.
| Public properties | ||
|---|---|---|
|
|
|
debug: STRING
|
|
Enable debug mode. (boolean) default(false)
|
||
|
|
|
force: STRING
|
|
Force overwrite of existing module, if any. Implies --force. (boolean) default(false)
|
||
|
|
|
ignoreDependencies: STRING
|
|
Do not attempt to install dependencies. Implied by --ignore-dependencies. (boolean) default(false)
|
||
|
|
|
installOrder: STRING
|
|
Order at which the Puppet module should be installed. (integer) default(50)
|
||
|
|
|
moduleName: STRING
|
|
Name of the module to be installed. This is not required if Module name is same as module name. (string)
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
||
|
|
|
uninstallOrder: STRING
|
|
Order at which the installed Puppet module should be uninstalled. (integer) default(49)
|
||
|
|
|
version: STRING
|
|
Version of the module to install from Puppet Forge. (string)
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
|
The set of CI templates.
|
puppet.TarBallModule
| Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Puppet module installed from a tarball archive file. The artifact name should be same as the Puppet module name. For example, puppetlabs-apache.
| 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.
|
||
|
|
|
debug: STRING
|
|
Enable debug mode. (boolean) default(false)
|
||
|
|
|
excludeFileNamesRegex: STRING
|
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
|
excludeFileNamesRegexToTranscode: STRING
|
|
A regex of file type that needs to be ignored for transcode
|
||
|
|
|
fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
|
|
Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
|
||
|
|
|
fileUri: STRING
|
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
|
installOrder: STRING
|
|
Order at which the Puppet module should be installed. (integer) default(50)
|
||
|
|
|
isRescanned: BOOLEAN
|
|
Indicates if the artifact has been rescanned
|
||
|
|
|
moduleName: STRING
|
|
Name of the module to be installed. This is not required if TarBallModule name is same as module name. (string)
|
||
|
|
|
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.
|
||
|
|
|
textFileNamesRegexToTranscode: 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 to transcode to EBCDIC
|
||
|
|
|
uninstallOrder: STRING
|
|
Order at which the installed Puppet module should be uninstalled. (integer) default(49)
|
| 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
|