Add best practice for updating team config (#9580)

Documentation only changes.
2023-01-31 13:47:10 -05:00
parent 4c4c114e96
commit ee0d93a80f
1 changed files with 33 additions and 0 deletions
@@ -171,6 +171,39 @@ The `secrets` section provides the list of enroll secrets that will be valid for
      - secret: RzTlxPvugG4o4O5IKS/HqEDJUmI1hwBoffff
      - secret: JZ/C/Z7ucq22dt/zjx2kEuDBN0iLjqfz
  ```
+### Modify an existing team
+
+You can modify an existing team by applying a new team configuration file with the same `name` as an existing team. The new team configuration will completely replace the previous configuration. In order to avoid overiding existing settings, we reccomend retreiving the existing configuration and modifying it. 
+
+Retrieve the team configuration and output to a YAML file:
+
+```console
+% fleetctl get teams --name Workstations --yaml > workstation_config.yml
+```
+After updating the generated YAML, apply the changes:
+
+```console
+% fleetctl apply -f workstation_config.yml
+```
+
+Depending on your Fleet version, you may see `unsupported key` errors for the following keys when applying the new team configuration:
+
+```
+id 
+user_count 
+host_count 
+integrations 
+webhook_settings 
+description 
+agent_options 
+created_at 
+user_count 
+host_count 
+integrations 
+webhook_settings
+```
+
+You can bypass these errors by removing the key from your YAML or adding the `--force` flag. This flag will force application of the changes without validation. Proceed with caution.

 #### Mobile device management (MDM) settings