plugin

Sep 9, 2021

Changes in this version

type DefaultStore

+ func (s *DefaultStore) Get(name string) (Client, bool)

+ func (s *DefaultStore) GetModuleService(name string) (ModuleService, error)

+ func (s *DefaultStore) Remove(name string)

type Manager

+ func (m *Manager) Unload(ctx context.Context, cmd string)

type ManagerStore

+ Get func(name string) (Client, bool)

+ GetModuleService func(name string) (ModuleService, error)

+ Remove func(name string)

+ type PluginConfig struct

+ Cmd string

+ Name string

May 6, 2021

Changes in this version

+ func ClientStateFrom(ctx context.Context) clientState

+ type ClientState interface

+ ClientID func() string

+ ContextName func() string

+ Filters func() []Filter

+ Namespace func() string

+ type Filter interface

+ Key func() string

+ Value func() string

Mar 25, 2021

Changes in this version

+ type DashboardMetadataKey string

type GRPCClient

+ func (c *GRPCClient) PrintTabs(ctx context.Context, object runtime.Object) ([]TabResponse, error)

type GRPCServer

+ func (s *GRPCServer) PrintTabs(ctx context.Context, objectRequest *dashboard.ObjectRequest) (*dashboard.PrintTabResponse, error)

type JSPlugin

+ PrintTabs func(ctx context.Context, object runtime.Object) ([]TabResponse, error)

type Service

+ PrintTabs func(ctx context.Context, object runtime.Object) ([]TabResponse, error)

Jan 12, 2021

Changes in this version

type ModuleProxy

+ func (ModuleProxy) GvkFromPath(contentPath, namespace string) (schema.GroupVersionKind, error)

+ func (m *ModuleProxy) Description() string

Sep 24, 2020

Changes in this version

type Manager

+ WSClient event.WSClientGetter

Aug 12, 2020

Changes in this version

+ func WithClassExtractor(pce JSClassExtractor) func(*jsPlugin)

+ func WithMetadataExtractor(pme JSMetadataExtractor) func(*jsPlugin)

+ func WithRuntimeFactory(prf JSRuntimeFactory) func(*jsPlugin)

+ type ClusterClient interface

+ DynamicClient func() (dynamic.Interface, error)

+ Resource func(gk schema.GroupKind) (schema.GroupVersionResource, bool, error)

+ type JSClassExtractor func(*goja.Runtime) (*goja.Object, error)

+ type JSMetadataExtractor func(*goja.Runtime, goja.Value) (*Metadata, error)

+ type JSOption func(*jsPlugin)

+ type JSRuntimeFactory func(context.Context, string) (*eventloop.EventLoop, error)

type Manager

+ func (m *Manager) SetOctantClient(client javascript.OctantClient)

type ManagerInterface

+ SetOctantClient func(octantClient javascript.OctantClient)

Jul 16, 2020

Changes in this version

+ func ExtractDefaultClass(vm *goja.Runtime) (*goja.Object, error)

+ func IsJavaScriptPlugin(pluginName string) bool

+ func IsTypescriptPlugin(pluginName string) bool

+ func NewJSPlugin(ctx context.Context, client *api.Client, pluginPath string, ...) (*jsPlugin, error)

type ActionRegistrar

+ Unregister func(actionPath string, pluginPath string)

type Capabilities

+ func (c Capabilities) HasObjectStatusSupport(gvk schema.GroupVersionKind) bool

type DefaultStore

+ func (s *DefaultStore) GetJS(name string) (JSPlugin, bool)

+ func (s *DefaultStore) NamesJS() []string

+ func (s *DefaultStore) RemoveJS(name string)

+ func (s *DefaultStore) StoreJS(name string, plugin JSPlugin) error

+ type JSPlugin interface

+ Close func()

+ Content func(ctx context.Context, contentPath string) (component.ContentResponse, error)

+ HandleAction func(ctx context.Context, actionName string, payload action.Payload) error

+ Metadata func() *Metadata

+ Navigation func(ctx context.Context) (navigation.Navigation, error)

+ ObjectStatus func(ctx context.Context, object runtime.Object) (ObjectStatusResponse, error)

+ PluginPath func() string

+ Print func(ctx context.Context, object runtime.Object) (PrintResponse, error)

+ PrintTab func(ctx context.Context, object runtime.Object) (TabResponse, error)

+ Register func(ctx context.Context, dashboardAPIAddress string) (Metadata, error)

type ManagerStore

+ GetJS func(name string) (JSPlugin, bool)

+ NamesJS func() []string

+ RemoveJS func(name string)

+ StoreJS func(name string, jspc JSPlugin) error

type Metadata

+ func ExtractMetadata(vm *goja.Runtime, pluginValue goja.Value) (*Metadata, error)

type ModuleRegistrar

+ Unregister func(mod module.Module)

+ type TSLoader struct

+ func CreateRuntime(ctx context.Context, logName string, typescript bool) (*goja.Runtime, *TSLoader, error)

+ func NewTSLoader(vm *goja.Runtime) (*TSLoader, error)

+ func (t *TSLoader) SourceLoader(path string) ([]byte, error)

+ func (t *TSLoader) TranspileAndRun(path string) (goja.Value, error)

+ func (t *TSLoader) TranspileModule(path string) ([]byte, error)

Mar 20, 2020

Changes in this version

type Config

+ OS func() string

Oct 30, 2019

Changes in this version

+ var DefaultConfig = &defaultConfig

+ var Handshake = plugin.HandshakeConfig

+ var Name = "plugin"

+ func AvailablePlugins(config Config) ([]string, error)

+ func Serve(service Service)

+ type ActionRegistrar interface

+ Register func(actionPath string, actionFunc action.DispatcherFunc) error

+ type Broker interface

+ AcceptAndServe func(id uint32, s func([]grpc.ServerOption) *grpc.Server)

+ NextId func() uint32

+ type Capabilities struct

+ ActionNames []string

+ IsModule bool

+ SupportsObjectStatus []schema.GroupVersionKind

+ SupportsPrinterConfig []schema.GroupVersionKind

+ SupportsPrinterItems []schema.GroupVersionKind

+ SupportsPrinterStatus []schema.GroupVersionKind

+ SupportsTab []schema.GroupVersionKind

+ func (c Capabilities) HasPrinterSupport(gvk schema.GroupVersionKind) bool

+ func (c Capabilities) HasTabSupport(gvk schema.GroupVersionKind) bool

+ type Client interface

+ Client func() (plugin.ClientProtocol, error)

+ Kill func()

+ type ClientFactory interface

+ Init func(ctx context.Context, cmd string) Client

+ type Config interface

+ Fs func() afero.Fs

+ Home func() string

+ PluginDirs func() ([]string, error)

+ type DefaultClientFactory struct

+ func NewDefaultClientFactory() *DefaultClientFactory

+ func (f *DefaultClientFactory) Init(ctx context.Context, cmd string) Client

+ type DefaultRunner struct

+ RunFunc func(ctx context.Context, name string, gvk schema.GroupVersionKind, ...) error

+ func ObjectStatusRunner(store ManagerStore, ch chan<- ObjectStatusResponse) DefaultRunner

+ func PrintRunner(store ManagerStore, ch chan<- PrintResponse) DefaultRunner

+ func TabRunner(store ManagerStore, ch chan<- component.Tab) DefaultRunner

+ func (pr *DefaultRunner) Run(ctx context.Context, object runtime.Object, clientNames []string) error

+ type DefaultStore struct

+ func NewDefaultStore() *DefaultStore

+ func (s *DefaultStore) ClientNames() []string

+ func (s *DefaultStore) Clients() map[string]Client

+ func (s *DefaultStore) GetCommand(name string) (string, error)

+ func (s *DefaultStore) GetMetadata(name string) (*Metadata, error)

+ func (s *DefaultStore) GetService(name string) (Service, error)

+ func (s *DefaultStore) Store(name string, client Client, metadata *Metadata, cmd string) error

+ type GRPCClient struct

+ func NewGRPCClient(broker Broker, client dashboard.PluginClient) *GRPCClient

+ func (c *GRPCClient) Content(ctx context.Context, contentPath string) (component.ContentResponse, error)

+ func (c *GRPCClient) HandleAction(ctx context.Context, payload action.Payload) error

+ func (c *GRPCClient) Navigation(ctx context.Context) (navigation.Navigation, error)

+ func (c *GRPCClient) ObjectStatus(ctx context.Context, object runtime.Object) (ObjectStatusResponse, error)

+ func (c *GRPCClient) Print(ctx context.Context, object runtime.Object) (PrintResponse, error)

+ func (c *GRPCClient) PrintTab(ctx context.Context, object runtime.Object) (TabResponse, error)

+ func (c *GRPCClient) Register(ctx context.Context, dashboardAPIAddress string) (Metadata, error)

+ type GRPCServer struct

+ Impl Service

+ func (s *GRPCServer) Content(ctx context.Context, req *dashboard.ContentRequest) (*dashboard.ContentResponse, error)

+ func (s *GRPCServer) HandleAction(ctx context.Context, handleActionRequest *dashboard.HandleActionRequest) (*dashboard.HandleActionResponse, error)

+ func (s *GRPCServer) Navigation(ctx context.Context, req *dashboard.NavigationRequest) (*dashboard.NavigationResponse, error)

+ func (s *GRPCServer) ObjectStatus(ctx context.Context, objectRequest *dashboard.ObjectRequest) (*dashboard.ObjectStatusResponse, error)

+ func (s *GRPCServer) Print(ctx context.Context, objectRequest *dashboard.ObjectRequest) (*dashboard.PrintResponse, error)

+ func (s *GRPCServer) PrintTab(ctx context.Context, objectRequest *dashboard.ObjectRequest) (*dashboard.PrintTabResponse, error)

+ func (s *GRPCServer) Register(ctx context.Context, registerRequest *dashboard.RegisterRequest) (*dashboard.RegisterResponse, error)

+ func (s *GRPCServer) WatchAdd(context.Context, *dashboard.WatchRequest) (*dashboard.Empty, error)

+ func (s *GRPCServer) WatchDelete(context.Context, *dashboard.WatchRequest) (*dashboard.Empty, error)

+ func (s *GRPCServer) WatchUpdate(context.Context, *dashboard.WatchRequest) (*dashboard.Empty, error)

+ type Manager struct

+ API api.API

+ ActionRegistrar ActionRegistrar

+ ClientFactory ClientFactory

+ ModuleRegistrar ModuleRegistrar

+ PortForwarder portforward.PortForwarder

+ Runners Runners

+ func NewManager(apiService api.API, moduleRegistrar ModuleRegistrar, ...) *Manager

+ func (m *Manager) Load(cmd string) error

+ func (m *Manager) ObjectStatus(ctx context.Context, object runtime.Object) (*ObjectStatusResponse, error)

+ func (m *Manager) Print(ctx context.Context, object runtime.Object) (*PrintResponse, error)

+ func (m *Manager) SetStore(store ManagerStore)

+ func (m *Manager) Start(ctx context.Context) error

+ func (m *Manager) Stop(ctx context.Context)

+ func (m *Manager) Store() ManagerStore

+ func (m *Manager) Tabs(ctx context.Context, object runtime.Object) ([]component.Tab, error)

+ type ManagerInterface interface

+ ObjectStatus func(ctx context.Context, object runtime.Object) (*ObjectStatusResponse, error)

+ Print func(ctx context.Context, object runtime.Object) (*PrintResponse, error)

+ Store func() ManagerStore

+ Tabs func(ctx context.Context, object runtime.Object) ([]component.Tab, error)

+ type ManagerOption func(*Manager)

+ type ManagerStore interface

+ ClientNames func() []string

+ Clients func() map[string]Client

+ GetCommand func(name string) (string, error)

+ GetMetadata func(name string) (*Metadata, error)

+ GetService func(name string) (Service, error)

+ Store func(name string, client Client, metadata *Metadata, cmd string) error

+ type Metadata struct

+ Capabilities Capabilities

+ Description string

+ Name string

+ type ModuleProxy struct

+ Metadata *Metadata

+ PluginName string

+ Service ModuleService

+ func NewModuleProxy(pluginName string, metadata *Metadata, service ModuleService) (*ModuleProxy, error)

+ func (ModuleProxy) AddCRD(ctx context.Context, crd *unstructured.Unstructured) error

+ func (ModuleProxy) Generators() []octant.Generator

+ func (ModuleProxy) GroupVersionKindPath(namespace, apiVersion, kind, name string) (string, error)

+ func (ModuleProxy) RemoveCRD(ctx context.Context, crd *unstructured.Unstructured) error

+ func (ModuleProxy) ResetCRDs(ctx context.Context) error

+ func (ModuleProxy) SetContext(ctx context.Context, contextName string) error

+ func (ModuleProxy) SetNamespace(namespace string) error

+ func (ModuleProxy) Start() error

+ func (ModuleProxy) Stop()

+ func (ModuleProxy) SupportedGroupVersionKind() []schema.GroupVersionKind

+ func (m *ModuleProxy) ClientRequestHandlers() []octant.ClientRequestHandler

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

+ func (m *ModuleProxy) ContentPath() string

+ func (m *ModuleProxy) Name() string

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

+ type ModuleRegistrar interface

+ Register func(mod module.Module) error

+ type ModuleService interface

+ Content func(ctx context.Context, contentPath string) (component.ContentResponse, error)

+ Navigation func(ctx context.Context) (navigation.Navigation, error)

+ type ObjectStatusResponse struct

+ ObjectStatus component.PodSummary

+ type PrintResponse struct

+ Config []component.SummarySection

+ Items []component.FlexLayoutItem

+ Status []component.SummarySection

+ type Runners interface

+ ObjectStatus func(ManagerStore) (DefaultRunner, chan ObjectStatusResponse)

+ Print func(ManagerStore) (DefaultRunner, chan PrintResponse)

+ Tab func(ManagerStore) (DefaultRunner, chan component.Tab)

+ type Service interface

+ HandleAction func(ctx context.Context, payload action.Payload) error

+ ObjectStatus func(ctx context.Context, object runtime.Object) (ObjectStatusResponse, error)

+ Print func(ctx context.Context, object runtime.Object) (PrintResponse, error)

+ PrintTab func(ctx context.Context, object runtime.Object) (TabResponse, error)

+ Register func(ctx context.Context, dashboardAPIAddress string) (Metadata, error)

+ type ServicePlugin struct

+ Impl Service

+ func (p *ServicePlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

+ func (p *ServicePlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

+ type TabResponse struct

+ Tab *component.Tab