PUPPET-KEY(8)

📦
version 5.5.22 · 2 versions
, in ubuntu jammy

💖 PUPPET-KEY 💖

okay bestie, welcome to puppet-key — that's section 8 of the Puppet manual, so you know it's a command you run from the shell, not some library nonsense. She creates, saves, and removes certificate keys. That's the whole vibe. ✨

🌸 SYNOPSIS 🌸

puppet key action [--terminus _TERMINUS] [--extra HASH]

that's it, that's the shape of it. one action, and then some optional little garnish flags. 🎀

🦋 DESCRIPTION 🦋

so this subcommand manages certificate private keys. literally its whole job. 💅

and here's the tea: keys are created automatically by puppet agent, and also when certificate requests get generated with puppet certificate generate. so like… it should not be necessary to use this subcommand directly?? it's the backup plan, the emergency contact, the "i know a guy" of subcommands. 🫶

✨ OPTIONS ✨

first things first, a lil note before we get into it: any setting that's valid in the configuration file is also a valid long argument — even if it's lowkey irrelevant to whatever action you're doing right now. like, server and run_mode are valid settings, so you can totally pass --server <servername>, or --run_mode <runmode> as an argument. slay. 💫

for the full list of acceptable parameters, go read the configuration file docs at https://puppet.com/docs/puppet/latest/configuration.html. and if you want a commented list of ALL the configuration options, just run puppet with --genconfig and it'll hand it over. 👑

  • --render-as FORMAT — the format your output gets rendered in. the most common formats are json, s (that's string, bestie), yaml, and console, but sometimes other options like dot show up too. pick your aesthetic. 🎨
  • --verbose — whether to log verbosely. do you want the whole story or just the highlights? 🗣️
  • --debug — whether to log debug information. this is the "tell me EVERYTHING, i can handle it" setting. 🔍
  • --extra HASH — so a terminus can take extra arguments to refine the operation, and those get passed as an arbitrary hash to the back-end. anything you pass as the extra value is just sent direct to the back-end. no filter, no middleman. 📬
  • --terminus _TERMINUS — okay this one's a whole paragraph, sit down.

indirector faces expose indirected subsystems of Puppet. each of these subsystems can retrieve and alter one specific type of data — using the familiar actions find, search, save, and destroy — from an arbitrary number of pluggable backends. and in Puppet parlance? those backends are called terminuses. periodt. 💅

almost all indirected subsystems have a rest terminus that interacts with the puppet master's data. most of them also have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request. 🛰️

the terminus for an action is often determined by context, but occasionally you gotta set it explicitly. see the "Notes" section of this face's manpage for more details. iykyk. 🎀

🔥 ACTIONS 🔥

here's the lineup, bestie. five actions, each one an icon in her own right.

destroy — Delete an object.

SYNOPSIS

puppet key destroy [--terminus _TERMINUS] [--extra HASH] key

DESCRIPTION

Delete an object. that's it. gone. poof. 🫥

find — Retrieve an object by name.

SYNOPSIS

puppet key find [--terminus _TERMINUS] [--extra HASH] [key]

DESCRIPTION

Retrieve an object by name. notice the key is in square brackets here — optional, bestie, she's flexible like that. 🙈

info — Print the default terminus class for this face.

SYNOPSIS

puppet key info [--terminus _TERMINUS] [--extra HASH]

DESCRIPTION

Prints the default terminus class for this subcommand. important caveat tho: different run modes may have different default termini — so when in doubt, specify the run mode with the '--run_mode' option. don't get caught out. 😭

save — API only: create or overwrite an object.

SYNOPSIS

puppet key save [--terminus _TERMINUS] [--extra HASH] key

DESCRIPTION

API only: create or overwrite an object. and here's the sad part — as the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line. so it's API-only fr fr. we mourn. 💀

search — Search for an object or retrieve multiple objects.

SYNOPSIS

puppet key search [--terminus _TERMINUS] [--extra HASH] query

DESCRIPTION

Search for an object or retrieve multiple objects. plural. she's a collector. 🌈

📝 NOTES 📝

okay so this subcommand is an indirector face, which means it exposes find, search, save, and destroy actions for an indirected subsystem of Puppet. we love a framework moment. 🫶

valid termini for this face include:

  • ca
  • disabled_ca
  • file
  • memory

four options, all valid, all iconic. 👑

Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING

💖 that's the whole page bestie!! go forth and manage those certificate keys (or, y'know, let puppet agent do it, because again — you're not supposed to need this) 💖

stay slay, Puppet, Inc. — May 2022 — PUPPET-KEY(8) ✨💅🎀🦋🌸

📦 where this page comes from