You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,23 +33,23 @@ As a services-led tool, Puppet Enterprise customers who are advised to start usi
33
33
The normal usage pattern for peadm is as follows.
34
34
35
35
1. Users set up a Bolt host from which they can run peadm plans. The Bolt host can be any machine that has ssh access to all of the PE nodes.
36
-
2. Users run the `peadm::provision` plan to bootstrap a new PE cluster. Depending on the architecture chosen, peadm may create some node groups in the classifier to set parameters on the built-in `puppet_enterprise` module, tuning it for large or extra large architectures.
36
+
2. Users run the `peadm::install` plan to bootstrap a new PE cluster. Depending on the architecture chosen, peadm may create some node groups in the classifier to set parameters on the built-in `puppet_enterprise` module, tuning it for large or extra large architectures.
37
37
3. Users use and operate their PE cluster as normal. The peadm module is not used again until the next upgrade.
38
38
4. When it is time to upgrade, users run the `peadm::upgrade` plan from their Bolt host to accelerate and aid in the upgrade process.
39
39
40
40
### What peadm affects
41
41
42
-
* The `peadm::provision` plan adds a number of custom OID trusted facts to the certificates of PE infrastructure nodes as it deploys them. These trusted facts are later used by the plans to quickly and correctly identify nodes in particular roles.
42
+
* The `peadm::install` plan adds a number of custom OID trusted facts to the certificates of PE infrastructure nodes as it deploys them. These trusted facts are later used by the plans to quickly and correctly identify nodes in particular roles.
43
43
* Up to four node groups may be created to help configure `puppet_enterprise` class parameters for PE infrastructure roles. The most notable configuration is the designation of compilers as being either "A" or "B" nodes for availability.
44
44
45
45
### What peadm does not affect
46
46
47
47
* The peadm module is not required to exist or be present outside of the point(s) in time it is used to create a new PE cluster, or upgrade an existing cluster. No new Puppet classes or other persistent content not provided out-of-box by PE itself is applied to PE infrastructure nodes by the peadm module.
48
-
* Having used the peadm module to provision or to upgrade a PE cluster is not known to affect or curtail the ability to use any normal, documented PE procedures, e.g. failover to a replica, or manual upgrade of a cluster.
48
+
* Having used the peadm module to install or to upgrade a PE cluster is not known to affect or curtail the ability to use any normal, documented PE procedures, e.g. failover to a replica, or manual upgrade of a cluster.
49
49
50
50
### Requirements
51
51
52
-
* Puppet Enterprise 2019.8.1 or newer (tested with PE 2021.0)
52
+
* Puppet Enterprise 2019.8.1 or newer (tested with PE 2021.2)
53
53
* Bolt 3.10.0 or newer (tested with Bolt 3.10.0)
54
54
* EL 7, EL 8, Ubuntu 18.04, or Ubuntu 20.04
55
55
* Classifier Data enabled. This PE feature is enabled by default on new installs, but can be disabled by users if they remove the relevant configuration from their global hiera.yaml file. See the [PE docs](https://puppet.com/docs/pe/latest/config_console.html#task-5039) for more information.
@@ -58,7 +58,7 @@ The normal usage pattern for peadm is as follows.
58
58
59
59
Follow the links below to usage instructions for each peadm plan.
Copy file name to clipboardExpand all lines: documentation/install.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# Provision Puppet Enterprise using the peadm module
1
+
# Install Puppet Enterprise using the peadm module
2
2
3
-
The peadm module can be used to provision new Puppet Enterprise infrastructure. Supported architectures include Standard, Large, and Extra Large.
3
+
The peadm module can be used to install Puppet Enterprise on new infrastructure. Supported architectures include Standard, Large, and Extra Large.
4
4
5
-
The peadm provisioning plan creates base reference implementation. Once a base stack is stood up, you may need to continue and perform additional configuration and adjustments to reach your target state, depending on your use case.
5
+
The peadm install plan creates a base install. Once a base cluster is installed, you may need to continue and perform additional configuration and adjustments to reach your target state, depending on your use case.
6
6
7
7
## Reference Architectures
8
8
9
-
When provisioning a new PE stack using peadm, there are several different host parameters which can be specified. At a minimum, you must always specify the primary parameter. Depending on which architecture you are deploying, other host parameters may be needed as well. The following is a list of the architectures peadm can provision and the required parameters.
9
+
When installing a new PE cluster using peadm, there are several different host parameters which can be specified. At a minimum, you must always specify the primary parameter. Depending on which architecture you are deploying, other host parameters may be needed as well. The following is a list of the architectures peadm can install and the required parameters.
10
10
11
11
* Standard
12
12
- primary
@@ -36,28 +36,28 @@ Supplying a combination of host parameters which does not match one of the suppo
36
36
## Usage
37
37
38
38
### Bolt 3 usage
39
-
We will name the bolt project `large_ha_peadm` in this example but the project name can be anything.
39
+
We will name the bolt project `large_ha_peadm` in this example but the project name can be anything.
40
40
41
41
1. Install Bolt on a jumphost. This can be the primary, or any other system. (via package)
42
-
2. Run `mkdir large_ha_peadm && cd large_ha_peadm && bolt project init large_ha_peadm --modules puppetlabs-peadm`
42
+
2. Run `mkdir large_ha_peadm && cd large_ha_peadm && bolt project init large_ha_peadm --modules puppetlabs-peadm`
43
43
4. Create an inventory file with connection information. Example included below.
44
44
5. Create a parameters file. Example included below.
45
-
6. Run `bolt plan run peadm::provision --params @params.json ` after the inventory and params files are created.
46
-
47
-
45
+
6. Run `bolt plan run peadm::install --params @params.json ` after the inventory and params files are created.
46
+
47
+
48
48
### Bolt 2 usage
49
49
50
50
1. Install Bolt on a jumphost. This can be the primary, or any other system.
51
51
2. Download or git clone the peadm module and put it somewhere on the jumphost. e.g. ~/modules/peadm.
52
52
3. Download or git clone the module dependencies, and put them somewhere on the jumphost. e.g. ~/modules/stdlib, ~/modules/node\_manager, etc.
53
53
4. Create an inventory file with connection information. Example included below.
54
54
5. Create a parameters file. Example included below.
55
-
6. Run the peadm::provision plan with the inputs created. Example:
55
+
6. Run the peadm::install plan with the inputs created. Example:
56
56
57
-
bolt plan run peadm::provision \
57
+
bolt plan run peadm::install \
58
58
--inventory inventory.yaml \
59
59
--modulepath ~/modules \
60
-
--params @params.json
60
+
--params @params.json
61
61
62
62
63
63
Example inventory.yaml Bolt inventory file:
@@ -103,13 +103,13 @@ Example params.json Bolt parameters file (shown: Extra Large with DR):
103
103
}
104
104
```
105
105
106
-
Review the [peadm::provision plan](../plans/provision.pp) to learn about more advanced provisioning options. It is possible to supply an ssh private key and git clone URL for a control-repo as part of provisioning, for example.
106
+
Review the [peadm::install plan](../plans/install.pp) to learn about more advanced installation options. It is possible to supply an ssh private key and git clone URL for a control-repo as part of installation, for example.
107
107
108
108
## Offline usage
109
109
110
-
The peadm::provision plan downloads installation content from an online repository by default. To perform an offline installation, you can prefetch the needed content and place it in the staging directory. If content is available in the staging directory, peadm::provision will not try to download it.
110
+
The peadm::install plan downloads installation content from an online repository by default. To perform an offline installation, you can prefetch the needed content and place it in the staging directory. If content is available in the staging directory, peadm::install will not try to download it.
111
111
112
-
The default staging directory is `/tmp`. If a different staging dir is being used, it can be specified using the `stagingdir` parameter to the peadm::provision plan.
112
+
The default staging directory is `/tmp`. If a different staging dir is being used, it can be specified using the `stagingdir` parameter to the peadm::install plan.
113
113
114
114
The content needed is the PE installation tarball for the target version. The installation content should be in the staging dir, and should have its original name. E.g. `/tmp/puppet-enterprise-2019.2.2-el-7-x86_64.tar.gz`.
115
115
@@ -123,11 +123,11 @@ If you wish to prevent the bolt host from transferring the installer tarball to
123
123
* /tmp on the replica PuppetDB PostgreSQL (if used)
124
124
## Online usage
125
125
126
-
The peadm::provision plan can be configured to download installation content directly to hosts. To configure online installation, set the `download_mode` parameter of the `peadm::provision` plan to `direct`. The direct mode is often more efficient when PE hosts have a route to the internet.
126
+
The peadm::install plan can be configured to download installation content directly to hosts. To configure online installation, set the `download_mode` parameter of the `peadm::install` plan to `direct`. The direct mode is often more efficient when PE hosts have a route to the internet.
127
127
128
128
## Hostnames and Certificate Names
129
129
130
-
The various host parameters given to the peadm::provision or peadm::action::install plans will be set as Puppet certificate names. You must use the names here that you want the servers to be identified as by Puppet.
130
+
The various host parameters given to the peadm::install or peadm::action::install plans will be set as Puppet certificate names. You must use the names here that you want the servers to be identified as by Puppet.
131
131
132
132
While it is not required that target names match hostnames, it _is_ required that target names be resolvable.
133
133
@@ -158,7 +158,7 @@ A parameters JSON file can then reference the target names, which will become th
158
158
159
159
## Implementation Reference
160
160
161
-
Provisioning can be broken down into two actions: [install](../plans/action/install.pp), and [configure](../plans/action/configure.pp). Installation currently requires ssh access to the un-provisioned nodes, but configure can be performed using the Orchestrator transport if installation has already been completed.
161
+
Provisioning can be broken down into two actions: [install](../plans/action/install.pp), and [configure](../plans/action/configure.pp). Installation currently requires ssh access to the un-installed nodes, but configure can be performed using the Orchestrator transport if installation has already been completed.
162
162
163
163
Besides getting Puppet Enterprise installed, the key configuration supporting Large and Extra Large architectures is laid out in four classification groups. Links are provided below to a Markdown document that describes the groups, and also to the Puppet manifest that actually configures them:
0 commit comments