Merge pull request #3 from benjamin-robertson/feature_fix_token_issue

Documentation updates.

Author: benjamin-robertson

CHANGELOG.md

@@ -6,6 +6,8 @@ All notable changes to this project will be documented in this file.
 
 **Features**
 
+- Minor documentation updates
+
 **Bugfixes**
 
 - No longer require a valid API token under the root user on the Puppet primary server.

README.md

@@ -37,6 +37,8 @@ Include the module within your Puppetfile.
 
 Run the plan **update_trusted_facts::update_trusted_facts** from the Puppet Enterprise console. 
 
+**Note:** If you restrict access to plans via RBAC and only grant users permission to run this plan; you will also need to grant users access to *enterprise_tasks::agent_cert_regen* plan. 
+
 **Required parameters**
 - pe_primary_server (FQDN)
 - targets (TargetSpec - [see here](https://www.puppet.com/docs/bolt/latest/bolt_types_reference.html#targetspec))

REFERENCE.md

@@ -134,7 +134,7 @@ The targets to run on (note this must match the certnames used by Puppet / shown
 
 Data type: `Stdlib::Fqdn`
 
-The Puppet Enterprise primary server in your PE installation.
+The Puppet Enterprise primary server in your PE installation you are running the plan from.
 
 ##### <a name="preserve_existing_facts"></a>`preserve_existing_facts`
 

plans/update_trusted_facts.pp

@@ -11,7 +11,7 @@
 # - https://www.puppet.com/docs/pe/2021.7/plans_limitations.html
 #
 # @param targets The targets to run on (note this must match the certnames used by Puppet / shown in PE console).
-# @param pe_primary_server The Puppet Enterprise primary server in your PE installation. 
+# @param pe_primary_server The Puppet Enterprise primary server in your PE installation you are running the plan from. 
 # @param preserve_existing_facts Whether to preserve existing facts from the nodes. If set to false all existing facts will be wiped and replaced with those set in the plan. Default: true
 # @param ignore_infra_status_error Ignore errors from 'puppet infrastructure status' command. This is used to verify the primary server. Can be used to allow the plan the run when some PE components are unavaliable. Default: false
 # @param noop Run the plan in noop. csr_attributes.yaml will still generated, however certificates will not be resigned. Default: false