purge_node

pdk
tasks
A Puppet Task to purge agents

Nate McCurdy

nate

9,577 downloads

2,038 latest version

5.0 quality score

Version information

  • 1.4.0 (latest)
  • 1.3.2
  • 1.3.1
  • 1.3.0
  • 1.2.0
  • 1.1.2
  • 1.1.1
  • 1.1.0
  • 1.0.1
  • 1.0.0
released Jan 7th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
  • Puppet >= 5.0.0 < 7.0.0
  • RedHat, CentOS, OracleLinux, Scientific, SLES, Ubuntu
Tasks:
  • clean_cert
  • purge_node

Start using this module

Documentation

nate/purge_node — version 1.4.0 Jan 7th 2020

Puppet Forge Build Status

The Purge Node Task

This module provides Puppet Bolt tasks for purging Puppet agents and cleaning their certificates.

For open-source Puppet Bolt users, this allows for cleaning agent certificates using Bolt and the SSH transport.

For Puppet Enterprise (PE) users, this allows for cleaning and purging agents with the SSH transport or the PE Orchestrator's PCP transport. PE's RBAC system can gate access to running these tasks via the PE Console or with Puppet Tasks through the Orchestrator API.

Requirements

For open-source Bolt users:

  • Bolt 0.5+ is required
  • SSH is the only transport available

For Puppet Enterprise users:

  • PE 2017.3+ is required
  • The SSH or PCP (Orchestrator) transports can be used

Task: purge_node

NOTE:

  • This task only works with Puppet Enterprise.
  • The target of this task must be your primary Puppet Enterprise master---not the agent(s) being purged.

The purge_node task is used to run the puppet node purge command command against a list of specified Puppet agent(s). This has the effect of completely removing an agent from your PE infrastructure. Its reports are removed, its certificate is cleaned, and its license is freed up.

Parameters:

  • agent_certnames: The Puppet agents that will be purged. This can be one certname or multiple certnames in a comma-separated list or JSON array.

Examples:

$ puppet task run purge_node agent_certnames=agent1,agent2,agent3 --nodes puppet-ca.corp.net

Task: purge_node::clean_cert

NOTE:

  • This task works with open-source Puppet(server) and Puppet Enterprise.
  • The target of this task must be your primary Puppet master---not the agent(s) being cleaned.

The purge_node::clean_cert task is used to clean a Puppet agent's certificate. For Puppetserver >= 6.0, puppetserver ca clean is used. For Puppetserver < 6.0, puppet cert clean is used.

Parameters:

  • agent_certnames: The agent certificate names that will be cleaned. This can be one certname or multiple certnames in a comma-separated list or JSON array.

Examples:

$ bolt task run purge_node::clean_cert agent_certnames=agent1,agent2,agent3 --targets puppet-ca.corp.net

Running the Tasks

With Bolt

With Bolt, you can run these tasks tasks from the command line with bolt task run.

To purge a node (PE only):

$ bolt task run purge_node agent_certnames=agent1,agent2,agent3 --nodes master.corp.net

To clean a node's certifiate:

$ bolt task run purge_node::clean_cert agent_certnames=agent1,agent2,agent3 --nodes master.corp.net

With Puppet Enterprise

With Puppet Enterprise 2017.3 or higher, you can run these tasks from_the_console, from the command line, or from the Orchestrator API.

In this example, three agents are purged from master.corp.net: agent1, agent2, and agent3

[nate@workstation]$ puppet task run purge_node agent_certnames=agent1,agent2,agent3 --nodes master.corp.net

[nate@workstation ~]# puppet task run purge_node agent_certnames=agent1,agent2,agent3 --nodes master.corp.net
Starting job ...
Note: The task will run only on permitted nodes.
New job ID: 5
Nodes: 1

Started on master.corp.net ...
Finished on node master.corp.net
  agent1 :
    result : Node purged

  agent2 :
    result : Node purged

  agent3 :
    result : Node purged
|
Job completed. 1/1 nodes succeeded.
Duration: 17 sec

In addition to the comma-separated list of certnames, the agent_certnames parameter can accept JSON array as input. This is useful when using the Orchestrator API to run tasks. The example below is a valid request to the commands endpoint.

{
  "environment" : "production",
  "task" : "purge_node",
  "params" : {
    "agent_certnames" : ["agent1", "agent2", "agent3"]
  },
  "scope" : {
    "nodes" : ["master.corp.net"]
  }
}

Finishing the Job

If you are on Puppet Enterprise 2017.3 or higher and you only have one Puppet master, you're done. There's nothing else you need to do after running this task.

For everyone else, continue reading...

Puppetserver Reload

On Puppetserver versions before 5.1.0, the puppetserver process needs to be reloaded/restarted to re-read the certificate revocation list (CRL) after purging a node. If you are at or above this version, you don't need to restart the puppetserver process.

This task does not restart puppetserver for you. It may in future versions.

Compile Masters

If you have Puppet Enterprise with a Master-of-Masters (MoM) and Compile Masters, you don't need to restart puppetserver but you do need to trigger a puppet run on the Compile Masters after purging to completely refresh the CRL and prevent that node from checking in again.

This can be done with the Orchestrator via the Console's Jobs page or the command line, like so:

puppet job run -q 'resources { type = "Class" and title = "Puppet_enterprise::Profile::Master" and !(certname = "FQDN_of_your_MoM") }'

Development

This module uses the Puppet Development Kit (PDK) to manage unit tests and style validation.

If you're going to submit a change, please consider using the PDK to validate your change:

  1. Install the PDK
    • (MacOS) brew cask install puppetlabs/puppet/pdk
  2. Run validation tests: pdk validate