Skip to content

Commit 28db49f

Browse files
committed
fix: rename wos to wfm
Workload Orchestration Service (WOS) has been renamed to Workload Fleet Management (WFM) after this PR was originally created. This commit fixes it. Signed-off-by: Silvano Cirujano Cuesta <silvano.cirujano-cuesta@siemens.com>
1 parent 3ac9aec commit 28db49f

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

system-design/fleet-management/workload/workload-fleet-management-edge-onboarding.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ In order for the Workload Fleet Management software to manage the edge device's
55
66
**The onboarding process includes:**
77

8-
- The end user provides the the Workload Fleet Management web service's root URL to the device's management client
9-
- The device's management client downloads the workload orchestration solution vendor's public root CA certificate using the [Onboarding API](../../margo-api-reference/workload-api/onboarding-api/rootca-download.md)
10-
- Context and trust is established between the device's management client and the Workload Fleet Management web service
11-
- The device's management client uses the [Onboarding API](../../margo-api-reference/workload-api/onboarding-api/device-onboarding.md) to onboard with the workload orchestration service.
8+
- The end user provides the the Workload Fleet Management (WFM) web service's root URL to the device's management client
9+
- The device's management client downloads the WFM solution vendor's public root CA certificate using the [Onboarding API](../../margo-api-reference/workload-api/onboarding-api/rootca-download.md)
10+
- Context and trust is established between the device's management client and the WFM web service
11+
- The device's management client uses the [Onboarding API](../../margo-api-reference/workload-api/onboarding-api/device-onboarding.md) to onboard with the WFM.
1212
- The device's management client receives the client Id, client secret and token endpoint URL used to generate a bearer token.
1313
- The device's management client receives the URL for the Git repository containing its desired state and an associated access token for authentication
14-
- The [device capabilities](./device-capability-reporting.md) information is sent from the device to the workload orchestration web service using the [Device API](../../margo-api-reference/workload-api/device-api/device-capabilities.md)
14+
- The [device capabilities](./device-capability-reporting.md) information is sent from the device to the WFM web service using the [Device API](../../margo-api-reference/workload-api/device-api/device-capabilities.md)
1515

1616
> Note:
1717
> 🔐 Indicates communication is secure and requires authentication/authorization.
@@ -24,49 +24,49 @@ sequenceDiagram
2424
participant device as Device
2525
actor user as End User
2626
participant rendezvous as Rendezvous Server
27-
participant wos as WOS
28-
participant git as WOS: Device Git Repo
29-
note over device, git: Workload orchestration onboarding
27+
participant wfm as WFM
28+
participant git as WFM: Device Git Repo
29+
note over device, git: WFM onboarding
3030
user ->>+ device: Get device id and cert
3131
device -->>- user: return
32-
user ->> wos: Provides device id and cert to pre-register device in end user's tenant 🔐
32+
user ->> wfm: Provides device id and cert to pre-register device in end user's tenant 🔐
3333
3434
%% A background highlight could be also used here
3535
%% https://mermaid.js.org/syntax/sequenceDiagram.html#background-highlighting
3636
alt FIDO: client-initiated rendezvous
37-
user ->> rendezvous: Provides WOS URL
37+
user ->> rendezvous: Provides WFM URL
3838
else FIDO: Discoverable credentials
39-
device ->>+ rendezvous: Looks up WOS URL
39+
device ->>+ rendezvous: Looks up WFM URL
4040
rendezvous -->>- device: return
4141
end
42-
device ->>+ wos: Request WOS' public signing cert 🔓
43-
wos -->>- device: return
44-
device ->>+ wos: Send onboard request, device id and certificate 🔓
45-
wos ->> wos: Validates device id and cert with onboarding registry
46-
wos -->>- device: returns URL to check onboarding status
42+
device ->>+ wfm: Request WFM' public signing cert 🔓
43+
wfm -->>- device: return
44+
device ->>+ wfm: Send onboard request, device id and certificate 🔓
45+
wfm ->> wfm: Validates device id and cert with onboarding registry
46+
wfm -->>- device: returns URL to check onboarding status
4747
4848
loop until onboarding status is active
49-
device ->>+ wos: Checks onboarding status providing device id and certificate 🔓
50-
wos ->> wos: Validates device id and cert with onboarding registry
51-
wos -->>- device: returns in progress
49+
device ->>+ wfm: Checks onboarding status providing device id and certificate 🔓
50+
wfm ->> wfm: Validates device id and cert with onboarding registry
51+
wfm -->>- device: returns in progress
5252
end
53-
device ->>+ wos: Checks onboarding status providing device id and certificate 🔓
54-
wos ->> wos: Validates device id and cert with onboarding registry
55-
wos -->>- device: returns git repo URL and GitOps token, encrypted client id, encrypted client secret
53+
device ->>+ wfm: Checks onboarding status providing device id and certificate 🔓
54+
wfm ->> wfm: Validates device id and cert with onboarding registry
55+
wfm -->>- device: returns git repo URL and GitOps token, encrypted client id, encrypted client secret
5656
57-
device ->> wos: Uploads device capabilities
57+
device ->> wfm: Uploads device capabilities
5858
note over device, git: Workload deployment
5959
loop Until end of time
6060
device ->>+ git: Checks for updates to desired state 🔐
6161
git -->>- device: return
6262
opt
63-
device ->> wos: Requests new GitOps token 🔐
64-
wos -->> device: return
63+
device ->> wfm: Requests new GitOps token 🔐
64+
wfm -->> device: return
6565
end
6666
device ->> device: Applies new desired state
67-
device ->> wos: Sends state 🔐
68-
device ->> wos: Sends state 🔐
69-
device ->> wos: Sends final state 🔐
67+
device ->> wfm: Sends state 🔐
68+
device ->> wfm: Sends state 🔐
69+
device ->> wfm: Sends final state 🔐
7070
end
7171
```
7272

@@ -76,11 +76,11 @@ sequenceDiagram
7676

7777
> Action: Ideally this URL is discoverable instead of having to manually enter it but we still need to determine if there is a good way to make this discoverable by using something like the FIDO Rendezvous service or multicast DNS. Also, once we determine how the Margo compliant device onboarding and fleet management is going to work it will probably impact this.
7878
79-
To ensure the management client is configured to communicate with the correct Workload Fleet Management web service, the device's management client needs to be configured with the expected URL. The device vendor MUST provide a way for the end user to manually set the URL the device's management client uses to communicate with the workload orchestration solution chosen by the end user.
79+
To ensure the management client is configured to communicate with the correct Workload Fleet Management web service, the device's management client needs to be configured with the expected URL. The device vendor MUST provide a way for the end user to manually set the URL the device's management client uses to communicate with the WFM solution chosen by the end user.
8080

8181
### Margo Web API Authentication Method
8282

83-
The Margo Web API communication pattern between the device's management client and the workload orchestration web service must use a secure communication channel. In order to facilitate this secure communication Margo requires the use of oAuth 2.0 for authentication.
83+
The Margo Web API communication pattern between the device's management client and the WFM web service must use a secure communication channel. In order to facilitate this secure communication Margo requires the use of oAuth 2.0 for authentication.
8484

8585
#### API Authorization Strategy
8686

@@ -94,7 +94,7 @@ The Margo Web API communication pattern between the device's management client a
9494
9595
Because of limitations using mTLS with common OT infrastructure such as TLS terminating HTTPS load-balancer or a HTTPS proxy doing lawful inspection Margo has adopted a certificate-based payload signing approach to protect payloads from being tampered with. By utilizing the certificates to create payload envelopes, the device's management client can ensure secure transport between the device's management client and the Workload Fleet Management's web service.
9696

97-
- During the onboarding process the end user uploads the device's x.509 certificate to the workload orchestration solution
97+
- During the onboarding process the end user uploads the device's x.509 certificate to the WFM solution
9898
- The device's management client downloads the root CA certificate using the [Onboarding API](../../margo-api-reference/workload-api/onboarding-api/rootca-download.md)
9999
- Once this is complete, both parties are able to [secure their payloads](../../margo-api-reference/margo-api-specification.md#signing-payloads).
100100

@@ -110,7 +110,7 @@ Once the edge device has a message prepared for the Workload Fleet Management's
110110
- This identifier MUST be the GUID provided by the device manufacturer. Typically the hardware serial number.
111111
- The envelope is sent as the payload to the Workload Fleet Management's web service.
112112
- The Workload Fleet Management's web service treats the request's payload as envelope structure, and receives the certificate identifier.
113-
> Note: This certificate is the device certificate that was manually uploaded to the workload orchestration solution during onboarding.
113+
> Note: This certificate is the device certificate that was manually uploaded to the WFM solution during onboarding.
114114
- The Workload Fleet Management's web service computes digest from the payload, and verifies the signature using the device certification.
115115
- The payload is then processed by the Workload Fleet Management's web service.
116116

0 commit comments

Comments
 (0)