Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with steps to install the module #416

Merged
merged 3 commits into from
Dec 22, 2023
Merged

Update README.md with steps to install the module #416

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57712af
Update README.md
J-Hunniford Dec 14, 2023
e00fce3
Edit "overview" steps
J-Hunniford Dec 15, 2023
0ecee11
Remove install plan info
J-Hunniford Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 25 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,31 @@ PEADM is a supported PE module. If you are a PE customer with the standard or pr

## Overview

This is the standard workflow for installing and using PEADM.

1. To enable the execution of PEADM plans, install Bolt on a jump host with SSH access to all nodes in your installation.
2. On the Bolt host, run the `peadm::install` plan to bootstrap a new PE installation. For large or extra-large architectures, PEADM creates node groups in the classifier to set relevant parameters in the `puppet_enterprise` module.
3. Use PE as normal. PEADM is not required until your next upgrade.
4. When you are ready to upgrade PE, run the `peadm::upgrade` plan from the Bolt host.
This is the standard workflow for installing PEADM.

1. [Install Bolt](https://www.puppet.com/docs/bolt/latest/bolt_installing) on a jump host.
2. To create a Bolt project that includes the PEADM module, run:</br>`mkdir <YOUR_PROJECT> && cd <YOUR_PROJECT> && bolt project init <YOUR_PROJECT> --modules puppetlabs-peadm`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strictly speaking, the br tag should be spelled like this: <br/> but this also works.

3. In the Bolt project directory, update the `inventory.yaml` file with connection information for the servers you plan to use for hosting PE infrastructure. For example:
```yaml
---
groups:
- name: puppet-enterprise-nodes
config:
transport: ssh
ssh:
host-key-check: false
user: centos
run-as: root
targets:
- pe-xl-core-0.lab1.puppet.vm
- pe-xl-core-1.lab1.puppet.vm
- pe-xl-core-2.lab1.puppet.vm
- pe-xl-core-3.lab1.puppet.vm
- name: pe-xl-compiler-0.lab1.puppet.vm
uri: 10.234.6.45
- name: pe-xl-compiler-1.lab1.puppet.vm
uri: 10.234.14.131
```

### What PEADM affects

Expand Down
Loading