Commit graph

2038 commits

Author SHA1 Message Date
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
Luke Heath
c471577dd5
Preserve manual release instructions (#22867) 2024-10-11 11:34:38 -05:00
Martin Angers
6224a5f81f
Fix: document mdm_enrolled activity limitations for Microsoft enrollments (#22793) 2024-10-09 19:03:09 -05:00
Ian Littman
92bb7ec666
Add policy ID and name to activity for automated software installs, list Fleet as author rather than installer uploader (#22747)
#22424, #22705

TODO: integration test updates

# 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] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added/updated tests
- [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
2024-10-09 18:15:56 -05:00
Ian Littman
5339794f97
Include the policy ID and name in the "script ran" activity of a script run queued by a policy failure (#22690)
#22692 

# 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] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added/updated tests
- [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
2024-10-08 15:45:31 -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
Katheryn Satterlee
3e44610200
Remove dead links (#22635)
Removed dead links for os versions in 'hosts' endpoint list

# Checklist for submitter

Docs only change
2024-10-04 14:28:37 -05:00
Tim Lee
46ade66c0f
Align battery health reporting (#22569) 2024-10-02 15:43:19 -06:00
Mike McNeil
4de7eb9f1c
Linux disk encryption :: Update standard-query-library.yml (#22498)
Credit: @jbilling
2024-10-02 16:20:35 -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
Noah Talerman
beec753a3f
API docs: OTA enrollment profile (#22457)
- Bring OTA enrollment profile endpoint into REST API docs
2024-10-01 17:07:30 -04:00
Mike McNeil
514ca727ec
Update why-fleet.md (#22499) 2024-10-01 15:38:00 -05:00
Tim Lee
937627f4ea
Windows Battery Status (#22455) 2024-09-30 16:58:00 -06:00
Mike Thomas
9b04349192
Update why-fleet.md (#22290)
Updated and optimized for readability and consistency with Fleet's
messaging.

Closes https://github.com/fleetdm/fleet/issues/22150
2024-09-27 16:18:43 -05:00
Allen Houchins
c211572242
Refreshed and updated content (#21982)
Updated the "How to uninstall osquery" document to no longer reference
older osquery references and file paths that no longer exist.

---------

Co-authored-by: JD <spokanemac@users.noreply.github.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2024-09-27 16:16:38 -05:00
Victor Lyuboslavsky
710465c1a3
Fixing Building Fleet docs (#22293)
- use correct node version
- update to use "docker compose", which is now integrated with Docker
2024-09-27 11:41:26 -05:00
Noah Talerman
0e22e4676e
Add missing anchor link (#22427)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-09-26 13:48:25 -05:00
Marko Lisica
8c705533ea
Document packages_only flag for list software titles endpoint (#22390) 2024-09-25 16:17:38 -05:00
Jahziel Villasana-Espinoza
38ba6cce47
fix: update docs with accurate response body (#22360) 2024-09-25 09:44:08 -05:00
Dante Catalfamo
d83ed46373
Add batch app store apps documentation (#21912) 2024-09-23 18:09:31 -05:00
Lucas Manuel Rodriguez
21b3c468c1
Add doc API changes for the now async software batch (#22259)
API changes for #22069.

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
2024-09-23 17:40:53 -05:00
Lucas Manuel Rodriguez
dfc7289a6d
Add missing docs for batch apply VPP apps (#22265)
#22069
2024-09-23 17:24:08 -04:00
Noah Talerman
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
Rebecca Cowart
a17ab39ab6
Update button name in deploy-fleet.md (#22271)
Render changed their "Apply" button to read "Deploy Blueprint"
2024-09-20 14:57:13 -05:00
Noah Talerman
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
Ian Littman
518a4a1f98
Use previous package filename for activity if installer edit doesn't change the package (#22177)
Also adds a line in the makefile help for generate-doc, as it took me
way too long to find that command this time.

# Checklist for submitter

- [x] Manual QA for all new/changed functionality
2024-09-17 15:21:25 -05:00