fleetdm / fleet

Open-source platform for IT, security, and infrastructure teams. (Linux, macOS, Chrome, Windows, cloud, data center)
https://fleetdm.com
Other
3.18k stars 435 forks source link

Document advanced agent options formats and validations. #7832

Open mna opened 2 years ago

mna commented 2 years ago

Goal

Extracted from #5222 (see https://github.com/fleetdm/fleet/issues/5222#issuecomment-1251096271).

The various Agent Options settings are now validated based on their data type, but reading the osquery documentation about those settings indicates that there are a number of settings that have restrictions that go beyond their data type. That is, a value may be correct for the required data type of a setting, but may still be invalid for osquery. While we don't currently validate those extra restrictions (it might be very hard to cover them all and keep them up to date on each release), we should at least document them as much as we can, as clear as we can.

Some examples of such restrictions:

As you can see, there are many such restrictions that can be found.

How?

Frontend

No impact on frontend, purely a documentation change.

Backend

No impact on backend, purely a documentation change.

mna commented 2 years ago

@noahtalerman as discussed in https://github.com/fleetdm/fleet/issues/5222#issuecomment-1251096271