You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/margo-api-reference/workload-api/application-package-api/resources/index.md.jinja2
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ The expected properties for the suppported deployment types are indicated below.
71
71
| --- | --- | --- | --- |
72
72
| repository | string | Y | The URL indicating the helm chart's location.|
73
73
| 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.|
75
75
| 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. |
76
76
77
77
- Properties for `compose` components
@@ -82,7 +82,7 @@ The expected properties for the suppported deployment types are indicated below.
82
82
| --- | --- | --- | --- |
83
83
| packageLocation | string | Y | The URL indicating the Compose package's location. |
84
84
| 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.|
86
86
| 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.|
Copy file name to clipboardExpand all lines: system-design/device-interoperability/collecting-workload-observability-data.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,15 +82,15 @@ For devices running non-clustered container platforms such as Docker or Podman t
82
82
83
83
> **Note:** Please see the [information below](#workload-observability-default-telemetry) for the default metrics emitted by the Host Metrics Receivers.
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.
88
88
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.
90
90
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.
92
92
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.
94
94
95
95
> **Action:** We need to understand what the WOS/a is going to be doing to determine what this is.
96
96
@@ -114,7 +114,7 @@ End users MUST be able to export observability data from a standalone device or
114
114
> **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.
115
115
>
116
116
> **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.
118
118
119
119
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.
Copy file name to clipboardExpand all lines: system-design/device-interoperability/device-requirements.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,15 +24,15 @@ The Cluster Leader Role within Margo describes devices that have the ability to
24
24
25
25
**Cluster Leader Functional Requirements:**
26
26
27
-
- Host the "Workload Fleet Management Agent" Interface
27
+
- Host the Workload Fleet Management Client
28
28
- This enables the device with the functionality outlined within the [Workload Management](../margo-overview/workload-management-interface-overview.md) section of the specification
29
29
- Enable management functionality via Kubernetes API
30
30
- Host the following additional components:
31
31
- Helm Client (Provider)
32
32
- OCI Container Runtime
33
33
- OTEL Collector
34
34
- Policy Agent
35
-
- Host Device Fleet Management Agent
35
+
- Host Device Fleet Management Client
36
36
-> Note: this functionality is coming soon to the specification
37
37
38
38
## Cluster Worker Role Details
@@ -46,7 +46,7 @@ The Cluster Worker Role within Margo describes devices that have a limited amoun
46
46
- OCI Container Runtime
47
47
- OTEL Collector
48
48
- Policy Agent
49
-
- Host Device Fleet Management Agent
49
+
- Host Device Fleet Management Client
50
50
-> Note: this functionality is coming soon to the specification
51
51
52
52
## Standalone Cluster Role Details
@@ -65,11 +65,11 @@ The Standalone Device role represents a device that can host Margo Compliant Wor
65
65
66
66
**Standalone Device functional requirements:**
67
67
68
-
- Host the "Workload Fleet Management Agent" Interface
68
+
- Host the Workload Fleet Management Client
69
69
- This enables the device with the functionality outlined within the [Workload Management](../margo-overview/workload-management-interface-overview.md) section of the specification
70
70
- Host the following additional components:
71
71
- OCI Container Runtime
72
72
- OTEL Collector
73
73
- 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