Chef Plugin Manual 25.1.x
The XL Deploy Chef plugin uses the Chef provisioning tool (chef-solo) to install recipes on hosts.
This document provides information that is specific to this version of the Chef plugin. For general information about the plugin, refer to Introduction to the XL Deploy Chef plugin.
Requirements
- XL Deploy 5.1.0 or later
- Chef 10.1 (Unix or Windows)
chef-solomust be configured on the target machine
Limitations
The plugin only supports deployment using chef-solo.
CI Reference
Configuration Item Overview
Deployables
| CI | Description |
|---|---|
| chef.CookbookSpec | Chef cookbook file applied on the host, in tar.gz format. |
Deployeds
| CI | Description |
|---|---|
| chef.Cookbook | Chef cookbook file applied on the host, in tar.gz format. |
Containers
| CI | Description |
|---|---|
| chef.Solo | Abstract base Container which can be extended |
Configuration Item Details
chef.Cookbook
| Type Hierarchy | udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Chef cookbook file applied on the host, in tar.gz format.
| Parent | ||
|---|---|---|
|
|
|
container:
CI<udm.Container>
|
|
The container on which this deployed runs.
|
| Public properties | ||
|---|---|---|
|
|
|
recipe: STRING
|
|
Comma-seperated list of recipes to be applied from cookbook. For example, test-cookbook::recipe-one, test-cookbook::recipe-two, where 'recipe-one' and 'recipe-two' are the names of recipes in test-cookbook.tar.gz.
|
||
|
|
|
applyOnNoop: BOOLEAN
|
|
Run recipe on NOOP state.
|
||
|
|
|
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>
|
||
|
|
|
runOrder: INTEGER = 50
|
|
Order at which the Chef recipe should be run.
|
| Hidden properties | ||
|---|---|---|
|
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
|
The set of created CIs.
|
chef.CookbookSpec
| Type Hierarchy | udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Chef cookbook file applied on the host, in tar.gz format.
| Public properties | ||
|---|---|---|
|
|
|
applyOnNoop: STRING
|
|
Run recipe on NOOP state. (boolean) default(false)
|
||
|
|
|
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
|
||
|
|
|
recipe: STRING
|
|
Comma-seperated list of recipes to be applied from cookbook. For example, test-cookbook::recipe-one, test-cookbook::recipe-two, where 'recipe-one' and 'recipe-two' are the names of recipes in test-cookbook.tar.gz. (string)
|
||
|
|
|
runOrder: STRING
|
|
Order at which the Chef recipe should be run. (integer) default(50)
|
||
|
|
|
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 = .+\.(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
|
chef.Solo
| Type Hierarchy | udm.BaseContainer >> udm.BaseConfigurationItem |
|---|---|
| Interfaces | udm.Container, udm.Taggable |
Abstract base Container which can be extended
| Parent | ||
|---|---|---|
|
|
|
host:
CI<overthere.Host>
|
|
Host
|
| Public properties | ||
|---|---|---|
|
|
|
chefPath: STRING = /usr/local/bin
|
|
Chef binary directory path.
|
||
|
|
|
tags: SET_OF_STRING
|
|
If set, only deployables with the same tag will be automatically mapped to this container.
|
||
|
|
|
tarCommand: STRING
|
|
Command used to open a .tar.gz file. If not specified the tar.exe from chefPath will be used. Microsoft Windows only.
|