Commit Graph
1647 Commits
Author SHA1 Message Date
Victor Lyuboslavsky edee09e22a Added parameter to PATCH /fleet/teams/:id endpoint (#16254)
API doc update for #15609

Added parameter to PATCH /fleet/teams/:id endpoint
2024-01-24 13:06:15 -06:00
99163d5dfc MDM Custom settings (profiles) - API changes (#14230)
API changes for the Windows configuration profiles story:
- #13281 

It's **ready for review**, but marked as a draft because of KPI (PR open
time)

- DONE: Remove activity types changes before merging (those will be
automatically generated)

#### `profile_id` and `profile_uuid` changes specified in following
ticket:
- #15274

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-24 11:13:56 -06:00
Rachael Shaw 88d8bf3b90 Update docs for CIS benchmark support (#16211) 2024-01-24 09:57:19 -05:00
Luke Heath 576405b029 Typo fix (#16306) 2024-01-23 16:52:05 -06:00
Sharon KatzandRachael Shaw 09f9e4ba82 16026 - document that Disa-stig linux distribution is not supported. (#16281)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-23 14:19:51 -06:00
Luke Heath 0f245df4fe Clarification and typo fix in releasing Fleet docs (#16266) 2024-01-22 17:13:07 -06:00
Victor Lyuboslavsky 4a5945b612 Corrected recent_vulnerability_max_age option. (#16153) 2024-01-17 16:06:32 -06:00
Mike Thomas 17f0a4e28e Update tutorials-and-guides.md (#16158)
typo fix
2024-01-17 15:32:48 -06:00
Victor Lyuboslavsky ac068f85c8 Failing policies are now listed first. (#16103)
API doc changes for #10379 -- failing policies are listed first.
2024-01-16 10:23:31 -06:00
Marko Lisica 8aaa4600ed Docs: Configure script execution timeout (#15483)
Docs changes for:
- #15196
2024-01-12 17:29:43 -05:00
Noah Talerman 2132c7ee17 Update Fleet server configuration docs (#16054)
- Pull info about duration-based settings to the top to make it clear.
For this bug: #15926
- Add info about self-managed v. managed-cloud customers
- Cut content
2024-01-12 17:28:18 -05:00
Noah Talerman c5738fbdeb Update supported host operating system (#16070)
- macOS is always lowercased
2024-01-11 17:11:46 -05:00
Grant Bilstad cd7da443a3 paragraph doubled in enroll docs (#16069)
Edit to remove double-copy of paragraph in docs
2024-01-11 14:09:42 -07:00
Rachael Shaw 0f3458b2a0 #14500 documentation: Option to disable scripts in organization settings (#15431)
Changes to the organization settings configuration example for
https://github.com/fleetdm/fleet/issues/14500
2024-01-11 14:37:25 -05:00
Rachael Shaw bc075b1eea #15058 API design: Add gigs total disk space to host endpoints (#15442)
Rest API changes for https://github.com/fleetdm/fleet/issues/15058
2024-01-11 14:35:56 -05:00
Rachael Shaw 7c84588689 #14800 API design: POST request for "Run live query" endpoint (#15508)
"Run live query" API updates based on @jrzmurray's PR
https://github.com/fleetdm/fleet/pull/13002, to resolve issue
https://github.com/fleetdm/fleet/issues/14800.
2024-01-11 14:28:48 -05:00
Katheryn Satterlee e761ba529d Update MySQL requirements (#15940)
Added a note about using alternative database servers with Fleet.

Resolves #15766
2024-01-11 10:00:38 -06:00
Noah Talerman 7a0e2089c4 API design: Get email w/o relying on end user (#15445)
- API changes for Get email w/o relying on end user: #15057
2024-01-10 17:29:51 -05:00
Noah Talerman 5f38355169 Merge fleetd doc page to enroll hosts page (#15907)
- Move relevant content from "Fleetd" doc page to "Enroll hosts" page
- Remove "Fleetd" docs page
2024-01-10 14:35:18 -05:00
Marko Lisica 89ff5541d3 API design: Lookup hosts based on IdP email (#15305)
API changes for the following story:

- #13034
2024-01-10 09:23:56 -05:00
Noah Talerman 59cd1bf491 Update Vulnerability Processing docs (#15939)
- Remove sentence and break out a new line to make top section more
scannable.
2024-01-10 09:18:36 -05:00
ad4737036b Docs: Add downgrading Fleet page (#15788)
Closes: https://github.com/fleetdm/confidential/issues/4665

Changes: 
- Added a new documentation page that provides instructions for
downgrading from Fleet premium. The content for this section was pulled
from a [commented-out FAQ
question](https://github.com/fleetdm/fleet/blob/1d2f5ae42ac0c9ab6cd560355a8f90ef012b78c6/docs/Get%20started/FAQ.md#L363-L394).

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-08 17:01:47 -06:00
Tim Lee 2f937ce9a2 Docs: Host Details Pack Stats API (#15672) 2024-01-04 11:16:47 -07:00
Lucas Manuel Rodriguez bd16acb66e Adding doc changes for configuring fleetd channels remotely (#15872)
#13825

Creating a separate PR to not block on docs review.
2024-01-04 10:23:51 -03:00
Noah Talerman 72ccbbbc6f Update supported operating systems (#15834)
- Clarify that Fleet Desktop on Fedora and Centos require Google Chrome
as the default browser.
2024-01-03 18:00:48 -05:00
Noah Talerman 3326dd4186 API design: Target hosts by serial number (#15344)
- API changes for #14748 
- Document `hardware_serial` name to be consistent w/ `hardware_serial`
parameter in hosts endpoints
2024-01-03 17:59:23 -05:00
Noah Talerman ef75a0131e MDM command docs (#15803)
- Fix typo. `fleetctl mdm run-command` expects `--hosts`
2024-01-03 17:58:49 -05:00
Jahziel Villasana-Espinoza 6dc9d2f6f0 fix: return better error when password is too long (#15875)
> Relevant issue: #15625

# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-01-03 17:24:28 -05:00
Jahziel Villasana-Espinoza 63613ef90c feat: update docs with new scripts disabled flag (#15888)
> Relevant issue: #14500

# 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-01-03 16:59:22 -05:00
Brock Walters 4519ff672f Update Automations.md (#15864)
previous: ...one ticket is created per CVE regardless of the number of
hosts on which such CVE is detected.

Hope that meaning is the same? If so, what is there is a little clunky.
2024-01-03 16:22:13 -05:00
Noah Talerman 5ef01b7fd6 Fix broken anchor link in docs (#15751)
- Fix link
2024-01-02 17:15:25 -05:00
Victor Lyuboslavsky 8c9feedc98 API change: add host_count_updated_at to policies (#15765)
API Change for #15323
2024-01-02 13:41:54 -06:00
Brock Walters fa9f1838f2 Update Troubleshooting-live-queries.md (#15681)
Not meaning to be pedantic just trying to make the flow a bit more
natural. :)

# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-12-21 14:48:25 -06:00
Noah Talerman 1d2f5ae42a Update Fleet server configuration docs (#15776) 2023-12-20 16:13:48 -06:00
nonpunctual 31c2f42b73 Update segment-hosts.md (#15680) 2023-12-15 18:03:54 -05:00
Rachael Shaw c40bd9f3c3 #12889 API design: Add software to "List hosts" response (#15019)
Proposed solution for https://github.com/fleetdm/fleet/issues/12889.
2023-12-15 15:59:45 -06:00
Rachael Shaw 197470a3ce #14920 API design: Add device health endpoint (#15038)
Proposed first version of the device health API endpoint for #14920
2023-12-15 15:57:41 -06:00
Marko Lisica b45737d780 Vulnerability processing docs improvement (#15306) 2023-12-15 15:54:10 -06:00
Victor Lyuboslavsky 24c9f5a4b6 Added query param to fleet/queries. (#15673)
Added query param to fleet/queries.
API change for #15630
2023-12-15 12:58:06 -06:00
Rachael ShawandTim Lee 5e3f501c87 #14415 API design: Per-host query report endpoint (#14805)
Adds new API endpoint to enable displaying query reports per-host
(#14415).

---------

Co-authored-by: Tim Lee <timlee@fleetdm.com>
2023-12-15 12:27:20 -06:00
Lucas Manuel Rodriguez 024a20ac11 Allow enrolling fleetd using osquery's instance identifier (#15570)
#14879

- [X] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [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)).
2023-12-15 15:26:32 -03:00
Eric a5065554b4 Docs: Uncomment FAQ question (#15639)
https://github.com/fleetdm/confidential/issues/4673

Changes:
- Moved the "How can I uninstall the osquery agent?" question out of the
commented-out block on the FAQ docs page.
2023-12-15 10:06:55 -06:00
Victor Lyuboslavsky bac932bd19 Documentation for max_prepared_stmt_count requirements and update-interval. (#15495)
Documentation changes for #15476
2023-12-14 17:38:47 -06:00
Noah Talerman 0dc43b5337 Update disk encryption (#15662)
- Clarify what volume Fleet encrypts on Windows
2023-12-14 14:24:25 -05:00
Rachael Shaw 6886317cad Docs: Update query permissions (#15154)
Updates to the "Manage access" page to reflect changes for:
+ https://github.com/fleetdm/fleet/issues/15146
+ https://github.com/fleetdm/fleet/issues/14415
2023-12-14 12:45:02 -06:00
Victor Lyuboslavsky 2520fc2179 Reduce server load for fleetd upgrade (#15606)
📺 Loom:
https://www.loom.com/share/9e17848963574af3aa10d426b450bcd0?sid=f8078293-c7e1-4864-a8a3-4cec996971f5

#15476 
#15540 
#15542

After upgrading fleetd, customer-blanco saw a spike in traffic and a
spike in DB connections. These fixes attempt to reduce the traffic and
DB load when fleetd is upgraded.

On the server, added fleet/device/{token}/ping endpoint to be used by
agents to check their token.

On the agent:
- Removed call to fleet/orbit/device_token unless token needs to be
updated.
- Changed call to fleet/device/{token}/desktop with a less resource
intensive call to fleet/device/{token}/ping
- Removed call to fleet/orbit/ping

# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [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)).
2023-12-13 14:31:48 -06:00
Noah Talerman 053582fd88 Update disk encryption docs (#15496)
- Associated w/ this story: #15600 
- Update docs now that disk encryption enforcement is cross platform
(Windows story here: #12577)
- Remove section about resetting a password w/ disk encryption key to
reduce doc content. Remove this link from the UI
2023-12-12 15:58:26 -05:00
Noah Talerman 883652cac6 Update setup instructions for macOS MDM (#15518)
- Clarify instructions
- Add bold text style to UI elements
2023-12-11 10:02:50 -05:00
Rachael ShawandVictor Lyuboslavsky 832f7fd8b6 API changes for confidential/#2118 (#15092)
API changes for https://github.com/fleetdm/confidential/issues/2118

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2023-12-08 17:12:24 -06:00
Rachael Shaw 3d14cc841d REST API docs: Consistent URL parameter formatting (#15535)
Makes parameter formatting in documented REST API paths consistent.
Previously, we were using a mix of `/foo/:parameter/bar` and
`/foo/{parameter}/bar`. This updates all URLs to use `:` instead of
`{…}`.

Also, opportunistically fixed some other inconsistent formatting I
noticed in a couple places.
2023-12-08 16:22:20 -06:00