Commit graph

2063 commits

Author SHA1 Message Date
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
Lucas Manuel Rodriguez
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 Talerman
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 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
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 Littman
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
Jahziel Villasana-Espinoza
ff90aade76
feat: add some docs for creating a signed fleetd-base installer for QA purposes (#23614)
Updated the docs based on our experience QA-ing
https://github.com/fleetdm/fleet/issues/19372

There will be a follow-up PR with some details for generating the base
installer during development.
2024-11-07 12:29:47 -05: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
Sarah Gillespie
3ea68ae1e7
Update guide to puppet module (#23369) 2024-11-06 16:57:59 -06:00
Noah Talerman
dabdb81be1
Update reference doc page: Fleet server configuration (#23551)
- Update section headers so that config options show up in the right
side bar. Today, there's only one header that shows up in the sidebar:
![Screenshot 2024-11-05 at 3 29
29 PM](https://github.com/user-attachments/assets/a208f6fa-d48d-482d-b689-36ba36fb8764)
- Remove "Example YAML" sections b/c they're redundant. More to maintain
2024-11-06 16:38:35 -06: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
Rachael Shaw
e892a826ee
Simplify "How can I uninstall fleetd?" answer (#23547)
Link to uninstall fleetd guide to avoid duplicate content
2024-11-05 17:48:04 -06:00
Eric
f623eed47b
Website: Update /queries page (#23472)
Changes:
- Standard query library:
- Added three policies to the Standard query library (tagged as premium)
- Changed the `kind` of the "Identify Apple development secrets (macOS)"
query to `policy` because it is an informational query (It returns rows
of results rather than 1 or 0) and removed its `resolution` value
- Updated the build-static-content script to remove platform names from
the end of query names (e.g., (macOS)). This is done to keep the URLs
for queries the same while hiding them in the UI
- Updated the layout of the queries page to match the latest wireframes
and updated the page to only show policies
 - Updated the styles and layout of the queries-details page.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-11-04 10:58:08 -06:00
Ian Littman
f59ffc235d
Add iOS/iPadOS updates to example GitOps YAML, reference OS update GitOps YAML from OS update enforcement guide (#23320)
#21998

While looking through this I noticed a few other issues:

1. We seem to be inconsistent about what time we pick for OS update
deadlines. For profiles [it's noon local
time](2e5bf75b6d/ee/server/service/mdm.go (L1096)),
while for Nudge [it appears to be 4am...server time or
UTC](2e5bf75b6d/server/fleet/nudge.go (L53-L57))?
#9013 also mentions "noon UTC-8/Pacific Standard Time", which is neither
of the above (and means that, if implemented as spec'd, the deadline
would shift by an hour during DST), while docs prior to this PR
mentioned 4am UTC-8. Maybe we don't care enough to fix the Nudge
behavior since macOS 14 (which no longer requires Nudge) came out over a
year ago, but we should at least agree on desired behavior for DDM and
document that (which is what I've done for iOS/iPad OS since they don't
use Nudge).
2. The [REST API
docs](2e5bf75b6d/docs/REST%20API/rest-api.md (L1720-L1757))
don't seem to match the description of macOS behavior in the article;
the former indicates that OS updates pop up with increasing frequency
post-deadline, rather than having an impassible dialog. This may be
because behavior changed from Nudge to DDM, but iOS/iPadOS got
copy-pasted from the macOS REST docs and they never used Nudge. My guess
is that we should describe DDM behavior here.

Tagging in @mna as he looks to have implemented DDM OS updates so should
have some context here, and @noahtalerman to confirm desired behavior,
particularly on the deadline side.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-11-01 14:13:58 -05:00
Ian Littman
06ad3ecb6b
Clarify OS update enforcement details in REST API docs (#23464)
This applies some consistency fixes as well (e.g. noting that Mac/Win
enforcement requires MDM). Also removed mention of MDM on iOS/iPadOS
enforcement as if an iOS/iPadOS host is enrolled, it's enrolled via MDM.

See #21998
2024-11-01 14:12:01 -05:00
Mike Thomas
a60d2afd9f
docs-tutorials-and-guides-update (#23377)
Closes https://github.com/fleetdm/fleet/issues/22951

- Updated the guides listed on
https://fleetdm.com/docs/get-started/tutorials-and-guides to only
include the most essential onboarding guides. Guides are listed in the
following order:
    - Deploying Fleet
    - Organizational units
    - Controls
    - Installing software
    - Admin
- Added archive notices to the three "How to install osquery..."
articles
- Added "Further reading" links to the bottom of the Queries guide and
Policies guide to point to related advanced topics
- Renamed "Managing labels in Fleet" to "Labels" for parallelism with
our other guides (left the URL as is, no redirect necessary)
- Renamed "What are Fleet policies" to "Policies" for parallelism with
our other guides (left the URL as is, no redirect necessary)
2024-10-30 11:34:44 -05:00
Noah Talerman
f6966d322c
Reference doc and guide updates: Policy automations: run script (#17129) (#23300)
- Update guides to reflect use case: automatically run scripts and
install software
- @noahtalerman: I removed top image from "Automatically run scripts"
b/c I think it looked rushed/unexpected
  - Update "execute" language to "run" and add "manual" language
- Clarify when a policy's host counts are reset
- Clarify support for policy automations: team v. default (global) v. no
team
- Update `software.packages` example to best practice: separate file
  - Inline is supported for backwards compatibility
- Remove `policies` and `controls` call outs about "No team." This info
is covered in the starter filed in fleetdm/gitops. For an example, see
`teams/no-teams.yml` here:
https://github.com/fleetdm/fleet-gitops/blob/main/teams/no-team.yml
2024-10-28 14:15:54 -05:00
Rachael Shaw
24db6c1cde
Update headings in YAML docs for easier navigation (#23217) 2024-10-25 16:45:54 -05:00
Marko Lisica
c381c301a0
Make file extensions lowercase (#23228)
File extensions should be written in lowercase with . in front of the
extension (e.g. .exe, .pkg, etc).
2024-10-25 14:35:32 -05:00
William Theaker
86713f1b71
Improve gitops dry run logging for query deletion (#23202) 2024-10-25 13:35:53 -05:00
Lucas Manuel Rodriguez
3f89b48ca5
Add iPadOS to minimum versions in FAQ docs (#23197)
Follow up to https://github.com/fleetdm/fleet/pull/23104.
2024-10-24 15:02:11 -05:00
Ian Littman
4e38e8e5c5
s/urf-8/utf-8 on manual config profile download (#23169)
# 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] Manual QA for all new/changed functionality
2024-10-24 09:54:24 -07:00
Harrison Ravazzolo
3eb3d85ac8
Add a line to docu 'turn off mdm' is only available on macOS' (#23155)
Add line indicating 'turn off mdm' is only available on macOS

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-10-23 17:53:37 -05:00
Rachael Shaw
8fa5aafa9d
Update configuration docs (#22990)
Move `license.enforce_host_limit` to contributor docs
2024-10-23 10:50:08 -05:00
Neil Blazevic
58ce48dea8
Update Render deploy pricing (#23113) 2024-10-23 10:07:20 -05:00
Jahziel Villasana-Espinoza
d25e6cd067
fix: add ios minimum version to os list (#23104)
> No issue, just a fix from a customer convo today

# 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-10-22 17:22:34 -05:00
Marko Lisica
3c3e6d6d1a
Add callout that software-related features are experimental (#23089) 2024-10-22 15:43:56 -05:00
Rachael Shaw
4cc3e3bb63
Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -05:00
Victor Lyuboslavsky
b27af3d4a2
Updating golangci-lint version (docs) (#22986) 2024-10-17 14:12:00 -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
Noah Talerman
43060bfdc8
Reference docs: default timeout for scripts and software (#22908)
- We made script timeouts configurable in this user story: #16645
- We added a default timeout for software in this bug: #22558
2024-10-16 09:19:02 -04:00
Ian Littman
841d8dcd86
Add warning on populate_software query for hosts list endpoint (#22945)
#22291

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-10-15 16:49:21 -05:00
Victor Lyuboslavsky
f2fedb0187
Update Building-Fleet.md (#22858)
Updated MySQL instruction for macOS M1
2024-10-15 12:56:20 -05:00
Noah Talerman
32c901e4a3
YAML files reference (#22913)
- Add examples that make it clear that these are label names (not IDs)

---------

Co-authored-by: Allen Houchins <32207388+allenhouchins@users.noreply.github.com>
2024-10-15 11:51:26 -05:00
Victor Lyuboslavsky
808d6a0007
Added activity feed items for NDES SCEP proxy config. (#22902)
For #21955 (the story has a video demo of core functionality)

Follow up for PR #22542

# Checklist for submitter

- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-10-14 15:55:52 -05:00
Katheryn Satterlee
5e692c7d8d
Correct placement of disable_tables (#22879)
Remove any reference to CLI only flag`disable_tables` in
`agent_options.config.options` and added a reference to
`agent_options.command_line_flags`

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

-Documentation only change, thanks to @rebeccaui for calling it out!
2024-10-14 11:24:45 -05:00
Roberto Dip
a49adc8214
mdm docs index (#22716)
effort to compile all the resources we have scattered about MDM and
document a few fleet-specific behaviors.

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: mostlikelee <tim@mostlikelee.com>
2024-10-11 16:42:45 -03: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