Skip to content

Integrate MIAF and WFM identity profile SUPs - #25

Open
matlec wants to merge 2 commits into
pre-draftfrom
feat/miaf-integration
Open

Integrate MIAF and WFM identity profile SUPs#25
matlec wants to merge 2 commits into
pre-draftfrom
feat/miaf-integration

Conversation

@matlec

@matlec matlec commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Description

Integrates the two voted MIAF SUPs into the concepts and lexicon. This is the non-normative companion to the specification PR.

What changes

  • Adds an Identity and Trust concept page under a new Concepts > Identity section. It explains the Trust Domain model, SVIDs, the MIS role, and mutual TLS, with a diagram and links into the normative spec.
  • Rewrites Device Client Onboarding around MIAF. Operator-provisioned identities and mutual TLS replace the root-CA download, the WFM-assigned client identifier, and per-request payload signatures.
  • Updates the Device Capabilities wording so capability reporting happens when the client first connects rather than at onboarding.
  • Adds an Identity Terms group to the technical lexicon: Trust Domain, SPIFFE ID, SVID, Trust Bundle, Margo Identity Service, Principal, WFM Identity, and WFM Client Identity.

Issues Addressed

Change Type

Please select the relevant options:

  • Fix (change that resolves an issue)
  • New enhancement (change that adds specification content)
  • Content edits (change that edits existing content)

Checklist

  • I have read the CONTRIBUTING document.
  • My changes adhere to the established patterns, and best practices.

@matlec
matlec requested a review from a team as a code owner July 20, 2026 19:39
@phil-abb
phil-abb self-requested a review July 21, 2026 10:21

@phil-abb phil-abb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did an initial review and didn't spot anything to comment on.

matlec added 2 commits August 6, 2026 09:40
Integrate the MIAF and WFM Identity Profile SUPs
into the concepts and lexicon: add the Identity and
Trust page, rewrite device client onboarding around
operator-provisioned SVIDs and mTLS, and add MIAF
identity terms.

Signed-off-by: Matthias Lechner <matlec.public@gmail.com>
The trust bundle is served as a single SPIFFE bundle, not a
SPIFFE Bundle Map.

Signed-off-by: Matthias Lechner <matlec.public@gmail.com>
@matlec
matlec force-pushed the feat/miaf-integration branch from 32c9123 to 1ca3aa7 Compare August 6, 2026 10:07
@ajcraig
ajcraig self-requested a review August 11, 2026 17:50

## Why identity lives at the Trust Domain level

A single industrial deployment often mixes hardware and software from several vendors. One environment might run more than one Workload Fleet Manager, from different suppliers, each managing its own devices. If each WFM defined its own identities and distributed its own trust anchors, nothing would recognize anything issued elsewhere, and every pairing of components would need its own bespoke trust setup.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend a reword on this paragraph, removing the notion of many fleet managers as Margo is trying to solve that issue :).
Recommendation is to reword to "many vendors of apps and devices with a fleet manager"

A Container Image Registry hosts container images. [Components](#component) which are provided as Helm Charts or Compose Archives link to such container images. No newline at end of file
A Container Image Registry hosts container images. [Components](#component) which are provided as Helm Charts or Compose Archives link to such container images.

## Identity Terms

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm questioning the need for the technical details supplied in this section. URI forms / spiffee forms for WFM Identity and WFM Client identity.

I think we can simplify these descriptions, then utilizing the links you have provided to enable the user to go "deeper" into the technical details within the concepts or specification sections.


#### Principal

A non-human Margo component that holds, or is being provisioned with, an identity in a [Trust Domain](#trust-domain). [Edge Compute Devices](#edge-compute-device), [Workload Fleet Managers](#workload-fleet-manager), and WFM Clients are all principals.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just something small here, but in this section we are treating edge devices and wfm clients as seperate principal entities in Margo.

I think it would read cleaner if we removed Edge Compute Devices since the WFM Client is the actual entity receiving a spiffee id from the trust domain.

@@ -1,43 +1,76 @@
# Device Client Onboarding

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be too controversial to rename this WFM Client Onboarding.

I'm sensitive to the fact the client can represent 1 to many devices. This still reads as a 1 to 1.

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.

3 participants