puppetlabs-peadm icon indicating copy to clipboard operation
puppetlabs-peadm copied to clipboard

peadm should print a summary of plan parameters to the standard log stream [SOLARCH-546]

Open Sharpie opened this issue 5 years ago • 0 comments

Use Case

The peadm::install and peadm::upgrade plans co-ordinate tasks across many nodes using a variety of inputs. When one of these plans fails, the output is often the first thing presented for debugging. Currently, this output lacks important information such as:

  • The peadm version being used

  • The nodes involved in the plan and their assigned roles

  • The PE version being installed.

  • The PE version being upgraded.

This lack of information leads to several follow-up questions before debugging can proceed.

Describe the Solution You Would Like

peadm plans that perform significant actions, such as install or upgrade, should log relevant parameters and version numbers using out::message so that most relevant information is captured in one log stream.

Describe Alternatives You've Considered

The current alternative is to manually gather plan inputs. This is tedious, often results in incomplete data, and can miss inconsistencies (i.e. the parameters the user thought they passed to the plan are not the parameters the plan ended up using due to inventory settings, peadm plans being called by other user-written plans, etc.).

Sharpie avatar Jun 24 '20 22:06 Sharpie