Documentation Powered by ReDoc

InfraGraph (0.6.1)

Download OpenAPI specification:Download

URL: https://github.com/keysight/infragraph/issues License: MIT

Overview

InfraGraph or infrastructure graph defines a model-driven, vendor-neutral, standard interface for capturing a system of systems suitable for use in co-designing AI/HPC solutions.

This model allows for defining physical infrastructure as a logical system of systems using graph like terminology. In addition to defining a logical graph, an unlimited number of different physical characteristics can be associated with logical endpoints.

Graph Terminology

  • an infrastructure node (vertex) is the fundamental unit or entity within an infrastructure graph; represented as a endpoint with the following syntax:
    • a combination of a device instance name and a 0 based index and a component name and a 0 based index such as switch.0.asic.0 and switch.0.port.0
  • an infrastructure edge is a combination of two nodes (endpoints) in a graph such as (switch.0.asic.0, switch.0.port.0)
  • path is a sequence of edges that allows for traversal through the graph such as [server.0.xpu.0, server.0.nic.0, switch.0.port.0, switch.0.asic.0]

Contributions

Contributions to the API and models schema can be made in the following ways:

Configuration

set_graph

Given an infrastructure object this API method will create a fully qualified infrastructure graph and validate it.

Creating a fully qualified infrastructure graph requires the following steps:

  • process each of the infrastructure instance objects by locating the device and creating a subgraph using the device's edges and substituting the instance name for the device name.
  • process each of the infrastructure edges, looking up the instance to determine the max count and the name to be substituted for the device and link the subgraphs to create a complete infrastructure graph
Request Body schema: application/json
name
string^[\sa-zA-Z0-9-_()><\[\]]+$

The name of the infrastructure. Globally unique name of an object. It also serves as the primary key for arrays of objects.

description
string

A detailed description of the infrastructure.

Array of objects (Device)

An inventory of devices and components.

Array of objects (Link)

An inventory of the links present in the infrastructure edges.

Array of objects (Instance)

An inventory of the device instances present in the infrastructure edges.

Array of objects (Infrastructure.Edge)

An array of edge objects used to connect instance devices and components to other instance devices and components. These edge objects are used to form a fully qualified qualified graph.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "devices": [
    ],
  • "links": [
    ],
  • "instances": [
    ],
  • "edges": [
    ]
}

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

get_graph

This will return the current graph.

Request Body schema: application/json
format
string
Value: "networkx"

The format that the graph will be returned in.

Responses

Request samples

Content type
application/json
{
  • "format": "networkx"
}

Response samples

Content type
application/json
{
  • "choice": "networkx",
  • "networkx": "string"
}

annotate_graph

Extend the current graph created by the set_graph API.

  • example: Update specific endpoints with name/value information such as rank=0
Request Body schema: application/json
choice
string
Enum: "nodes" "edges"

Select whether to annotate nodes or edges..

Array of objects (Annotation.Node)

List of node annotations to apply when the choice is set to nodes.

Array of objects (Annotation.Edge)

List of edge annotations to apply when the choice is set to edges.

Responses

Request samples

Content type
application/json
{
  • "choice": "nodes",
  • "nodes": [
    ],
  • "edges": [
    ]
}

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

Actions

query_graph

Query the current fully expanded graph using a declarative query syntax.

  • example: Ask the graph for specific endpoints such as those of type XPU or NIC
Request Body schema: application/json
choice
string
Enum: "node_filters" "shortest_path_filters"

Type of filters specified in this query request.

Array of objects (QueryNodeFilter)

List of filters to match nodes.

Array of objects (QueryShortestPathFilter)

Under Review: Proposal to abstract the shortest path interface to the graph.

Add shortest path filters to retrive the shortest path between source and destination nodes

Responses

Request samples

Content type
application/json
{
  • "choice": "node_filters",
  • "node_filters": [
    ],
  • "shortest_path_filters": [
    ]
}

Response samples

Content type
application/json
{
  • "choice": "node_matches",
  • "node_matches": [
    ],
  • "shortest_path_matches": [
    ]
}

Capabilities

get_version

Responses

Response samples

Content type
application/json
{
  • "api_spec_version": "",
  • "sdk_version": "",
  • "app_version": ""
}