Device Client Onboarding

In order for the Workload Fleet Management software to manage the edge device's workloads, the device's management client must first complete onboarding.

• Requests to this endpoint MUST be authenticated using the HTTP Message Signature method as defined in the Payload Security section.

Onboarding Sequence

• The end user provides the the Workload Fleet Management web service's root URL to the device's management client
• The device's management client downloads the Workload Fleet Manager's public root CA certificate using the Certificate API
• Context and trust is established between the device's management client and the Workload Fleet Management web service
• The device's management client uses the Onboarding API to onboard with the Workload Fleet Management service by providing its X.509 certificate
• The device's management client receives its unique client Id assigned via the Workload Fleet Manager
• The device capabilities information is sent from the device to the WFM using the Device API

Onboarding Sequence diagram

Onboarding API Details

Route and HTTP Methods

POST /api/v1/onboarding

Request Body Attributes

Example Request Body

{ 
  "apiVersion": "onboarding.margo.org/v1alpha1",
  "kind": "OnboardingRequest",
  "certificate": "MIIDdzCCAl+gAwIBAgIEb1...<truncated Base64 X.509 cert>...."
}

Response Codes

Example Response Body

{
    "clientId": "<base-64 encoded UUID or other URL safe string identifier>"
}