resourceviewer

Documentation

Index

• func Create(ctx context.Context, dashConfig config.Dash, q queryer.Queryer, ...) (*component.ResourceViewer, error)
• func GenerateComponent(ctx context.Context, details Details, selected types.UID) (*component.ResourceViewer, error)
• type Details
• type EdgeEntry
• type Handler
  • func NewHandler(dashConfig config.Dash, options ...HandlerOption) (*Handler, error)
  • func (h *Handler) AddEdge(ctx context.Context, from, to *unstructured.Unstructured, level int) error
  • func (h *Handler) AdjacencyList() (*component.AdjList, error)
  • func (h *Handler) FinalizeEdge(ctx context.Context, from, to *unstructured.Unstructured) error
  • func (h *Handler) Nodes(ctx context.Context) (component.Nodes, error)
  • func (h *Handler) Process(ctx context.Context, object *unstructured.Unstructured) error
  • func (h *Handler) SetLevel(objectKind string, level int) int
• type HandlerObjectStatus
  • func NewHandlerObjectStatus(objectStore store.Store, pluginManager plugin.ManagerInterface) *HandlerObjectStatus
  • func (h *HandlerObjectStatus) Status(ctx context.Context, object runtime.Object) (*objectstatus.ObjectStatus, error)
• type HandlerOption
  • func SetHandlerObjectStatus(objectStatus ObjectStatus) HandlerOption
• type ObjectStatus
• type ResourceViewer
  • func New(dashConfig config.Dash, opts ...ViewerOpt) (*ResourceViewer, error)
  • func (rv *ResourceViewer) Visit(ctx context.Context, object runtime.Object, handler *Handler) error
• type ViewerOpt
  • func WithDefaultQueryer(dashConfig config.Dash, q queryer.Queryer) ViewerOpt

Functions

func Create

func Create(ctx context.Context, dashConfig config.Dash, q queryer.Queryer, objects ...*unstructured.Unstructured) (*component.ResourceViewer, error)

Create creates a resource viewer given a list objects.

func GenerateComponent

func GenerateComponent(ctx context.Context, details Details, selected types.UID) (*component.ResourceViewer, error)

GenerateComponent generates a resource viewer component given details.

Types

type Details

type Details interface {
	AdjacencyList() (*component.AdjList, error)
	Nodes(ctx context.Context) (component.Nodes, error)
}

Details generates details for resource viewer.

type EdgeEntry

type EdgeEntry struct {
	// contains filtered or unexported fields
}

EdgeEntry contains Edge info stored in edgeCache

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler is a visitor handler.

func NewHandler

func NewHandler(dashConfig config.Dash, options ...HandlerOption) (*Handler, error)

NewHandler creates an instance of Handler.

func (*Handler) AddEdge

func (h *Handler) AddEdge(ctx context.Context, from, to *unstructured.Unstructured, level int) error

AddEdge adds edge to the cache

func (*Handler) AdjacencyList

func (h *Handler) AdjacencyList() (*component.AdjList, error)

func (*Handler) FinalizeEdge

func (h *Handler) FinalizeEdge(ctx context.Context, from, to *unstructured.Unstructured) error

FinalizeEdge is finalizing the edge creation process by applying edge from cache

func (*Handler) Nodes

func (h *Handler) Nodes(ctx context.Context) (component.Nodes, error)

Nodes generates nodes from the handler.

func (*Handler) Process

func (h *Handler) Process(ctx context.Context, object *unstructured.Unstructured) error

Process adds nodes to the dependency graph.

func (*Handler) SetLevel

func (h *Handler) SetLevel(objectKind string, level int) int

SetLevel sets the next depth level for node tree and makes sure it's in level cache

type HandlerObjectStatus

type HandlerObjectStatus struct {
	// contains filtered or unexported fields
}

func NewHandlerObjectStatus

func NewHandlerObjectStatus(objectStore store.Store, pluginManager plugin.ManagerInterface) *HandlerObjectStatus

func (*HandlerObjectStatus) Status

func (h *HandlerObjectStatus) Status(ctx context.Context, object runtime.Object) (*objectstatus.ObjectStatus, error)

type HandlerOption

type HandlerOption func(h *Handler)

HandlerOption is an option for configuring Handler.

func SetHandlerObjectStatus

func SetHandlerObjectStatus(objectStatus ObjectStatus) HandlerOption

SetHandlerObjectStatus configures handler to use a custom object status generator.

type ObjectStatus

type ObjectStatus interface {
	Status(ctx context.Context, object runtime.Object) (*objectstatus.ObjectStatus, error)
}

type ResourceViewer

type ResourceViewer struct {
	// contains filtered or unexported fields
}

ResourceViewer visits an object and creates a view component.

func New

func New(dashConfig config.Dash, opts ...ViewerOpt) (*ResourceViewer, error)

New creates an instance of ResourceViewer.

func (*ResourceViewer) Visit

func (rv *ResourceViewer) Visit(ctx context.Context, object runtime.Object, handler *Handler) error

Visit visits an object and creates a view component.

type ViewerOpt

type ViewerOpt func(*ResourceViewer) error

ViewerOpt is an option for ResourceViewer.

func WithDefaultQueryer

func WithDefaultQueryer(dashConfig config.Dash, q queryer.Queryer) ViewerOpt

WithDefaultQueryer configures ResourceViewer with the default visitor.