Skip to content

Commit

Permalink
GitOps docs: Install software (#20502)
Browse files Browse the repository at this point in the history
- Update GitOps reference to cover the following user stories:
  - #14921 (4.50)
  - #18867 (4.55)
  - #19447 (4.56)
  - #19550 (4.56)
  • Loading branch information
noahtalerman authored Jul 19, 2024
1 parent 0d56d8a commit 3126c05
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/Using Fleet/GitOps.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ policies:
queries:
agent_options:
controls:
software:
org_settings: # Only default.yml
team_settings: # Only teams/team-name.yml
```
Expand All @@ -33,6 +34,7 @@ team_settings: # Only teams/team-name.yml
- [queries](#queries)
- [agent_options](#agent-options)
- [controls](#controls)
- [software](#software)
- [org_settings and team_settings](#org-settings-and-team-settings)
### policies
Expand Down Expand Up @@ -279,6 +281,43 @@ The `macos_setup` section lets you control the [end user migration workflow](htt

Can only be configure for all teams (`default.yml`).

### software

The `software` section allows you to configure packages and Apple App Store apps that you want to install on your hosts.

- `packages` is a list of software packages (.pkg, .msi, .exe, or .deb) and software specific options.
- `app_store_apps` is a list of Apple App Store apps.

##### Example

```yaml
software:
packages:
- url: https://github.com/organinzation/repository/package-1.pkg
install_script:
path: /lib/crowdstrike-install.sh
pre_install_query:
path: /lib/check-crowdstrike-configuration-profile.queries.yml
post_install_script:
path: /lib/crowdstrike-post-install.sh
self_service: true
- url: https://github.com/organinzation/repository/package-2.msi
app_store_apps:
- app_store_id: 1091189122
```

#### packages

- `url` specifies the URL at which the software is located. Fleet will download the software and upload it to S3 (default: `""`).
- `install_script.path` specifies the command Fleet will run on hosts to install software. The [default script](https://github.com/fleetdm/fleet/tree/main/pkg/file/scripts) is dependent on the software type (i.e. .pkg).
- `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/account_policy_data) (default: `""`).
- `post_install_script.path` is the script Fleet will run on hosts after intalling software (default: `""`).
- `self_service` specifies whether or not end users can install from **Fleet Desktop > Self-service**.

#### app_store_apps

- `app_store_id` is the ID of the Apple App Store app. You can find this at the end of the app's App Store URL. For example, "Bear - Markdown Notes" URL is "https://apps.apple.com/us/app/bear-markdown-notes/id1016366447" and the `app_store_id` is `1016366447` (default: `0`).

### org_settings and team_settings

#### features
Expand Down

0 comments on commit 3126c05

Please sign in to comment.