Install Continuous Delivery for PE
Use version 1.1.0 or later of the puppetlabs-cd4pe
module to install
and configure Continuous Delivery for Puppet Enterprise (PE). This module installs Docker, configures the Continuous Delivery for PE
Docker image and service for you, and creates a Docker volume for disk storage.
Install Continuous Delivery for PE with the cd4pe
module
Use the puppetlabs-cd4pe
module version 1.1.0 or
later to install Continuous Delivery for PE.
puppetlabs-cd4pe
module must be used with seven
dependent modules, plus a module to manage job hardware. The modules and their
required versions are as follows:Module | Required version |
---|---|
puppetlabs-cd4pe
|
1.1.0 or later in the 1.x or 2.x series The Nodes page requires version 2.0.1 or later |
puppetlabs-stdlib
|
4.19.0 or later |
puppetlabs-puppet_authorization
|
0.5.0 or later |
puppetlabs-hocon
|
0.9.3 or later |
puppetlabs-concat
|
2.1.0 or later |
puppetlabs-docker
|
3.3.0 or later |
puppetlabs-apt
|
4.4.1 or later |
puppetlabs-translate
|
1.1.0 or later |
puppetlabs-cd4pe_jobs
Note: This module manages job hardware running
a Puppet agent.
Install this module with Continuous Delivery for PE version 3.4.0 or
newer.
|
1.0.0 or later |
puppetlabs-pipelines
Note: This module manages job hardware running
the deprecated Continuous Delivery agent. Install
this module only if you are installing Continuous Delivery for PE version 3.3.0 or
older.
|
1.0.1 |
Configure Continuous Delivery for PE with a task
Once you've completed the installation of Continuous Delivery for PE using the
cd4pe
module, run a task to
configure the software.
Advanced configuration options
Customize your Continuous Delivery for PE installation from the PE console by setting any of the following parameters on the
cd4pe
class. If none of these parameters are set, your
installation proceeds with the default settings.
Parameters to configure the Docker image and version | |
---|---|
The following two parameters are concatenated by the
puppetlabs-cd4pe module as follows: image
=> "${cd4pe_image}:${cd4pe_version}",
|
|
cd4pe_image | Set this parameter if you use an internal Docker registry for mirroring containers. Use this parameter to set the image name; use cd4pe_version to set a tag. |
cd4pe_version | Use this parameter to specify a particular version of the Continuous Delivery for PE
Docker container. Specify 3.x to use the 3.x series. |
Parameters to configure the database | |
---|---|
⛔ DEPRECATED: Support for MySQL and Amazon DynamoDB external databases is deprecated and will be removed in a future release. By default, thepuppetlabs-cd4pe module (version 1.3.0 and newer) creates a new
installation of PE-PostgreSQL on the node where you installed Continuous Delivery for PE. If you prefer to use Amazon DynamoDB or MySQL, set the parameters in this
section.
CAUTION: Changing any of these parameters post-install creates a
new database and destroys all data kept in the previous database.
|
|
manage_database | Set this parameter to false to use an external DynamoDB or
MySQL server. Set this parameter to true to use Continuous Delivery for PE-managed PostgreSQL or MySQL. |
db_provider | Enter mysql if you're using MySQL. Do not set this parameter if using DynamoDB. |
db_host | Enter the address of the database. (Required for external MySQL and DynamoDB.) |
db_name | Enter the name of the database. (Required for external MySQL and DynamoDB.) |
db_pass | Enter the password for the database. (Required for external MySQL and DynamoDB.)
CAUTION: To set your password successfully, you must set the
root_password parameter to
Sensitive in Hiera. For instructions, see Setting sensitive parameters in
Hiera. |
db_port | Optional. Enter the port the database listens on. |
db_prefix |
Optional. If you'd like your database tables to share a prefix, such as cdpe- , enter it here. |
Parameters to configure the port mappings | |
---|---|
agent_service_port | Defaults to 7000. |
backend_service_port | Defaults to 8000. |
web_ui_port | Defaults to 8080. |
Other optional parameters | |
---|---|
cd4pe_docker_extra_params | To pass any additional arguments to the Docker
process running the Continuous Delivery for PE container, specify them as an
array. For example: ["--add-host
gitlab.puppetdebug.vlan:10.32.47.33","-v
/etc/puppetlabs/cd4pe/config:/config","--env-file
/etc/puppetlabs/cd4pe/env-extra","-e CD4PE_LDAP_GROUP_SEARCH_SIZE_LIMIT=250",
]
|
analytics | To opt out of analytics data collection, set this parameter to false. To learn about what data we collect, see Analytics data collection. |