Skip to content

Commit 4b79fb3

Browse files
ajcraigphil-abb
andauthored
Update WFM technical lexicon throughout specification (#83) Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com>
* Initial commit to build consistency around new technical lexicon Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Update system-design/margo-overview/workload-management-interface-overview.md Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> * Additional lexicon fixes based on FB. Upgrade to the system design drawing. Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> * Additional tweaks following fb. Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> * Quick drawing update commit. agent --> client Signed-off-by: Armand Craig <ajcraig@ra.rockwell.com> --------- Signed-off-by: Armand Craig <110038079+ajcraig@users.noreply.github.com> Co-authored-by: Philip Presson <philip.presson@us.abb.com>
1 parent f8268f2 commit 4b79fb3

19 files changed

+4352
-2211
lines changed

src/margo-api-reference/workload-api/application-package-api/resources/index.md.jinja2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The expected properties for the suppported deployment types are indicated below.
7171
| --- | --- | --- | --- |
7272
| repository | string | Y | The URL indicating the helm chart's location.|
7373
| revision | string | Y | The helm chart's full version.|
74-
| wait | bool | N | If `True`, indicates the device MUST wait until the helm chart has finished installing before installing the next helm chart. The default is `True`. The Workload Orchestration Agent MUST support `True` and MAY support `False`. Only applies if multiple `helm.v3` components are provided.|
74+
| wait | bool | N | If `True`, indicates the device MUST wait until the helm chart has finished installing before installing the next helm chart. The default is `True`. The Workload Fleet Management Client MUST support `True` and MAY support `False`. Only applies if multiple `helm.v3` components are provided.|
7575
| timeout | string | N | The time to wait for the component's installation to complete. If the installation does not completed before the timeout occurs the installation process fails. The format is "##m##s" indicating the total number of minutes and seconds to wait. |
7676

7777
- Properties for `compose` components
@@ -82,7 +82,7 @@ The expected properties for the suppported deployment types are indicated below.
8282
| --- | --- | --- | --- |
8383
| packageLocation | string | Y | The URL indicating the Compose package's location. |
8484
| keyLocation | string | N | The public key used to validated the digitally signed package. It is highly recommend to digitally sign the package. When signing the package PGP MUST be used.|
85-
| wait | bool | N | If `True`, indicates the device MUST wait until the Compose file has finished starting up before starting the next Compose file. The default is `True`. The Workload Orchestration Agent MUST support `True` and MAY support `False`. Only applies if multiple `compose` components are provided.|
85+
| wait | bool | N | If `True`, indicates the device MUST wait until the Compose file has finished starting up before starting the next Compose file. The default is `True`. The Workload Fleet Management Client MUST support `True` and MAY support `False`. Only applies if multiple `compose` components are provided.|
8686
| timeout | string | N | The time to wait for the component's installation to complete. If the installation does not completed before the timeout occurs the installation process fails. The format is "##m##s" indicating the total number of minutes and seconds to wait.|
8787

8888
## Defining configurable application parameters

system-design/device-interoperability/collecting-workload-observability-data.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,15 @@ For devices running non-clustered container platforms such as Docker or Podman t
8282

8383
> **Note:** Please see the [information below](#workload-observability-default-telemetry) for the default metrics emitted by the Host Metrics Receivers.
8484
85-
## Workload Fleet Management Agent Observability Requirements
85+
## Workload Fleet Management Client Observability Requirements
8686

87-
For several reasons, it is recommended the workload fleet management agent be deployed as a containerized workload. If it is deployed this way, the workload's resource utilization observability data is captured automatically as part of the container platform observability requirements.
87+
For several reasons, it is recommended the Workload Fleet Management Client be deployed as a containerized workload. If it is deployed this way, the workload's resource utilization observability data is captured automatically as part of the container platform observability requirements.
8888

89-
If the device owner chooses not to deploy the workload fleet management agent as a containerized workload they MUST ensure the following resource usage observability data is available from the OpenTelemetry collector for their agent.
89+
If the device owner chooses not to deploy the Workload Fleet Management Client as a containerized workload they MUST ensure the following resource usage observability data is available from the OpenTelemetry collector for their client.
9090

91-
> **Action:** Need to do research to determine if this makes sense, or not, when the agent is not running as a containerized workload. We may have to leave it up to what is covered through device observability for this case. If it is possible, and makes sense, we need to define what should be provided.
91+
> **Action:** Need to do research to determine if this makes sense, or not, when the client is not running as a containerized workload. We may have to leave it up to what is covered through device observability for this case. If it is possible, and makes sense, we need to define what should be provided.
9292
93-
In addition to the resource utilization data the workload fleet management agent MUST also send the following minimum set of workload observability data to the open telemetry collector on the standalone device or cluster. The device owner MAY choose to provided additional observability data if they wish.
93+
In addition to the resource utilization data the Workload Fleet Management Client MUST also send the following minimum set of workload observability data to the open telemetry collector on the standalone device or cluster. The device owner MAY choose to provided additional observability data if they wish.
9494

9595
> **Action:** We need to understand what the WOS/a is going to be doing to determine what this is.
9696
@@ -114,7 +114,7 @@ End users MUST be able to export observability data from a standalone device or
114114
> **Decision Needed:** There is a dependency on the decisions about using OpenTelemetry instead of the management API approach. If OpenTelemetry is chosen then there would be some subset of data that MUST be exported to the workload fleet manager supplier.
115115
>
116116
> **Future Decision:**
117-
> For MVS1 we have decided the configuration is updated manually. We know this is not ideal because it is error prone and can result in changes being made that should not be made. The current thinking is that the device fleet management agent will be responsible for updating the configuration when the WOS vendor or customer needs to add exports but this is out of scope for MVS1.
117+
> For MVS1 we have decided the configuration is updated manually. We know this is not ideal because it is error prone and can result in changes being made that should not be made. The current thinking is that the Device Fleet Management Client will be responsible for updating the configuration when the WOS vendor or customer needs to add exports but this is out of scope for MVS1.
118118
119119
OpenTelemetry allows using either a push or pull approach for getting data from a collector. Cloud based workload fleet management or observability platform service vendors should NOT require a pull method for collecting observability data because most end users will not allow devices to be exposed to the internet because of security concerns.
120120

system-design/device-interoperability/device-requirements.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ The Cluster Leader Role within Margo describes devices that have the ability to
2424

2525
**Cluster Leader Functional Requirements:**
2626

27-
- Host the "Workload Fleet Management Agent" Interface
27+
- Host the Workload Fleet Management Client
2828
- This enables the device with the functionality outlined within the [Workload Management](../margo-overview/workload-management-interface-overview.md) section of the specification
2929
- Enable management functionality via Kubernetes API
3030
- Host the following additional components:
3131
- Helm Client (Provider)
3232
- OCI Container Runtime
3333
- OTEL Collector
3434
- Policy Agent
35-
- Host Device Fleet Management Agent
35+
- Host Device Fleet Management Client
3636
- > Note: this functionality is coming soon to the specification
3737
3838
## Cluster Worker Role Details
@@ -46,7 +46,7 @@ The Cluster Worker Role within Margo describes devices that have a limited amoun
4646
- OCI Container Runtime
4747
- OTEL Collector
4848
- Policy Agent
49-
- Host Device Fleet Management Agent
49+
- Host Device Fleet Management Client
5050
- > Note: this functionality is coming soon to the specification
5151
5252
## Standalone Cluster Role Details
@@ -65,11 +65,11 @@ The Standalone Device role represents a device that can host Margo Compliant Wor
6565

6666
**Standalone Device functional requirements:**
6767

68-
- Host the "Workload Fleet Management Agent" Interface
68+
- Host the Workload Fleet Management Client
6969
- This enables the device with the functionality outlined within the [Workload Management](../margo-overview/workload-management-interface-overview.md) section of the specification
7070
- Host the following additional components:
7171
- OCI Container Runtime
7272
- OTEL Collector
7373
- Policy Agent
74-
- Host Device Fleet Management Agent
75-
- **Note:** Out of scope for MVS1
74+
- Host Device Fleet Management Client
75+
- > Note: this functionality is coming soon to the specification

0 commit comments

Comments
 (0)