[SERVER-3006] Provide parsable (json) output for puppetserver ca commands - Puppet Jira Server

XML

Word

Printable

Acceptance Criteria:
Hide

The puppetserver ca cli enables to user to display information in different formats when using the list command

The old behaviour is still the default (and can be explicitly set with using "text" as format).

A json-output-format is available.
Show
The puppetserver ca cli enables to user to display information in different formats when using the list command The old behaviour is still the default (and can be explicitly set with using "text" as format). A json-output-format is available.
Epic Link:
Server CA CLI v2
Team:
Froyo
Story Points:
2
Sprint:
Froyo - 6/30/2021, Froyo - 7/14/2021

Release Notes:
New Feature
Release Notes Summary:
The puppetserver-ca CLI tool now can output certificates in a specified format by the user's choice through using the '--format' flag. Current available options are: 'text' (default), 'json'.

Scenario

We are currently using a puppet bolt script in order to sign CSRs. For now, we are parsing the output of the following command.

puppetserver ca list --all

Motivation

Parsing plain text is quite error prone and most likely, if something changes in the output printing, it will fail in the future.

Proposal

It would be good, if the output format of the ca command could be controlled by using a switch such as:

--format json

For our use case, json would be completely sufficient.

Notes

The puppetserver-ca-cli already seems to internally work with json and could probably easily just dump it without converting it beforehand.

blocks

SERVER-3038 Release puppetserver-ca gem for inclusion in upcoming releases

is duplicated by

SERVER-2252 Add `--format` flag to `puppetserver ca` cli tool