pe_xl

Profile classes used to deploy an at-scale Puppet Enterprise architecture

Project URL RSS Feed Report issues

Module Stats

7,283 downloads

4,098 latest version

4.8 quality score

Version information

released Jul 12th 2019

This version is compatible with:

Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
Puppet >=5.3.0
,

This module has been deprecated by its author since Nov 15th 2019.

The reason given was: This module has been renamed puppetlabs/peadm. Available at https://github.com/puppetlabs/puppetlabs-peadm

Tasks:

agent_install

agent_upgrade

code_manager

configure_node_groups

divert_code_manager

download

enable_replica

and 9 more. See all tasks

Plans:

pe_xl

configure

install

upgrade

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'reidmv-pe_xl', '0.1.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add reidmv-pe_xl

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install reidmv-pe_xl --version 0.1.1

Documentation

reidmv/pe_xl — version 0.1.1 Jul 12th 2019

Puppet Enterprise Extra Large

This Puppet module contains profile classes used to deploy an at-scale Puppet Enterprise architecture.

It SHOULD contain instructions for how to set that all up, too. Right now it doesn't. Big To-do.

Note pending more detailed instructions:

This deployment depends on and assumes the use of trusted facts. Specifically, pp_role and pp_environment.
This deployment assumes that at least for PE infrastructure nodes, Puppet certnames are correct, resolvable FQDNs.
This deployment assumes the control repository to manage PE is independent of the normal "customer" control-repo.

Documentation

See this README file and any documents in the documentation directory.

Architecture

architecture

Installation

These are just sketched out instructions right now. It's likely there are big gaps still.

Prepare the Control Repositories

You'll need two control repositories configured. One dedicated to managing Puppet Enterprise nodes (consider it kinda like an appliance), and another for your regular Puppet code used to manage your infrastructure.

Installing the Primary Master

Download and extract the Puppet Enterprise installer
Place the csr_attributes.yaml file from installer/primary-master in /etc/puppetlabs/puppet/csr_attributes.yaml
Place the pe.conf file from installer/primary-master in the working directory, and edit it to fill in required values
Run the installer, passing the appropriate flags to use the prepared pe.conf file
Set up the ssh private keys needed to access the configured control repositories
For each environment configured (however many you want to initially deploy), run e.g.
```
puppet code deploy production --wait
puppet code deploy pe_production --wait
```

Using the same list of environments deployed above, run e.g.

puppet apply --environment pe_production --exec '
  class { "pe_xl::node_manager":
    environments => ["production", "pe_production"],
  }
'

Perform the PuppetDB Database installation (described below)
Run puppet agent -t

Installing the PuppetDB Database

Download and extract the Puppet Enterprise installer
Place the csr_attributes.yaml file from installer/puppetdb-database in /etc/puppetlabs/puppet/csr_attributes.yaml
Place the pe.conf file from installer/puppetdb-database in the working directory, and edit it to fill in required values
Run the installer, passing the appropriate flags to use the prepared pe.conf file
Finish the Primary Master installation (described above)
Run puppet agent -t

Installing a Compile Master

curl -k https://primary-master.example.com:8140/packages/current/install.bash | sudo bash -s \
  main:certname=<certname> \
  extension_requests:pp_role="pe_xl::compile_master" \
  extension_requests:pp_environment="pe_production"

What are tasks?

Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Tasks in this module release

agent_install

Install the Puppet agent from a master

Parameters
install_flags	Positional arguments to pass to the shell installer `Array[String]`
server	The resolvable name of the Puppet server to install from `String`

agent_upgrade

Upgrade the target system using upgrade.bash from a master

Parameters
server	The resolvable name of the Puppet server to upgrade from `String`

code_manager

Perform various code manager actions

Parameters
action	Which code manager action to perform `Enum['deploy','commit','flush-environment-cache','file-sync commit']`
environment	Which environment should be deployed `Optional[String]`

Input method

environment

configure_node_groups

Configure console node groups for a new install

Parameters
compile_master_pool_address	The service name to use for the compile master pool `String`
manage_environment_groups	This will regroup the production and additional PE Environment groups `Boolean`
primary_master_host	The certname of the primary master `String`
primary_master_replica_host	The certname of the primary master replica `String`
puppetdb_database_host	The certname of the PuppetDB database `String`
puppetdb_database_replica_host	The certname of the PuppetDB database replica `String`

Input method

environment

divert_code_manager

Divert the code manager live-dir setting

download

Download a file using curl

Parameters
path	Where to save the downloaded file `String`
source	Where to download the file from `String`

enable_replica

Execute the enable replica puppet command

Parameters
primary_master_replica	The name of the replica to enable `String`
token_file	The name of the token file to use for auth `Optional[String]`

filesize

Return the size of a file in bytes

Parameters
path	Path to the file to return the size of `String`

hostname

Print the hostname of a system

mkdir_p_file

Create a file with the specified content at the specified location

Parameters
chown_r	If supplied, recursively chown starting at this path `Optional[String]`
content	The content to create the file with `String`
group	The file group `Optional[String]`
mode	The file mode `Optional[String]`
owner	The file owner `Optional[String]`
path	The fully qualified path of the file to create `String`

Input method

environment

orchestrator_healthcheck

Return when the orchestrator service is healthy, or timeout after 15 seconds

pe_install

Install Puppet Enterprise from a tarball

Parameters
peconf	The path to the pe.conf file `Optional[String]`
shortcircuit_puppetdb	If true, during install, configure PuppetDB to short-circuit its startup `Optional[Boolean]`
tarball	The path to the Puppet Enterprise tarball `String`

Input method

environment

provision_replica

Execute the replica provision puppet command

Parameters
primary_master_replica	The name of the replica to provision `String`
token_file	The name of the token-file for auth `Optional[String]`

puppet_runonce

Run the Puppet agent one time

Parameters
noop	If true, run Puppet in no-op mode `Optional[Boolean]`

rbac_token

Get and save an rbac token for the root user, admin rbac user

Parameters
password	The password for the admin user `String`

run_puppet_w_master

Run Puppet Enterprise against a identified master

Parameters
debug	Run script in debug mode to output more information `Optional[Boolean]`
puppet_master	The puppet master to run puppet against `String`

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

pe_xl

Version information

This version is compatible with:

This module has been deprecated by its author since Nov 15th 2019.

Tasks:

Plans:

Start using this module

Documentation

Puppet Enterprise Extra Large

Documentation

Architecture

Installation

Prepare the Control Repositories

Installing the Primary Master

Installing the PuppetDB Database

Installing a Compile Master

What are tasks?

Tasks in this module release

agent_install

agent_upgrade

code_manager

configure_node_groups

divert_code_manager

download

enable_replica

filesize

hostname

mkdir_p_file

orchestrator_healthcheck

pe_install

provision_replica

puppet_runonce

rbac_token

run_puppet_w_master

What are plans?

Dependencies