Manage scripts with YAML

[lukeheath]

CLI usage

Update config and team YAML files

See the Figma here for changes, behavior, and error messages.

Create POST to batch-apply scripts

Matches the format and behavior of POST /api/v1/fleet/mdm/apple/profiles/batch. This API endpoint is documented here.

POST /api/v1/fleet/scripts/batch

Parameters

Name	Type	In	Description
team_id	number	query	Available in Fleet Premium The team ID to apply the scripts to. Only one of team_name/team_id can be provided.
team_name	string	query	Available in Fleet Premium The name of the team to apply the scripts to. Only one of team_name/team_id can be provided.
dry_run	bool	query	Validate the provided scripts and return any validation errors, but do not apply the changes.
scripts	json	body	An array of strings, the base64-encoded script files to apply.

• If no team (id or name) is provided, the scripts are applied for all hosts (for Fleet Free) or for hosts that are not part of a team (for Fleet Premium).
• After the call, the provided list of scripts will be the active scripts for that team (or no team) - that is, any existing profile that is not part of that list will be removed, and an existing script with the same filename as a new script will be edited.
• If the list of provided script is empty, all scripts are removed for that team (or no team).

Example

POST /api/v1/scripts/batch

Default response

204

[lukeheath]

Hey team! Please add your planning poker estimate with Zenhub @gillespi314 @mna @roperzh

[mna]

@noahtalerman Questions based on the experience of the similar ticket for macos custom settings:

• I presume this should fail if MDM is not enabled?
• What is the "name" of a script? Is it just the filename or the full path (i.e. if applying path/a/script1.sh and path/b/script1.sh, is that a duplicate name or do we accept both of those)?

[mna]

@noahtalerman answering the question regarding the name from my comment above, as mentioned in the estimation meeting, the answer is in the UI figma: the name of the script is the filename (with the extension, but without any directory and path separator).

So if a script has the same filename as another script in another directory, we reject it as a duplicate.

[noahtalerman]

the name of the script is the filename

@mna correct.

if a script has the same filename as another script in another directory, we reject it as a duplicate.

Yep!

[noahtalerman]

Sarah: It would be great to have the error messages be spec'd outside of the UI and CLI because we can see where we need the same errors for CLI and UI and where they're different.

• We end up hardcoding or repeating ourselves.

[georgekarrv]

Please add your planning poker estimate with Zenhub @ghernandez345

[georgekarrv]

Please add your planning poker estimate with Zenhub @marcosd4h

[fleet-release]

Scripts managed with ease, In YAML's gentle breeze, Fleet's growth, it shall please.