Instant deployment with Fleet Managed Cloud. Join the beta
Welcome to the documentation for Fleet, the lightweight telemetry platform for servers and workstations.
Install osquery and Fleet
Get startedCan't find what you need?
SupportApplies only to Fleet Premium
ℹ️ In Fleet 4.0, Teams were introduced.
In Fleet, you can group hosts together in a team.
With hosts segmented into exclusive teams, you can apply specific queries, policies, and agent options to each team.
For example, you might create a team for each type of system in your organization. You can name the teams Workstations
, Workstations - sandbox
, Servers
, and Servers - sandbox
.
A popular pattern is to end a team’s name with “- sandbox”, then you can use this to test new queries and configuration with staging hosts or volunteers acting as canaries.
Then you can:
Enroll hosts to one team using team specific enroll secrets
Apply unique agent options to each team
Schedule queries that target one or more teams
Run live queries against one or more teams
Grant users access to one or more
To view teams:
In the top navigation select "Settings" and then "Teams."
To create a team:
In the top navigation select "Settings" and then, in the sub-navigation, select "Teams."
To the left of the search box, select "Create team."
Enter your new team's name and select "Save."
Hosts can only belong to one team in Fleet.
You can add hosts to a new team in Fleet by either enrolling the host with a team's enroll secret or by transferring the host via the Fleet UI after the host has been enrolled to Fleet.
To automatically add hosts to a team in Fleet, check out the "Adding hosts" documentation.
If a host was previously enrolled using a global enroll secret, changing the host's osquery enroll secret will not cause the host to be transferred to the desired team. You must delete the
osquery/osquery.db
file on the host, which forces the host to re-enroll using the new team enroll secret. Alternatively, you can transfer the host via the Fleet UI, the fleetctl CLI usingfleetctl hosts transfer
, or the transfer host API endpoint.
Hosts can be transferred to a different team they've has been enrolled to Fleet.
To transfer a host to a team:
In the top navigation, select "Hosts."
Using the checkboxes in the Hosts table, select the hosts you'd like to transfer.
In the Hosts table header select "Transfer to team."
Choose the team you'd like to transfer the hosts to and confirm the action.
Global users cannot be added to a team.
To add users to a team:
In the top navigation, select "Settings" and then, in the sub-navigation, select "Teams."
Find your team and select it.
To the left of the search box, select "Add member."
Select one or more users by searching for their full name and confirm the action.
Users will be given the Observer role when added to the team. The Edit a member's role provides instructions on changing the permission level of users on a team.
To edit a member's role:
In the top navigation, select "Settings" and then, in the sub-navigation, select "Teams."
Find your team and select it.
In the Members table, select the "Actions" button for the user you'd like to edit and then select "Edit."
In the Teams section of the form, to the right of the team you'd like to change the users role on, select "Observer" (this may also say "Maintainer") and then select the new role.
Confirm the action.
To remove a member from a team:
In the top navigation, select "Settings" and then, in the sub-navigation, select "Teams."
Find your team and select it.
In the Members table, select the "Actions" button for the user you'd like to edit and then select "Remove."
Confirm the action.
To delete a team:
In the top navigation, select "Settings" and then, in the sub-navigation, select "Teams."
Find your team and select it.
On the right side, select "Delete team" and confirm the action.
If you notice something we've missed or could be improved on, please follow this link and submit a pull request to the Fleet repo.