diff --git a/src/docs.html b/src/docs.html index 5d21c77..73276be 100644 --- a/src/docs.html +++ b/src/docs.html @@ -60,6 +60,7 @@
Mental model + How harvesting works Single-site vs multi-site Remote harvesting JinjaTurtle templates @@ -123,6 +124,40 @@
+
+

How harvesting works

+

At a high level, this is what happens when enroll harvest runs on a host:

+ + +
+

Other things to be aware of:

+ + +
+
Does Enroll use Ansible community/galaxy roles?
+
No, Enroll doesn't have any knowledge of Ansible Galaxy roles or community plugins. It generates all the roles itself. If you really want to use roles from the community, Enroll may not be the tool for you, other than perhaps to help get you started.
+
+
Keep in mind that a lot of software config files are also good candidates for being Jinja templates with abstracted vars for separate hosts.
+
+
Enroll does use my companion tool JinjaTurtle if it's installed, but JinjaTurtle only recognises certain types of files (.ini style, .json, .xml, .yaml, .toml, but not special ones like Nginx or Apache conf files which have their own special syntax). When Enroll can't turn a config file into a template, it copies the raw file instead and uses it with ansible.builtin.copy in role tasks.
+
+
+

Single-site vs multi-site

Manifest output has two styles. Choose based on how you'll use the result.

@@ -164,7 +199,13 @@

Run Enroll on your workstation, harvest a remote host over SSH. The harvest is pulled locally.

$ enroll harvest --remote-host myhost.example.com --remote-user myuser --out /tmp/enroll-harvest
-$ enroll single-shot --remote-host myhost.example.com --remote-user myuser --out /tmp/enroll-ansible --fqdn myhost.example.com
+$ enroll manifest --harvest /tmp/enroll-harvest --out /tmp/enroll-manifest + +# Alternatively, run both commands combined together with the 'single-shot' mode: + +$ enroll single-shot --remote-host myhost.example.com --remote-user myuser \ + --harvest /tmp/enroll-harvest --out /tmp/enroll-ansible \ + --fqdn myhost.example.com
Tip
diff --git a/src/index.html b/src/index.html index d5323b3..7bb41fd 100644 --- a/src/index.html +++ b/src/index.html @@ -276,8 +276,7 @@ enroll diff \
Harvest
Collect state into a bundle.
-
-
+
@@ -296,7 +295,7 @@ enroll diff \
Single-shot
-
One command → workable output.
+
Harvest → Manifest in one command.
@@ -305,7 +304,7 @@ enroll diff \
Diff
-
Drift report + notifications.
+
Drift report + webhook/email notifications.
@@ -352,7 +351,7 @@ sudo apt install enroll sudo tee /etc/yum.repos.d/mig5.repo > /dev/null << 'EOF' [mig5] name=mig5 Repository -baseurl=https://rpm.mig5.net/rpm/$basearch +baseurl=https://rpm.mig5.net/$releasever/rpm/$basearch enabled=1 gpgcheck=1 repo_gpgcheck=1