Install Continuous Delivery for PE from the PE console

Sections

This installation method is intended for users who are trying out the software, and is not recommended for production installations. Users of supported PE versions (2019.x and 2018.1.8+) who are running Enterprise Linux 7 on their Puppet master can install Continuous Delivery for PE directly from the PE console.

Before you begin

Review the system requirements and ensure you have:

  • A designated node where you'll install Continuous Delivery for PE. This node must be running Enterprise Linux 7, and must have Puppet installed.
    Important: To install Continuous Delivery for PE from the PE console, you must be running Enterprise Linux 7 in one of the following distributions on your Puppet master.
    • CentOS
    • Oracle Linux
    • Red Hat Enterprise Linux
    • Scientific Linux
    For all other operating systems and versions, see Install Continuous Delivery for PE using the cd4pe module.
  • The PE user permission to run tasks on this node.

CAUTION: Code Manager webhooks are not compatible with Continuous Delivery for PE. If your organization currently uses Code Manager webhooks to deploy code, you must dismantle these webhooks before installing Continuous Delivery for PE.

Install Continuous Delivery for PE from the PE 2019.x console

Users of the PE 2019.x series can install Continuous Delivery for PE directly from the PE console with just a few clicks.

  1. In the PE console, click Integrations.
  2. In the Continuous Delivery for PE host field, enter the name of the node where you wish to install Continuous Delivery for PE.
    Note: This node must be running Enterprise Linux 7, and must have Puppet installed.
  3. In the Administrator email field, enter the email address for the Continuous Delivery for PE administrator, also known as the root user. This email address is used as your username when signing in to Continuous Delivery for PE as the root user.
  4. In the Administrator password field, enter a strong password for the Continuous Delivery for PE administrator account.
  5. Follow the instructions for your preferred installation type:
    1. To perform a default installation of Continuous Delivery for PE, click Install.
    2. To customize your installation, click Advanced options and see Advanced configuration options. Once you've set all applicable parameters, click Run job to install Continuous Delivery for PE.
    Important: In order to use the default installation, your Puppet certificate name must be a resolvable DNS hostname. If that is not the case, you must set the resolvable_hostname parameter to a resolvable address where the Continuous Delivery for PE server is reachable. You can use the ${trusted[certname]} fact to set this parameter.
  6. When the installation job is complete, navigate to the URL printed on the task page. Click Trial Mode to start a free seven-day trial. Once this period is complete, you'll be prompted to generate and upload a license. See Generate a license for instructions on creating a free 30-day trial license.
What to do next:
Now that Continuous Delivery for PE is installed, create your individual user account and then move on to these next steps:
  1. Install the puppetlabs-cd4pe module to automate upgrades of Continuous Delivery for PE.
  2. Follow our Getting started with Continuous Delivery for PE guide beginning with Step 2 to configure your new software, add integrations, and learn about core workflows and capabilities.

Install Continuous Delivery for PE from the PE 2018.1.8+ console

If you're running PE version 2018.1.8 or a newer version in the 2018.1 series, install Continuous Delivery for PE by running a pre-populated task in the PE console.

  1. In the PE console, click Integrations.
  2. In the Continuous Delivery for Puppet Enterprise area, click Install. The Run a task page opens with the pe_installer_cd4pe::install task pre-populated.
  3. In the Value field for the required cd4pe_admin_email parameter, enter the email address for the Continuous Delivery for PE administrator, also known as the root user. This email address is used as your username when signing in to Continuous Delivery for PE as the root user.
  4. In the Value field for the required cd4pe_admin_password parameter, enter a strong password for the Continuous Delivery for PE administrator account.
  5. Optional: Customize your Continuous Delivery for PE installation by setting any of the parameters listed in Advanced configuration options. If none of these parameters are set, your installation proceeds with the default settings.
    Important: In order to use the default installation, your Puppet certificate name must be a resolvable DNS hostname. If that is not the case, you must set the resolvable_hostname parameter to a resolvable address where the Continuous Delivery for PE server is reachable. You can use the ${trusted[certname]} fact to set this parameter.
  6. In the Select targets area, specify the node on which you want to install Continuous Delivery for PE.
    Note: This node must be running Enterprise Linux 7, and must have Puppet installed.
  7. Click Run Job.
  8. When the job is complete, navigate to the URL printed on the task page. Click Trial Mode to start a free seven-day trial. Once this period is complete, you'll be prompted to generate and upload a license. See Generate a license for instructions on creating a free 30-day trial license.
What to do next:
Now that Continuous Delivery for PE is installed, create your individual user account and then move on to these next steps:
  1. Install the puppetlabs-cd4pe module to automate upgrades of Continuous Delivery for PE.
  2. Follow our Getting started with Continuous Delivery for PE guide beginning with Step 2 to configure your new software, add integrations, and learn about core workflows and capabilities.

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
Important: Support for MySQL and Amazon DynamoDB external databases is deprecated and will be removed in a future release.
By default, the puppetlabs-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.
How helpful was this page?

If you leave us your email, we may contact you regarding your feedback. For more information on how Puppet uses your personal information, see our privacy policy.

Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.