Skip to content

Gateway SUP integration#180

Open
julienduquesnay-se wants to merge 3 commits into
pre-draftfrom
gateway-sup
Open

Gateway SUP integration#180
julienduquesnay-se wants to merge 3 commits into
pre-draftfrom
gateway-sup

Conversation

@julienduquesnay-se
Copy link
Copy Markdown

Description

Specification update related to the Gateway SUP. Add support of gateway service.

Issues Addressed

#137

Change Type

Please select the relevant options:

  • [] Fix (change that resolves an issue)
  • New enhancement (change that adds specification content)
  • Content edits (change that edits existing content)

Checklist

  • I have read the CONTRIBUTING document.
  • My changes adhere to the established patterns, and best practices.

@julienduquesnay-se julienduquesnay-se requested a review from a team as a code owner May 14, 2026 14:54
@phil-abb phil-abb self-requested a review May 15, 2026 10:16
@phil-abb
Copy link
Copy Markdown
Contributor

@julienduquesnay-se - I won't be able to review this until next week.

@phil-abb
Copy link
Copy Markdown
Contributor

@julienduquesnay-se - would you mind updating your branch? It's showing changes related to the helm PR as changes in your branch

@julienduquesnay-se
Copy link
Copy Markdown
Author

@julienduquesnay-se - would you mind updating your branch? It's showing changes related to the helm PR as changes in your branch

@phil-abb, I was trying to merge the latest changes from the "pre-draft" branch, and it looks like it grabbed your latest commit. I might need help to clean that up.

Signed-off-by: Julien Duquesnay <julien.duquesnay@se.com>
Signed-off-by: Julien Duquesnay <julien.duquesnay@se.com>
Signed-off-by: Julien Duquesnay <julien.duquesnay@se.com>
@phil-abb
Copy link
Copy Markdown
Contributor

@julienduquesnay-se - would you mind updating your branch? It's showing changes related to the helm PR as changes in your branch

@phil-abb, I was trying to merge the latest changes from the "pre-draft" branch, and it looks like it grabbed your latest commit. I might need help to clean that up.

I rebased via the GitHub PR UI, and it looks ok now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should not be added to this repo. It should be added to the General Website Content repo

The specification repo should only contain the files related directly to the specification. There is an open PR to delete the other files from this repo, but it's still in draft state (@ajcraig)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same with this diagram.

| message | string | Y | Associated error message that provides further details to the WFM about the error that was encountered. |

> Note: Error codes and messages are implementation-specific.
When the error is generated by a see-thru gateway, the source attribute of the error structure MUST be set to the gateway device id, with its full hierachy if applicable.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be good to link to the location where th types of gateways is explained.

Comment on lines +75 to +77
> Note: Most error codes and messages are implementation-specific.

> Note: the purpose of the `source` attribute is to avoid collision between reserved error codes and implementation-specific error codes.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can these two notes be combined?

| 101 | Unknown child device ID | Id of the gateway | The gateway cannot identify the child device with the given ID. |
| 102 | Child device unreachable | Id of the gateway | The gateway cannot establish a connection with the child device. |

When the error used is a reserved code for gateway-generated error, the `source` attribute MUST be set to the id of the gateway, with its full hierachy if applicable.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When the error used is a reserved code for gateway-generated error, the `source` attribute MUST be set to the id of the gateway, with its full hierachy if applicable.
When the error used is a reserved code for a gateway-generated error, the `source` attribute MUST be set to the id of the gateway, with its full hierachy if applicable.

DeviceId:
# format: "{id}[/{id}[/{id}...]]"
# Top-level id is required and must include only Unreserved Characters as specified in RFC3986.
# Subsequent ids are optional, but if present must include only Unreserved Characters as specified in RFC3986.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Subsequent ids are optional, but if present must include only Unreserved Characters as specified in RFC3986.
# Subsequent ids are optional, but if present must include only unreserved characters as specified in RFC3986.

pattern: '^[A-Za-z0-9._~-]+(\/[A-Za-z0-9._~-]+)*$'
DeviceId_with_asterisk:
# format: "{id}[/{id}[/{id}...]/*]"
# Top-level id is required and must include only Unreserved Characters as specified in RFC3986.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Top-level id is required and must include only Unreserved Characters as specified in RFC3986.
# Top-level id is required and must include only unreserved characters as specified in RFC3986.

DeviceId:
# format: "{id}[/{id}[/{id}...]]"
# Top-level id is required and must include only Unreserved Characters as specified in RFC3986.
# Subsequent ids are optional, but if present must include only Unreserved Characters as specified in RFC3986.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a better way to phrase this? They are not really optional because you have to use them to provide the information for child devices.

DeviceId_with_asterisk:
# format: "{id}[/{id}[/{id}...]/*]"
# Top-level id is required and must include only Unreserved Characters as specified in RFC3986.
# Subsequent ids are optional, but if present must include only Unreserved Characters as specified in RFC3986.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

Comment thread mkdocs.yml
- concepts/workload-fleet-managers/workload-deployment.md
- Edge Compute Devices:
- concepts/edge-compute-devices/devices.md
- Gateways:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to check on this with the new combined website layout. I'm not sure how we add to the navigation now. I'm not sure if this file is used anymore.

@ajcraig do you know?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants