Update guide to puppet module (#23369)

This commit is contained in:
Sarah Gillespie
2024-11-06 16:57:59 -06:00
committed by GitHub
parent dabdb81be1
commit 3ea68ae1e7
2 changed files with 11 additions and 10 deletions
+7 -7
View File
@@ -20,11 +20,11 @@ Install [Fleet's Puppet module](https://forge.puppet.com/modules/fleetdm/fleetdm
### Step 2: configure Puppet to talk to Fleet using Heira
1. In Fleet, create an API-only user with the GitOps role. Instructions for creating an API-only user are [here](./fleetctl-CLI.md#create-an-api-only-user).
1. In Fleet, create an API-only user with the GitOps role. Instructions for creating an API-only user are
[here](https://fleetdm.com/guides/fleetctl#create-api-only-user).
2. Get the API token for your new API-only user. Learn how [here](./fleetctl-CLI.md#get-the-api-token-of-an-api-only-user).
3. Set `fleetdm::host` and `fleetdm::token` values to your Fleet server's URL and the API token respectively. Here's an example of the Hiera YAML:
2. Set the `fleetdm::token` and `fleetdm::host` values to the API token of your API-only user and
your Fleet server's URL, respectively. Here's an example of the Hiera YAML:
```yaml
fleetdm::host: https://fleet.example.com
@@ -99,11 +99,11 @@ Set the `ensure` parameter to `absent` to create teams that exclude specific pro
For more examples check out the `examples/` folder in Fleet's GitHub repository [here](https://github.com/fleetdm/fleet/tree/main/ee/tools/puppet/fleetdm/examples).
> Note that all teams created by Puppet inherit the bootstrap package, macOS Setup Assistant settings, and end user authentication settings from "No team." Learn more about these [here](./mdm-setup.md). In addition all teams automatically enable disk encryption. Learn more about disk encryption [here](./MDM-disk-encryption.md).
> Note that all teams created by Puppet inherit the bootstrap package, macOS Setup Assistant settings, and end user authentication settings from "No team." Learn more about these [here](https://fleetdm.com/guides/macos-setup-experience). In addition all teams automatically enable disk encryption. Learn more about disk encryption [here](https://fleetdm.com/guides/enforce-disk-encryption).
## Release host
If you set `await_device_configured` to `true` in your [macOS Setup Assistant settings](./mdm-setup.md#macos-setup-assistant), you can use the `fleetdm::release_device` function to release the host from the Setup Assistant.
If you set `enable_release_device_manually` to `true` in your [macOS setup experience](https://fleetdm.com/docs/rest-api/rest-api#configure-setup-experience), you can use the `fleetdm::release_device` function to release the host from the Setup Assistant.
Here's what your Puppet code, with error handling, will look like:
@@ -149,7 +149,7 @@ if $err != '' {
}
```
The above example includes the XML payload for the `EnableRemoteDesktop` MDM command. Learn more about creating the payload for other custom commands [here](./MDM-commands.md).
The above example includes the XML payload for the `EnableRemoteDesktop` MDM command. Learn more about creating the payload for other custom commands [here](https://fleetdm.com/guides/mdm-commands).
<meta name="category" value="guides">
<meta name="authorGitHubUsername" value="noahtalerman">
+4 -3
View File
@@ -5736,7 +5736,7 @@ Get aggregate status counts of profiles for to macOS and Windows hosts that are
- [Delete a bootstrap package](#delete-a-bootstrap-package)
- [Download a bootstrap package](#download-a-bootstrap-package)
- [Get a summary of bootstrap package status](#get-a-summary-of-bootstrap-package-status)
- [Turn on end user authentication for macOS setup](#turn-on-end-user-authentication-for-macos-setup)
- [Configure setup experience](#configure-setup-experience)
- [Upload an EULA file](#upload-an-eula-file)
- [Get metadata about an EULA file](#get-metadata-about-an-eula-file)
- [Delete an EULA file](#delete-an-eula-file)
@@ -6105,7 +6105,7 @@ The summary can optionally be filtered by team ID.
}
```
### Turn on end user authentication for macOS setup
### Configure setup experience
_Available in Fleet Premium_
@@ -6128,7 +6128,8 @@ _Available in Fleet Premium_
```json
{
"team_id": 1,
"enabled_end_user_authentication": true
"enable_end_user_authentication": true,
"enable_release_device_manually": true
}
```