Commit Graph
2095 Commits
Author SHA1 Message Date
c4a2bb4d6b 4.61 documentation changes (#24833)
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-12-17 15:39:24 -06:00
Noah TalermanandRachael Shaw 8759f4b23f Currently, Fleet Desktop for Kubuntu requires Google Chrome (#24812)
More context:
https://github.com/fleetdm/fleet/issues/23697#issuecomment-2546913113

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-12-16 17:50:56 -06:00
Noah Talerman 6b6eb19bb0 Fleet server configuration docs: capitalize "S3" (#24794) 2024-12-16 10:42:20 -06:00
Andrea Scarpino e3c87a2c79 List paths used by Fleet desktop (#23891)
We don't expose fleet publicly and we had to open these paths to make
Fleet Desktop work.
2024-12-13 17:47:50 -06:00
Konstantin SykulevandRachael Shaw abeb16c087 Updated deprecated endpoint references with new endpoint (#24723)
[#23880](https://github.com/fleetdm/fleet/issues/23880)

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-12-12 13:55:49 -06:00
Eugene 039ea91f9b Capitalization fix & added :id information (#24643)
Fixed capitalization of "Default response" and id information for
modiifying a package
2024-12-12 12:50:49 -06:00
Eugene f1ea2360d2 Edit the "List activities" description. (#24562)
Edited for length and clarity
2024-12-11 17:33:56 -05:00
Jahziel Villasana-Espinoza 5814e3985a feat: add software title ID to add software activity (#24577)
> Related issue: #24120

## Changes
- Added the `software_title_id` field to the activity details for
`added_software` activities, which get generated when adding a customer
installer or a FMA
- Added a return value (`titleID`) to
`ds.MatchOrCreateSoftwareInstaller`
- Removed `ds.GetSoftwareTitleIDByMaintainedAppID`. Since we're
returning the new value above, this method was no longer needed.

## Testing steps
1. Add a custom installer
2. Add a FMA
3. Check the activity details in the response to `GET /activities`.
Verify that the `software_title_id` field exists and is correct.
4. Add a FMA with automatic install. Make sure the policy is correctly
created, has the correct software title ID associated with it, and that
it installs the app.

# 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 tests
- [x] Manual QA for all new/changed functionality
2024-12-11 09:54:15 -05:00
Noah TalermanandRachael Shaw 68f2d99b25 API reference docs: disk encryption is cross-platform (#24588)
API reference doc changes for the following story:
- #22074

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-12-10 16:52:29 -06:00
Noah Talerman 6e4ddaeab9 YAML files reference docs: labels and users coming soon, ticket creation, ABM and VPP (#24480) 2024-12-10 17:50:04 -05:00
Katheryn Satterlee 7b87a32606 Add detail_query_overrides to contributor docs (#24589) 2024-12-10 15:46:59 -05:00
Janis Watts a2e85abc62 Changed Metadata URL in SSO configuration to 127.0.0.1 due to product validation update (#24599)
Fleet now has a validation check in the Metadata URL field. Updated
instructions from

Metadata URL: http://localhost:9080/simplesaml/saml2/idp/metadata.php

TO

Metadata URL: http://127.0.0.1:9080/simplesaml/saml2/idp/metadata.php
2024-12-10 14:53:09 -05:00
Noah Talerman 8fe05fcf93 API reference: run script w/ team_id and script_name (#24484) 2024-12-10 13:39:24 -06:00
Martin Angers 538abdccf8 Add contributor docs to document the teams/no team conventions (#24569)
Not associated with a ticket, was an action item from our retrospective
meeting.
2024-12-10 10:19:28 -05: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
Jahziel Villasana-Espinoza 614446e9b3 feat: document orbit-auth endpoints (#24368)
> Related issue: #22811

# 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] Manual QA for all new/changed functionality
2024-12-05 11:22:13 -06:00
Noah Talerman c8ac4067a8 Missing YAML files (GitOps) reference docs (#24362)
- Add `uninstall_script` for `packages`
- This feature was shipped as part of the following user story: #20320
  - Looks like we forgot to merge in the reference docs
2024-12-05 11:20:16 -06:00
Victor Lyuboslavsky e04ab28128 Docs for /fleet/abm_tokens/count API endpoint (#24303)
For #24288
2024-12-04 19:19:16 -06:00
Ian Littman 4e27aebb5b Indicate that we show date only (not date and time) for build_date in version endpoint response (#24388)
For #24293.
2024-12-04 18:24:44 -05:00
Allen Houchins 8b8f5f0649 Update yaml-files.md (#24371)
- Disk encryption for Linux
2024-12-04 18:08:53 -05:00
William Theaker a7ec57e881 Fix gitops secret example (#24217)
The current string doesn't work.
2024-12-04 16:03:25 -06: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
Marko Lisica ad83e71e39 [API design] Custom OS settings: "include any label" option for custom target (#23647) 2024-12-03 18:17:42 -05:00
Marko Lisica 42d51a5b05 [YAML changes] Custom OS settings: "include any label" option for custom target (#23648) 2024-12-03 18:15:38 -05:00
Martin Angers aa8e20f21e Merge branch 'main' into feat-automatic-migrate-windows-hosts 2024-12-02 16:12:30 -05:00
Brock WaltersandRachael Shaw f09d6fd797 Update rest-api.md (#24021)
Added note to get Setup Experience section warning against setting
custom URL values in custom profile. This was tested by CSA &
customer-starchik.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-12-02 10:53:10 -06:00
Martin Angers f399a90901 Merge branch 'main' into feat-automatic-migrate-windows-hosts 2024-12-02 09:34:49 -05:00
Rachael Shaw 6fd3ebf4cf Docs v4.60.0 (#24197) 2024-11-27 15:21:16 -06:00
Martin Angers c4404d9d68 Windows MDM Migration: API, CLI and activities (#24141) 2024-11-26 11:52:56 -05:00
Ian LittmanandTim Lee 195bb861e0 Update contributor API docs to cover LUKS trigger/escrow endpoints (#23583, #23584) (#23943)
Other cleanup:

* Remove orphaned FileVault rotation ToC link
* Revise transparency endpoint to reference new "About Fleet"
terminology
* Remove enforce_bitlocker_encryption Fleet Desktop notification (that
notification is on Orbit config, which we don't document in contributor
docs, not on the Fleet Desktop endpoint)

---------

Co-authored-by: Tim Lee <timlee@fleetdm.com>
2024-11-22 20:51:57 -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
Mike McNeil 8080737870 Website: Update FAQ.md (#23718)
- 1000 => 300
- "cost-efficient" might make it seem like it's cost prohibitive for
everyone (but the real problem is just that we can't quite yet afford to
run thousands of small instances of Fleet for folks with 10-100 hosts,
because it means increasing infrastructure engineering headcount)
2024-11-19 22:42:20 -06:00
Noah Talerman 1e1b32ea40 Update pricing FAQ: pending hosts don't count (#23947) 2024-11-19 14:11:01 -05:00
Rachael Shaw 249189fc0c Remove docs for #22464 (#23936)
Missed this one when updating v4.59 docs branch: #22464 is still on the
drafting board.
2024-11-18 18:08:55 -06:00
Rachael Shaw 2e779db0a8 Docs: v4.59.1 API changes (#23928)
Bring in @lucasmrod's changes from
https://github.com/fleetdm/fleet/pull/23743
2024-11-18 16:26:05 -06:00
Victor Lyuboslavsky 698e9e80fe Added activity item for fleetd enrollment with host serial and display name. (#23790)
#22810 

# Demo
[![22810
demo](http://img.youtube.com/vi/le71QQ92suc/0.jpg)](http://www.youtube.com/watch?v=le71QQ92suc)

# 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 support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [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)).
2024-11-18 15:51:36 -06:00
RachelElysia 4f3bf6439e Docs: Update software status docs using old 'failed' value (#23848) 2024-11-18 09:04:32 -05:00
4b4fc976a2 Add team_identifier to macOS software (#23766)
Changes to add `team_identifier` signing information to macOS
applications on the `/api/latest/fleet/hosts/:id/software` API endpoint.

Docs: https://github.com/fleetdm/fleet/pull/23743

- [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 tests
- [X] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary 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] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [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)).

---------

Co-authored-by: Tim Lee <timlee@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
2024-11-15 14:17:04 -03:00
Victor Lyuboslavsky a541961a26 fleetd telemetry doc updates (#23423)
docs for #23413
2024-11-14 13:43:16 -06:00
Konstantin Sykulev 48b992e268 Modify status code for software batch endpoint (#23711)
When using the `fleet/software/batch` endpoint, due to its async nature,
it should return a 202 (Accepted) rather than a 200 (Ok).

https://github.com/fleetdm/fleet/issues/23492

# 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 tests
- [x] Manual QA for all new/changed functionality
2024-11-13 17:22:51 -06:00
Noah Talerman 12b66f9186 Update tutorials-and-guides.md (#23724)
- Certificates in fleetd is an advanced article about configuring fleetd
w/ custom certificates. I think "Custom OS settings" (configuration
profiles) is a better controls article
- Simplify titles of software links
2024-11-13 12:37:26 -06:00
Noah TalermanandIan Littman d130ebe1e8 Add Debian to supported operating systems (#23773)
- Debian is a popular Linux flavor for servers
- Several Fleet customers have Debian hosts enrolled (see usage stats
[here](https://docs.google.com/spreadsheets/d/1Mh7Vf4kJL8b5TWlHxcX7mYwaakZMg_ZGNLY3kl1VI-c/edit?gid=538901298#gid=538901298))
- @iansltx has tested Fleet w/ Debian 11 and 12

---------

Co-authored-by: Ian Littman <iansltx@gmail.com>
2024-11-13 12:33:49 -06:00
Katheryn SatterleeandRachael Shaw 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
Rachael Shaw f5598e003c Docs v4.59.0 (#23693) 2024-11-12 11:05:45 -06:00
Victor Lyuboslavsky c4c1b65492 NDES REST API and config doc changes (#22968) 2024-11-12 11:05:33 -06:00
Mike McNeil af2a3e6a6d Website: Follow-up to "fluffing" PR (#23715) 2024-11-11 22:53:28 -06:00
Rachael Shaw df6da8101f API docs: fix queries response formatting (#23698)
Fix indentation
2024-11-11 15:27:31 -06:00
Rachael Shaw 9585ca7d9a Docs: Fix formatting issues in API responses (#23692)
+ Fixed some indentation
+ Added some missing commas and colons
+ Removed some duplicate keynames
2024-11-11 14:08:14 -06:00
Ian LittmanandAndrea Scarpino d746b9179a Record activity when activity automations are enabled/edited/disabled (#23477)
#21709, re-roll/expansion of work done by @ilpianista in #21368

# 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 tests
- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Andrea Scarpino <andrea@scarpino.dev>
2024-11-08 09:07:56 -06:00