Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[YAML design] Setup experience: scope software via labels when Macs boot #26109

Open
wants to merge 4 commits into
base: docs-v4.65.0
Choose a base branch
from

Conversation

noahtalerman
Copy link
Member

@noahtalerman noahtalerman commented Feb 5, 2025

YAML and redirect changes for the following user story:

@@ -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).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant