graph

Documentation

Overview

Package graph builds deterministic dependency graphs from native Ramen resources without reading state or invoking an executor.

The graph package is part of Ramen's supported v0.1 core API.

Index

• Constants
• func DOT(doc Document) string
• type Diagnostic
• type Document
  • func BuildProject(doc *project.Document) Document
• type GraphEdge
• type GraphNode
• type Node
  • func Sort(nodes []Node) ([]Node, error)
• type OperationRef

Constants

const DocumentVersion = "ramen.graph.v1"

Functions

func DOT

func DOT(doc Document) string

Types

type Diagnostic

type Diagnostic struct {
	Code          string `json:"code"`
	Severity      string `json:"severity"`
	Message       string `json:"message"`
	Address       string `json:"address,omitempty"`
	APISourceKind string `json:"api_source_kind,omitempty"`
	APISourceID   string `json:"api_source_id,omitempty"`
	OperationID   string `json:"operation_id,omitempty"`
}

type Document

type Document struct {
	Version     string       `json:"version"`
	ProjectPath string       `json:"project_path,omitempty"`
	Nodes       []GraphNode  `json:"nodes,omitempty"`
	Edges       []GraphEdge  `json:"edges,omitempty"`
	Diagnostics []Diagnostic `json:"diagnostics,omitempty"`
}

func BuildProject

func BuildProject(doc *project.Document) Document

type GraphEdge

type GraphEdge struct {
	From string `json:"from"`
	To   string `json:"to"`
	Type string `json:"type"`
}

type GraphNode

type GraphNode struct {
	Address    string         `json:"address"`
	Kind       string         `json:"kind,omitempty"`
	Type       string         `json:"type,omitempty"`
	Operations []OperationRef `json:"operations,omitempty"`
}

type Node

type Node struct {
	Address   string
	DependsOn []string
}

func Sort

func Sort(nodes []Node) ([]Node, error)

type OperationRef

type OperationRef struct {
	Role        string `json:"role"`
	SourceKind  string `json:"source_kind,omitempty"`
	SourceID    string `json:"source_id,omitempty"`
	OperationID string `json:"operation_id,omitempty"`
}