OpenConfig Documentation Portal

Welcome to the OpenConfig documentation portal. To ensure our technical documentation remains up-to-date and close to the implementation, most of our detailed guides and specifications are hosted directly in their respective GitHub repositories.

Use the cards below to navigate to the relevant documentation.

FAQs

Common questions about the OpenConfig project, goals, and participation.

Read FAQs

User Guides

Tutorials, style guides, and "OpenConfig by Example" documentation hosted on GitHub.

View on GitHub

YANG Data Models

Schema Path Explorer

Search, filter, and browse the unified list of all schema paths defined in OpenConfig models.

Explore Paths

Schema Documentation

View detailed, interactive documentation and tree views for each YANG module.

View Documentation

Model Info (GitHub)

Specific model overviews (QoS, Network Instance, EVPN, etc.) on GitHub.

View on GitHub

Management Protocols

gNMI Spec

Detailed specification for the gRPC Network Management Interface.

View Spec

gNOI Spec

Documentation and protobufs for the gRPC Network Operations Interface.

View Docs

ProtoMap Explorer

An interactive visual map for navigating OpenConfig gRPC services and message structures. Created by Roman Dodin.

Explore ProtoMap