mirror of
https://github.com/fleetdm/fleet
synced 2026-04-29 09:27:18 +00:00
2a18f56655
For #24473 # Checklist for submitter <!-- 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. ## Details This PR adds the ability to manage labels via GitOps. Usage is as follows: * If a top-level `labels:` key is provided in the global YAML file provided to GitOps, then any labels in this list will be created (if using a new name) or updated (if using an existing name). * If no top-level `labels:` key is provided, no changes will be made to labels. This allows backwards-compatibility; customers won't blow away all of their labels if they don't immediately use `labels:` in their YAML Additionally, some new validation has been added so that label usage is checked prior to application. This means that when the gitops command is run, it will verify that any labels referenced elsewhere in the YAML (e.g. by software installers or mdm profiles) exist, and will bail with an error message if they don't. ## Testing **Test label deletion** 1. Add some labels via the UI 2. Run `fleetctl gitops --dry-run` with a default.yml file _without_ `labels:` in it, and verify that it doesn't say it will update or delete any labels 2. Run `fleetctl gitops` with a default.yml file _without_ `labels:` in it, and verify that it doesn't modify or remove your labels 4. Run `fleetctl gitops --dry-run` with a default.yml file with `labels:` in it and nothing underneath, and verify that it says that it will delete your labels 4. Run `fleetctl gitops` with a default.yml file with `labels:` in it and nothing underneath, and verify that it removes all your labels **Test label create/update** 1. Add a label "foo" via the UI 2. Run `fleetctl gitops --dry-run` with a default.yml file with two `labels:` in it, one named "foo" and one named "bar". Verify that the output says that one label will be created and one will be updated. 2. Run `fleetctl gitops` with a default.yml file with two `labels:` in it, one named "foo" and one named "bar". Verify that the two labels now exist in the UI with the configuration you specified. **Test label usage** 1. Add a label "foo" in the UI. 1. Run `fleetctl gitops --dry-run` with a default.yml file _without_ `labels:` in it, where a software installer or mdm profile uses the "foo" label via `labels_include_any`. Verify that the output doesn't complain about unknown labels. 1. Run `fleetctl gitops --dry-run` with a default.yml file _with_ `labels:` in it with nothing underneath, and a software installer or mdm profile uses the "foo" label via `labels_include_any`. Verify that the output complains about unknown label "foo" 1. Run `fleetctl gitops --dry-run` with a default.yml file _with_ `labels:` in it with a "foo" label defined underneath, and a software installer or mdm profile uses the "foo" label via `labels_include_any`. Verify that the output doesn't complain about unknown labels. |
||
|---|---|---|
| .. | ||
| lib | ||
| subdir | ||
| global_config_no_paths.yml | ||
| global_config_no_paths_no_controls.yml | ||
| global_config_no_paths_no_labels.yml | ||
| global_config_windows_migration_false_false.yml | ||
| global_config_windows_migration_false_true.yml | ||
| global_config_windows_migration_true_false.yml | ||
| global_config_windows_migration_true_true.yml | ||
| global_integration.yml | ||
| global_macos_custom_settings_valid_deprecated.yml | ||
| global_macos_windows_custom_settings_valid.yml | ||
| global_windows_custom_settings_invalid_label_mix.yml | ||
| global_windows_custom_settings_invalid_label_mix_2.yml | ||
| global_windows_custom_settings_unknown_label.yml | ||
| no_team_setup_software_invalid_script.yml | ||
| no_team_setup_software_invalid_software_package.yml | ||
| no_team_setup_software_invalid_vpp_app.yml | ||
| no_team_setup_software_valid.yml | ||
| no_team_software_installer_install_not_found.yml | ||
| no_team_software_installer_invalid_both_include_exclude.yml | ||
| no_team_software_installer_invalid_self_service_value.yml | ||
| no_team_software_installer_invalid_unknown_label.yml | ||
| no_team_software_installer_no_url.yml | ||
| no_team_software_installer_not_found.yml | ||
| no_team_software_installer_post_install_not_found.yml | ||
| no_team_software_installer_pre_condition_multiple_queries.yml | ||
| no_team_software_installer_pre_condition_not_found.yml | ||
| no_team_software_installer_subdir.yml | ||
| no_team_software_installer_too_large.yml | ||
| no_team_software_installer_uninstall_not_found.yml | ||
| no_team_software_installer_unsupported.yml | ||
| no_team_software_installer_valid.yml | ||
| no_team_software_installer_valid_exclude.yml | ||
| no_team_software_installer_valid_include.yml | ||
| team_config_no_paths.yml | ||
| team_config_webhook.yml | ||
| team_macos_custom_settings_valid_deprecated.yml | ||
| team_macos_windows_custom_settings_invalid_labels_mix.yml | ||
| team_macos_windows_custom_settings_invalid_labels_mix_2.yml | ||
| team_macos_windows_custom_settings_unknown_label.yml | ||
| team_macos_windows_custom_settings_valid.yml | ||
| team_setup_software_invalid_script.yml | ||
| team_setup_software_invalid_software_package.yml | ||
| team_setup_software_invalid_vpp_app.yml | ||
| team_setup_software_valid.yml | ||
| team_software_installer_install_not_found.yml | ||
| team_software_installer_invalid_both_include_exclude.yml | ||
| team_software_installer_invalid_self_service_value.yml | ||
| team_software_installer_invalid_unknown_label.yml | ||
| team_software_installer_no_url.yml | ||
| team_software_installer_not_found.yml | ||
| team_software_installer_post_install_not_found.yml | ||
| team_software_installer_pre_condition_multiple_queries.yml | ||
| team_software_installer_pre_condition_multiple_queries_apply.yml | ||
| team_software_installer_pre_condition_not_found.yml | ||
| team_software_installer_subdir.yml | ||
| team_software_installer_too_large.yml | ||
| team_software_installer_uninstall_not_found.yml | ||
| team_software_installer_unsupported.yml | ||
| team_software_installer_valid.yml | ||
| team_software_installer_valid_apply.yml | ||
| team_software_installer_valid_env_query.yml | ||
| team_software_installer_valid_exclude.yml | ||
| team_software_installer_valid_include.yml | ||
| team_vpp_empty_adamid.yml | ||
| team_vpp_incorrect_type.yml | ||
| team_vpp_invalid_app.yml | ||
| team_vpp_invalid_app_labels_both.yml | ||
| team_vpp_invalid_app_labels_exclude_any.yml | ||
| team_vpp_invalid_app_labels_include_any.yml | ||
| team_vpp_valid_app.yml | ||
| team_vpp_valid_app_labels_exclude_any.yml | ||
| team_vpp_valid_app_labels_include_any.yml | ||
| team_vpp_valid_app_self_service.yml | ||
| team_vpp_valid_empty.yml | ||