Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity

Fix duplicate note and while we're at it some typos under docs/ (#32575)

Browse Source 
Fixing the following duplicate note in
`docs/Configuration/yaml-files.md`:
<img width="512" height="630" alt="Screenshot 2025-09-04 at 5 49 05 AM"
src="https://github.com/user-attachments/assets/37229d45-e9b2-4744-9fe1-1c4c54be72b0"
/>

And while we're at it... fixing some typos under `docs/`.
This commit is contained in:
Lucas Manuel Rodriguez
2025-09-09 19:33:18 -03:00
committed by GitHub
parent 8c66ebbc2f
commit 4fe2ec58b7
16 changed files with 27 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Configuration/fleet-server-configuration.md
+1 -1
View File
@@ -927,7 +927,7 @@ to the amount of time it takes for Fleet to give the host the label queries.
### osquery_enable_async_host_processing
**Experimental feature**. Enable asynchronous processing of hosts' query results. Currently, asyncronous processing is only supported for label query execution, policy membership results, hosts' last seen timestamp, and hosts' scheduled query statistics. This may improve the performance and CPU usage of the Fleet instances and MySQL database servers for setups with a large number of hosts while requiring more resources from Redis server(s).
**Experimental feature**. Enable asynchronous processing of hosts' query results. Currently, asynchronous processing is only supported for label query execution, policy membership results, hosts' last seen timestamp, and hosts' scheduled query statistics. This may improve the performance and CPU usage of the Fleet instances and MySQL database servers for setups with a large number of hosts while requiring more resources from Redis server(s).
Note that currently, if both the failing policies webhook *and* this `osquery.enable_async_host_processing` option are set, some failing policies webhooks could be missing (some transitions from succeeding to failing or vice-versa could happen without triggering a webhook request).
docs/Configuration/yaml-files.md
+1 -3
View File
@@ -509,8 +509,6 @@ Currently, for Fleet-maintained apps and App Store (VPP) apps, the `labels_` and
- `self_service` specifies whether or not end users can install from **Fleet Desktop > Self-service**.
- `categories` is an array of categories. See [supported categories](#labels-and-categories).
> Without specifying a hash, Fleet downloads each installer for each team on each GitOps run.
#### Example
##### URL
@@ -1093,7 +1091,7 @@ org_settings:
Can only be configured for all teams (`org_settings`).
Unlike other options, ommitting `smtp_settings` or leaving it blank won't reset the values back to the default.
Unlike other options, omitting `smtp_settings` or leaving it blank won't reset the values back to the default.
<meta name="title" value="GitOps">
<meta name="description" value="Reference documentation for Fleet's GitOps workflow. See examples and configuration options.">
docs/Contributing/architecture/mdm/apple-declarative-device-management.md
+2 -2
View File
@@ -31,7 +31,7 @@ Via the API (which is used by the UI), the following endpoints support DDM profi
Note that the following endpoints do _not_ support DDM profiles:
* `GET /api/latest/fleet/hosts/{id}/configuration_profiles` lists only the Apple `.mobileconfig` profiles of the host, not the DDM profiles nor the Windows profiles. See [the API reference](https://fleetdm.com/docs/rest-api/rest-api#get-configuration-profiles-assigned-to-a-host).
* `POST /api/_version_/fleet/configuration_profiles/resend/batch` batch-resends a specific configuration profile to all hosts where it is in a specific satus (e.g. "failed"). Does not support re-sending a DDM profile. See [the API reference](https://fleetdm.com/docs/rest-api/rest-api#batch-resend-custom-os-setting-configuration-profile).
* `POST /api/_version_/fleet/configuration_profiles/resend/batch` batch-resends a specific configuration profile to all hosts where it is in a specific status (e.g. "failed"). Does not support re-sending a DDM profile. See [the API reference](https://fleetdm.com/docs/rest-api/rest-api#batch-resend-custom-os-setting-configuration-profile).
Via `fleetctl gitops`, the following YAML section can be used to manage profiles:
@@ -79,7 +79,7 @@ The [various endpoint operations are handled in the Fleet implementation](https:
* `strings.HasPrefix(Endpoint, "declaration/activation")`: sends the full JSON of the corresponding activation (identified by the "Endpoint"). Activations can be used to conditionally apply configurations based on predicates, but we currently don't use that feature and send an unconditional activation.
* `Endpoint == "status"`: receives the status report of the DDM profiles on the host. If the declaration is active and valid, it is marked as "verified", and if it is invalid it is marked as "failed". Other rare cases are handled in this code, but those are the main ones. Note that [according the Roberto's research at the time](https://github.com/fleetdm/fleet/blob/afc37124eedde3a226137cca613adf3a0ff799c7/server/service/apple_mdm.go#L6084-L6093), the host will not send "remove" statuses, instead we detect removal by the fact that the declaration is not in the status report.
Note that the "status" endpoint [can carry other information](https://developer.apple.com/documentation/devicemanagement/status-reports), like changes in dynamic device state (e.g. if a declaration had a subscription requesting that information, such as battery healty, certificates, etc.). We currently only use it to update the declaration's status.
Note that the "status" endpoint [can carry other information](https://developer.apple.com/documentation/devicemanagement/status-reports), like changes in dynamic device state (e.g. if a declaration had a subscription requesting that information, such as battery health, certificates, etc.). We currently only use it to update the declaration's status.
In addition to verifying the DDM profiles from the status response of the DDM protocol, we also [update the statuses from the response of the traditional `DeclarativeManagement` command](https://github.com/fleetdm/fleet/blob/afc37124eedde3a226137cca613adf3a0ff799c7/server/service/apple_mdm.go#L3486) to do the initial transition from "pending" to "verifying" or "failed" depending on the result of the command. This batch-affects all declarations for the host.
docs/Contributing/architecture/software/vulnerability-processing.md
+6 -6
View File
@@ -315,7 +315,7 @@ The following CPE translation rule is used to reduce false positives when ruby i
This is needed because ruby is commonly included in the title in the CPE database.
This rule matches the software name `ruby` matching a regular expression pattern and installed on
the host using `homebrew`.
When searching for [CPEs](https://en.wikipedia.org/wiki/Common_Platform_Enumeration), the specifed `product` and `vendor` will be added to the filter criteria.
When searching for [CPEs](https://en.wikipedia.org/wiki/Common_Platform_Enumeration), the specified `product` and `vendor` will be added to the filter criteria.
```json
[
@@ -382,11 +382,11 @@ The CPE translation rule.
The CPE translation software match criteria. Used to match software collected from hosts. Fields are are AND'd together. Values inside each field are OR'd together.
| Name | Type | Description |
| --- | --- | --- |
| `name` | array[string] | The software name to match. Enclose within `/` to specify a regular expression pattern. |
| `bundle_identifer` | array[string] | The software bundle identifier (MacOS apps only) to match. Enclose within `/` to specify a regular expression pattern. |
| `source` | array[string] | The software source to match. Enclose within `/` to specify a regular expression pattern. |
| Name | Type | Description |
| --- | --- | --- |
| `name` | array[string] | The software name to match. Enclose within `/` to specify a regular expression pattern. |
| `bundle_identifier` | array[string] | The software bundle identifier (MacOS apps only) to match. Enclose within `/` to specify a regular expression pattern. |
| `source` | array[string] | The software source to match. Enclose within `/` to specify a regular expression pattern. |
##### CPE Translation (object)
docs/Contributing/guides/ui/design-qa-considerations.md
+1 -1
View File
@@ -85,7 +85,7 @@ This is meant to be a helpful checklist of 'events' or 'transactions' to help ca
- Remove Manual label
- Add host to an existing label
- Remove a host from a label
- Label selecion (policy / profile / software)
- Label selection (policy / profile / software)
- Include all
- Include any
- Exclude all
docs/Contributing/product-groups/mdm/android-mdm.md
+1 -1
View File
@@ -59,7 +59,7 @@ There's also a command-line tool in `tools/android` that can list/delete/etc. en
## Known issues and limitations
- The Fleet server URL must be public for pub/sub to work properly.
- The Fleet server URL cannot change -- pub/sub is set up with one URL. See issue [Allow Fleet server URL update when using Android](https://github.com/fleetdm/fleet/issues/29878)
- Network reliability issues may leave the Android enterprise flow in a broken state. For example, if fleetdm.com proxy creates an Android enteprise but Fleet server goes offline and does not receive the secret key.
- Network reliability issues may leave the Android enterprise flow in a broken state. For example, if fleetdm.com proxy creates an Android enterprise but Fleet server goes offline and does not receive the secret key.
## Architecture diagrams
docs/Contributing/product-groups/orchestration/understanding-host-vitals.md
+1 -1
View File
@@ -292,7 +292,7 @@ WITH registry_keys AS (
-- in order to account for hosts that might not have this
-- key, and servers
WHERE COALESCE(e.state, '0') IN ('0', '1', '2', '3')
-- old enrollments that aren't completely cleaned up may still be aronud
-- old enrollments that aren't completely cleaned up may still be around
-- in the registry so we want to make sure we return the one with an actual
-- discovery URL set if there is one. LENGTH is used here to prefer those
-- with actual URLs over empty string/null if there are multiple
docs/Contributing/reference/audit-logs.md
+1 -1
View File
@@ -1947,7 +1947,7 @@ This activity contains the following fields:
## added_conditional_access_integration_microsoft
Generated when Microsoft Entra is connected for conditonal access.
Generated when Microsoft Entra is connected for conditional access.
This activity does not contain any detail fields.
docs/Contributing/reference/patterns-backend.md
+2 -2
View File
@@ -27,9 +27,9 @@ Inputs corresponding to sortable or indexed DB fields should be preprocessed (tr
Invalid inputs should NOT log a server error. Server errors should be reserved for unexpected/serious issues. [`InvalidArgumentError` implements `IsClientError`](https://github.com/fleetdm/fleet/blob/529f4ed725117d99d668318aad23c9e1575fa7ee/server/fleet/errors.go#L134) method to indicate that it is a client error. [Backend sync where discussed](https://us-65885.app.gong.io/call?id=6515110653090875786&highlights=%5B%7B%22type%22%3A%22SHARE%22%2C%22from%22%3A340%2C%22to%22%3A1578%7D%5D).
### JSON unmarshaling
### JSON unmarshalling
`PATCH` API calls often need to distinguish between a field being set to `null` and a field not being present in the JSON. Use the structs from `optjson` package to handle this. [Backend sync where discussed](https://us-65885.app.gong.io/call?id=4055688254267958899). [JSON unmarshaling article and example](https://victoronsoftware.com/posts/go-json-unmarshal/).
`PATCH` API calls often need to distinguish between a field being set to `null` and a field not being present in the JSON. Use the structs from `optjson` package to handle this. [Backend sync where discussed](https://us-65885.app.gong.io/call?id=4055688254267958899). [JSON unmarshalling article and example](https://victoronsoftware.com/posts/go-json-unmarshal/).
## Go
docs/Contributing/research/software/software-version-extract.md
+1 -1
View File
@@ -95,7 +95,7 @@ dmg contents on the server, from Wikipedia:
> Hierarchical File System (HFS), HFS Plus (HFS+), File Allocation Table (FAT),
> ISO9660, and Universal Disk Format (UDF).
Becuse we can't mount a `dmg` image in the server, and unless we find a
Because we can't mount a `dmg` image in the server, and unless we find a
creative way to hack around this, we'll need to implement the logic to in Go.
The only [library I could find](https://github.com/blacktop/go-apfs) is a WIP,
docs/Deploy/Reference-Architectures.md
+2 -2
View File
@@ -299,7 +299,7 @@ GCP reference architecture can be found in [the Fleet repository](https://github
- Cloud SQL MySQL 8.0 (Fleet database)
- Memorystore Redis (Fleet cache & live query orchestrator)
GCP support for add/install software and file carve features is coming soon. Get [commmunity support](https://chat.osquery.io/c/fleet).
GCP support for add/install software and file carve features is coming soon. Get [community support](https://chat.osquery.io/c/fleet).
##### Example configuration breakpoints
###### [Up to 1000 hosts](https://cloud.google.com/products/calculator/#id=59670518-9af4-4044-af4a-cc100a9bed2f)
@@ -338,7 +338,7 @@ GCP support for add/install software and file carve features is coming soon. Get
#### Azure
Coming soon. Get [commmunity support](https://chat.osquery.io/c/fleet).
Coming soon. Get [community support](https://chat.osquery.io/c/fleet).
#### Render
docs/Get started/anatomy.md
+1 -1
View File
@@ -5,7 +5,7 @@ This page details the core concepts you need to know to use Fleet.
Fleet UI is the GUI (graphical user interface) used to control Fleet. [Learn more](https://youtu.be/1VNvg3_drow?si=SWyQSEQMoHUYDZ8C).
## Fleetctl
Fleetctl (pronouced “fleet control”) is a CLI (command line interface) tool for managing Fleet from the command line. [Docs](https://fleetdm.com/docs/using-fleet/fleetctl-cli).
Fleetctl (pronounced “fleet control”) is a CLI (command line interface) tool for managing Fleet from the command line. [Docs](https://fleetdm.com/docs/using-fleet/fleetctl-cli).
## Fleetd
Fleetd is a bundle of agents provided by Fleet to gather information about your devices. Fleetd includes:
docs/queries.yml
+4 -4
View File
@@ -323,7 +323,7 @@ spec:
-- in order to account for hosts that might not have this
-- key, and servers
WHERE COALESCE(e.state, '0') IN ('0', '1', '2', '3')
-- old enrollments that aren't completely cleaned up may still be aronud
-- old enrollments that aren't completely cleaned up may still be around
-- in the registry so we want to make sure we return the one with an actual
-- discovery URL set if there is one. LENGTH is used here to prefer those
-- with actual URLs over empty string/null if there are multiple
@@ -382,7 +382,7 @@ kind: built-in
spec:
name: Munki info
platform: darwin
description: Retrives information about the last Munki run on a macOS device.
description: Retrieves information about the last Munki run on a macOS device.
query: |
SELECT
version, errors, warnings
@@ -397,7 +397,7 @@ kind: built-in
spec:
name: Network interfaces (Chrome)
platform: chrome
description: Retrives information about a ChromeOS device's current network.
description: Retrieves information about a ChromeOS device's current network.
query: |
SELECT
ipv4 AS address, mac
@@ -546,7 +546,7 @@ kind: built-in
spec:
name: Orbit information
platform: darwin, linux, windows
description: Retreives configuration information the osquery version and configuration manager running on a device.
description: Retrieves configuration information the osquery version and configuration manager running on a device.
query: SELECT * FROM orbit_info
purpose: Informational
tags: built-in