Models and APIs

Overview

Nephio APIs consist primarily of a collection of Go API objects, CRDs, and other KRM types, specified and maintained in the Nephio API repository. This section aims to give a high-level overview of the objects that are available and their relationships, and is based on an original document developed by Tal Liron.

The aim is to keep the diagrams as simple as possible for now and only convey the important aspects of the modeled entities. As such, they are intended to give a high-level overview of the entities and relationships that can be accessed and modified via the Nephio API, and provide reference to detailed documentation, generated from the code, where available.

Topology and network APIs

This is a high-level overview of the Nephio models and their relationships, with links to the relevant API documentation where available, and to the source code where not.

A detailed API description can be found here.

Porch

A detailed API description of Porch can be found here.