navigation

Documentation

Index

• func CustomResourceDefinition(ctx context.Context, name string, o store.Store) (*apiextv1beta1.CustomResourceDefinition, error)
• func CustomResourceDefinitions(ctx context.Context, o store.Store) ([]*apiextv1beta1.CustomResourceDefinition, error)
• func ListCustomResources(ctx context.Context, crd *apiextv1beta1.CustomResourceDefinition, ...) (*unstructured.UnstructuredList, error)
• type Navigation
  • func CRDEntries(ctx context.Context, prefix, namespace string, objectStore store.Store) ([]Navigation, error)
  • func New(title, path string, options ...Option) (*Navigation, error)
• type NavigationEntriesHelper
  • func (neh *NavigationEntriesHelper) Add(title, suffix, iconName string)
  • func (neh *NavigationEntriesHelper) Generate(prefix string) ([]Navigation, error)
• type Option
  • func SetNavigationIcon(name string) Option

Functions

func CustomResourceDefinition

func CustomResourceDefinition(ctx context.Context, name string, o store.Store) (*apiextv1beta1.CustomResourceDefinition, error)

CustomResourceDefinition retrieves a CRD.

func CustomResourceDefinitions

func CustomResourceDefinitions(ctx context.Context, o store.Store) ([]*apiextv1beta1.CustomResourceDefinition, error)

func ListCustomResources

func ListCustomResources(
	ctx context.Context,
	crd *apiextv1beta1.CustomResourceDefinition,
	namespace string,
	o store.Store,
	selector *labels.Set) (*unstructured.UnstructuredList, error)

ListCustomResources lists all custom resources given a CRD.

Types

type Navigation

type Navigation struct {
	Title      string       `json:"title,omitempty"`
	Path       string       `json:"path,omitempty"`
	Children   []Navigation `json:"children,omitempty"`
	IconName   string       `json:"iconName,omitempty"`
	IconSource string       `json:"iconSource,omitempty"`
}

Navigation is a set of navigation entries.

func CRDEntries

func CRDEntries(ctx context.Context, prefix, namespace string, objectStore store.Store) ([]Navigation, error)

CRDEntries generates navigation entries for CRDs.

func New

func New(title, path string, options ...Option) (*Navigation, error)

New creates a Navigation.

type NavigationEntriesHelper

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

NavigationEntriesHelper generates navigation entries.

func (*NavigationEntriesHelper) Add

func (neh *NavigationEntriesHelper) Add(title, suffix, iconName string)

Add adds an entry.

func (*NavigationEntriesHelper) Generate

func (neh *NavigationEntriesHelper) Generate(prefix string) ([]Navigation, error)

Generate generates navigation entries.

type Option

type Option func(*Navigation) error

Option is an option for configuring navigation.

func SetNavigationIcon

func SetNavigationIcon(name string) Option

SetNavigationIcon sets the icon for the navigation entry.