Jira (PUP-11680) puppet node purge documentation is misleading

4 views
Skip to first unread message

Tim Meusel (Jira)

unread,
Nov 21, 2022, 3:15:03 AM11/21/22
to puppe...@googlegroups.com
Tim Meusel created an issue
 
Puppet / Improvement PUP-11680
puppet node purge documentation is misleading
Issue Type: Improvement Improvement
Assignee: Unassigned
Created: 2022/11/21 12:14 AM
Priority: Normal Normal
Reporter: Tim Meusel

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
#

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

Tim Meusel (Jira)

unread,
Nov 21, 2022, 3:18:02 AM11/21/22
to puppe...@googlegroups.com
Tim Meusel commented on Improvement PUP-11680
 
Re: puppet node purge documentation is misleading

I cloned it (I don't understand why you didn't do this and just closed it).

Reply all
Reply to author
Forward
0 new messages