[doc]: Define in-box gNOI client access model - #2482
Open
hdwhdw wants to merge 1 commit into
Open
Conversation
Signed-off-by: Dawei Huang <daweihuang@microsoft.com>
Collaborator
|
/azp run |
This was referenced Aug 3, 2026
|
No pipelines are associated with this pull request. |
There was a problem hiding this comment.
Pull request overview
Adds a new management-plane HLD to define the SONiC in-box gNOI Python client packaging boundary and a deny-by-default policy for granting containers access to the local gNMI/gNOI Unix-domain socket, along with a supporting access-model diagram.
Changes:
- Documented the
sonic_grpc(gNOI client) packaging model, transport options (secure TCP, insecure TCP, UDS), and security implications of UDS access. - Defined deny-by-default UDS admission criteria and suggested test expectations for future in-box consumers.
- Added a draw.io source diagram for the package and access-policy model.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| doc/mgmt/gnmi/gnoi_client_access_hld.md | New HLD describing the in-box gNOI client package boundary and UDS access policy/security model. |
| doc/mgmt/gnmi/images/gnoi_client_access.drawio | New diagram source illustrating package generation/distribution and UDS admission/access paths. |
Contributor
Author
|
/copilot review |
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
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.
Why I did it
sonic-buildimage PR 28341 adds a typed Python gNOI client to
sonic-py-common. The package and access to the local gNMI/gNOI Unix socket are separate capabilities, so SONiC needs an explicit policy for granting that socket to in-box containers.How I did it
Added an HLD that documents:
sonic_grpcSystem and File modules;By default, the
gnmiserver owner has read-write access to/var/run/gnmi;swss,syncd, andpmonhave no/var/run/gnmimount.Verification
npx --yes markdownlint-cli@0.45.0 doc/mgmt/gnmi/gnoi_client_access_hld.md.drawiosource: 0 errors, 0 warnings.drawiosource and visually inspected for overlaps, crossings, and clipped labelsDependencies