Commit graph

2360 commits

Author SHA1 Message Date
Jordan Montgomery
149cd9daca
Tweak MDM detection query to return the proper enrollment when there are multiple entries (#29360)
This change is deceptively simple but helps us choose the right one in
cases like #29042 where there are multiple enrollments in the registry.
In this case the customer seems to have been using something like
co-management(though even using their MDM we have not repro'd
internally) which leads to 2 registry keys in the registry with a UPN
node. I believe the way some MDM services handle unenroll can also leave
the registry keys in this state. Either way, because of this, and the
fact that we have a LIMIT 1 in the query, we were, in 50% of the cases
where we had multiple keys, returning the less useful of the nodes from
the query and because no Server URL was coming back we were treating it
as if the host was not MDM enrolled and thus, not unenrolling it, and
leading to enrollment failing.

With this change we'll return the proper registry key which should allow
us to, in the case of migration, properly unenroll the host and even in
the case where a customer isn't using Fleet MDM will allow us to display
the correct information from the registry.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Manual QA for all new/changed functionality
2025-05-22 14:08:05 -04:00
Janis Watts
8b64e498de
Update Kinesis testing steps (#29370) 2025-05-22 12:07:06 -05:00
Rachael Shaw
97bb6a124b
API docs: Clarify software install statuses (#29203)
Clarify options for software install status filters on "List hosts"
endpoint.

---------

Co-authored-by: Ian Littman <iansltx@gmail.com>
2025-05-21 10:21:54 -05:00
Konstantin Sykulev
a42167462f
Added SHA256 hash from mac apps on install paths (#29280)
https://github.com/fleetdm/fleet/issues/25545

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/guides/committing-changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [x] Added/updated automated tests
- [x] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/workflows/fleetd-development-and-release-strategy.md)).
- [x] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [x] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2025-05-20 23:38:59 -05:00
Dale Ribeiro
168d41a773
Update rest-api with additional_queries correction.md (#29184)
The additional_queries property in the modify configuration endpoint is
not a boolean. It should be an object that contains a key/value pair
with the name of the query and the query itself. I updated the
description and example to reflect this and match what we have in our
GitOps docs: https://fleetdm.com/docs/configuration/yaml-files#features

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-05-20 13:13:25 -05:00
Luke Heath
030c61ca17
Update contrib docs headers to sentence case (#29276) 2025-05-20 11:26:35 -05:00
Victor Lyuboslavsky
396a3f2edc
Fixed/updated SCIM contributor guide. (#29257) 2025-05-19 11:29:36 -05:00
Luke Heath
7380919dc3
Organize contributor docs and establish ADR process and template (#29101) 2025-05-17 15:03:52 -05:00
Gabe Lopez
9132627c89
Update Testing-and-local-development.md (#28892) 2025-05-16 10:15:21 -05:00
Eric
27b8dbd585
Docs: Update macOS software host vital query (#29139)
Changes:
- Updated the macOS software host vital query
2025-05-15 18:26:35 -05:00
Harrison Ravazzolo
2d5219b447
clarifying section of webhooks (#29168)
Adding a clarification note to the documentation for gitops

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-05-15 16:49:46 -05:00
Jordan Moore
503a6b5e76
Documentation updates to Gitops sso_settings section (#29110)
Documentation updates to flip-flop the descriptions for
`enable_jit_provisioning` and `enable_sso_idp_login`
2025-05-15 15:09:02 -05:00
Victor Lyuboslavsky
7c8710996e
Research doc for Apple user channel. (#29016) 2025-05-14 11:20:02 -05:00
Ian Littman
3edf684db1
Add backend for uninstalls in My device UI (#29035)
For #28846. Intentionally not limited to self-service/in-scope apps,
though we don't have any software listing changes in this PR to show
more titles in the self-service list.

QA plan is a bit light due to ticket being underspec'd. Can figure out
how we deal with that later.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added/updated automated tests
- [ ] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-05-13 12:14:45 -05:00
Katheryn Satterlee
9ea5ecde68
Add neon to Linux platform list (#28977)
Added `neon` to list of Linux platforms associated with hosts so that
Linux-specific detail queries and policies will be sent to hosts running
the XDE Neon operating system.

This does not guarantee full compatibility with Neon, but will improve
telemetry.

Resolves #28560 


# Checklist for submitter


If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Added/updated automated tests
- [ ] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [ ] Manual QA for all new/changed functionality
2025-05-12 17:37:21 -05:00
Eric
1f0c723589
Docs: Fix urls of two images on SSO page (#28990)
Closes: #28972

Changes:
- Fixed two broken image URLs on the SSO documentation page.
2025-05-08 17:30:28 -05:00
Victor Lyuboslavsky
6f9030ee3c
SCIM Entra ID support (#28832)
For #28196

This PR adds full patching for SCIM Users and Groups, and adds the
ability to filter Groups by displayName.

The changes have been tested with [Entra ID SCIM
Validator](67dfd91c0c/docs/Contributing/SCIM-integration.md (entra-id-integration))
and Okta SCIM 2.0 SPEC Test (to make sure we didn't break Okta).

# Checklist for submitter
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-05-08 13:02:49 -05:00
Martin Angers
48de857dca
BRP: add batch-resend profile to hosts endpoint based on status (#28871) 2025-05-07 16:48:18 -04:00
Mike Thomas
e92feb17b7
Update single-sign-on-sso.md (#28193)
I've updated this section to include information about SCIM as per this
[website request](https://github.com/fleetdm/fleet/issues/27971) from a
Fleet contributor.

Please confirm that I have understood correctly and that this is
accurate.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-05-07 15:47:12 -05:00
Mike Thomas
a91042ae02
Update queries.yml (#28897)
uppercase 'S' was breaking the query.
2025-05-07 14:48:08 -05:00
Noah Talerman
7262c6ed0a
GitOps reference (#28877)
- Learned during NYC GitOps training that it's more intuitive to
explicitly set `macos_updates.deadline` to a string
- I think let's pick one of single quotes or double quotes and be
consistent: let's go with double quotes
2025-05-06 16:44:53 -05:00
jacobshandling
55bacd830c
Add link to mocks README (#28382) 2025-05-06 15:58:21 -05:00
Victor Lyuboslavsky
3d3d43864a
Bumping MySQL 8.4.3->8.4.5 and 9.1.0->9.3.0 in tests. (#28767)
I forced a test run on 9.3.0 (which only runs nightly be default).
2025-05-02 13:40:11 -05:00
Marko Lisica
64152febc9
[Docs update] Call out that mdm.macos_setup in config and team endpoint is set only by GitOps (#28695)
Called out that `mdm.macos_setup` in GET config and GET team is only set
by YAML files.

Related to: 

- #28497
2025-05-01 13:59:09 -04:00
Victor Lyuboslavsky
f831318c85
Documenting POC investigation for account-driven user enrollment (#28661)
For #27391
2025-04-30 13:08:25 -05:00
Noah Talerman
e4bbe185a8
Update reference docs/guides: reset automations (#28677)
Update guides to clarify current behavior and best practice.

More context here:
https://github.com/fleetdm/fleet/issues/28611#issuecomment-2841952742
2025-04-30 13:00:00 -05:00
Dale Ribeiro
d51c8324fb
Added update custom device mapping (#28654)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-30 12:59:08 -05:00
Rachael Shaw
ba89eca450
Docs: Update note about human-device mapping endpoints (#28665)
We added the "Edit" endpoint back to the docs.
2025-04-29 16:28:43 -05:00
Dale Ribeiro
d3cab6fa7c
Updated human-device mapping deprecation info (#28653)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-04-29 14:27:23 -05:00
Victor Lyuboslavsky
eac6ccb4e4
Contributor docs for bootstrap pkg (#28609) 2025-04-28 15:36:38 -05:00
Jordan Montgomery
a7967a398c
Update DigiCert integration contributor doc for renewal (#28517)
Updates contributor doc based on recently merged DigiCert renewal
changes

I'm not sure if leaving the "admin" on that last mermaid doc was the
right thing to do but I wanted to make it clear this all happens
automatically without admin intervention once setup
2025-04-28 11:30:56 -04:00
Ian Littman
94b3761bfb
Sync docs (#28582) 2025-04-28 10:08:30 -05:00
Rachael Shaw
7ae8b9a3da
Documentation changes for v4.67.0 (#28528)
Docs for the 4.67.0 release.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Drew Baker <89049099+Drew-P-drawers@users.noreply.github.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
2025-04-24 16:10:41 -05:00
Ian Littman
49c49c7433
Implement self-service install status endpoints (#28424)
For #28411.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-04-24 12:20:21 -05:00
Rachael Shaw
0c95e92b5a
Revert changes to batch-run script docs
Merged into wrong branch; for 4.68
2025-04-22 18:08:32 -05:00
Rachael Shaw
13b9b885c1
Bulk script doc spruce up (#28471)
Move around some parameters and mark `script_id` required

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Jahziel Villasana-Espinoza <jahziel@fleetdm.com>
2025-04-22 18:02:54 -05:00
Rachael Shaw
b1ea8dd757
Rename "Get host's scripts" -> "List host's scripts" (#28470)
Keeps the naming consistent.
2025-04-22 17:42:21 -05:00
Rachael Shaw
39ca7a1856
REST API docs: Move "Get host's scripts" under "Scripts" heading (#28469) 2025-04-22 17:38:55 -05:00
Noah Talerman
c4bf51e9a1
API docs: Bulk => batch (#28460)
Batch run script API coming soon...

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-22 17:32:30 -05:00
Rachael Shaw
9404dafbea
Docs: Update bulk transfer/delete hosts formatting (filters in a separate table) (#28457)
Move `filters` parameter into its own table to make it easier to
understand what the available filters are.
2025-04-22 15:49:56 -05:00
Raiven
42a847d076
docs: Update Adding-new-endpoints.md (#28377)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-04-21 10:11:02 -05:00
Noah Talerman
1393d7bcd9
Puppet module: remove guide and update docs (#28335)
We don't think anyone is using it so we want to remove it in Fleet 5
(next major version).

- More context here: https://github.com/fleetdm/fleet/issues/28334
2025-04-18 16:47:11 -04:00
Mike Thomas
3d9958df66
add-button-ids-to-deploy-docs (#28319)
I'm testing out user behavior in HotJar. Need to add some IDs to buttons
to properly track and test.
2025-04-18 11:19:56 -05:00
Victor Lyuboslavsky
ce9467070e
Move backend patterns.md to docs/Contributing (#28243)
As discussed in a recent Backend sync, moving patterns.md to
docs/Contributing
2025-04-16 13:36:14 -05:00
Noah Talerman
f4ffaf0d07
GitOps reference: add links for configuration profile variables (#28260)
Link to GitLab and Apple docs
2025-04-15 14:39:01 -05:00
Marko Lisica
57d73fcd6c
End user authentication wasn't documented as subsection of MDM under PATCH /config endpoint (#28244)
`end_user_authentication` isn't documented as all other endpoints under
`mdm` in `PATCH /config` endpoint.

I also removed `issuer_uri` as this isn't implemented to this endpoint.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-15 20:00:05 +02:00
Jahziel Villasana-Espinoza
fa8c087abf
fix: change how macOS software names are calculated to avoid erroneous duplicates (#28037)
> For #24087 

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-04-11 19:19:07 -04:00
Katheryn Satterlee
801d97f496
Update Upgrading-Fleet.md (#28112)
Add clear language around the requirement for Fleet to be offline during
the upgrade process.
2025-04-11 17:32:08 -05:00
Adam Anklewicz
c8d9dd81dc
Update yaml-files.md (#28028)
Received an error from GitHub Actions stating it was expecting a string
and got a number. Added quotes and it worked. Changing the documentation
to match.
2025-04-11 17:31:12 -05:00
Noah Talerman
dce7bbe48b
API reference: add missing yara_rules to PATCH /config (#27976)
Based on community feedback here:
https://github.com/fleetdm/fleet/issues/27569#issuecomment-2775322232
2025-04-11 17:10:56 -05:00
Jordan Montgomery
0ffdc14596
Update Autopilot testing info (#28125)
Updates the relevant Contributing doc based on what Gabe and I learned
while testing Autopilot
2025-04-11 14:31:02 -04:00
Rachael Shaw
06f8ed8f3b
Update labels API docs (#28119)
Improvements/fixes for manual label documentation.

Follow-up from this old draft PR:
https://github.com/fleetdm/fleet/pull/23589

---------

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
2025-04-11 09:17:13 -05:00
jacobshandling
bc6dc21ac9
Add host id to fleet enrolled activity (#28068)
## For #26695 

<img width="1795" alt="Screenshot 2025-04-09 at 7 25 25 PM"
src="https://github.com/user-attachments/assets/edeb5c51-9643-4fe0-8171-0400f513373f"
/>


- [x] Changes file added for user-visible changes in `changes/`
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-04-10 13:50:14 -07:00
Eric
747af2247b
Update query for "Software codesign" vital (#28092)
Changes:
- Updated the query for the "Software codesign" host vital. (The vital
was incorrectly using the same query as the "Software (macOS)" host
vital)
2025-04-10 15:02:05 -05:00
Martin Angers
00149cb5a9
Cancel upcoming activities: create past canceled activities (#27956) 2025-04-09 16:08:51 -04:00
Rachael Shaw
4cff3790be
Mark DigiCert and custom SCEP CA experimental (#27988)
@marko-lisica's previous PR: https://github.com/fleetdm/fleet/pull/27724
(needed to change base branch to `main` because `docs-v4.66.0` was
merged).
2025-04-09 16:08:40 -04:00
Victor Lyuboslavsky
087d7209fe
Updated SSO user contributing docs. (#27981)
For #27284
2025-04-08 10:53:58 -05:00
Victor Lyuboslavsky
3d0025c570
SCIM + host integration (#27880)
For #27284

This PR:
- Adds SCIM as a fallback for username during macOS end user
authentication during setup experience
- Adds SCIM/endUsers details to host details

# Checklist for submitter
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-04-08 09:35:06 -05:00
Allen Houchins
c57fc2d03e
Fixed policy check for macOS - Disable guest account (#27531)
I created and tested the fix before seeing the [comment in this
issue](https://github.com/fleetdm/fleet/issues/24417).

Feel free to merge the fix or close this out but I made this pull
request since we had another customer report this issue today.
2025-04-08 08:52:05 -05:00
Rachael Shaw
76cab7fdba
Add missing commas in example response (#27964) 2025-04-07 20:04:32 -05:00
Victor Lyuboslavsky
0f65252517
Fixed wrong API verb. (#27954)
For #27284
2025-04-07 18:47:11 -05:00
Mike McNeil
8452eff7f0
Apple Intelligence enabled? (#27866)
Add Allen's Apple Intelligence check to the policy library so that any
user can import/copy+paste and use it directly without writing SQL.


https://www.linkedin.com/posts/allenhouchins_fleet-it-infosec-activity-7257454593012322304-yvek

---------

Co-authored-by: Allen Houchins <allenhouchins@mac.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2025-04-07 18:40:37 -05:00
Dale Ribeiro
33eb54d013
Update single-sign-on-sso.md (#27784)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.

---------

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
2025-04-04 18:04:18 -05:00
Allen Houchins
97c9b651e1
Update fleet-server-configuration.md (#27868)
Fixed typo
2025-04-04 17:44:19 -05:00
Lucas Manuel Rodriguez
5c7599764d
Run make generate-doc (#27911)
This will fix CI on `main`.
2025-04-04 16:27:09 -05:00
Ian Littman
65ba89e60c
Update FMA docs to include Windows + current instructions/impl details (#27828)
For #26716.

Also moves the article to an OS-independent URL, updates links from
elsewhere, and adds a bit more internal-link juice for install
automation.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-04 14:55:27 -05:00
Rachael Shaw
c592c2b24e
Docs v4.66.0 (#27844)
Documentation changes for the 4.66.0 release.

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Marko Lisica <markol.lisica@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Dante Catalfamo <43040593+dantecatalfamo@users.noreply.github.com>
2025-04-04 14:28:09 -05:00
Victor Lyuboslavsky
61a7b70b5d
SCIM integration tests (#27750)
For #27287

This PR adds integration tests for SCIM API endpoints as well as some
bug fixes found by these tests.

# Checklist for submitter

- [x] Added/updated automated tests
- [x] Manual QA for all new/changed functionality
2025-04-04 11:00:46 -05:00
Luke Heath
28232b5c11
Update API-Versioning.md (#27855) 2025-04-04 10:34:27 -05:00
George Karr
28a82b19c9
Create certs.md (#27013) 2025-04-03 14:19:00 -05:00
Eric
dd06b2a414
Docs: Remove "Time and date are configured to be updated automatically (macOS)" policy (#27788)
Closes: #27460

Changes:
- Removed the "Time and date are configured to be updated automatically
(macOS)" policy from the standard query library yaml. The policy checks
a value that can only be set on iOS devices
(https://developer.apple.com/documentation/devicemanagement/restrictions#:~:text=forceAutomaticDateAndTime).
2025-04-02 16:30:49 -05:00
Scott Gress
fc3cd3b33f
Add docs for upgrading Go (#27693)
For #27605 

Adds a guide to the contributor docs about how to upgrade the Go version
used to build Fleet.
2025-04-02 15:30:32 -05:00
Victor Lyuboslavsky
15c84b67f7
Added contributing docs for end user authentication. (#27690)
For #23236
2025-04-02 13:03:52 -05:00
Victor Lyuboslavsky
2801eab201
Tweaks to high level Fleet diagram. (#27749) 2025-04-02 11:34:51 -05:00
Victor Lyuboslavsky
2198fd8d65
Add SCIM Users (#27551)
For #27287

Video explaining the PR: https://www.youtube.com/watch?v=ZHgFUAvrPEI

This PR adds SCIM Users support for Okta. The goal is to first add
Users/Groups support so that the remaining backend SCIM work can be done
in parallel.

This PR does not include the following, which will be added in later PRs
- Changes file
- Groups support for Okta
- Full support for Entra ID
- Integration tests

# Checklist for submitter

- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-04-01 11:02:24 -05:00
Victor Lyuboslavsky
ea8b81993e
Updating DigiCert/SCEP contributor docs. (#27625) 2025-03-31 13:50:05 -05:00
Scott Gress
59f96651b6
Update to Go 1.24.1 (#27506)
For #26713 

# Details

This PR updates Fleet and its related tools and binaries to use Go
version 1.24.1.

Scanning through the changelog, I didn't see anything relevant to Fleet
that requires action. The only possible breaking change I spotted was:

> As [announced](https://tip.golang.org/doc/go1.23#linux) in the Go 1.23
release notes, Go 1.24 requires Linux kernel version 3.2 or later.

Linux kernel 3.2 was released in January of 2012, so I think we can
commit to dropping support for earlier kernel versions.

The new [tools directive](https://tip.golang.org/doc/go1.24#tools) is
interesting as it means we can move away from using `tools.go` files,
but it's not a required update.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [X] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- [x] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [X] Make sure fleetd is compatible with the latest released version of
Fleet
   - [x] Orbit runs on macOS  , Linux   and Windows. 
- [x] Manual QA must be performed in the three main OSs, macOS ,
Windows and Linux .
2025-03-31 11:14:09 -05:00
Eric
ac390757f9
Docs: update title meta tag & h1 on yaml-files page (#27519)
Closes: #26503

Changes:
- Updated the heading and `<meta>` title of the yaml-files.md
documentation page to be "GitOps" (Note: the URL will not change)
2025-03-27 10:45:30 -05:00
Eric
f351cb2820
Docs: Break tutorials and guides page into two sections (#27521)
Closes: #27261

Changes:
- Updated the tutorials-and-guides docs page to have two lists of
guides: "Get set up" and "Further learning"
2025-03-26 16:46:13 -05:00
RachelElysia
c7e243d618
Fleet docs: Fix spelling and grammar (#27528)
## Description
- Documentation spelling and grammar fixes
2025-03-26 16:45:23 -05:00
Victor Lyuboslavsky
23a55cc1aa
Update MDM-Android.md -- improve class diagram display (#27538) 2025-03-26 13:09:49 -05:00
Eric
11d7f51b7f
Docs: Update vitals in queries.yml (#27373)
Closes: https://github.com/fleetdm/confidential/issues/10005

Changes:
- Updated the vitals in docs/queries.yml to have the latest changes from
docs/contributing/understanding-host-vitals.md (updated the software
vitals for Windows and macOS, added the host certificate vital, added
two python packages vitals)
2025-03-24 11:41:05 -05:00
Benjamin Edwards
c6178c64cd
add configuration setting for forcing h2c (#26799) 2025-03-21 09:38:21 -04:00
Lucas Manuel Rodriguez
e6cb16453e
Added more logging for troubleshooting of software package installation (#27291)
For #27234.

- Improved logging in orbit to help us during troubleshooting.
- Added some documentation on how to grep for errors related to software
package installation in orbit.
- Added `took` to server request error logs (it was only present when
the request succeeds).

---

- [X] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [X] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [x] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [x] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [x] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [x] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2025-03-20 11:09:57 -03:00
Mike McNeil
21dfccc655
Update fleet-server-configuration.md (#27313) 2025-03-19 15:09:34 -05:00
Mike McNeil
aa73c0dfd2
Update deploy-fleet.md (#27311) 2025-03-19 15:09:05 -05:00
Marko Lisica
84892741dd
Merge Android docs changes (#27221)
Related to: 

- #23231
2025-03-19 10:03:02 -05:00
Victor Lyuboslavsky
6b7d232522
Additional CA validation (#27169)
For #26623

- Updated `github.com/groob/plist` to `github.com/micromdm/plist` -- it
was renamed
- Added validation that restricts DigiCert Fleet variables to
`com.apple.security.pkcs12` payloads plus additional restrictions
- Added validation that restricts Custom SCEP Fleet variables to
`com.apple.security.scep` payloads plus additional restrictions
- Enabled multiple CAs (Fleet variables) to be present in an Apple MDM
profile. But each CA can only be used once. For example, we can have
DigiCert CA and Custom SCEP CA in one Apple profile.

# Checklist for submitter
- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-03-19 08:27:55 -05:00
Noah Talerman
ac9072ab95
API reference (#27197)
Do we need the “by ID”? I wonder if we could pull that out (less words
and it’s consistent with other endpoints)
2025-03-17 13:44:48 -05:00
Jorge Falcon
9affceb6d1
Typo fix in agent-configuration.md (#27148)
Fixing typo on L3. 
- "fleed" -> "fleetd"
2025-03-17 12:33:17 -05:00
Victor Lyuboslavsky
131a52695b
Custom SCEP integration (#27121)
For #26623 

This PR enables deploying an Apple configuration profile with Fleet
proxying a custom SCEP server.

# Checklist for submitter

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-03-17 10:59:07 -05:00
Jahziel Villasana-Espinoza
d0f70c5980
fix: report a failure in setup experience if a VPP app installation fails due to lack of licenses (#27163)
> For #26345

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-03-17 09:43:51 -04:00
Rachael Shaw
3679471a99
API docs: Combine policies and team policies (#27167)
Document all policies API endpoints under "Policies" instead of having 2
separate sections:

![Screenshot 2025-03-14 at 4 51
44 PM](https://github.com/user-attachments/assets/96546c23-dea9-41cd-8ef9-ad692a6667fb)


Also renamed "Remove policy" to "Delete policy" to make language more
consistent w/ other endpoints.
2025-03-14 16:54:03 -05:00
Lucas Manuel Rodriguez
46c9f9a37b
Fix auto generated docs on main (#27165)
Ran `make generate-doc`.
2025-03-14 17:41:57 -03:00
Rachael Shaw
990322321d
Documentation changes for v4.65.0 (#27108)
Documentation changes for the 4.65.0 release

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
2025-03-14 14:54:48 -05:00
Rachael Shaw
3333139496
Small indentation fix in API docs (#27158) 2025-03-14 14:31:10 -05:00
Ian Littman
1537eb710f
Revise discovery queries for Python software inventory to be compatible with earlier versions of osquery (#27130) 2025-03-13 17:32:06 -06:00
Noah Talerman
76071505ff
YAML reference docs: custom targets (labels) is Premium only (#27109) 2025-03-13 16:51:54 -05:00
Teffen Ellis
f61c8e8800
Add instructions for single sign-on via authentik. (#27079)
Hi Fleet team!

I'm an engineer at authentik and I've been working on a guide to help
our users integrate Fleet with authentik as an identity provider. While
our own documentation is still in progress, I wanted to contribute this
guide to the Fleet documentation to help our users get started with SSO.

This PR expands Fleet's Single Sign-on guide to include a section for
[authentik](https://goauthentik.io) as an identity provider.

Please let me know if I can provide any additional information or make
any changes to this PR.

Thank you for considering this contribution!
2025-03-12 13:55:12 -05:00
Martin Angers
e7d6a36c2c
Add contributor doc explaining the upcoming activities queue (#27071) 2025-03-12 11:55:56 -04:00