Repository navigation
Bunch of docs changes to clarify Fleet enrollment #555
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.
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
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a55390e
docs: don't register Fleet-synced hosts; clarify when to use the API …
tashian c2f0c95
docs: point Fleet auto-approval links at the live API docs slug
tashian 24fda4a
docs: osquery-based enrollment for Fleet, 2026-05-01 API, auto-approv…
tashian 43a567d
Merge branch 'main' into docs/eff-334-fleet-osquery-enrollment
tashian 8af1701
Merge branch 'main' into docs/eff-334-fleet-osquery-enrollment
tashian 5184686
Merge branch 'main' into docs/eff-334-fleet-osquery-enrollment
tashian ea081f2
Include macOS in osquery-based enrollment guidance (#555)
tashian a00de19
Merge branch 'main' into docs/eff-334-fleet-osquery-enrollment
tashian File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -952,4 +952,6 @@ publicKey | |
| serialNumber | ||
| testuser | ||
| disallow | ||
| osquery | ||
| fleetctl | ||
| APNs | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| updated_at: May 21, 2026 | ||
| updated_at: September 8, 2026 | ||
| title: Connect Fleet DM to Smallstep | ||
| html_title: Integrate Fleet DM with Smallstep Tutorial | ||
| description: Connect Fleet DM with Smallstep for device security. Complete guide for deploying certificates and syncing device inventory using Fleet's device management platform. | ||
|
|
@@ -289,10 +289,13 @@ Once the enrollment report is configured in Fleet, the Smallstep platform needs | |
| 2. In the Smallstep console, edit your Fleet configuration | ||
| 3. Set the **Enrollment Query ID** to the numeric ID | ||
|
|
||
| Your fleet's TPM information will begin syncing to Smallstep. | ||
|
|
||
| ## Step 5. Linux agent configuration | ||
|
|
||
| Linux does not support MDM configuration profiles, so the SCEP enrollment flow used for macOS and Windows does not apply. Instead, the Smallstep agent on Linux registers directly using TPM attestation. After installing the agent package and the osquery extension, you must configure the agent with your Smallstep team slug and CA fingerprint. | ||
| Linux does not support MDM configuration profiles, so the SCEP enrollment flow used for macOS and Windows does not apply. Instead, the Smallstep agent on Linux uses ACME Device Attestation with the system's TPM. | ||
|
|
||
| After installing the agent package and the osquery extension, you must configure the agent with your Smallstep team slug and CA fingerprint. | ||
|
|
||
| When adding a Linux agent package in Fleet, add the following **post-install script** to configure and start the agent: | ||
|
|
||
|
|
@@ -311,8 +314,34 @@ systemctl daemon-reload | |
| systemctl enable --now step-agent | ||
| ``` | ||
|
|
||
| When the agent starts, it attests with the endpoint's TPM. Smallstep matches the attestation to the inventory data you just synced. By default, devices synced from Fleet need admin approval: if the host shows as `pending` in the [Smallstep console](https://smallstep.com/app/?next=/devices), approve it there. | ||
|
|
||
| To approve Fleet-synced devices automatically, add `Fleet` to `autoApproveSources` in your team's device enrollment policy. This setting isn't exposed in the Smallstep console. Use the [Device Enrollment Policy API](https://gateway.smallstep.com/v2026-05-01/operations/PutDeviceEnrollmentPolicy) with an [API token](https://smallstep.com/app/?next=/settings/api/tokens/add) that has the `get-device-enrollment-policy` and `put-device-enrollment-policy` scopes. The `PUT` replaces the whole policy, so fetch the current policy first and resubmit it with `Fleet` added to `autoApproveSources`: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. May be good to add UI for this in the console. |
||
|
|
||
| After deployment, Linux devices will self-register with your Smallstep team via TPM attestation. By default, new devices require admin approval in the [Smallstep console](https://smallstep.com/app/?next=/devices). To automate approval, you can [pre-register devices via API](../platform/smallstep-agent.mdx#pre-registration-via-api). | ||
| ```bash | ||
| set +o history | ||
| echo "Authorization: Bearer [your API token]" > api_headers | ||
| set -o history | ||
|
|
||
| # Fetch the current policy | ||
| curl -sH @api_headers --request GET \ | ||
| --url https://gateway.smallstep.com/api/device-enrollment-policy \ | ||
| --header 'Accept: application/json' \ | ||
| --header 'x-smallstep-api-version: 2026-05-01' | jq | ||
|
|
||
| # Resubmit it with Fleet in autoApproveSources. | ||
| # Adjust both lists to match the policy you fetched. | ||
| curl -sH @api_headers --request PUT \ | ||
| --url https://gateway.smallstep.com/api/device-enrollment-policy \ | ||
| --header 'Accept: application/json' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --header 'x-smallstep-api-version: 2026-05-01' \ | ||
| --data '{ | ||
| "allowedSources": ["Smallstep API", "Smallstep Agent", "Fleet"], | ||
| "autoApproveSources": ["Fleet"], | ||
| "requireUserBinding": true | ||
| }' | jq | ||
| ``` | ||
|
|
||
| ## Step 6. Confirmation (Linux) | ||
|
|
||
|
|
@@ -444,7 +473,34 @@ Add the Smallstep agent MSI as Fleet software so it installs on enrollment: | |
| 2. In the Fleet console, go to **Software**, choose **Add software → Custom package**, and upload the MSI | ||
| 3. Scope the install to your Windows hosts | ||
|
|
||
| The agent reads the registry values written in Step 3 on startup, and completes TPM-attested registration with your Smallstep team. | ||
| On startup, the agent reads the registry values to find the team information, then attests with the endpoint's TPM. Smallstep matches the attestation to the inventory data synced from Fleet. | ||
|
|
||
| By default, devices synced from Fleet need admin approval: if the host shows as pending in the [Smallstep console](https://smallstep.com/app/?next=/devices), approve it there. To approve Fleet-synced devices automatically, add `Fleet` to `autoApproveSources` in your team's device enrollment policy. This setting isn't exposed in the Smallstep console. Use the [Device Enrollment Policy API](https://gateway.smallstep.com/v2026-05-01/operations/PutDeviceEnrollmentPolicy) with an [API token](https://smallstep.com/app/?next=/settings/api/tokens/add) that has the `get-device-enrollment-policy` and `put-device-enrollment-policy` scopes. The `PUT` replaces the whole policy, so fetch the current policy first and resubmit it with `Fleet` added to `autoApproveSources`: | ||
|
|
||
| ```bash | ||
| set +o history | ||
| echo "Authorization: Bearer [your API token]" > api_headers | ||
| set -o history | ||
|
|
||
| # Fetch the current policy | ||
| curl -sH @api_headers --request GET \ | ||
| --url https://gateway.smallstep.com/api/device-enrollment-policy \ | ||
| --header 'Accept: application/json' \ | ||
| --header 'x-smallstep-api-version: 2026-05-01' | jq | ||
|
|
||
| # Resubmit it with Fleet in autoApproveSources. | ||
| # Adjust both lists to match the policy you fetched. | ||
| curl -sH @api_headers --request PUT \ | ||
| --url https://gateway.smallstep.com/api/device-enrollment-policy \ | ||
| --header 'Accept: application/json' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --header 'x-smallstep-api-version: 2026-05-01' \ | ||
| --data '{ | ||
| "allowedSources": ["Smallstep API", "Smallstep Agent", "Fleet"], | ||
| "autoApproveSources": ["Fleet"], | ||
| "requireUserBinding": true | ||
| }' | jq | ||
| ``` | ||
|
|
||
| ## Step 6. Confirmation (Windows) | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like auto-approve being off is the case, but I'm curious if this was changed recently? I don't remember adding the MDM using the API myself.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like we actually have a fallback with defaults, but that currently doesn't include Fleet atm.
I'll open a PR with that change. After that gets merged, one would not have to call the API anymore, unless they need customization.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My thought about the fallback seems to be wrong; it's a different knob.
Still don't remember having had to use the API myself to add Fleet to auto-approve, though.