Commit Graph
34 Commits
Author SHA1 Message Date
Eric e71b8cdd3b Docs: add keywordsForDocsearch meta tags (#44544)
Related to: https://github.com/fleetdm/fleet/issues/12704

Changes:
- Added `keywordsForDocsearch` meta tags to documentation pages.
2026-05-04 16:21:18 -05:00
b93a530b83 Fleet server configuration docs: Clarify S3 endpoint_url override behavior and region fallback (#42798)
@noahtalerman: For the following bug:
- https://github.com/fleetdm/fleet/issues/43160

## Summary

- Condense and relocate the S3 `endpoint_url` override warning from the
general `## S3` section header into the individual `endpoint_url`
setting sections
- The primary warning now lives in
`s3_software_installers_endpoint_url`; the `s3_carves_endpoint_url` and
`packaging_s3_endpoint_url` sections cross-reference it
- Condense region-discovery notes similarly (primary in
`s3_software_installers_region`, cross-references elsewhere)
- Condense the Reference Architectures S3 section to a single paragraph

## Changes

**`docs/Configuration/fleet-server-configuration.md`:**
- Removed the large callout block under `## S3`
- Added concise warning to `s3_software_installers_endpoint_url` with
link to [#42349](https://github.com/fleetdm/fleet/issues/42349)
- Added concise note to `s3_software_installers_region`
- Updated `s3_carves_endpoint_url`, `s3_carves_region`,
`packaging_s3_endpoint_url`, and `packaging_s3_region` with short
cross-references

**`docs/Deploy/Reference-Architectures.md`:**
- Condensed the `S3 configuration for AWS deployments` section to a
single paragraph with link to the config reference

## Related

- Relates to #42349

---

Built for
[ntalerman](https://fleetdm.slack.com/archives/D0AEA6U4SM9/p1775051868003859?thread_ts=1775051234.724799&cid=D0AEA6U4SM9)
by [Kilo for Slack](https://kilo.ai/features/slack-integration)

---------

Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2026-05-04 09:49:33 -04:00
Ian Littman c9d97d01ce Switch recommended Redis version to 7 (#42694)
We're keeping the tested version at 6 for now until we have a CI matrix
to test multiple versions. We run both 6.x and 7.x in production and if
we shipped 7+ code we'd break things.

This PR also fixes a spot I missed when mentioning MySQL version
compatibility.
2026-03-30 17:29:29 -05:00
Magnus Jensen 188dbcce0d Add missing space in note in Reference Architectures documentation (#42622) 2026-03-30 17:20:15 -05:00
Noah Talerman 09590bc6e2 "Teams" => "fleets", "queries" => "reports" doc changes (#39585) 2026-03-11 23:41:14 -05:00
Robert Fairburn 135f0cff4c Update AWS Pricings in ref arch (#41110) 2026-03-06 11:41:23 -06:00
Ian Littman 7d4acdc5c4 Bump supported MySQL versions (#40892)
Fixes #40975.

8.0.32 (was running in Aurora managed cloud at the time) -> 8.0.39 (what
we're running now) 8.0.36 -> 8.0.44 (latest 8.0.x version supported by
Aurora; holding off on 8.0.45 until Aurora supports it) 8.4.7 -> 8.4.8
9.5.0 -> 9.6.0

Also bumped the supported Aurora version from 3.07.0 to 3.08.2 to match
what we're running in managed cloud right now

Fleet might work on older patch versions but we'll no longer dev/test on
them. MySQL 9.x not testing previous minor versions matches with our
previous approach for that version.

Since these are all patch/minor bumps (and the overnight build cases are
patch bumps/are covered by AWS envs) automated testing should be
sufficient here.
2026-03-04 12:25:20 -06:00
Victor Lyuboslavsky 321ed1dc12 Update MySQL versions we test with to 8.4.7 and 9.5.0 (#36803)
<!-- Add the related story/sub-task/bug number, like Resolves #123, or
remove if NA -->
**Related issue:** Resolves #36801

Test and docs changes only.

Passing 8.4.7 tests in this workflow run:
https://github.com/fleetdm/fleet/actions/runs/19978256106/job/57299389148
2025-12-08 09:12:05 -06:00
Marko Lisica daae2c1c06 Update MySQL support details in Reference Architectures (#35706)
Added information about supported database setups and resource
provisioning for multiple Fleet instances.

Related to:

- #35400

We got a community member trying to install Fleet in a way we don't
test, but it's not explicitly documented that we don't support that way.
2025-11-14 11:28:44 -05:00
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
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
Ian LittmanandNoah Talerman 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
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
Mike McNeil 78b2a6f12f Update Reference-Architectures.md (#26702) 2025-02-28 14:35:05 -06:00
Robert Fairburn 94e6b972ce Change documentation to point to new terraform repo (#26200) 2025-02-10 17:42:28 -06:00
Harrison RavazzoloandHarrison John 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
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
Luke Heath 6c88513963 Update Reference-Architectures.md (#23990) 2024-11-22 13:39:27 -06: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
JoGSalandRachael Shaw 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
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
EricandMike Thomas 2dd7b6e564 Website: add "Deploy Fleet" docs page. (#18992)
https://github.com/fleetdm/fleet/issues/16660

Changes:
- Added a new page (deploy-fleet.md) to the deploying docs
- Moved the content from the following pages to the
deploy/reference-architectures page:
  - Systemd
  - Proxies
  - Public IPs
  - Monitoring Fleet
  - Introduction
- Reordered the pages in the Deploy docs folder
- Added a redirect: `/docs/deploy/introduction »
/docs/deploy/deploy-fleet`

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2024-05-15 13:56:36 +09:00
RachelElysiaandRachael Shaw f076769ee2 Documentation: Spelling and grammar fixes (#16403)
---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-06 09:19:42 -05:00
Rachael Shaw 283e694e06 Fix link formatting (#14541)
Fixed markdown syntax for links in a couple places where it was
formatted incorrectly (`(…)[…]` instead of `[…](…)`)

(Fixed one earlier and just searched the docs folder for `)[` to find
these; hopefully this PR nabs the rest.)
2023-10-16 16:52:58 -05:00
Mo Zhu 9d2c3f0870 Update Reference-Architectures.md (#14039)
Purpose of this change:
- Right now we don't have a guide for deploying on Azure. We want to
prompt people to ask for it by linking them to the Slack. That is a way
that we can kick off the process of writing a formal document.
2023-09-27 08:19:31 -07:00
8fb22579ea Reorganize Fleet documentation (#12871)
Closes: #12611

Changes:
- Added three new documentation sections `/docs/get-started/`,
`/docs/configuration` and `/docs/rest api/`
- Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and
`/docs/deploying` » `/docs/deploy/`
- Moved `/docs/using-fleet/process-events.md` to `/articles` and updated
the meta tags to change it into a guide.
- Added support for a new meta tag: `navSection`. This meta tag is used
to organize pages in the sidebar navigation on fleetdm.com/docs
- Moved `docs/using-fleet/application-security.md` and
`docs/using-fleet/security-audits.md` to the security handbook.
- Moved `docs/deploying/load-testing.md` and
`docs/deploying/debugging.md` to the engineering handbook.
- Moved the following files/folders:
- `docs/using-fleet/configuration-files/` »
`docs/configuration/configuration-files/`
- `docs/deploying/configuration.md` »
`docs/configuration/fleet-server-configuration.md`
    -  `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md`
- `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md`
- Updated filenames:
- `docs/using-fleet/permissions.md` »
`docs/using-fleet/manage-access.md`
- `docs/using-fleet/adding-hosts.md` »
`docs/using-fleet/enroll-hosts.md`
    -  `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md`
- `docs/using-fleet/fleet-ctl-agent-updates.md` »
`docs/using-fleet/update-agents.md`
- `docs/using-fleet/chromeos.md` »
`docs/using-fleet/enroll-chromebooks.md`
- Updated the generated markdown in `server/fleet/gen_activity_doc.go`
and `server/service/osquery_utils/gen_queries_doc.go`
- Updated the navigation sidebar and mobile dropdown links on docs pages
to group pages by their `navSection` meta tag.
- Updated fleetdm.com/docs not to show pages in the `docs/contributing/`
folder in the sidebar navigation
- Added redirects for docs pages that have moved.

.

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-07-27 17:40:01 -05:00