Skip to content

[YAML] Pin Fleet-maintained apps to a specific version #35972

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Nov 20, 2025
Merged

[YAML] Pin Fleet-maintained apps to a specific version #35972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0108e25
Document automatic_updates field for fleet_maintained_apps
marko-lisica Nov 19, 2025
bdfd4ef
update
marko-lisica Nov 19, 2025
9452060
Apply suggestion from @marko-lisica
marko-lisica Nov 19, 2025
125c647
Apply suggestion from @marko-lisica
marko-lisica Nov 19, 2025
06d2cb2
Add route for available FMA versions
marko-lisica Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/Configuration/yaml-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,7 @@ software:
setup_experience: true
fleet_maintained_apps:
- slug: slack/darwin
pin_version: "4.47.59"
install_script:
path: ../lib/software/slack-install-script.sh
uninstall_script:
Expand Down Expand Up @@ -594,14 +595,15 @@ Currently, one app for each of an App Store app's supported platforms are added,

- `fleet_maintained_apps` is a list of Fleet-maintained apps. Provide the `slug` field to include a Fleet-maintained app on a team. To find the `slug`, head to **Software > Add software** and select a Fleet-maintained app, then select **Show details**. You can also see the [list of app slugs on GitHub](https://github.com/fleetdm/fleet/blob/main/ee/maintained-apps/outputs/apps.json).

Currently, Fleet-maintained apps will be updated to the latest version published by Fleet when GitOps runs.
By default, Fleet-maintained apps will be updated to the latest version published by Fleet when GitOps runs.

The below fields are all optional.

- `self_service` specifies whether end users can install from **Fleet Desktop > Self-service**.
- `pre_install_query.path` is the osquery query Fleet runs before installing the software. Software will be installed only if the [query returns results](https://fleetdm.com/tables).
- `post_install_script.path` is the script that, if supplied, Fleet will run on hosts after the software installs.
- `icon.path` is a relative path to the PNG icon that will be displayed in Fleet and on **Fleet Desktop > Self-service** instead of the default icon the icon sourced from Apple. It must be a square PNG with dimensions between 120x120 px and 1024x1024 px. Custom icons will only override the icon for the software title and team where they are added.
- `pin_version` specifies the version of the package that will be downloaded by Fleet. Version can be set only to the version that is available in [the app's metadata on GitHub](https://github.com/fleetdm/fleet/tree/main/ee/maintained-apps/outputs). If version isn't specified, Fleet downloads the latest version as soon as it's available in the app's metadata.
Copy link
Member Author

@marko-lisica marko-lisica Nov 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Dev note

  • If the user specifies a version that is not the current version, not available here in Fleet's repo, show following error:
1 error occured: Couldn't edit "<file_name>" at "<full_path>": specified version is not available. Find available versions: https://fleetdm.com/learn-more-about/available-fma-versions

See this PR for error format: PR link


The below fields are optional, and if omitted will default to values specified in [the app's metadata on GitHub](https://github.com/fleetdm/fleet/tree/main/ee/maintained-apps/outputs).

Expand Down
1 change: 1 addition & 0 deletions website/config/routes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,6 +1012,7 @@ module.exports.routes = {
'GET /learn-more-about/built-in-variables': '/docs/configuration/yaml-files#variables',
'GET /learn-more-about/apple-available-os-updates': 'guides/enforce-os-updates',
'GET /learn-more-about/disable-entra-conditional-access': '/guides/entra-conditional-access-integration#disable',
'GET /learn-more-about/available-fma-versions': 'https://github.com/fleetdm/fleet/tree/main/ee/maintained-apps/outputs',

// Sitemap
// =============================================================================================================
Expand Down
Loading