Bolt Tasks and Plan to quickly pull Puppet Enterprise information for SE engagement
The plan in this repo will quickly collect data from a Puppet Enterprise server to be used for understanding the environment better and providing the customer with value as a baseline moving forward. Plans and tasks included in this module can be run using either Puppet Bolt or Puppet Enterprise Plans and/or Tasks. Thanks to the repository at https://github.com/puppetlabs/pe_tech_check for providing support script parts of the data collect.
For a review of the data collected as part of the module please see the documentation located at https://github.com/puppetlabs/puppetlabs-pe_quick_data/blob/master/data_use/data_use.md
WARNING: When running this module and have the puppet metrics collector module running, ensure that the puppet metrics module is at version 6.1.0 or later. If not, file sizes of the pe_quick_data output will typically be >10 GBs in size or larger. To avoid this issue, upgrade the puppetlabs/puppet_metrics_collector to version 6.1.0 or higher when using version 6 of the collector. Versions 5.3.0 and below are not affected.
Use module from the forge by adding the module to your Boltdir directory Puppetfile.
mod 'puppetlabs-pe_quick_data', '2.3.4'
Run bolt puppetfile install
from the Boltdir directory where the Puppetfile is located.
Save inventory.yaml file with PE master defined for the environment into the same Boltdir directory.
The default directory for the data collection is currently /var/tmp/pe_quick_data on the Puppet Enterprise master, but this can be changed at run time.
If an alternate directory is specified for the data collection through the outputdir parameter, the folder pe_quick_data will be created on the PE master, in the alternate directory.
To use the plan run bolt plan run pe_quick_data::data_collect
with --targets specified to point to the master or masters for Puppet Enterprise
output_dir - specifies the directory where the pe_quick_data directory will be created.
enable_logs - specifies whether or not to include the support script log output
download - allows for downloading to the Boltdir/downloads directory from where the plan is run
bolt plan run pe_quick_data::data_collect --targets puppetm.example.com
bolt plan run pe_quick_data::data_collect --targets puppetm.example.com --user <USER> --private-key <KEY_PATH> --transport ssh --no-host-key-check --run-as root
bolt plan run pe_quick_data::data_collect --targets puppetm.example.com output_dir=/tmp/
bolt plan run pe_quick_data::data_collect --targets puppetm.example.com enable_logs=true