<a id="reference-high-level-deployment"></a>

# High-level deployment overview

This page shows how the osquery charm fits into a typical deployment.

The osquery charm is a subordinate that runs on the same machine as a principal
application. On each host, the charm installs and manages the `osqueryd`
daemon. Every agent connects outward over TLS to a centrally managed osquery
controller, which supplies the agents’ configuration and collects their logs.

Key points:

- The `general-info` relation places one osquery subordinate unit on each
  principal machine. See [Relation endpoints](https://canonical.com/juju/docs/osquery-charm/latest/reference/relation-endpoints/index.html.md#reference-relation-endpoints).
- Each `osqueryd` agent is configured from Juju configurations, which the
  charm renders into an osquery flagfile. See [Configurations](https://canonical.com/juju/docs/osquery-charm/latest/reference/configurations/index.html.md#reference-configurations).
- All agents communicate with the osquery controller over TLS. The controller,
  not Juju, owns the fleet’s query schedules, telemetry rules, and log storage.

This charm targets [osctrl](https://osctrl.net/) as the controller. For how to
deploy and operate it, see the [osctrl documentation](https://docs.osctrl.net/).
