Commit graph

85 commits

Author SHA1 Message Date
Lucas Manuel Rodriguez
4fe2ec58b7
Fix duplicate note and while we're at it some typos under docs/ (#32575)
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/`.
2025-09-09 19:33:18 -03:00
Eric
ee655a6953
Docs: Update broken README links, remove unused folder (#32370)
Closes: #32361

Changes:
- Updated links in the `docs/Deploy` folder's README
- Removed the `docs/Using Fleet` folder.
2025-09-03 16:18:18 -05:00
Victor Lyuboslavsky
58eef867e0
Update MySQL versions we test with to 8.4.6 and 9.4.0 (#31694)
Fixes #31693

Manually forced a run for MySQL 8.4.6 to validate.

# Checklist for submitter

- Changes not needed since this is not a product change.

## Testing

- [x] Added/updated automated tests
2025-08-08 07:19:06 +02:00
Jorge Falcon
f637cfadac
AWS Reference Architecture MySQL verison update (#31369)
- Bumping MySQL version `8.0.mysql_aurora.3.07.1` ->
`8.0.mysql_aurora.3.08.2`
2025-07-30 23:42:43 -04:00
Eric
d7eb87842e
Update Hosting Fleet documentation (#31011)
Closes: https://github.com/fleetdm/confidential/issues/11093

Changes:
- Moved the content from the AWS section of the "Hosting Fleet"
documentation page to the "Deploy Fleet on AWS with Terraform" guide
- Moved the content from the Render section of the "Hosting Fleet"
documentation page to the "Deploy Fleet on Render" guide
- Updated the Hosting Fleet page to include card links to the reference
architecture docs, the try-fleet page, and deployment guides for Render,
GCP, Kubernetes, and AWS.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-07-21 13:57:48 -05:00
Ian Littman
6f772a4405
Clean up "here" link anchors for docs, ee, and frontend dirs (#29742)
More work to fix #29720.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-06-13 15:05:52 -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
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
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
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
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
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
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
Mike McNeil
aa73c0dfd2
Update deploy-fleet.md (#27311) 2025-03-19 15:09:05 -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
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
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
Mike McNeil
78b2a6f12f
Update Reference-Architectures.md (#26702) 2025-02-28 14:35:05 -06:00
Jordan Moore
7df866754e
Correct a URL in the documentation so it doesn't 404 (#26651)
The URL was pointing to a file in the fleet-terraform repo that didn't
exist causing it to 404.
2025-02-27 09:27:15 -06:00
Robert Fairburn
94e6b972ce
Change documentation to point to new terraform repo (#26200) 2025-02-10 17:42:28 -06:00
Noah Talerman
8b23ed5262
Kubernetes: remove outdated files and update guide (#25835)
We have two ways to deploy Fleet to Kubernetes. The non-Helm way is so
old it might not work to deploy Fleet

Changes:
- Remove files for deploying Fleet to Kubernetes the non-Helm way
- Update guide to remove mention of non-Helm (kubectl) way
- Remove note in handbook about files with `_` prefix because
`docs/Deploy/_Kubernetes` was the only one.

---------

Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com>
2025-01-30 08:49:58 -06:00
Eric
6dfd114cce
Docs: Update heading links on "Hosting Fleet" page. (#25820)
Closes: #25797

Changes:
- Updated the HTML links on the "Hosting Fleet" documentation page so
they will be linkable by the "On this page" sidebar on the Fleet
website.
2025-01-28 11:59:38 -06:00
Harrison Ravazzolo
ec2a866029
Update proxy doc in reference architecture (#25230)
Small change from a slack convo -
https://fleetdm.slack.com/archives/C019WG4GH0A/p1736282697358929

Co-authored-by: Harrison John <harrisonjohn@mac.lan>
2025-01-08 16:13:46 -06:00
Katheryn Satterlee
6421a65326
Update Aurora RDS Versions (#25214)
Updated AWS Aurora versions to reflect MySQL requirements

# Checklist for submitter

Docs only change
2025-01-08 11:52:17 -06:00
Victor Lyuboslavsky
0b9f36ad03
Enable MySQL 9.1 Go tests (#25055)
Enable MySQL 9 tests in the nightly Go test run.

The tests passed in my run:
https://github.com/fleetdm/fleet/actions/runs/12552738253/job/34999129651
2025-01-02 15:36:10 -06:00
Victor Lyuboslavsky
4c463b6c2f
Use Render Redis service (#23056)
Use Render's Redis service in `render.yaml`

Successfully deployed on Render:
<img width="1009" alt="image"
src="https://github.com/user-attachments/assets/fdb79286-3336-4747-97c0-b75c7578c0e8"
/>
2025-01-02 10:07:54 -06:00
Noah Talerman
3881d0b9d6
macOS setup experience guide: end user authentication (#24990)
- Put "already configured SSO" message at the top b/c this scenario will
apply to most users
- Add missing permissions for IdP for end user auth and end user
migration
- Clean up language in docs
- Add redirects for the UI in case content moves later

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-12-27 16:33:00 +01:00
Noah Talerman
ec43ee288b
SSO guide: best practice for email 2FA (#25005)
Fleet shipped email 2FA. User story is here (#22078)

- Add best practice to guides:
  - Email 2FA for "break-glass" user
  - SSO for all other users
- Update pricing page to link to feature request instead of the user
story.

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-12-25 11:55:24 +01:00
Katheryn Satterlee
c06a6b0509
Update deploy-fleet.md (#24503)
Add link to reference architecture for users who want to self-host.

Docs-only change.
2024-12-09 10:32:57 -05:00
Konstantin Sykulev
e3c9bf67cc
Fixed broken link in Deploy/README.md (#24134)
A `monitoring-fleet.md` file does not seem to exist. Pointed the link to
the `Reference-Architectures.md` Monitoring Fleet section.
2024-12-04 15:49:22 -06:00
Eric
a95a83cf2b
Docs: change name of "Deploy Fleet" page (#23985)
Closes: #23759

Changes:
- Added a title meta tag to the "Deploy Fleet" documentation page to
change the name to "Hosting Fleet"

> Note: This only changes the title of the page in the UI on
fleetdm.com, the URL will still be `/docs/deploy/deploy-fleet`
2024-11-22 13:39:37 -06:00
Luke Heath
6c88513963
Update Reference-Architectures.md (#23990) 2024-11-22 13:39:27 -06:00
Katheryn Satterlee
3c85098821
Update Upgrading-Fleet.md (#23774)
Add TF upgrade instructions

# 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.
- [ ] Added/updated tests
- [ ] 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`).
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] 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)).

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-11-13 12:33:24 -06:00
Mike McNeil
af2a3e6a6d
Website: Follow-up to "fluffing" PR (#23715) 2024-11-11 22:53:28 -06:00
Mike McNeil
48e1d7bde1
Update single-sign-on-sso.md (#22500)
This is a really bad PR. I am sorry. I previewed it and I know it looks
horrible. Please consider it only little stickerboard of ideas.

I do, however, stand by these ideas (though not my execution of them):
- changing the first sentence to clarify whether or not this is SSO for
the Fleet console GUI/CLI experience, or if we're talking about end user
admin for employees using Fleet Desktop / getting "zero touched"
(signing into their ABM'd or autopiloted devices)
- finding some way to name Okta, and ideally the other examples I
provided, for SEO, to give people examples from a set, to get
recognizable names of the integratiion above the fold, to give people a
dash of personality by including authentik
- consolidating JIT and the other SAML implementation details into a
sentence
- unhoisting it downards (though not in the weird way I did it) -

> References:
> - ["Why read
documentation?"](https://fleetdm.com/handbook/company/why-this-way#why-read-documentation)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-11-07 08:02:28 +09:00
Harrison Ravazzolo
b1cabd20ee
Update deploy-fleet Guide (#23561)
Adding a clarifying point to the AWS deploy docs.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-11-06 12:01:04 -06:00
Neil Blazevic
58ce48dea8
Update Render deploy pricing (#23113) 2024-10-23 10:07:20 -05:00
Brock Walters
69b284f98e
Update deploy-fleet.md (#22959)
Cleaned up instructions.

# 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.
- [ ] Added/updated tests
- [ ] 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`).
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] 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)).

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-10-16 11:36:52 -05:00
JoGSal
40bd21a202
Documentation: Add clarity to deployment options (#20914)
Annotations file feedback row 15.3: Clarity is needed in order to track
what steps are required to successfully complete a deployment.

# 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. -->

---------

Co-authored-by: Joey Salazar <jgsal@yahoo.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-10-11 11:50:27 -05:00
Rebecca Cowart
a17ab39ab6
Update button name in deploy-fleet.md (#22271)
Render changed their "Apply" button to read "Deploy Blueprint"
2024-09-20 14:57:13 -05:00
Ian Littman
ab996dc57d
Note that minimum MySQL version is 8.0.36 everywhere (not just 8.0) because that's what we test with (#22072)
Also mention that we test with 8.4.2 in a few more places.

Note that while I'm editing release articles, this isn't retconning
minimum requirements; we mention in 4.55.0 release notes further down
that we expect 8.0.36.
2024-09-13 10:59:38 -05:00
JoGSal
388a2621c5
Documentation: Add referenced links to existing documentation (#20898)
Annotations file feedback row 15.1: Add links to various topics
mentioned

# 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. -->
2024-09-05 17:23:25 -05:00
JoGSal
3e10bde50c
Documentation: Add links to Mysql and Redis configuration sections (#20903)
Annotations file feedback row 15.4: remove duplicated reference and add
clarity for Mysql and Redis sections

# 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. -->

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-09-05 17:08:26 -05:00
JoGSal
50cc41c7f9
Documentation: Internationalize Render deployment guide (#20725)
Row 11: Internationalize Render deployment guide. Updated language to
reflect need to be aware of regional settings when outside the United
States.

# 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. -->

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-08-30 16:06:55 -05:00
Roberto Dip
b3eba15291
add "cache" prefix for Redis AWS Reference-Architectures.md (#21249) 2024-08-12 19:59:51 -03:00
Ian Littman
8362c328a1
Fix grammar on load balancer documentation in deploy docs (#21032)
Checklist deleted as items are irrlevant for docs updates.
2024-08-05 11:23:26 -05:00
Dante Catalfamo
5e1a3d03ae
MySQL 8.0 Migration (#20225)
#17249
2024-07-22 16:27:36 -04:00
Robert Fairburn
3972c8a004
Update ref architecture + pricing to reflect terraform module (#20234) 2024-07-05 14:28:33 -05:00
Noah Talerman
84a1c84244
Update docs: Best practice infra for deploy security agents (#19251)
- Add S3 to AWS reference architecture docs
- Add note that GCP support for add/install software (deploy security
agents) and file carves is coming soon
- Add note that Render support for add/install software (deploy security
agents) is coming soon
- Update links to best practice Terraform example
2024-05-28 14:41:54 -04:00
Eric
7bd7c023e2
Docs: Fix broken relative link on SSO docs page (#19216)
Changes:
- Fixed a broken relative link
2024-05-24 16:57:29 -05:00