Skip to content

Commit df0506f

Browse files
committed
(SLV-366) Add docs for Large deployment
This commit adds a document for using the pe_xl module to deploy a "PE Large Architecture". An architecture diagram for the supported deployment is included for clarity. Currently, deploying the HA version of the Large Architecture is not supported by the tooling.
1 parent 8f608ea commit df0506f

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed
Loading

documentation/large_deploy.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# PE Large Architecture
2+
3+
4+
## Overview
5+
6+
This module can also be used to deploy a Puppet Enterprise Large Architecture.
7+
Such an deployment differs from an Extra Large Architecture in that it does
8+
**not** include an external database. PuppetDB is served from the master.
9+
10+
**NOTE:** Currently, the module does not deploy a Large Architecture with HA.
11+
The currently supported deployment architecture is shown below.
12+
13+
![Large Architecture without HA](images/PE_Large_Architecture_no_HA.png)
14+
15+
16+
## Instructions
17+
18+
The process for deploying a PE Large Architecture is very similar to the
19+
[basic_usage](basic_usage.md) for deploying the XL Architecture. These two
20+
differ only in the parameters supplied to the bolt plans. Specifically, the
21+
`puppetdb_database_host`, `master_replica_host`, and
22+
`puppetdb_database_replica_host` parameters need to be omitted in order to
23+
deploy a PE Large Architecture.
24+
25+
Ensuring that the parameters above are omitted from the `params.json` file,
26+
the [basic usage instructions](basic_usage.md#basic-usage-instructions) can be
27+
used to run the `pe_xl` plan in order to install and configure the deployment.
28+
29+
Example nodes.yaml Bolt inventory file:
30+
31+
```yaml
32+
---
33+
groups:
34+
- name: pe_xl_nodes
35+
config:
36+
transport: ssh
37+
ssh:
38+
host-key-check: false
39+
user: centos
40+
run-as: root
41+
tty: true
42+
nodes:
43+
- pe-xl-core-0.lab1.puppet.vm
44+
- pe-xl-compiler-0.lab1.puppet.vm
45+
- pe-xl-compiler-1.lab1.puppet.vm
46+
```
47+
48+
Example params.json Bolt parameters file:
49+
50+
```json
51+
{
52+
"install": true,
53+
"configure": true,
54+
"upgrade": false,
55+
56+
"master_host": "pe-xl-core-0.lab1.puppet.vm",
57+
"compiler_hosts": [
58+
"pe-xl-compiler-0.lab1.puppet.vm",
59+
"pe-xl-compiler-1.lab1.puppet.vm"
60+
],
61+
62+
"console_password": "puppetlabs",
63+
"dns_alt_names": [ "puppet", "puppet.lab1.puppet.vm" ],
64+
"compiler_pool_address": "puppet.lab1.puppet.vm",
65+
"version": "2018.1.4"
66+
}
67+
```

0 commit comments

Comments
 (0)