diff --git a/docs/Using-Fleet/configuration-files/README.md b/docs/Using-Fleet/configuration-files/README.md index 6b9d330327..4d2c92ec77 100644 --- a/docs/Using-Fleet/configuration-files/README.md +++ b/docs/Using-Fleet/configuration-files/README.md @@ -880,6 +880,40 @@ spec: agent_options: ``` +##### `extensions` option + +> This feature requires [Orbit, the Fleet agent manager](https://fleetdm.com/announcements/introducing-orbit-your-fleet-agent-manager), along with a custom TUF auto-update server. + +The `extensions` key inside of `agent_options` allows you to remotely manage and deploy osquery extensions. + +This is best illustrated with an example. Here is an example of using the `extensions` key: + +```yaml +apiVersion: v1 +kind: config +spec: + agent_options: + extensions: # requires Fleet's osquery installer + hello_world: + channel: 'stable' + platform: 'macos' +``` + +In the above example, we are configuring our `hello_world` extension. We do this by creating a `hello_world` sub-key under `extensions`, and then specifying the `channel` and `platform` keys for that extension. + +Next, you will need to make sure to push the binary file of our `hello_world` extension as a target on your TUF server. This step needs to follow these conventions: + +* The binary file of the extension, must have the same name as the extension, followed by the `.ext`. In the above case, the filename should be `hello_world.ext` +* The target name for the TUF server must be named as `extensions/`. For the above example, this would be `extensions/hello_world` +* `platform` is one of `macos`, `linux`, or `windows` + +If you are using `fleetctl` to manage your TUF server, these same conventions apply. You can run the following command to add a new target: + +```bash +fleetctl updates add --path /path/to/local/TUF/repo --target /path/to/extensions/binary/hello_world.ext --name extensions/hello_world --platform macos --version 0.1 +``` + +After successfully configuring the agent options, and pushing the extension as a target on your TUF server, Orbit will periodically check with the TUF server for updates to these extensions. ##### Example Agent options YAML