From 9ef382389e8d20105b19f443f6282fee34bcb29e Mon Sep 17 00:00:00 2001 From: Eugene Date: Tue, 25 Feb 2025 07:44:43 +1000 Subject: [PATCH] Update yaml-files.md intro section for legibility and to call out missing or mispelled settings. (#26459) Updated top text area for legibility and to call out what happens to missing or mispelled settings. These changes were prompted by https://github.com/fleetdm/fleet/issues/26450 --------- Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com> --- docs/Configuration/yaml-files.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/Configuration/yaml-files.md b/docs/Configuration/yaml-files.md index 521ec46df3..f59ce9948f 100644 --- a/docs/Configuration/yaml-files.md +++ b/docs/Configuration/yaml-files.md @@ -1,12 +1,10 @@ # YAML files -Use Fleet's best practice GitOps workflow to manage your computers as code. +Use Fleet's best practice GitOps workflow to manage your computers as code. To learn how to set up a GitOps workflow see the [Fleet GitOps repo](https://github.com/fleetdm/fleet-gitops). -Fleet GitOps is a declarative configuration management system. You define your desired Fleet settings in YAML files and Fleet GitOps makes it so. -Any settings not defined in your YAML files will be reset to the default values, which may include deleting assets such as software packages. 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. -To learn how to set up a GitOps workflow see the [Fleet GitOps repo](https://github.com/fleetdm/fleet-gitops). +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. The following are the required keys in the `default.yml` and any `teams/team-name.yml` files: