Jira (PUP-11668) puppet node purge help is misleading

Issue Type:	Improvement
Assignee:	Unassigned
Created:	2022/11/08 9:23 AM
Priority:	Normal
Reporter:	Parker Leach

This was mistakenly created as a docs ticket:

Hi,
I think the help for "puppet node purge" is a bit misleading:

puppet node --help

USAGE: puppet node <action> [--terminus _TERMINUS]

This subcommand interacts with node objects, which are used by Puppet to

build a catalog. A node object consists of the node's facts, environment,

node parameters (exposed in the parser as top-scope variables), and classes.

OPTIONS:

--render-as FORMAT - The rendering format to use.

--verbose - Whether to log verbosely.

--debug - Whether to log debug information.

--terminus _TERMINUS - The indirector terminus to use.

ACTIONS:

clean Clean up signed certs, cached facts, node objects, and reports

for a node stored by the puppetmaster

deactivate Deactivate a set of nodes in PuppetDB

decrypt Decrypt a value using the agent's own certificate

encrypt Encrypt a value using a specified agent's certificate

exports Return the exports of nodes from puppetdb

find Retrieve a node object.

info Print the default terminus class for this face.

purge Deactivate nodes, delete from inventory, delete PuppetDB data,

and clean node info from the primary

status Fetch the current status for a set of nodes in PuppetDB

TERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml

See 'puppet help node' or 'man puppet-node' for full help.

#

"Clean" mentions "Clean up signed certs". This isn't mentioned for "purge", but it also revokes the certificate:

puppet node purge catalog-diff

Notice: Certificate for catalog-diff has been revoked

Notice: Cleaned files related to catalog-diff

Node "catalog-diff" was purged.

To ensure a node can not check into any compilers, run 'puppet agent -t' on all compilers.

To re-add a node to your Puppet Enterprise infrastructure:

On the node:

1. Run 'puppet ssl clean' to purge that node's local certificates.

2. Run 'puppet agent -t' to generate a new certificate request.

puppet --version

7.20.0

#

This message was sent by Atlassian Jira (v8.20.11#820011-sha1:0629dd8)

Parker Leach (Jira)

unread,

Nov 8, 2022, 12:26:02 PM11/8/22

to puppe...@googlegroups.com

Parker Leach updated an issue

Puppet /

Change By:	Parker Leach

This was mistakenly created as a docs ticket:

Hi,
I think the help for "puppet node purge" is a bit misleading:

| {code:java}
# puppet node --help |
| |
| |
| USAGE: puppet node <action> [--terminus _TERMINUS] |
| |
| This subcommand interacts with node objects, which are used by Puppet to |
| build a catalog. A node object consists of the node's facts, environment, |
| node parameters (exposed in the parser as top-scope variables), and classes. |
| |
| OPTIONS: |
| --render-as FORMAT - The rendering format to use. |
| --verbose - Whether to log verbosely. |
| --debug - Whether to log debug information. |
| --terminus _TERMINUS - The indirector terminus to use. |
| |
| ACTIONS: |
| clean Clean up signed certs, cached facts, node objects, and reports |
| for a node stored by the puppetmaster |
| deactivate Deactivate a set of nodes in PuppetDB |
| decrypt Decrypt a value using the agent's own certificate |
| encrypt Encrypt a value using a specified agent's certificate |
| exports Return the exports of nodes from puppetdb |
| find Retrieve a node object. |
| info Print the default terminus class for this face. |
| purge Deactivate nodes, delete from inventory, delete PuppetDB data, |
| and clean node info from the primary |
| status Fetch the current status for a set of nodes in PuppetDB |
| |
| TERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml |
| |
| See 'puppet help node' or 'man puppet-node' for full help. |
| # | {code}

"Clean" mentions "Clean up signed certs". This isn't mentioned for "purge", but it also revokes the certificate:

|# puppet node purge catalog-diff|

|Notice: Certificate for catalog-diff has been revoked|
|Notice: Cleaned files related to catalog-diff|
|Node "catalog-diff" was purged.|
| |
|To ensure a node can not check into any compilers, run 'puppet agent -t' on all compilers.|
| |
|To re-add a node to your Puppet Enterprise infrastructure:|
|On the node:|
|1. Run 'puppet ssl clean' to purge that node's local certificates.|
|2. Run 'puppet agent -t' to generate a new certificate request.|

|# puppet --version|
|7.20.0|
|#|

Parker Leach (Jira)

unread,

Nov 8, 2022, 12:29:03 PM11/8/22

to puppe...@googlegroups.com

Parker Leach (Jira)

unread,

Nov 8, 2022, 12:31:03 PM11/8/22

to puppe...@googlegroups.com

Parker Leach updated an issue

Puppet /

Change By:	Parker Leach

This was mistakenly created as a docs ticket:

Hi,
I think the help for "puppet node purge" is a bit misleading:

{code:java}

# puppet node --help USAGE: puppet node <action> [--terminus _TERMINUS] This subcommand interacts with node objects, which are used by Puppet tobuild a catalog. A node object consists of the node's facts, environment,node parameters (exposed in the parser as top-scope variables), and classes. OPTIONS: --render-as FORMAT - The rendering format to use. --verbose - Whether to log verbosely. --debug - Whether to log debug information. --terminus _TERMINUS - The indirector terminus to use. ACTIONS: clean Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster deactivate Deactivate a set of nodes in PuppetDB decrypt Decrypt a value using the agent's own certificate encrypt Encrypt a value using a specified agent's certificate exports Return the exports of nodes from puppetdb find Retrieve a node object. info Print the default terminus class for this face. purge Deactivate nodes, delete from inventory, delete PuppetDB data, and clean node info from the primary status Fetch the current status for a set of nodes in PuppetDB TERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml See 'puppet help node' or 'man puppet-node' for full help.# {code}

"Clean" mentions "Clean up signed certs". This isn't mentioned for "purge", but it also revokes the certificate:

| # puppet node purge catalog-diff|
|Notice: Certificate for catalog-diff has been revoked|
|Notice: Cleaned files related to catalog-diff|
|Node "catalog-diff" was purged.|
| |
|To ensure a node can not check into any compilers, run 'puppet agent -t' on all compilers.|
| |
|To re-add a node to your Puppet Enterprise infrastructure:|
|On the node:|
|1. Run 'puppet ssl clean' to purge that node's local certificates.|
|2. Run 'puppet agent -t' to generate a new certificate request.|
| # puppet --version|
|7.20.0|
|#|

Parker Leach (Jira)

unread,

Nov 8, 2022, 12:31:03 PM11/8/22

to puppe...@googlegroups.com

Parker Leach updated an issue

Puppet /

Change By:	Parker Leach

This was mistakenly created as a docs ticket:

Hi,
I think the help for "puppet node purge" is a bit misleading:

{code:java}

# puppet node --help USAGE: puppet node <action> [--terminus _TERMINUS] This subcommand interacts with node objects, which are used by Puppet to build tobuild a catalog. A node object consists of the node's facts, environment, node parameters (exposed in the parser as top-scope variables), and classes. OPTIONS: --render-as FORMAT - The rendering format to use. --verbose - Whether to log verbosely. --debug - Whether to log debug information. --terminus _TERMINUS - The indirector terminus to use. ACTIONS: clean Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster deactivate Deactivate a set of nodes in PuppetDB decrypt Decrypt a value using the agent's own certificate encrypt Encrypt a value using a specified agent's certificate exports Return the exports of nodes from puppetdb find Retrieve a node object. info Print the default terminus class for this face. purge Deactivate nodes, delete from inventory, delete PuppetDB data, and clean node info from the primary status Fetch the current status for a set of nodes in PuppetDB TERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml See 'puppet help node' or 'man puppet-node' for full help. # {code}

"Clean" mentions "Clean up signed certs". This isn't mentioned for "purge", but it also revokes the certificate:

| # puppet node purge catalog-diff|
|Notice: Certificate for catalog-diff has been revoked|
|Notice: Cleaned files related to catalog-diff|
|Node "catalog-diff" was purged.|
| |
|To ensure a node can not check into any compilers, run 'puppet agent -t' on all compilers.|
| |
|To re-add a node to your Puppet Enterprise infrastructure:|
|On the node:|
|1. Run 'puppet ssl clean' to purge that node's local certificates.|
|2. Run 'puppet agent -t' to generate a new certificate request.|
| # puppet --version|
|7.20.0|
|#|

Parker Leach (Jira)

unread,

Nov 8, 2022, 12:32:01 PM11/8/22

to puppe...@googlegroups.com

Parker Leach updated an issue

Puppet /

Change By:	Parker Leach

This was mistakenly created as a docs ticket:

Hi,
I think the help for "puppet node purge" is a bit misleading:

{ code:java noformat }
# puppet node --help USAGE: puppet node <action> [--terminus _TERMINUS] This subcommand interacts with node objects, which are used by Puppet tobuild a catalog. A node object consists of the node's facts, environment,node parameters (exposed in the parser as top-scope variables), and classes. OPTIONS: --render-as FORMAT - The rendering format to use. --verbose - Whether to log verbosely. --debug - Whether to log debug information. --terminus _TERMINUS - The indirector terminus to use. ACTIONS: clean Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster deactivate Deactivate a set of nodes in PuppetDB decrypt Decrypt a value using the agent's own certificate encrypt Encrypt a value using a specified agent's certificate exports Return the exports of nodes from puppetdb find Retrieve a node object. info Print the default terminus class for this face. purge Deactivate nodes, delete from inventory, delete PuppetDB data, and clean node info from the primary status Fetch the current status for a set of nodes in PuppetDB TERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml See 'puppet help node' or 'man puppet-node' for full help.# { code noformat }

"Clean" mentions "Clean up signed certs". This isn't mentioned for "purge", but it also revokes the certificate:

| # puppet node purge catalog-diff|
|Notice: Certificate for catalog-diff has been revoked|
|Notice: Cleaned files related to catalog-diff|
|Node "catalog-diff" was purged.|
| |
|To ensure a node can not check into any compilers, run 'puppet agent -t' on all compilers.|
| |
|To re-add a node to your Puppet Enterprise infrastructure:|
|On the node:|
|1. Run 'puppet ssl clean' to purge that node's local certificates.|
|2. Run 'puppet agent -t' to generate a new certificate request.|
| # puppet --version|
|7.20.0|
|#|

Parker Leach (Jira)

unread,

Nov 8, 2022, 12:33:02 PM11/8/22

to puppe...@googlegroups.com

Parker Leach updated an issue

Puppet /

Change By:	Parker Leach

This was mistakenly created as a docs ticket:

Hi,
I think the help for "puppet node purge" is a bit misleading:

{ noformat code:java }
// code placeholder

# puppet node --help USAGE: puppet node <action> [--terminus _TERMINUS] This subcommand interacts with node objects, which are used by Puppet tobuild a catalog. A node object consists of the node's facts, environment,node parameters (exposed in the parser as top-scope variables), and classes. OPTIONS: --render-as FORMAT - The rendering format to use. --verbose - Whether to log verbosely. --debug - Whether to log debug information. --terminus _TERMINUS - The indirector terminus to use. ACTIONS: clean Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster deactivate Deactivate a set of nodes in PuppetDB decrypt Decrypt a value using the agent's own certificate encrypt Encrypt a value using a specified agent's certificate exports Return the exports of nodes from puppetdb find Retrieve a node object. info Print the default terminus class for this face. purge Deactivate nodes, delete from inventory, delete PuppetDB data, and clean node info from the primary status Fetch the current status for a set of nodes in PuppetDB TERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml See 'puppet help node' or 'man puppet-node' for full help.#{ noformat code }

"Clean" mentions "Clean up signed certs". This isn't mentioned for "purge", but it also revokes the certificate:

| # puppet node purge catalog-diff|
|Notice: Certificate for catalog-diff has been revoked|
|Notice: Cleaned files related to catalog-diff|
|Node "catalog-diff" was purged.|
| |
|To ensure a node can not check into any compilers, run 'puppet agent -t' on all compilers.|
| |
|To re-add a node to your Puppet Enterprise infrastructure:|
|On the node:|
|1. Run 'puppet ssl clean' to purge that node's local certificates.|
|2. Run 'puppet agent -t' to generate a new certificate request.|
| # puppet --version|
|7.20.0|
|#|

Parker Leach (Jira)

unread,

Nov 8, 2022, 12:34:03 PM11/8/22

to puppe...@googlegroups.com

Parker Leach updated an issue

Puppet /

Change By:	Parker Leach

This was mistakenly created as a docs ticket:

Hi,
I think the help for "puppet node purge" is a bit misleading:

{code :java }

// code placeholder

# puppet node --help

USAGE: puppet node <action> [--terminus _TERMINUS]

This subcommand interacts with node objects, which are used by Puppet tobuild to
build a catalog. A node object consists of the node's facts, environment,

node parameters (exposed in the parser as top-scope variables), and classes.

OPTIONS:
  --render-as FORMAT             - The rendering format to use.
  --verbose                     - Whether to log verbosely.
  --debug                     - Whether to log debug information.
  --terminus _TERMINUS           - The indirector terminus to use.

ACTIONS:
  clean         Clean up signed certs, cached facts, node objects, and reports
                for a node stored by the puppetmaster
  deactivate    Deactivate a set of nodes in PuppetDB
  decrypt       Decrypt a value using the agent's own certificate
  encrypt       Encrypt a value using a specified agent's certificate
  exports       Return the exports of nodes from puppetdb
  find          Retrieve a node object.
  info          Print the default terminus class for this face.
  purge         Deactivate nodes, delete from inventory, delete PuppetDB data,
                and clean node info from the primary
  status        Fetch the current status for a set of nodes in PuppetDB

TERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml

See 'puppet help node' or 'man puppet-node' for full help.
#

{code}

"Clean" mentions "Clean up signed certs". This isn't mentioned for "purge", but it also revokes the certificate:

{code}

{code}