Skip to content

Commit bb44890

Browse files
authored
feat: add documentation for upcoming label scoping software feature (#25045)
> Related issue: #24555 # Checklist for submitter If some of the following don't apply, delete the relevant line. <!-- Note that API documentation changes are now addressed by the product design team. --> - [x] Manual QA for all new/changed functionality
1 parent 47271bc commit bb44890

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

articles/deploy-software-packages.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Learn more about automatically installing software in a separate guide [here](ht
3535
> - [.deb extractor code](https://github.com/fleetdm/fleet/blob/main/pkg/file/deb.go#:~:text=func%20ExtractDebMetadata)
3636
> - [.rpm extractor code](https://github.com/fleetdm/fleet/blob/main/pkg/file/rpm.go#:~:text=func%20ExtractRPMMetadata)
3737
38+
* Select the hosts that you want to target with this software, under "Target". Select "All hosts" if you want the software to be available to all your hosts. Select "Custom" to scope the software to specific groups of hosts based on label membership. You can select "Include any", which will scope the software to hosts that have any of the labels you select, or "Exclude any", which will scope the software to hosts that do _not_ have the selected labels.
39+
3840
* To allow users to install the software from Fleet Desktop, check the “Self-service” checkbox.
3941

4042
* To customize installer behavior, click on “Advanced options.”

articles/install-fleet-maintained-apps-on-macos-hosts.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ Fleet maintains these [celebrity apps](https://github.com/fleetdm/fleet/blob/mai
1212

1313
1. Head to the **Software** page and click **Add software**.
1414
2. From the **Add software** page, navigate to the **Fleet-maintained** tab.
15-
3. You’ll see a list of popular apps, such as Chrome, Visual Studio Code, and Notion. Click on a row in the table to select the desired app.
16-
4. You will be taken to the app details page after selecting the app. Here, you can set the app as a self-service app, allowing hosts to install it on demand. You can also expand the **Advanced options**, which will enable you to edit the following:
15+
3. You’ll see a list of popular apps, such as Chrome, Visual Studio Code, and Notion. Click on a row in the table to select the desired app and go to its details page.
16+
4. Select the hosts that you want to target with this software, under "Target". Select "All hosts" if you want the software to be available to all your hosts. Select "Custom" to scope the software to specific groups of hosts based on label membership. You can select "Include any", which will scope the software to hosts that have any of the labels you select, or "Exclude any", which will scope the software to hosts that do _not_ have the selected labels.
17+
5. Choose whether you want the app to be self-service. [Self-service apps](https://fleetdm.com/guides/software-self-service) are available for install on demand by end users on the "My device" page, which they can access via Fleet Desktop.
18+
6. You can also expand the **Advanced options**, which will enable you to edit the following:
1719

1820
- Pre-install query
1921
- Installation script

articles/software-self-service.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,12 @@ Fleet’s self-service software feature empowers end users by allowing them to i
1818
2. **Select a team**: Click the dropdown in the upper left corner of the page and click on the team to which you want to add the software package.
1919
3. **Open the “Add software” modal**: Click the “Add software” button in the upper right corner of the page.
2020
4. **Select a software package to upload**: Click “Choose file” in the “Add software” modal and select a software package from your computer.
21-
5. **Advanced options**: If desired, click “Advanced options” to add a pre-install condition or post-install script to your software package.
21+
5. **Select the hosts that you want to target**: Select "All hosts" if you want the software to be available to all your hosts. Select "Custom" to scope the software to specific groups of hosts based on label membership. You can select "Include any", which will scope the software to hosts that have any of the labels you select, or "Exclude any", which will scope the software to hosts that do _not_ have the selected labels.
22+
6. **Advanced options**: If desired, click “Advanced options” to add a pre-install condition or post-install script to your software package.
2223
* **Pre-install condition**: This is an osquery query that results in true. For example, you might require a specific software title to exist before installing additional extensions.
2324
* **Post-install script**: This might be used to apply a license key, perform configuration tasks, or execute cleanup tasks after the software installation.
24-
6. **Make the software package self-service**: Check the “Self-service” checkbox to mark the software package as self-service.
25-
7. **Finish the upload**: Click the “Add software” button to finish the upload process.
25+
7. **Make the software package self-service**: Check the “Self-service” checkbox to mark the software package as self-service.
26+
8. **Finish the upload**: Click the “Add software” button to finish the upload process.
2627

2728
### Editing a self-service software package
2829

0 commit comments

Comments
 (0)