h1. CMS-Report-Data

This page aim is to find common elements between all configuration management systems reports.

See [[Chef-reporting]] for first discussion about implementation on a Foreman plugin.

See [[json-report-format]] and [[json-fact-format]]

h2. Puppet

Vocabulary:

Configuration management tool : puppet

System data informations tool : facter

General information:

* Sent from Puppetmaster (centralized)

* Multiple report processor allowed

Notions in reports: 

* Node name

* Time elapsed (File, Exec, User, Group, Conf Retrieval, Service, Package, Total)

* Resources Managed (Skipped, Scheduled, Out of Sync, Applied, Failed, Restarted, Failed Restarts, Total)

* Changes (number of changes in transaction)

* Log (bulk message) :

** level (debug,info, notice, warning, ..)

** source (resource name, puppet)

See: 

* http://docs.puppetlabs.com/guides/reporting.html

* http://docs.puppetlabs.com/puppet/3/reference/format_report.html

h2. Chef

Vocabulary:

Configuration management tool : chef

System data informations tool : ohai

General informations:

* Sent from chef-client (nodes)

* Multiple report processor allowed

Notions in reports:

* Node name

* Success or Failed run

* Global run backtrace

* Time elapsed by type of resource

* All resources in run_list

* All resources in run_list updated during chef-run

See:

* http://docs.opscode.com/essentials_handlers.html

* https://github.com/theforeman/chef-handler-foreman

* https://github.com/opscode/chef/blob/master/lib/chef/event_dispatch/base.rb

* https://github.com/opscode/chef/blob/master/lib/chef/resource_reporter.rb

h2. CFengine3

Vocabulary:

Configuration management tool : cf-agent

System data informations tool : cf-agent (discovery of local information)

General informations:

* Stored in promises, decentralized

* Can fetch information from Policy Hub in Enterprise version

Notions in reports:

* Node name

* % of promises kept, repaired, error

h2. Rudder

Vocabulary:

Configuration management tool : cf-agent

System data informations tool : fusion-inventory

General informations:

* Stored in generated promises

* Each node has its own set of generated promises

Notions in reports (one report per handled component):

* Node name

* Directive id

* Rule id

* Component name

* Component value

* Date

* Status (success, repaired, error)

See:

* http://www.rudder-project.org/rudder-doc-2.8/rudder-doc.html#_compliance

* http://www.rudder-project.org/foswiki/Development/ReportsInTechniques

* http://www.rudder-project.org/foswiki/Development/ContextedVariables

h2. Salt Stack

Vocabulary:

Configuration management tool : salt

System data informations tool : grains

General information:

* Foreman plugin in progress here: https://github.com/theforeman/foreman_salt/

* Smart proxy plugin in progress here: https://github.com/theforeman/smart_proxy_salt

Notions in reports: 

See: 

* https://github.com/saltstack/halite (salt stack webinterface for triggering commands and reading information about jobs, events, clients, etc.)

* http://docs.saltstack.com/topics/targeting/grains.html

* http://docs.saltstack.com/ref/states/layers.html

* http://docs.saltstack.com/topics/conventions/formulas.html

* SaltStack Formula for Foreman and many more on https://github.com/bechtoldt/

* http://docs.saltstack.com/en/latest/ref/pillar/all/salt.pillar.foreman.html#module-salt.pillar.foreman (https://github.com/saltstack/salt/blob/develop/salt/pillar/foreman.py)

h2. Ansible