Device roles to capabilities - #197
Open
ajcraig wants to merge 25 commits into
Open
Conversation
Signed-off-by: Armand Craig <acraig@project.margo.org>
… files. Signed-off-by: Armand Craig <acraig@project.margo.org>
ajcraig
changed the title
Additional edits are still warranted in the observability content regarding gateway devices(this will be handled outside this PR). Signed-off-by: Armand Craig <acraig@project.margo.org>
4 tasks
ajcraig
marked this pull request as ready for review
July 30, 2026 18:35
ajcraig
changed the title
phil-abb
reviewed
Jul 31, 2026
Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…capabilities.md Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…observability-data.md Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…observability-data.md Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…capabilities.md Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…capabilities.md Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…capabilities.md Co-authored-by: Philip Presson <philip.presson@us.abb.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Signed-off-by: Armand Craig <acraig@project.margo.org>
…properties. Signed-off-by: Armand Craig <acraig@project.margo.org>
Signed-off-by: Armand Craig <acraig@project.margo.org>
phil-abb
approved these changes
Aug 3, 2026
matlec
reviewed
Aug 3, 2026
matlec
left a comment
matlec
left a comment
Contributor
There was a problem hiding this comment.
Related to my comments in collecting-workload-observability-data.md: publishing-workload-observability-data.md also still refers to the removed device roles (standalone/cluster).
| # Device Requirements | ||
|
|
||
| All current device roles MUST meet the following requirements to be considered Margo compliant. These requirements ensure devices can effectively host and manage Margo compliant workloads. A device MUST support onboarding and management from only a single workload fleet manager. | ||
| All Margo conformant devices MUST meet a baseline set of requirements to be considered Margo compliant. These requirements ensure devices can effectively manage Margo-compliant workload and/or host those workloads. A device MUST support onboarding and management from only a single workload fleet manager. A device reports what it can provide to the ecosystem through its [device capabilities](../margo-management-interface/device-capabilities.md). |
Contributor
There was a problem hiding this comment.
- The first sentence reads circular :)
- I'd align on a single wording for "Margo-conformant/-compliant" (I suggest Margo-conformant)
Suggested change
| All Margo conformant devices MUST meet a baseline set of requirements to be considered Margo compliant. These requirements ensure devices can effectively manage Margo-compliant workload and/or host those workloads. A device MUST support onboarding and management from only a single workload fleet manager. A device reports what it can provide to the ecosystem through its [device capabilities](../margo-management-interface/device-capabilities.md). | |
| A devices MUST meet a baseline set of requirements to be considered Margo-conformant. These requirements ensure devices can effectively manage Margo-conformant workload and/or host those workloads. A device MUST support onboarding and management from only a single workload fleet manager. A device reports what it can provide to the ecosystem through its [device capabilities](../margo-management-interface/device-capabilities.md). |
|
|
||
| > **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. | ||
|
|
||
| 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. |
Contributor
There was a problem hiding this comment.
Rewording needed for "standalone" / "clustered"
|
|
||
| ### Connecting to the OpenTelemetry Collector | ||
|
|
||
| In order for a workload to publish its observability data to the collector on the standalone device or cluster the device own MUST inject the following environment variables into each container. |
Contributor
There was a problem hiding this comment.
Rewording needed for "standalone" / "clustered"
|
|
||
| ## Exporting Observability Data | ||
|
|
||
| End users MUST be able to export observability data from a standalone device or cluster to collectors, or backends, onsite or in the cloud if they wish to make the information available to enable remote monitoring and diagnostics. |
Contributor
There was a problem hiding this comment.
Rewording needed for "standalone" / "clustered"
| required: [cores] | ||
| properties: | ||
| cores: | ||
| type: number |
Contributor
There was a problem hiding this comment.
The prose / table says integer, the schema number
|
|
||
| | Attribute | Type | Required? | Description | | ||
| | --- | --- | --- | --- | | ||
| | cores | integer | Y | Defines the cores available within the hosts CPU. Specified as decimal units of CPU cores (e.g., `0.5` is half a core). This is defined by the device owner. After deployment of the application, the device MUST provide this number of CPU cores for the application.| |
Contributor
There was a problem hiding this comment.
0.5 wouldn't be an accepted value for cores under type integer. See my note in the OpenAPI spec below.
…capabilities.md Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…capabilities.md Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…capabilities.md Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
…capabilities.md Co-authored-by: Matthias Lechner <matlec.public@gmail.com> Signed-off-by: Armand Craig <acraig@project.margo.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR implements the approved strategy to remove device roles in lieu of device capabilities.
Issues Addressed
Implements approved SUP linked below:
margo/specification-enhancements#63
Change Type
Please select the relevant options:
Checklist