.fixtures.yml

@@ -0,0 +1,12 @@
+---
+fixtures:
+  repositories:
+    facts: 'https://github.com/puppetlabs/puppetlabs-facts.git'
+    puppet_agent: 'https://github.com/puppetlabs/puppetlabs-puppet_agent.git'
+    provision: 'https://github.com/puppetlabs/provision.git'
+    stdlib: 'https://github.com/puppetlabs/puppetlabs-stdlib.git'
+    node_manager: 'https://github.com/WhatsARanjit/puppet-node_manager'
+    apply_helpers: 'https://github.com/puppetlabs/puppetlabs-apply_helpers'
+    bolt_shim: 'https://github.com/puppetlabs/puppetlabs-bolt_shim'
+  symlinks:
+    "peadm": "#{source_dir}"

.gitignore

@@ -25,3 +25,4 @@
 .project
 .envrc
 /inventory.yaml
+.rerun.json

.sync.yml

@@ -2,3 +2,6 @@
 Rakefile:
   extras:
     - 'PuppetSyntax.exclude_paths = ["plans/**/*.pp", "vendor/**/*"]'
+.gitignore:
+  paths:
+    - '.rerun.json'

README.md

@@ -1,16 +1,25 @@
 # Puppet Enterprise (pe) Administration (adm) Module
 
-This Puppet module contains Puppet Task Plans used to deploy and manage at-scale Puppet Enterprise architecture.
+This Puppet module contains Bolt plans used to deploy and manage Puppet Enterprise infrastructure. Plans are provided to automate common lifecycle activities, in order to increase velocity and reduce the possibility of human error incurred by manually performing these activities.
 
-Use this module to deploy Puppet Enterprise 2019.x Standard, Large, and Extra Large architecture.
+The peadm module is able to deploy and manage Puppet Enterprise 2019.x Standard, Large, and Extra Large architectures.
 
-* This deployment depends on and assumes the use of trusted facts. Specifically, `pp_application` and `pp_cluster`.
-* This deployment assumes that at least for PE infrastructure nodes, Puppet certnames are correct, resolvable FQDNs.
+## Expectations
+
+The peadm module is intended to be used only by Puppet Enterprise customers actively working with and being guided by Puppet Customer Success teams—specifically, the Support team and the Solutions Architecture team. Independent use is not recommended for production environments.
 
 ## Documentation
 
 See this README file and any documents in the [documentation](documentation) directory.
 
-## Architecture
+Plans:
+
+* [Provision](documentation/provision.md)
+* [Upgrade](documentation/upgrade.md)
+* [Convert](documentation/convert.md)
+
+Reference:
 
-![architecture](documentation/images/architecture.png)
+* [Classification](documentation/classification.md)
+* [Architectures](documentation/architectures.md)
+* [Testing](documentation/pre_post_checks.md)

documentation/architectures.md

@@ -0,0 +1,15 @@
+# Architectures
+
+The peadm module supports Puppet Enterprise 2019.x Standard, Large, and Extra Large architectures.
+
+## Standard
+
+Todo: diagram
+
+## Large
+
+Todo: diagram
+
+## Extra Large
+
+![architecture](images/architecture.png)

documentation/convert.md

@@ -0,0 +1,26 @@
+# Convert infrastructure for use with the peadm module
+
+The peadm::convert plan can be used to adopt manually deployed infrastructure for use with peadm, or to adopt infrastructure deployed with a version of peadm older than 1.0.0.
+
+## Convert an Existing Deployment
+
+Prepare to run the plan against all servers in the PE infrastructure, using a params.json file such as this one:
+
+```json
+{
+  "master_host": "pe-xl-core-0.lab1.puppet.vm",
+  "master_replica_host": "pe-xl-core-1.lab1.puppet.vm",
+  "compiler_hosts": [
+    "pe-xl-compiler-0.lab1.puppet.vm",
+    "pe-xl-compiler-1.lab1.puppet.vm"
+  ],
+
+  "compiler_pool_address": "puppet.lab1.puppet.vm",
+}
+```
+
+See the [provision](provision.md#reference-architectures) documentation for a list of supported architectures. Note that for convert, *all infrastructure being converted must already be functional*; you cannot use convert to add new systems to the infrastructure, nor can you use it to change your architecture.
+
+```
+bolt plan run peadm::convert --params @params.json 
+```