Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamin-robertson committed Mar 3, 2023
1 parent 987fc74 commit 5dafaa6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Preserve existing trusted facts

### <a name="update_trusted_factsupdate_trusted_facts"></a>`update_trusted_facts::update_trusted_facts`

lint:ignore:140chars:2sp_soft_tabs-check
lint:ignore:140chars lint:ignore:strict_indent

This plans allows for the easy modification of trusted facts on already deployed nodes via the Puppet Enterprise console.
It will preserve the existing trusted facts by reading the existing certificate and merging any proposed changes over existing. This behaviour can be changed by setting the preserve_existing_facts parameter to false
Expand Down Expand Up @@ -140,23 +140,23 @@ The Puppet Enterprise primary server in your PE installation.

Data type: `Boolean`

Whether to preserve existing facts from the nodes. If set to false all existing facts will be wiped and replace with those set in the plan. Default: true
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

Default value: ``true``

##### <a name="ignore_infra_status_error"></a>`ignore_infra_status_error`

Data type: `Boolean`

Ignore errors from 'puppet infrastructure status' command. This is used to verify the primary server. Can be use to still allow the plan the run when some PE components a unavaliable. Default: false
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

Default value: ``false``

##### <a name="noop"></a>`noop`

Data type: `Boolean`

Run the plan noop. csr_attributes.yaml will still generated however certificates will not be resigned. Default: false
Run the plan in noop. csr_attributes.yaml will still generated, however certificates will not be resigned. Default: false

Default value: ``false``

Expand Down
6 changes: 3 additions & 3 deletions plans/update_trusted_facts.pp
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
#
# @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 preserve_existing_facts Whether to preserve existing facts from the nodes. If set to false all existing facts will be wiped and replace 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 use to still allow the plan the run when some PE components a unavaliable. Default: false
# @param noop Run the plan noop. csr_attributes.yaml will still generated however certificates will not be resigned. Default: false
# @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
# @param pp_role Set the pp_role trusted fact. Default: undef
# @param pp_uuid Set the pp_uuid trusted fact. Default: undef
# @param pp_environment Set the pp_environment trusted fact. Default: undef
Expand Down

0 comments on commit 5dafaa6

Please sign in to comment.