workloads

Documentation

Index

• type DetailDescriber
  • func NewDetailDescriber() (*DetailDescriber, error)
  • func (d *DetailDescriber) Describe(ctx context.Context, namespace string, options describer.Options) (component.ContentResponse, error)
  • func (d *DetailDescriber) PathFilters() []describer.PathFilter
  • func (d DetailDescriber) Reset(_ context.Context) error
• type HomeDescriber
  • func NewHomeDescriber(options ...HomeDescriberOption) (*HomeDescriber, error)
  • func (h *HomeDescriber) Describe(ctx context.Context, namespace string, options describer.Options) (component.ContentResponse, error)
  • func (h *HomeDescriber) PathFilters() []describer.PathFilter
  • func (h HomeDescriber) Reset(ctx context.Context) error
• type HomeDescriberOption
• type Module
  • func New(ctx context.Context, options Options) (*Module, error)
  • func (m Module) AddCRD(ctx context.Context, crd *unstructured.Unstructured) error
  • func (m *Module) ClientRequestHandlers() []octant.ClientRequestHandler
  • func (m *Module) Content(ctx context.Context, contentPath string, opts module.ContentOptions) (component.ContentResponse, error)
  • func (m *Module) ContentPath() string
  • func (m *Module) Description() string
  • func (m Module) Generators() []octant.Generator
  • func (m Module) GroupVersionKindPath(namespace, apiVersion, kind, name string) (string, error)
  • func (m Module) GvkFromPath(contentPath, namespace string) (schema.GroupVersionKind, error)
  • func (m *Module) Name() string
  • func (m *Module) Navigation(ctx context.Context, namespace, root string) ([]navigation.Navigation, error)
  • func (m Module) RemoveCRD(ctx context.Context, crd *unstructured.Unstructured) error
  • func (m Module) ResetCRDs(ctx context.Context) error
  • func (m Module) SetContext(ctx context.Context, contextName string) error
  • func (m Module) SetNamespace(namespace string) error
  • func (m Module) Start() error
  • func (m Module) Stop()
  • func (m Module) SupportedGroupVersionKind() []schema.GroupVersionKind
• type Options

Types

type DetailDescriber

type DetailDescriber struct{}

func NewDetailDescriber

func NewDetailDescriber() (*DetailDescriber, error)

func (*DetailDescriber) Describe

func (d *DetailDescriber) Describe(ctx context.Context, namespace string, options describer.Options) (component.ContentResponse, error)

func (*DetailDescriber) PathFilters

func (d *DetailDescriber) PathFilters() []describer.PathFilter

func (DetailDescriber) Reset

func (d DetailDescriber) Reset(_ context.Context) error

type HomeDescriber

type HomeDescriber struct{}

HomeDescriber describe the home page for workloads module.

func NewHomeDescriber

func NewHomeDescriber(options ...HomeDescriberOption) (*HomeDescriber, error)

NewHomeDescriber creates an instance of HomeDescriber.

func (*HomeDescriber) Describe

func (h *HomeDescriber) Describe(ctx context.Context, namespace string, options describer.Options) (component.ContentResponse, error)

Describe creates a content response for workloads.

func (*HomeDescriber) PathFilters

func (h *HomeDescriber) PathFilters() []describer.PathFilter

PathFilters returns a path filter for the root path.

func (HomeDescriber) Reset

func (h HomeDescriber) Reset(ctx context.Context) error

Reset is a no-op.

type HomeDescriberOption

type HomeDescriberOption func(hd *HomeDescriber)

HomeDescriberOption is an option for configuring home describer.

type Module

type Module struct {
	Options
	// contains filtered or unexported fields
}

Module contains the implementation for the workloads module.

func New

func New(ctx context.Context, options Options) (*Module, error)

New creates an instance of Module.

func (Module) AddCRD

func (m Module) AddCRD(ctx context.Context, crd *unstructured.Unstructured) error

AddCRD is a no-op.

func (*Module) ClientRequestHandlers

func (m *Module) ClientRequestHandlers() []octant.ClientRequestHandler

ClientRequestHandlers returns nil.

func (*Module) Content

func (m *Module) Content(ctx context.Context, contentPath string, opts module.ContentOptions) (component.ContentResponse, error)

Content handles content for the module.

func (*Module) ContentPath

func (m *Module) ContentPath() string

ContentPath returns the content path for this module.

func (*Module) Description

func (m *Module) Description() string

Description returns the module description.

func (Module) Generators

func (m Module) Generators() []octant.Generator

Generators returns nil.

func (Module) GroupVersionKindPath

func (m Module) GroupVersionKindPath(namespace, apiVersion, kind, name string) (string, error)

GroupVersionKindPath return return an error as this module does not support.

func (Module) GvkFromPath

func (m Module) GvkFromPath(contentPath, namespace string) (schema.GroupVersionKind, error)

func (*Module) Name

func (m *Module) Name() string

Name returns the module name.

func (*Module) Navigation

func (m *Module) Navigation(ctx context.Context, namespace, root string) ([]navigation.Navigation, error)

Navigation returns navigation entries for the module.

func (Module) RemoveCRD

func (m Module) RemoveCRD(ctx context.Context, crd *unstructured.Unstructured) error

RemoveCRD is a no-op.

func (Module) ResetCRDs

func (m Module) ResetCRDs(ctx context.Context) error

ResetCRDs is a no-op.

func (Module) SetContext

func (m Module) SetContext(ctx context.Context, contextName string) error

SetContext is a no-op.

func (Module) SetNamespace

func (m Module) SetNamespace(namespace string) error

SetNamespace is a no-op.

func (Module) Start

func (m Module) Start() error

Start is a no-op.

func (Module) Stop

func (m Module) Stop()

Stop is a no-op.

func (Module) SupportedGroupVersionKind

func (m Module) SupportedGroupVersionKind() []schema.GroupVersionKind

SupportedGroupVersionKind returns nil.

type Options

type Options struct {
	DashConfig config.Dash
}

Options for configuring Module.