Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

Update yaml-files.md (#31413)

Browse Source 
Added a section discussing how pathing works within Fleet’s GitOps to
help clear up any confusion. This was requested by a customer in the
Fleet Slack channel:


https://fleetdm.slack.com/archives/C05LE08TUD7/p1753812814755329?thread_ts=1753804250.222989&cid=C05LE08TUD7

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
This commit is contained in:
Mitch Francese
2025-08-08 10:32:20 -05:00
committed by GitHub
co-authored by Rachael Shaw
parent 974bc00862
commit 6d5927c95c
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Configuration/yaml-files.md
+12 -2
View File
@@ -4,9 +4,9 @@ Use Fleet's best practice GitOps workflow to manage your computers as code. To l
Fleet GitOps workflow is designed to be applied to all teams at once. However, the flow can be customized to only modify specific teams and/or global settings.
Users that have global admin permissions may apply GitOps configurations globally and to all teams, while users whose permissions are scoped to specific teams may apply settings to only to teams they has permissions to modify.
Users with global admin permissions may apply GitOps configurations globally and to all teams, while users whose permissions are scoped to specific teams may apply settings to only the teams they have permission to modify.
Any settings not defined in your YAML files (including missing or mispelled keys) will be reset to the default values, which may include deleting assets such as software packages.
Any settings not defined in your YAML files (including missing or misspelled keys) will be reset to the default values, which may include deleting assets such as software packages.
The following are the required keys in the `default.yml` and any `teams/team-name.yml` files:
@@ -20,6 +20,16 @@ software: # Can be defined in teams/no-team.yml too
org_settings: # Only default.yml
team_settings: # Only teams/team-name.yml
```
Paths in YAML files are always relative to the file you’re editing.
For example:
```yaml
# If the file is in the same directory:
package_path: package_name.yml
# If the file is in a different directory:
package_path: ../software/package_name.yml
```
You may also wish to create specialized API-Only users which may modify configurations through GitOps, but cannot access fleet through the UI. These specialized users can be created through `fleetctl user create` with the `--api-only` flag, and then assigned the `GitOps` role, and given global or team scope in the UI.