[YAML design] Setup experience: scope software via labels when Macs boot #26109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
noahtalerman
had a problem deploying
to
Docker Hub
GitHub Actions
Error
noahtalerman
had a problem deploying
to
Docker Hub
GitHub Actions
Error
noahtalerman
had a problem deploying
to
Docker Hub
GitHub Actions
Error
noahtalerman
temporarily deployed
to
Docker Hub
GitHub Actions
Inactive
noahtalerman
commented
Feb 5, 2025
| @@ -352,6 +348,7 @@ Use `labels_include_any` to target hosts that have any label in the array or `la | |||
| - `uninstall_script.path` is the script Fleet will run on hosts to uninstall software. The [default script](https://github.com/fleetdm/fleet/tree/main/pkg/file/scripts) is dependent on the software type (i.e. .pkg). | |||
| - `post_install_script.path` is the script Fleet will run on hosts after the software install. There is no default. | |||
| - `self_service` specifies whether or not end users can install from **Fleet Desktop > Self-service**. | |||
| - `setup_experience` specifies whether the app will be installed when the host is first step up. Currently this works only for macOS apps (i.e. .pkg). | |||
There was a problem hiding this comment.
Dev note
If setup_experience is set to true for a Windows or Linux package, error and show the following message:
Error: Currently, setup_experience is only supported for macOS (.pkg) packages.
noahtalerman
commented
Feb 5, 2025
| @@ -300,7 +297,6 @@ The `macos_setup` section lets you control the out-of-the-box macOS [setup exper | |||
| - `enable_end_user_authentication` specifies whether or not to require end user authentication when the user first sets up their macOS host. | |||
| - `macos_setup_assistant` is a path to a custom automatic enrollment (ADE) profile (.json). | |||
| - `script` is the path to a custom setup script to run after the host is first set up. | |||
| - `software` is a list of references to either a `package_path` matching a package in the `software` section below or an `app_store_id` to install when the host is first set up. | |||
There was a problem hiding this comment.
Dev note
Remove macos_setup.software and remove it from the docs. Support macos_setup.software for backwards compatibility.
If setup_experience is set to true for one or more software items and macos_setup.software is defined, error and show the following message:
Error: "macos_setup.software has been deprecated. Please use setup_experience in your software YAML instead: https://fleetdm.com/learn-more-about/yaml-setup-experience-software
This was referenced Feb 5, 2025
noahtalerman
added
the
~api-or-yaml-design
rachaelshaw
approved these changes
Feb 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
YAML and redirect changes for the following user story: