Skip to content

update gnmi documentation on website #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wisotzky wants to merge 2 commits into
base: master
Choose a base branch
from
Open

update gnmi documentation on website #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35a351d
Add missing gNMI docs to references
wisotzky Oct 13, 2025
8b898b8
Update README.md
wisotzky Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions ietf/drafts/draft-openconfig-rtgwg-gnmi-spec-01.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,13 +269,88 @@
<date month="January" year="2018" />
</front>
</reference>
<reference anchor="GNMI-CONFIG-SUBS" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-config-subscriptions.md">
Copy link

@earies earies Oct 13, 2025

Choose a reason for hiding this comment

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

This .xml source for the long expired draft should not be touched unless there is intention to bring this back through the IETF (which I believe is highly unlikely nor of interest at this point) - essentially these old references can stay untouched for historical reasons is all imo.

Copy link
Author

@wisotzky wisotzky Oct 14, 2025

Choose a reason for hiding this comment

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

Hej Ebben (@earies),

My main concern is that the documentation hosted on openconfig.net feels quite incomplete. While the Markdown files for gNMI extensions exist in the GitHub repository, they don’t seem to be used when rendering the website.

My assumption was that the XML document serves as an index of relevant files—similar to how mkdocs.yml works—and that it’s used in the CI flow to publish the site. But perhaps I missed something.

I’d be happy to help improve the publishing setup and ensure the docs are properly surfaced on the webpage. Pointing people directly to subfolders in the GitHub repo doesn’t feel like the right long-term solution.

/wiso

Copy link

@earies earies Oct 14, 2025

Choose a reason for hiding this comment

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

Agreed - outside of the specification .md, I think doc reordering, a proper index and cleanup is necessary.... YMMV with the other docs atm.

This .xml is just the source to generate a draft for submission through the IETF so it's historical and not for the intentions you suggest. Worth keeping around but not to be edited.

<front>
<title>gNMI Config Subscription Extension</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="July" year="2024" />
</front>
</reference>
<reference anchor="GNMI-DEPTH" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-depth.md">
<front>
<title>gNMI Depth Extension</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="March" year="2024" />
</front>
</reference>
<reference anchor="GNMI-SECURITY" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-authentication.md">
<front>
<title>gNMI Authentication and Encryption</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="October" year="2016" />
</front>
</reference>
<reference anchor="GNMI-DECIMAL64" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/decimal64-deprecation.md">
<front>
<title>Deprecation of Decimal64 in gNMI</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="April" year="2022" />
</front>
</reference>
<reference anchor="GNMI-HISTORY" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-history.md">
<front>
<title>gNMI History Extension</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="August" year="2020" />
</front>
</reference>
<reference anchor="GNMI-MASTER-ARBITRATION" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-master-arbitration.md">
<front>
<title>gNMI Support for Multiple Client Roles and Master Arbitration</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="October" year="2016" />
</front>
</reference>
<reference anchor="GNMI-PATH-CONVENTIONS" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-path-conventions.md">
<front>
<title>Schema path encoding conventions for gNMI</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="June" year="2017" />
</front>
</reference>
<reference anchor="GNMI-PATH-STRINGS" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-path-strings.md">
<front>
<title>Representing gNMI Paths as Strings</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="October" year="2018" />
</front>
</reference>
<reference anchor="GNMI-UNION-REPLACE" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-union_replace.md">
<front>
<title>union_replace gNMI method</title>
<author><organization>OpenConfig operator working group</organization></author>
</front>
</reference>
<reference anchor="GNMI-COMMIT-CONFIRMED" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-commit-confirmed.md">
<front>
<title>gNMI Commit Confirmed Extension</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="September" year="2023" />
</front>
</reference>
<reference anchor="GNMI-GRPCTUNNEL" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmignoissh-dialout-grpctunnel.md">
<front>
<title>gNMI/gNOI/SSH Dial-out via gRPC Tunnel</title>
<author><organization>OpenConfig operator working group</organization></author>
</front>
</reference>
<reference anchor="GNMI-PROTOBUF-VALS" target="https://github.com/openconfig/reference/blob/master/rpc/gnmi/protobuf-vals.md">
<front>
<title>Carrying Binary Wire Format Protobuf Messages in gNMI</title>
<author><organization>OpenConfig operator working group</organization></author>
<date month="May" year="2018" />
</front>
</reference>
<reference anchor="OPENCONFIG" target="http://www.openconfig.net/">
<front>
<title>OpenConfig</title>
Expand Down
14 changes: 13 additions & 1 deletion rpc/gnmi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,24 @@ The protobuf specification is stored in

The repository contents are as follows:


* Specification for gNMI - [gnmi-specification.md](gnmi-specification.md).
* Authentication Specification for gNMI - [gnmi-authentication.md](gnmi-authentication.md)
* Path Conventions for gNMI - [gnmi-path-conventions.md](gnmi-path-conventions.md)
* gNMI Support for Multiple Client Roles and Master Arbitration - [gnmi-master-arbitration.md](gnmi-master-arbitration.md)
* gNMI/gNOI/SSH Dial-out via gRPC Tunnel - [gnmignoissh-dialout-grpctunnel.md](gnmignoissh-dialout-grpctunnel.md)

* Deprecation of Decimal64 in gNMI - [decimal64-deprecation.md](decimal64-deprecation.md).
* Representing gNMI Paths as Strings - [gnmi-path-strings.md](gnmi-path-strings.md).
* `union_replace` gNMI method - [gnmi-union_replace.md](gnmi-union_replace.md).
* Carrying Binary Wire Format Protobuf Messages in gNMI - [protobuf-vals.md](protobuf-vals.md).

gNMI Extensions:

* Extensions to gNMI - [gnmi-extensions.md](gnmi-extensions.md).
* gNMI Commit Confirmed Extension - [gnmi-commit-confirmed.md](gnmi-commit-confirmed.md).
* gNMI Config Subscription Extension - [gnmi-config-subscriptions.md](gnmi-config-subscriptions.md).
* gNMI Depth Extension - [gnmi-depth.md](gnmi-depth.md).
* gNMI History Extension - [gnmi-history.md](gnmi-history.md).

**Note:** This is not an official Google product.