Skip to content

Commit be81fd7

Browse files
committed
Update docs for provision plan
1 parent 57f21ae commit be81fd7

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

documentation/basic_usage.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,28 @@
22

33
This is a 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.
44

5-
The reference implementation currently includes Task Plans to install, configure, and later upgrade a new Extra Large HA stack.
5+
The reference implementation currently includes Task Plans to provision new stacks, and to upgrade stacks previously provisioned using this module.
66

77
The current versions of those plans can be found at:
88

9-
* [install.pp](https://github.com/reidmv/reidmv-pe_xl/blob/master/plans/install.pp)
10-
* [configure.pp](https://github.com/reidmv/reidmv-pe_xl/blob/master/plans/configure.pp)
11-
* [upgrade.pp](https://github.com/reidmv/reidmv-pe_xl/blob/master/plans/upgrade.pp)
9+
* [provision.pp](../plans/provision.pp)
10+
* [upgrade.pp](../plans/upgrade.pp)
1211

13-
These are still a work in progress and lack documentation. Reading through them can give you an idea of what steps we've found to be required to deploy and configure all of the Puppet Enterprise components.
12+
Provisioning can be broken down into two actions: [install](../plans/unit/install.pp), and [configure](../plans/unit/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.
1413

15-
Besides getting everything installed the key configuration that makes this work is laid out in four classification groups. Links provided below to a Markdown document that describes the groups, and also to the Puppet manifest that actually configures them:
14+
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:
1615

17-
* [classification.md](https://github.com/reidmv/reidmv-pe_xl/blob/master/docs/classification.md)
18-
* [pe\_xl::node\_manager class](https://github.com/reidmv/reidmv-pe_xl/blob/master/manifests/node_manager.pp)
16+
* [classification.md](classification.md)
17+
* [pe\_xl::node\_manager class](../manifests/node_manager.pp)
1918

2019
The reference implementation uses trusted facts to put nodes in the right groups. Because the important puppet\_enterprise::\* class parameters and data are specified in the console, it should also be safe to have a pe.conf present on both the master, and the master replica nodes.
2120

2221
## Basic usage instructions
2322

24-
1. Ensure the hostname of each system is set correctly, to the same value that will be used to connect to the system, and refer to the system as. If the hostname is not set as expected the installation plan will refuse to continue.
25-
2. Install Bolt on a jumphost. This can be the master, or any other system.
26-
3. Download or git clone the pe\_xl module and put it somewhere on the jumphost, e.g. ~/modules/pe\_xl.
23+
1. Install Bolt on a jumphost. This can be the master, or any other system.
24+
2. Download or git clone the pe\_xl module and put it somewhere on the jumphost. e.g. ~/modules/pe\_xl.
25+
2. Download or git clone the module dependencies, and put them somewhere on the jumphost. e.g. ~/modules/stdlib, ~/modules/node\_manager, etc.
26+
2. Ensure the hostname of each system is set correctly, to the same value that will be used to connect to the system, and refer to the system as. If the hostname is not set as expected the installation plan will refuse to continue.
2727
4. Create an inventory file with connection information. Example included below. Available Bolt configuration options are documented here.
2828
5. Create a parameters file. Example included below. Note at the top of the file are arguments which dictate which plans should be run, such as install+configure.
2929
6. Run the pe\_xl plan with the inputs created. Example:

0 commit comments

Comments
 (0)