dao

Documentation

Index

• Constants
• type Accessor
• type Event
• type EventInfo
  • func (e EventInfo) IsIssue() bool
• type EventInfos
  • func EventsFor(ctx context.Context, gvr types.GVR, level, kind, fqn string) (EventInfos, error)
  • func (ee EventInfos) Issues() []string
• type Generic
  • func (g *Generic) Get(ctx context.Context, path string) (runtime.Object, error)
  • func (g *Generic) List(ctx context.Context) ([]runtime.Object, error)
• type Getter
• type Lister
• type NonResource
  • func (n *NonResource) GVR() string
  • func (n *NonResource) Get(context.Context, string) (runtime.Object, error)
  • func (n *NonResource) Init(f types.Factory, gvr types.GVR)
• type Resource
  • func (r *Resource) Get(_ context.Context, path string) (runtime.Object, error)
  • func (r *Resource) List(ctx context.Context) ([]runtime.Object, error)
• type ResourceMetas
• type Table
  • func (t *Table) Get(ctx context.Context, path string) (runtime.Object, error)
  • func (t *Table) List(ctx context.Context, ns string) ([]runtime.Object, error)

Constants

const (
	WarnEvt = "Warning"
)

Types

type Accessor

type Accessor interface {
	Lister
	Getter

	// Init the resource with a factory object.
	Init(types.Factory, types.GVR)

	// GVR returns a gvr a string.
	GVR() string
}

Accessor represents an accessible k8s resource.

type Event

type Event struct {
	Table
}

type EventInfo

type EventInfo struct {
	Kind    string
	Reason  string
	Message string
	Count   int64
}

func (EventInfo) IsIssue

func (e EventInfo) IsIssue() bool

type EventInfos

type EventInfos []EventInfo

func EventsFor

func EventsFor(ctx context.Context, gvr types.GVR, level, kind, fqn string) (EventInfos, error)

func (EventInfos) Issues

func (ee EventInfos) Issues() []string

type Generic

type Generic struct {
	NonResource
}

Generic represents a generic resource.

func (*Generic) Get

func (g *Generic) Get(ctx context.Context, path string) (runtime.Object, error)

Get returns a given resource.

func (*Generic) List

func (g *Generic) List(ctx context.Context) ([]runtime.Object, error)

List returns a collection of resources.

type Getter

type Getter interface {
	// Get return a given resource.
	Get(ctx context.Context, path string) (runtime.Object, error)
}

Getter represents a resource getter.

type Lister

type Lister interface {
	// List returns a resource collection.
	List(ctx context.Context) ([]runtime.Object, error)
}

Lister represents a resource lister.

type NonResource

type NonResource struct {
	types.Factory
	// contains filtered or unexported fields
}

NonResource represents a non k8s resource.

func (*NonResource) GVR

func (n *NonResource) GVR() string

GVR returns a gvr.

func (*NonResource) Get

func (n *NonResource) Get(context.Context, string) (runtime.Object, error)

Get returns the given resource.

func (*NonResource) Init

func (n *NonResource) Init(f types.Factory, gvr types.GVR)

Init initializes the resource.

type Resource

type Resource struct {
	Generic
}

Resource represents an informer based resource.

func (*Resource) Get

func (r *Resource) Get(_ context.Context, path string) (runtime.Object, error)

Get returns a resource instance if found, else an error.

func (*Resource) List

func (r *Resource) List(ctx context.Context) ([]runtime.Object, error)

List returns a collection of resources.

type ResourceMetas

type ResourceMetas map[types.GVR]metav1.APIResource

ResourceMetas represents a collection of resource metadata.

type Table

type Table struct {
	Generic
}

Table retrieves K8s resources as tabular data.

func (*Table) Get

func (t *Table) Get(ctx context.Context, path string) (runtime.Object, error)

Get returns a given resource.

func (*Table) List

func (t *Table) List(ctx context.Context, ns string) ([]runtime.Object, error)

List all Resources in a given namespace.