Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/Configuration/agent-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If you are not using the latest version of osquery, you can create a config YAML
fleetctl apply --force -f config.yaml
```

You can verify that your agent options are valid by using [the fleetctl apply command](https://fleetdm.com/docs/using-fleet/fleetctl-cli#fleetctl-apply) with the `--dry-run` flag. This will report any error and do nothing if the configuration was valid. If you don't use the latest version of osquery, you can override validation using the `--force` flag. This will update agent options even if they are invalid.
You can verify that your agent options are valid by using [the `fleetctl apply` command](https://fleetdm.com/docs/using-fleet/fleetctl-cli) with the `--dry-run` flag. This will report any error and do nothing if the configuration was valid. If you don't use the latest version of osquery, you can override validation using the `--force` flag. This will update agent options even if they are invalid.

Existing options will be overwritten by the application of this file.

Expand Down Expand Up @@ -132,7 +132,7 @@ apiVersion: v1
kind: config
spec:
agent_options:
command_line_flags: # requires Fleet's osquery installer
command_line_flags: # requires Fleet's agent (fleetd)
verbose: true
disable_watchdog: false
logger_path: /path/to/logger
Expand Down Expand Up @@ -186,7 +186,7 @@ apiVersion: v1
kind: config
spec:
agent_options:
extensions: # requires Fleet's osquery installer
extensions: # requires Fleet's agent (fleetd)
hello_world_macos:
channel: 'stable'
platform: 'macos'
Expand Down Expand Up @@ -252,7 +252,7 @@ apiVersion: v1
kind: config
spec:
agent_options:
extensions: # requires Fleet's osquery installer
extensions: # requires Fleet's agent (fleetd)
hello_world_macos:
channel: 'stable'
platform: 'macos'
Expand Down Expand Up @@ -284,7 +284,7 @@ apiVersion: v1
kind: config
spec:
agent_options:
update_channels: # requires Fleet's osquery installer
update_channels: # requires Fleet's agent (fleetd)
orbit: stable
osqueryd: '5.10.2'
desktop: edge
Expand All @@ -294,7 +294,7 @@ apiVersion: v1
kind: config
spec:
agent_options:
update_channels: # requires Fleet's osquery installer
update_channels: # requires Fleet's agent (fleetd)
orbit: edge
osqueryd: '5.10.2'
# in this configuration `desktop` is assumed to be "stable"
Expand Down
8 changes: 4 additions & 4 deletions docs/Configuration/fleet-server-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,7 @@ This flag can be used to control load on the database in scenarios in which many

##### osquery_label_update_interval

The interval at which Fleet will ask osquery agents to update their results for label queries.
The interval at which Fleet will ask Fleet's agent (fleetd) to update results for label queries.

Setting this to a higher value can reduce baseline load on the Fleet server in larger deployments.

Expand All @@ -915,7 +915,7 @@ Valid time units are `s`, `m`, `h`.

##### osquery_policy_update_interval

The interval at which Fleet will ask osquery agents to update their results for policy queries.
The interval at which Fleet will ask Fleet's agent (fleetd) to update results for policy queries.

Setting this to a higher value can reduce baseline load on the Fleet server in larger deployments.

Expand All @@ -933,7 +933,7 @@ Valid time units are `s`, `m`, `h`.

##### osquery_detail_update_interval

The interval at which Fleet will ask osquery agents to update host details (such as uptime, hostname, network interfaces, etc.)
The interval at which Fleet will ask Fleet's agent (fleetd) to update host details (such as uptime, hostname, network interfaces, etc.)

Setting this to a higher value can reduce baseline load on the Fleet server in larger deployments.

Expand Down Expand Up @@ -2553,7 +2553,7 @@ stored in your database.

##### packaging_s3_bucket

This is the name of the S3 bucket to store pre-built Fleetd installers.
This is the name of the S3 bucket to store pre-built Fleet agent (fleetd) installers.

- Default value: ""
- Environment variable: `FLEET_PACKAGING_S3_BUCKET`
Expand Down
6 changes: 3 additions & 3 deletions docs/Contributing/File-carving.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## File carving

Fleet supports osquery's file carving functionality as of Fleet 3.3.0. This allows the Fleet server to request files (and sets of files) from osquery agents, returning the full contents to Fleet.
Fleet supports osquery's file carving functionality as of Fleet 3.3.0. This allows the Fleet server to request files (and sets of files) from Fleet's agent (fleetd) returning the full contents to Fleet.

File carving data can be either stored in Fleet's database or to an external S3 bucket. For information on how to configure the latter, consult the [configuration docs](https://fleetdm.com/docs/deploying/configuration#s-3-file-carving-backend).

### Configuration

Given a working flagfile for connecting osquery agents to Fleet, add the following flags to enable carving:
Given a working flagfile for connecting fleetd to Fleet, add the following flags to enable carving:

```sh
--disable_carver=false
Expand All @@ -16,7 +16,7 @@ Given a working flagfile for connecting osquery agents to Fleet, add the followi
--carver_block_size=8000000
```

The default flagfile provided in the "Add New Host" dialog also includes this configuration.
The default flagfile provided in the "Add new host" dialog also includes this configuration.

#### Carver block size

Expand Down
2 changes: 1 addition & 1 deletion docs/Deploy/deploy-on-render.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Fleet is up and running, head to your public URL.

You should be prompted with a setup page, where you can enter your name, email, and password. Run through those steps and you should have an empty hosts page waiting for you.

You’ll find the enroll-secret after clicking “Add hosts”. This is a special secret the host will need to register to your Fleet instance. Once you have the enroll-secret you can use `fleetctl` to generate installers, which makes installing and updating osquery super simple.
You’ll find the enroll-secret after clicking “Add hosts”. This is a special secret the host will need to register to your Fleet instance. Once you have the enroll-secret you can use `fleetctl` to generate Fleet's agent (fleetd), which makes installing and updating osquery super simple.

To install `fleetctl`, which is the command line interface (CLI) used to communicate between your computer and Fleet, you either run `npm install -g fleetctl` or [download fleetctl](https://github.com/fleetdm/fleet/releases/tag/fleet-v4.3.0) from Github. Once it's installed try the following command (Docker require) on your terminal:

Expand Down
2 changes: 1 addition & 1 deletion docs/Deploy/public-ip.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Public IPs of devices

Fleet attempts to deduce the public IP of devices from well-known HTTP headers received on requests made by the osquery agent.
Fleet attempts to deduce the public IP of devices from well-known HTTP headers received on requests made by Fleet's agent (fleetd).

The HTTP request headers are checked in the following order:
1. If `True-Client-IP` header is set, then Fleet will extract its value.
Expand Down
8 changes: 4 additions & 4 deletions docs/Get started/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Fleet is simple enough to [spin up for yourself](https://fleetdm.com/docs/deploy

Fleet provides a standard [Terraform module](https://fleetdm.com/docs/deploy/deploy-on-aws-with-terraform) that deploys Fleet with best practices, along with [cloud cost calculators and reference architectures](https://fleetdm.com/docs/deploy/reference-architectures#cloud-providers) used by some of Fleet’s largest customers with tens and hundreds of thousands of hosts. Fleet Premium customers can also opt for managed hosting provided by Fleet. You can also deploy Fleet anywhere you want.

You can enroll servers and laptops using a simple installer or automatically deliver the agent using your existing tools, such as Chef, Terraform, Munki/autopkg, Ansible, Puppet, Jamf, Intune, etc.
You can enroll servers and laptops using a simple installer or automatically deliver Fleet's agent (fleetd) using your existing tools, such as Chef, Terraform, Munki/autopkg, Ansible, Puppet, Jamf, Intune, etc.

By default, Fleet keeps agents up to date automatically. For self-managed instances, Fleet provides a [migration runner](https://fleetdm.com/docs/deploy/upgrading-fleet#upgrading-fleet).
By default, Fleet keeps fleetd up to date automatically. For self-managed instances, Fleet provides a [migration runner](https://fleetdm.com/docs/deploy/upgrading-fleet#upgrading-fleet).

## What options do I have for access control? What about auditing admin activity?

Expand Down Expand Up @@ -106,8 +106,8 @@ Anyone is free to contribute to the free or paid features of the project. We are

The only way we are able to partner as a business to provide support and build new open source and paid features is through customers purchasing Fleet Premium.

## How can I uninstall the osquery agent?
To uninstall the osquery agent, follow the below instructions for your operating system.
## How can I uninstall fleetd?
To uninstall Fleet's agent (fleetd), follow the below instructions for your operating system.

#### MacOS
Run the Orbit [cleanup script](https://github.com/fleetdm/fleet/blob/main/orbit/tools/cleanup/cleanup_macos.sh)
Expand Down
2 changes: 1 addition & 1 deletion docs/Get started/anatomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Fleet Desktop is a menu bar icon that gives end users visibility into the securi
The Fleetd Chrome extension enrolls ChromeOS devices in Fleet. [Docs](https://github.com/fleetdm/fleet/blob/main/ee/fleetd-chrome/README.md).

## Host
A host is a computer, server, or other endpoint. Fleet gathers information from an osquery agent installed on each of your hosts. [Docs](https://fleetdm.com/docs/using-fleet/adding-hosts).
A host is a computer, server, or other endpoint. Fleet gathers information from Fleet's agent (fleetd) installed on each of your hosts. [Docs](https://fleetdm.com/docs/using-fleet/adding-hosts).

## 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](https://fleetdm.com/docs/using-fleet/teams).
Expand Down
9 changes: 4 additions & 5 deletions docs/REST API/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ for pagination. For a comprehensive list of activity types and detailed informat
- [Get carve](#get-carve)
- [Get carve block](#get-carve-block)

Fleet supports osquery's file carving functionality as of Fleet 3.3.0. This allows the Fleet server to request files (and sets of files) from osquery agents, returning the full contents to Fleet.
Fleet supports osquery's file carving functionality as of Fleet 3.3.0. This allows the Fleet server to request files (and sets of files) from Fleet's agent (fleetd), returning the full contents to Fleet.

To initiate a file carve using the Fleet API, you can use the [live query](#run-live-query) endpoint to run a query against the `carves` table.

Expand Down Expand Up @@ -3269,7 +3269,7 @@ This report includes a subset of host vitals, and simplified policy and vulnerab

Currently supports Windows and MacOS. On MacOS this requires the [macadmins osquery
extension](https://github.com/macadmins/osquery-extension) which comes bundled
in [Fleet's osquery installers](https://fleetdm.com/docs/using-fleet/adding-hosts#osquery-installer).
in [Fleet's agent (fleetd)](https://fleetdm.com/docs/get-started/anatomy#fleetd).

Retrieves a host's MDM enrollment status and MDM server URL.

Expand Down Expand Up @@ -3306,7 +3306,7 @@ If the host exists but is not enrolled to an MDM server, then this API returns `

Currently supports Windows and MacOS. On MacOS this requires the [macadmins osquery
extension](https://github.com/macadmins/osquery-extension) which comes bundled
in [Fleet's osquery installers](https://fleetdm.com/docs/using-fleet/adding-hosts#osquery-installer).
in [Fleet's agent (fleetd)](https://fleetdm.com/docs/get-started/anatomy#fleetd).

Retrieves MDM enrollment summary. Windows servers are excluded from the aggregated data.

Expand Down Expand Up @@ -3413,8 +3413,7 @@ Retrieves a host's MDM enrollment status, MDM server URL, and Munki version.

Requires the [macadmins osquery
extension](https://github.com/macadmins/osquery-extension) which comes bundled
in [Fleet's osquery
installers](https://fleetdm.com/docs/using-fleet/adding-hosts#osquery-installer).
in [Fleet's agent (fleetd)](https://fleetdm.com/docs/get-started/anatomy#fleetd).
Currently supported only on macOS.


Expand Down
6 changes: 3 additions & 3 deletions docs/Using Fleet/Learn-how-to-use-Fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ To add your device:

1. Select **Add hosts**. In Fleet, devices are referred to as "hosts."
2. Select your device's platform.
3. Select **Download** to download your Fleet osquery installer. The download may take several seconds.
4. Open the Fleet osquery installer and follow the installation steps.
3. Select **Download** to download Fleet's agent (fleetd). The download may take several seconds.
4. Open fleetd and follow the installation steps.

> It may take several seconds for Fleet osquery to send your device's data to Fleet.

Expand All @@ -43,7 +43,7 @@ To run this query on your device:
3. Type the query you would like to run, `SELECT * FROM os_version;`.
4. Select **Run query**, then select **All hosts** (your device may be the only host added to Fleet), and finally select **Run** to execute the query.

The query may take several seconds to complete, because Fleet has to wait for the osquery agents to respond with results. Only online hosts will respond with results to a live query.
The query may take several seconds to complete, because Fleet has to wait for the Fleet's agent (fleetd) to respond with results. Only online hosts will respond with results to a live query.

> Fleet's query response time is inherently variable because of osquery's heartbeat response time. This helps prevent performance issues on hosts.

Expand Down
6 changes: 3 additions & 3 deletions docs/Using Fleet/Supported-host-operating-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Not all osquery tables are available for every OS. Please check out the [osquery
If a table is not available for your host, Fleet will generally handle things behind the scenes for you.

### M1 Macs
The osquery installer generated for MacOS by `fleetctl package` does not include native support for M1 Macs. Some values returned may reflect the information returned by Rosetta rather than the system. For example, a CPU will show up as `i486`.
Fleet's agent (fleetd) generated for MacOS by `fleetctl package` does not include native support for M1 Macs. Some values returned may reflect the information returned by Rosetta rather than the system. For example, a CPU will show up as `i486`.

### Linux
The osquery installer will run on Linux distributions where `glibc` is >= 2.2 (there is ongoing work to make osquery work with `glibc` 2.12+).
Fleet's agent (fleetd) will run on Linux distributions where `glibc` is >= 2.2 (there is ongoing work to make osquery work with `glibc` 2.12+).
If you aren't sure what version of `glibc` your distribution is using, [DistroWatch](https://distrowatch.com/) is a great resource.

> On Linux, Fleet Desktop only supports $DISPLAY `:0`.
Expand All @@ -32,5 +32,5 @@ If you aren't sure what version of `glibc` your distribution is using, [DistroWa
> The `fleetctl package` command is not supported on DISA-STIG distribution.

<meta name="pageOrderInSection" value="1200">
<meta name="description" value="This page contains information about operating systems that are compatible with the osquery agent.">
<meta name="description" value="This page contains information about operating systems that are compatible with Fleet's agent (fleetd).">
<meta name="navSection" value="The basics">
Loading