Skip to content

Commit de0961f

Browse files
authored
Merge pull request #150 from nwops/bolt_35
Updated docs to reflect bolt 3.5 usage
2 parents 7bd1c1e + 97dec85 commit de0961f

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The normal usage pattern for peadm is as follows.
5050
### Requirements
5151

5252
* Puppet Enterprise 2019.8.1 or newer (tested with PE 2021.0)
53-
* Bolt 2.27.0 or newer (tested with Bolt 3.0.1)
53+
* Bolt 2.27.0 or newer (tested with Bolt 3.5)
5454
* EL 7, EL 8, Ubuntu 18.04, or Ubuntu 20.04
5555
* 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.
5656

documentation/classification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This reference implementation uses four non-default node classification groups to implement the Extra Large HA architecture. Intentionally, classification of default, out-of-box node groups is not modified. This allows normal commands such as `puppet infrastructure enable replica` to behave more or less exactly as they would in Standard or Large architecture deployments.
66

7-
This image shows a fully expanded view of the PE Infrastructure node group, highlighting the new additions made to support the Extra Large archtecture.
7+
This image shows a fully expanded view of the PE Infrastructure node group, highlighting the new additions made to support the Extra Large architecture.
88

99
![PE Classification tree](images/pe-xl-classification.png)
1010

documentation/provision.md

+19
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,18 @@ Supplying a combination of host parameters which does not match one of the suppo
3535

3636
## Usage
3737

38+
### Bolt 3 usage
39+
We will name the bolt project `large_ha_peadm` in this example but the project name can be anything.
40+
41+
1. Install Bolt on a jumphost. This can be the master, 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`
43+
4. Create an inventory file with connection information. Example included below.
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+
48+
### Bolt 2 usage
49+
3850
1. Install Bolt on a jumphost. This can be the master, or any other system.
3951
2. Download or git clone the peadm module and put it somewhere on the jumphost. e.g. ~/modules/peadm.
4052
3. Download or git clone the module dependencies, and put them somewhere on the jumphost. e.g. ~/modules/stdlib, ~/modules/node\_manager, etc.
@@ -47,6 +59,7 @@ Supplying a combination of host parameters which does not match one of the suppo
4759
--modulepath ~/modules \
4860
--params @params.json
4961

62+
5063
Example inventory.yaml Bolt inventory file:
5164

5265
```yaml
@@ -102,6 +115,12 @@ The content needed is the PE installation tarball for the target version. The in
102115

103116
Installation content can be downloaded from [https://puppet.com/try-puppet/puppet-enterprise/download/](https://puppet.com/try-puppet/puppet-enterprise/download/).
104117

118+
If you wish to prevent the bolt host from transferring the installer tarball to the targets you can place the installer tar files on the target hosts in the staging directory. This can save time over slow networks, but is best to just perform the bolt task on the target node (puppetserver). The tar file will need to exist in the staging directory for the following configuration:
119+
120+
* /tmp on the Bolt host
121+
* /tmp on the primary
122+
* /tmp on the primary PuppetDB PostgreSQL (if used)
123+
* /tmp on the replica PuppetDB PostgreSQL (if used)
105124
## Online usage
106125

107126
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.

0 commit comments

Comments
 (0)