https://github.com/osquery/osquery logo
Title
g

Gavin

03/22/2022, 3:01 PM
General Docs feedback, from our journey to primarily configuring everything with config.yml files. The example config file formats could do with being more verbose for examples other wise it can be a minefield of issues for example. https://fleetdm.com/docs/deploying/configuration#osquery-status-log-plugin is
osquery:
    status_log_plugin: firehose
where as at a minimum you would have to include the relevant API spec which is not on that page.
---
apiVersion: v1
kind: config
spec:
  osquery:
      status_log_plugin: firehose
Which gives
fleetctl apply -f firehose.yml                                  
applying fleet config: PATCH /api/v1/fleet/config received status 400 Bad request: json: unknown field "osquery"
In general the config values align more to the Helm Chart config that the config file setup https://github.com/fleetdm/fleet/blob/4e6d1ee1567ea46eedee425511a9891c09bfb894/tools/ci/helm-values/disable-fleet-tls.yaml
z

zwass

03/22/2022, 6:14 PM
Thank you Gavin! @koo @Kathy Satterlee can you please take a look at this feedback and incorporate into the docs?
k

Kathy Satterlee

03/22/2022, 6:14 PM
That's excellent feedback, thanks! I'll get that taken care of as I'm working on docs this week.
g

Gavin

03/22/2022, 6:17 PM
Thanks, further review is pretty much everything labelled as
Config file format:
should be labelled as helm chart configuration options with probably a mention that there is a helm chart. I also personally found finding this section a bit difficult https://fleetdm.com/docs/using-fleet/configuration-files
:ty: 1
k

koo

03/22/2022, 7:41 PM
Great feedback @Gavin