fleet/schema/tables/puppet_info.yml
Lucas Manuel Rodriguez 4784217b57
Add documentation for missing fleetd tables and regenerate JSON (#9960)
Updating documentation of Fleetd tables as part of the oncall duty.

Updating the json used by Fleet using the following command:
```sh
cd website
 ./node_modules/sails/bin/sails.js run generate-merged-schema
```

Samples:
![Screenshot 2023-02-20 at 17 20
55](https://user-images.githubusercontent.com/2073526/220192112-69a116e4-badb-4328-92d3-9a2a6f8657fe.png)
![Screenshot 2023-02-20 at 17 21
09](https://user-images.githubusercontent.com/2073526/220192117-dfa06c69-2166-47d4-99c3-e108911e2084.png)


@mikermcneil @eashaw: `generate-merged-schema` generates a different
output every time it's executed. Guess: It seems it should sort the
output lexicograhically?
2023-02-22 16:05:36 -03:00

85 lines
2.9 KiB
YAML

name: puppet_info
notes: This table is not a core osquery table. It is included as part of [Fleetd](https://fleetdm.com/docs/using-fleet/orbit), the osquery manager from Fleet. Fleetd can be built with [fleetctl](https://fleetdm.com/docs/using-fleet/adding-hosts#osquery-installer).
description: Information on the last [Puppet](https://puppet.com/) run. This table uses data from the `last_run_report` that Puppet creates.
platforms:
- darwin
- windows
- linux
evented: false
examples: >-
List all the information available about the last Puppet run.
```
SELECT * FROM puppet_info;
```
columns:
- name: cached_catalog_status
description: The status of Puppet catalogs cached on the system.
required: false
type: text
- name: catalog_uuid
description: The [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) of the catalog downloaded by Puppet.
required: false
type: text
- name: code_id
description: The `code_id` links the catalog with the compile-time version of file resources using the `puppet:///` URI.
required: false
type: text
- name: configuration_version
description: The version of the Puppet configuration.
required: false
type: text
- name: corrective_change
description: A corrective change is triggered when Puppet detects a discrepency between the current state and the expected state of a value.
required: false
type: text
- name: environment
description: The environment name.
required: false
type: text
- name: host
description: The host on which Puppet is used.
required: false
type: text
- name: kind
description: Kind of Puppet run.
required: false
type: text
- name: master_used
description: The Puppet server used.
required: false
type: text
- name: noop
description: Indicates if Puppet was run in [noop](https://puppet.com/docs/puppet/latest/metaparameter.html#noop) mode.
required: false
type: text
- name: noop_prending
description: Items pending from a [noop](https://puppet.com/docs/puppet/latest/metaparameter.html#noop) run.
required: false
type: text
- name: puppet_version
description: The version of Puppet used during the last run.
required: false
type: text
- name: report_format
description: The format the Puppet report was exported as.
required: false
type: text
- name: status
description: The status of Puppet on this system.
required: false
type: text
- name: time
description: The time of the last Puppet run.
required: false
type: text
- name: transaction_completed
description: Indicates if the transaction completed or not.
required: false
type: text
- name: transaction_uuid
description: The [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) of the transaction.
required: false
type: text