Commit graph

27 commits

Author SHA1 Message Date
Marko Lisica
8b073d577c
Update docs and guide about variables (#25445)
Related to:
- https://github.com/fleetdm/fleet/issues/23238#issuecomment-2591300093
2025-01-16 13:34:28 -05:00
Dante Catalfamo
39466cb644
Use webhooks settings from gitops even when empty (#25347)
#24958

---------

Co-authored-by: Scott Gress <scottmgress@gmail.com>
2025-01-15 11:31:48 -05:00
Rachael Shaw
378b404421
Documentation changes for v4.62.0 (#25315)
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2025-01-09 18:04:34 -06:00
Noah Talerman
5f9fcfc9f4
YAML files reference docs: windows_migration_enabled (#24891)
- Add missing reference docs for the following user story:
  - #22075
2024-12-19 14:37:49 -05:00
Rachael Shaw
c4a2bb4d6b
4.61 documentation changes (#24833)
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-12-17 15:39:24 -06:00
Noah Talerman
6e4ddaeab9
YAML files reference docs: labels and users coming soon, ticket creation, ABM and VPP (#24480) 2024-12-10 17:50:04 -05:00
Noah Talerman
c8ac4067a8
Missing YAML files (GitOps) reference docs (#24362)
- Add `uninstall_script` for `packages`
- This feature was shipped as part of the following user story: #20320
  - Looks like we forgot to merge in the reference docs
2024-12-05 11:20:16 -06:00
Allen Houchins
8b8f5f0649
Update yaml-files.md (#24371)
- Disk encryption for Linux
2024-12-04 18:08:53 -05:00
William Theaker
a7ec57e881
Fix gitops secret example (#24217)
The current string doesn't work.
2024-12-04 16:03:25 -06:00
Marko Lisica
42d51a5b05
[YAML changes] Custom OS settings: "include any label" option for custom target (#23648) 2024-12-03 18:15:38 -05: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
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
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
4cc3e3bb63
Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -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
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
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
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
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
Luke Heath
0835fa4804
Update app_store_apps docs (#22001) 2024-09-11 13:57:56 -05: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
Mike Thomas
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
Renamed from docs/Using Fleet/GitOps.md (Browse further)