Skip to content

Bunch of docs changes to clarify Fleet enrollment - #555

Open
tashian wants to merge 3 commits into
mainfrom
docs/eff-334-fleet-osquery-enrollment
Open

Bunch of docs changes to clarify Fleet enrollment#555
tashian wants to merge 3 commits into
mainfrom
docs/eff-334-fleet-osquery-enrollment

Conversation

@tashian

@tashian tashian commented Sep 8, 2026

Copy link
Copy Markdown
Member

Describe your changes:

Follow-up to EFF-334.

Fleet tutorial (tutorials/connect-fleet-dm-to-smallstep.mdx)

  • Linux and Windows agent steps: describe enrollment and how it relates to Fleet osquery inventory sync.
  • Replace the "pre-register via API" approval pointer. Devices synced from Fleet need admin approval by default. Auto-approval is a setting that the console does not expose, so both platform sections now include API curl examples.

Enrollment guide (platform/enrollment-guide.mdx)

  • Recommend osquery-based enrollment for Fleet-managed Linux and Windows hosts.
  • Device API links and the curl example move from the 2025-01-01 to the 2026-05-01 API version.

Agent guide (platform/smallstep-agent.mdx)

  • Add Fleet to the MDM tutorial list

Troubleshooting guide (platform/troubleshooting-agent.mdx)

  • New symptom under "Device approval and attestation" for unprocessable entity / duplicate-registration prompt on a device that already exists in inventory, with the fix and cleanup steps.

Related links/other PRs/issues:

🤖 Generated with Claude Code

https://claude.ai/code/session_017MzPzeUonmnLSsg2KvYgAK

…path

Hosts that Fleet syncs to Smallstep with the osquery extension already
exist in inventory. Running `step-agent register` on them creates a
conflicting device entry and fails with `unprocessable entity`. Say so
in the Fleet tutorial (Linux and Windows), add the symptom to the
troubleshooting guide, and reframe self-registration and API
pre-registration in the agent guide and enrollment guide as the paths
for devices Smallstep can't sync from an MDM.

Also replace the Linux approval pointer in the Fleet tutorial: devices
synced from Fleet need admin approval by default, and auto-approval is
set through the Device Enrollment Policy API, not by adding the device
via API.

Fixes EFF-334.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017MzPzeUonmnLSsg2KvYgAK
@tashian
tashian requested a review from a team as a code owner September 8, 2026 16:04
tashian and others added 2 commits September 8, 2026 09:39
The API docs site keys operations by PascalCase operationId
(PutDeviceEnrollmentPolicy) and the 2026-05-01 version is current.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017MzPzeUonmnLSsg2KvYgAK
…al curl

- Enrollment guide: add an osquery-based enrollment section for Fleet, and
  move the device API examples to the 2026-05-01 API version.
- Fleet tutorial: describe Linux enrollment as ACME Device Attestation with
  the TPM, and show the curl flow for adding Fleet to autoApproveSources via
  the Device Enrollment Policy API, since the console doesn't expose it.
- Agent guide and troubleshooting: tighten the wording around
  pre-registration and the duplicate-registration symptom.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017MzPzeUonmnLSsg2KvYgAK
@tashian tashian changed the title docs: don't register Fleet-synced hosts; clarify when to use the API path Bunch of docs changes to clarify Fleet enrollment Sep 8, 2026
@tashian
tashian enabled auto-merge September 8, 2026 18:30
@tashian
tashian requested a review from hslatman September 8, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant