Commit graph

2246 commits

Author SHA1 Message Date
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
Mike McNeil
97696ccdca
Update deploy-fleet.md (#26935)
Remove settings that aren't minimally required to make it simpler to
follow along


@rfairburn @edwardsb @lukeheath Y'all, please stop me if this is a bad
idea.
2025-03-11 15:35:51 -05:00
Marko Lisica
17904525ab
Remove GET /api/v1/fleet/vpp (deprecated and not working) (#27023)
I found that `GET /api/v1/fleet/vpp` isn't working, but is still
documented. I believe we moved to new endpoint to manage VPP tokens:
`GET /api/v1/fleet/vpp_tokens`
2025-03-11 15:34:44 -05:00
Victor Lyuboslavsky
0f3a76dd27
Add DigiCert integration dev docs. (#27039)
For #25822
2025-03-11 15:33:44 -05:00
Mike Thomas
5c8c0422fe
Add license key details to deploy docs (#26985)
Closes https://github.com/fleetdm/confidential/issues/9461

- Add license key details to deploy docs.

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
2025-03-11 07:06:52 +09:00
Noah Talerman
e4ef8cc6db
YAML reference docs (#27000)
- Fix quotes
- `macos_settings` is for all Apple platforms Fleet supports: #26096
2025-03-10 13:43:23 -05:00
Noah Talerman
273601d695
Agent configuration reference docs (#26999)
- Remove rotate enroll secret instructions because they're wrong: #25755
- Update contributor docs to simplify: #24309

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-03-10 13:36:44 -05:00
Victor Lyuboslavsky
683c93f99f
Android architecture docs (#26975)
For #23231

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
2025-03-10 13:01:57 -05:00
jacobshandling
1268036c1f
23971 Proposed API and schema changes (#25013)
## For #25034

### API changes:
[this PR diff](https://github.com/fleetdm/fleet/pull/25013/files)
("available_teams" change is adding missing documentation for current
API behavior)

### schema changes:
- new col in `users` table, `settings`, type `json`. Defaults to `{}`.
New setting, `hidden_host_columns`, added or updated on first relevant
API call per user.

### semantics

- **null** `"hidden_host_columns"` field means "not yet set, use
defaults": `{"settings":{"hidden_host_columns": null}}`
- **included and empty** `"hidden_host_columns"` field means "no columns
hidden, show all columns in the UI":
`{"settings":{"hidden_host_columns": []}}`

### Updates 1/7/25 per discussion with @rachaelshaw @lucasmrod
@sgress454:
- Optional query param `include_ui_settings=true` included with `GET`s
to `/me` or `/users/:id` will trigger considering the API call to be a
contributor API call, giving more flexibility for future changes. Note
that this is the first time we have one endpoint that can be
conditionally considered a contributor endpoint depending on how it is
called.

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-03-10 10:17:57 -07:00
George Karr
4b3e2a0f69
Create design-qa-considerations.md (#26774)
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: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com>
2025-03-07 15:32:41 -06:00
Ian Littman
014f10fb46
Add experimental software title name update endpoint for titles with a bundle ID (#26938)
For #26933.

# 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

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-03-07 11:36:17 -06:00
Eugene
31191689e8
Update yaml-files.md (#26781)
Cleaning up and standardizing use of quotations in YAML.

1. Updated to use single quotes
2. Updated to use double quotes to enclose single quote references.
3. Removed extraneous quotes around strings.
2025-03-06 17:34:44 -06:00
Rachael Shaw
f229230ada
API docs: Indentation fix in get config example (#26916) 2025-03-06 14:00:33 -06:00
Rachael Shaw
4c5aa74434
Update license in GET /config example (#26915)
Include premium license fields
2025-03-06 13:53:33 -06:00
Gabe Lopez
f51bb7c7ea
Add files via upload to replace old screenshot for SSO config (#26841)
Replacing an old screenshot for SSO-Setup that removes the `issuer URI`
field that is no longer needed nor available in Fleet

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2025-03-06 13:28:57 -06:00