fleet/schema/tables/puppet_state.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

69 lines
2.2 KiB
YAML

name: puppet_state
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: State of every resource [Puppet](https://puppet.com/) is managing. This table uses data from the `last_run_report` that Puppet creates.
platforms:
- darwin
- windows
- linux
evented: false
examples: >-
List resources that failed or took over a minute to evaluate.
```
SELECT * FROM puppet_state WHERE failed='true' OR evaluation_time>'60';
```
columns:
- name: title
description: The name of the resource.
required: false
type: text
- name: file
description: The file that contains the resource.
required: false
type: text
- name: line
description: The line on which the resource is specified.
required: false
type: text
- name: resource
description: The resource and its title as `Type[title]`.
required: false
type: text
- name: resource_type
description: The resource type.
required: false
type: text
- name: evaluation_time
description: The amount of seconds it took to evaluate the resource.
required: false
type: text
- name: failed
description: If Puppet failed to evaluate this resource, this column is `true`.
required: false
type: text
- name: changed
description: If `change_count` is above `0`, this is `true`.
required: false
type: text
- name: out_of_sync
description: If `out_of_sync_count` is above `0`, this is `true`.
required: false
type: text
- name: skipped
description: True if this resource was skipped.
required: false
type: text
- name: change_count
description: The count of changes to be performed.
required: false
type: text
- name: out_of_sync_count
description: The number of properties that are out of sync
required: false
type: text
- name: corrective_change
description: True if a change on the system caused unexpected changes between two Puppet runs.
required: false
type: text