Commit Graph
1625 Commits
Author SHA1 Message Date
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
Roberto Dip 1a526aa19f update documentation with expected response (#15527)
for  #13251
2023-12-08 18:56:58 -03:00
Luke Heath 300d318437 Cleaning up releasing Fleet docs (#15523) 2023-12-08 15:05:07 -06:00
Luke Heath ff45facd81 Update releasing Fleet documentation (#15506) 2023-12-08 10:29:30 -06:00
Marko Lisica 6e1dfca816 Removing duplicated "Command line flags" section (#15514) 2023-12-08 16:10:30 +01:00
Noah Talerman f6d8bcc732 Docs for Windows MDM commands (#15371)
- Update "Commands" doc page to cover Windows MDM commands
- Remove more doc content than added
2023-12-07 14:08:04 -05:00
Marko Lisica 95a7e7f8fa Scripts docs typo - broken link (#15485)
# 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-07 17:05:40 +01:00
Noah Talerman 845ef393bb Update scripts docs (#15416)
- Simplify usage instructions to make it more like a reference
- Move "Run script asynchronously" to contributor docs so that user
facing API docs have one best practice API endpoint for scripts. Call
synchronous endpoint "Run script"
2023-12-06 12:40:42 -05:00
Noah Talerman 8d8846ed03 Remove broken link in Enroll hosts docs (#15428)
- Remove anchor link for section that was removed in a separate PR here:
#15279
2023-12-06 09:53:16 -05:00
Sharon Katz 29580a242d 15135 remove atom package (#15410) 2023-12-04 14:26:26 -05:00
Noah Talerman e673cc6caa Update Enroll hosts doc page (#15279)
- Remove section about plain osquery and launcher. Using fleetd is best
practice and we want all new Fleet users to follow this best practice.
If they can't we want to learn why.
- Replace "Fleetd configuration options" section with a tip. Easier to
maintain as we add/update flags.
2023-12-04 11:19:16 -05:00
Noah Talerman bd54184510 Puppet module docs (#15336)
- We learned from a customer that the Puppet module requires global
admin
2023-12-04 11:18:18 -05:00
Noah Talerman 4bf2635453 Enroll hosts docs (#15374)
- Move "Grant full disk access for macOS hosts" to Advanced section
2023-12-04 11:16:55 -05:00
Martin Angers 88612cdf8c Add back Windows OS Updates documentation changes (#15363) 2023-12-04 09:50:06 -05:00
Martin Angers 6fd06d6486 Add back Windows Profiles documentation changes (#15358) 2023-12-04 08:41:37 -05:00
Eric f14ab358fe 2023-11-21 Website: Add new usage statistics (#15263)
Closes: #15255

Changes:
- Added the usage statistics added in
https://github.com/fleetdm/fleet/pull/14216 to the inputs of the
`receive-usage-analytics` webhook.
- Updated the `receive-usage-analytics` webhook to send the new usage
statistics to Datadog.
- Added attributes for the new usage statistics to the
`HistoricalUsageSnapshot` model.
- Removed the `columnName` from the `hostsStatusWebHookEnabled`
attribute of the `HistoricalUsageSnapshot` model, the name of this
column will be changed in the database when the new columns are added to
the databse table.
- Updated the usage statistics documentation to have the new statistics.


This PR requires database migrations. When this is approved and ready to
merge, we will need to:
- [ ] Merge this PR
- [ ] Put fleetdm.com into maintenance mode while the "Deploy Fleet
website" GH action runs.
- [ ] Add the new columns to the database table
- [ ] Change the name of the `hostStatusWebhookEnabled` column to
`hostsStatusWebHookEnabled`
- [ ] Set the default values for the new columns on the existing
records.
- [ ] When the website has finished redeploying, take it out of
maintenance mode.
2023-12-01 17:59:41 -06:00
Neil Blazevic 3da2529a13 Update standard query library docs w link (#15131) 2023-11-29 17:15:40 -06:00
Noah Talerman f5923ba422 Update usage statistics docs (#15175)
- v4.0 was a long time ago
2023-11-27 16:55:30 -05:00
Noah Talerman e8a3643abf Update configuration docs (#15211)
Use capital "MB"
2023-11-27 16:54:53 -05:00
Roberto Dip 9c7b740b03 disable windows profiles feature in the back-end (#15278)
per discussion in slack, reverting relevant user-facing changes for
#13281
2023-11-27 16:08:52 -03:00
Alex Mitchell b6e1dad27e Update fleetd.md (#14833)
Removed Orbit from top header list and the Components diagram. There is
a lot of additional Orbit content throughout this doc that needs to be
purged over time, especially when fleetctl commands are changed as the
Orbit object is eliminated.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [ ] 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 API changes (docs/REST API/rest-api.md or
docs/Contributing/API-for-contributors.md)
- [ ] 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-11-21 21:58:47 -06:00
Sam PflugerandRachael Shaw b2899c402e Handbook/company/leadership#structure-of-departmental-handbook-pages (#14811)
- Add Isabell to team table
- reorder contact-us in leadership page
- Standardize "Contact us" on all departmental pages
- Convert all responsibilities to imperative mood verb phrase
- Untangle and deduplicate Engineering <> Product groups <> Product

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-11-21 13:55:46 -06:00
4194c44131 Use NVD API 2.0 to download CVE information (#15102)
#14888

@getvictor This is ready for review, but keeping as draft as there are
probably many tests that need amending.

I used the new version of the `./tools/nvd/nvdvuln/nvdvuln.go` to
compare the current vulnerabilities found in our dogfood environment
with the vulnerabilities found by the code in this PR and both results
match:
```
go run -race -tags fts5 ./tools/nvd/nvdvuln/nvdvuln.go --debug --db_dir ./local --software_from_url <dogfood URL> --software_from_api_token <API_TOKEN> --sync 2>&1 | tee out.txt
[...]
CVEs found and expected matched!
```

- [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.
- [ ] Added/updated tests
- [X] Manual QA for all new/changed functionality

---------

Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2023-11-21 12:30:07 -06:00