mirror of https://github.com/empayre/fleet.git synced 2024-11-06 17:05:18 +00:00

Reorganize Fleet documentation (#12871 )

Closes: #12611

Changes:
- Added three new documentation sections `/docs/get-started/`,
`/docs/configuration` and `/docs/rest api/`
- Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and
`/docs/deploying` » `/docs/deploy/`
- Moved `/docs/using-fleet/process-events.md` to `/articles` and updated
the meta tags to change it into a guide.
- Added support for a new meta tag: `navSection`. This meta tag is used
to organize pages in the sidebar navigation on fleetdm.com/docs
- Moved `docs/using-fleet/application-security.md` and
`docs/using-fleet/security-audits.md` to the security handbook.
- Moved `docs/deploying/load-testing.md` and
`docs/deploying/debugging.md` to the engineering handbook.
- Moved the following files/folders:
- `docs/using-fleet/configuration-files/` »
`docs/configuration/configuration-files/`
- `docs/deploying/configuration.md` »
`docs/configuration/fleet-server-configuration.md`
    -  `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md`
- `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md`
- Updated filenames:
- `docs/using-fleet/permissions.md` »
`docs/using-fleet/manage-access.md`
- `docs/using-fleet/adding-hosts.md` »
`docs/using-fleet/enroll-hosts.md`
    -  `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md`
- `docs/using-fleet/fleet-ctl-agent-updates.md` »
`docs/using-fleet/update-agents.md`
- `docs/using-fleet/chromeos.md` »
`docs/using-fleet/enroll-chromebooks.md`
- Updated the generated markdown in `server/fleet/gen_activity_doc.go`
and `server/service/osquery_utils/gen_queries_doc.go`
- Updated the navigation sidebar and mobile dropdown links on docs pages
to group pages by their `navSection` meta tag.
- Updated fleetdm.com/docs not to show pages in the `docs/contributing/`
folder in the sidebar navigation
- Added redirects for docs pages that have moved.

.

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>

2023-07-27 17:40:01 -05:00

2.1 KiB

Raw Blame History

Anatomy

This page details the core concepts you need to know to use Fleet.

Fleet UI

Fleet UI is the GUI (graphical user interface) used to control Fleet. Docs.

Fleetctl

Fleetctl (pronouced “fleet control”) is a CLI (command line interface) tool for managing Fleet from the command line. Docs.

Fleetd

Fleetd is a bundle of agents provided by Fleet to gather information about your devices. Fleetd includes osquery, Orbit, and Fleet Desktop. Docs.

Osquery

Osquery is an open-source tool for gathering information about the state of any device that the osquery agent has been installed on. Learn more.

Orbit

Orbit is an osquery version and configuration manager, built by Fleet. Docs.

Fleet Desktop

Fleet Desktop is a menu bar icon that gives end users visibility into the security and status of their machine. Docs.

Host

A host is a computer, server, or other endpoint. Fleet gathers information from an osquery agent installed on each of your hosts. Docs.

Team

A team is a group of hosts. Use teams to segment your hosts into groups that reflect your organization's IT and security policies. Docs.

Query

A query in Fleet refers to an osquery query. Osquery uses basic SQL commands to request data from hosts. Use queries to manage, monitor, and identify threats on your devices. Docs.

Policy

A policy is a specific “yes” or “no” query. Use policies to manage security compliance in your organization.

Host vitals

Host vitals are the hard-coded queries Fleet uses to populate device details.

Software library

An inventory of each host’s installed software, including information about detected vulnerabilities (CVEs).

2.1 KiB Raw Blame History Unescape Escape