Commit Graph
91 Commits
Author SHA1 Message Date
Ian LittmanandRachael Shaw 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](https://github.com/fleetdm/fleet/blob/2e5bf75b6d40d65c5f05b0f58665375dbb71e650/ee/server/service/mdm.go#L1096),
while for Nudge [it appears to be 4am...server time or
UTC](https://github.com/fleetdm/fleet/blob/2e5bf75b6d40d65c5f05b0f58665375dbb71e650/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](https://github.com/fleetdm/fleet/blob/2e5bf75b6d40d65c5f05b0f58665375dbb71e650/docs/REST%20API/rest-api.md?plain=1#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
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
William Theaker 86713f1b71 Improve gitops dry run logging for query deletion (#23202) 2024-10-25 13:35:53 -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
Rachael Shaw 4cc3e3bb63 Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -05:00
Noah TalermanandAllen Houchins 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
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
Allen Houchins 278b81d7f5 Fixed minor typo in yaml-files.md (#22698)
# 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)).
2024-10-07 12:48:34 -05:00
Marko Lisica c545495f60 API design: Self-service: Install Apple App Store apps on macOS (#22102)
API design for:
- #19620
2024-10-01 17:09:33 -04:00
adf19c4527 Reference docs for v4.57.0 (#22319)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: mostlikelee <tim@mostlikelee.com>
Co-authored-by: Tim Lee <timlee@fleetdm.com>
Co-authored-by: Marko Lisica <markol.lisica@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Luke Heath <luke@fleetdm.com>
2024-09-23 15:56:59 -05:00
1677783064 GitOps & API design: Add multiple Apple Business Manager and Volume Purchasing Program connections (#21043)
GitOps and API changes for the following story:
- #9956

DONE: 
- ~~Contributor API endpoints to support best practice GitOps (`fleetctl
gitops`) and backwards compatibility GitOps (`fleetctl apply`)~~
  - https://github.com/fleetdm/fleet/pull/21043#issuecomment-2338218929

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
Co-authored-by: Dante Catalfamo <43040593+dantecatalfamo@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-09-20 12:21:52 -05:00
Marko Lisica cd62ba40e7 YAML: add missing ios_updates and ipados_updates (#21999)
We missed to document `ios_updates` and `ipados_updates` that's built as
part of the #19852
2024-09-11 17:54:34 -04:00
Noah Talerman 527021641b Reference docs: Store bootstrap package outside the Fleet database (#20671)
Reference docs and website redirect for the following story:
- #19037
2024-09-11 13:59:55 -05:00
Luke Heath 0835fa4804 Update app_store_apps docs (#22001) 2024-09-11 13:57:56 -05:00
Victor Lyuboslavsky 5eab74709d Doc updates for #21038 (#21125) 2024-09-11 09:28:18 -04:00
Roberto Dip 078c0ac3b7 document and use MDM SSO settings via gitops (#21869)
for #21313
2024-09-09 17:03:20 -03:00
Luke Heath fae3dec60f Set software as experimental in yaml docs (#21602) 2024-08-27 14:09:07 -05:00
2171544ad1 Docs quick reference optimization (#21331)
This PR closes https://github.com/fleetdm/fleet/issues/21108

@noahtalerman, I double-checked all redirects, and they are working.
Clicking through the URLs in [this
spreadsheet](https://docs.google.com/spreadsheets/d/1djVynIMuJK4pT5ziJW12CluVqcaoxxnCLaBO3VXfAt4/edit?usp=sharing)
is a pretty quick way to go through them all. Note that "Audit logs" and
"Understanding host vitals" redirect to the contributor docs on GitHub,
so they will throw a 404 until this is merged.

Some new guides benefitted from a name change, so they make more sense
as stand-alone guides, and also so that we don't have to mess around
with more redirects later. Those name changes followed [this
convention](https://fleetdm.com/handbook/company/communications#headings-and-titles),
which was recently documented in the handbook.

Have fun!

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
2024-08-16 15:30:31 -05:00
Noah Talerman e9b2217ae8 Update Fleet server configuration docs (#21283)
- Osquery configuration isn't server config
- Condense top section by removing examples
2024-08-13 13:56:04 -07:00
Marko Lisica 5b88c7d754 Agent configuration docs: Increase timeout limit for scripts (#20651)
Docs changes related to: #16645
2024-07-25 16:56:36 -04:00
Dale Ribeiro 67852a0280 added link to available options for update channels (#20529)
# 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://fleetdm.com/docs/contributing/committing-changes#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 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)).
2024-07-25 10:04:37 -04:00
Dante Catalfamo 5e1a3d03ae MySQL 8.0 Migration (#20225)
#17249
2024-07-22 16:27:36 -04:00
Benjamin Edwards e52f6c8291 update GCP terraform code to be compatible with software installers updates (#20585) 2024-07-22 11:23:44 -04:00
Austin Culter 137f58eae3 Minor Fix Fleet Server Configuration Docs Markdown Docs (#20498)
- Removes _"Optional unique identifier that can be used by the principal
assuming the role to assert its identity."_ text as it:
1. Is (possibly?) duplicative of _"AWS STS External ID to use for
Firehose authentication. This is typically used in conjunction with an
STS role ARN to ensure that only the intended AWS account can assume the
role."_
2. Seems ill-placed (even if it should persist, if should probably be
nested under the [`firehose​_sts​_external​_id`
heading](https://fleetdm.com/docs/configuration/fleet-server-configuration#firehose-sts-external-id))
- Fixes markdown formatting on `firehose_sts_assume_role_arn` by adding
another newline char so the resulting HTML gets properly rendered (as an
`<h5>`) _outside the `<ul>` tag:_

![image](https://github.com/user-attachments/assets/ace319f7-a2ac-4a6b-93d7-ef19414e2c46)

Currently looks like this on [Fleet Server Configuration
page](https://fleetdm.com/docs/configuration/fleet-server-configuration):

![image](https://github.com/user-attachments/assets/95114996-41af-4ea8-9cc5-677b49fdcf84)

# Checklist for submitter

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

(None of the checklist items applied to this change.
2024-07-17 16:51:38 -04:00
Noah Talerman 0076148a79 Docs: GitOps reference (#19740)
Docs for Fleet's best practice GitOps: #13643 (also #17043)
2024-07-02 11:11:43 -04:00
Noah Talerman 36f7406eda Server configuration docs: Comment out section (#20034)
- See commented out section for context
2024-06-28 17:11:02 -04:00
Noah Talerman e9d4749eb8 Server configuration docs: S3 for software and carves (#20032)
Docs from changes to address following bug:
- #19526
2024-06-28 10:40:02 -04:00
Dave HerderandRachael Shaw bb6ee46987 fix a broken link in MDM-setup section (#19756)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-06-14 12:17:33 -07:00
Dave Herder 6c44a12a9e Fix dead rotating enroll secrets guide link (#19667) 2024-06-11 15:56:20 -07:00
Noah Talerman 6aef9520e9 MDM setup docs: APNs and ABM in the UI (#19463) 2024-06-07 14:33:00 -07:00
Noah Talerman 23ae7c763c Server configuration docs: APNs and ABM in the UI (#19461)
- Add redirect for error message on Fleet server startup if private key
is missing: #19455
- Move the APNs and ABM environment variables to contributor docs. They
will no longer be used
2024-06-03 15:45:41 -04:00
Roberto Dip 178c0d565f Merge remote-tracking branch 'origin/main' into feat-save-certs 2024-05-30 18:34:40 -03:00
Jahziel Villasana-Espinoza 5d40c4c352 feat: add note about updating 2024-05-29 10:53:39 -04:00
Jahziel Villasana-Espinoza 52a1d3f480 fix: truncate key, docs 2024-05-29 10:36:38 -04:00
Noah Talerman 27cc943a4b Sever config docs: Deploy security agents (#19236)
Server configuration doc changes for "Deploy security agents" story
(#14921)
2024-05-23 17:07:28 -04:00
Benjamin Edwards 677835e2c3 support external id in STS Assume Role calls (#18901) 2024-05-21 13:19:35 -04:00
Rachael ShawandEric 895d4bc2f7 Use "Fleet's agent (fleetd)" naming in the docs (#18138)
For #16512

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-04-29 11:12:03 -05:00
Victor Lyuboslavsky 1dc1e23b65 Removed current_instance_checks from docs. (#18186)
#16661 

Removed current_instance_checks from docs.
2024-04-15 10:25:04 -05:00
Rachael Shaw 57a28ed18d #14916 Configuration change: Host status webhook per-team (#15612)
Adds `webhook_settings.host_status_webhook` options to team config for
#14916.

Also updated conceptual docs that reference this config (and cut down
some content to make room).
2024-04-10 15:28:17 -05:00
Rachael Shaw 42aeb9f75e Sentence-case fix (#17611)
+ Fix casing of "External activity audit logging"
+ Fix a nearby typo
2024-03-13 18:00:06 -05:00
Victor Lyuboslavsky e01c79ca7f Updating server config docs. (#17214)
Server config doc updates for:
https://github.com/fleetdm/fleet/issues/16331
2024-03-07 13:22:03 -06:00
2a60823a93 Update Kubernetes best practice docs (#16807)
- Remove example YAML file from docs to deduplicate
- Update "Prepare a new version of Fleet" handbook instructions to point
to the best practice YAML
- Add README to point to docs
- Move tools for deploying Fleet on Kubernetes to `Deploy/` folder.
- Add @dherder as CODEOWNER so that Dave gets pinged every time a
contributor wants to make a change to the Kubernetes

---------

Co-authored-by: Dave Herder <27025660+dherder@users.noreply.github.com>
Co-authored-by: Luke Heath <luke@fleetdm.com>
2024-02-27 22:49:48 -06:00
489b45368e API design: enable profiles based on labels (#15117)
API changes for the following story: 
- #14715

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Roberto Dip <me@roperzh.com>
2024-02-23 12:54:18 -06:00
Rachael Shaw 6cd2ae32dc Document team host expiry config (#17114)
Add `host_expiry` to team configuration file example.
2024-02-22 17:52:43 -06:00
Zak Scholl e173e23d08 fix: update k8s manifests for kubernetes install (#16570)
When attempting to follow the kubernetes install directions I
encountered a few issues.

1. The image version was no longer hosted on dockerhub. And new versions
now are tagged with a "v" prefix.
2. The webserver was not able to bind to port 443 on a managed version
of k8s.
3. The dns name(s) for the latest redis helm chart have changed. They
are now `{release}-master` for read-write and `{release}-replica` for
read only nodes.
4. The deployment API is out of date.

This PR fixes those issues.
2024-02-21 14:57:05 -05:00
50edcc07d0 Docs: Windows OS updates (#16270)
Docs for the "Windows OS updates" (#11951) user story

- Update "macOS updates" doc page to cross-platform "OS updates" page
- Update pricing page
- Update copy in the UI to clarify behavior of Windows updates

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-16 14:30:00 -06:00
Noah Talerman c723bd48b5 Configuration files page (#16937)
- Update interface to match what Fleet accepts today
2024-02-16 14:10:03 -06:00
Zach Wasserman d6ef0841ec Clarify Fleet Premium for self-hosted extension updates. (#16714) 2024-02-12 14:57:08 -08:00
Eric 14010452f8 Fix broken links in documentation (#16708)
Closes: #16493

Changes:
- Fixed five broken links in Fleet's documentation
2024-02-09 15:00:04 -06:00