plugin

package

v0.12.0 Latest Latest Go to latest Published: Jun 24, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/katanomi/pkg

Links

Open Source Insights

Documentation ¶

Overview ¶

Package plugin for building and running plugin

Index ¶

func NewPlugin() *plugin
type DefaultPluginAddresser
- func (p DefaultPluginAddresser) GetAddressURL() *apis.URL
type PluginBase
- func (p PluginBase) CheckAlive(ctx context.Context) error
- func (p PluginBase) GetWebhookURL() (*apis.URL, bool)
type ShutdownFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewPlugin ¶

func NewPlugin() *plugin

NewPlugin method never used. was supposed to initiate plugins Deprecated: This plugin initializer has never been used and is not recommended TODO: cleanup unnecessary code

Types ¶

type DefaultPluginAddresser ¶ added in v0.7.0

type DefaultPluginAddresser struct{}

DefaultPluginAddresser provides default methods implementing client.PluginAddressable

func (DefaultPluginAddresser) GetAddressURL ¶ added in v0.7.0

func (p DefaultPluginAddresser) GetAddressURL() *apis.URL

GetAddressURL get the access url of the plugin service(not tool service)

type PluginBase ¶ added in v0.7.0

type PluginBase struct {
	DefaultPluginAddresser
}

PluginBase is the base struct for all plugins

func (PluginBase) CheckAlive ¶ added in v0.7.0

func (p PluginBase) CheckAlive(ctx context.Context) error

CheckAlive request the tool service with get method to check if it is alive

func (PluginBase) GetWebhookURL ¶ added in v0.7.0

func (p PluginBase) GetWebhookURL() (*apis.URL, bool)

GetWebhookURL get the webhook url used to receive events from the tool service

type ShutdownFunc ¶

type ShutdownFunc func() error

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
client Package client contains functions to add and retrieve auth from context	Package client contains functions to add and retrieve auth from context
base Package base contains functions to add and retrieve auth from context	Package base contains functions to add and retrieve auth from context
v2 Package v2 the v2 version of plugin sdk	Package v2 the v2 version of plugin sdk
component
metrics Package metrics provides prometheus metrics for restful	Package metrics provides prometheus metrics for restful
tracing Package tracing contains useful functionality for tracing.	Package tracing contains useful functionality for tracing.
config
path Package path provides helper functions for handling url path	Package path provides helper functions for handling url path
route Package route contains useful functionality for the package route	Package route contains useful functionality for the package route
storage Package storage for storage plugin	Package storage for storage plugin
capabilities Package capabilities for storage plugin capabilities	Package capabilities for storage plugin capabilities
capabilities/archive Package archive for archive capability	Package archive for archive capability
capabilities/archive/v1alpha1 Package v1alpha1 defines versioned interfaces for archive capability	Package v1alpha1 defines versioned interfaces for archive capability
capabilities/filestore Package filestore for file store capability	Package filestore for file store capability
capabilities/filestore/v1alpha1 Package v1alpha1 defines versioned interfaces for file-store capability	Package v1alpha1 defines versioned interfaces for file-store capability
client Package client for storage plugin client	Package client for storage plugin client
client/versioned/archive/v1alpha1 Package v1alpha1 for archive v1alpha1 client	Package v1alpha1 for archive v1alpha1 client
client/versioned/core/v1alpha1 Package v1alpha1 for storage plugin core v1alpha1 client	Package v1alpha1 for storage plugin core v1alpha1 client
client/versioned/filestore/v1alpha1 Package v1alpha1 for file store v1alpha1 client	Package v1alpha1 for file store v1alpha1 client
core/v1alpha1 Package v1alpha1 defines versioned api server routes of core v1alpha1	Package v1alpha1 defines versioned api server routes of core v1alpha1
route Package route for storage plugin api server routes	Package route for storage plugin api server routes
route/archive/v1alpha1 Package v1alpha1 for archive v1alpha1 routes	Package v1alpha1 for archive v1alpha1 routes
route/core/v1alpha1 Package v1alpha1 for core v1alpha1 routes	Package v1alpha1 for core v1alpha1 routes
route/filestore/v1alpha1 Package v1alpha1 for file store v1alpha1 routes	Package v1alpha1 for file store v1alpha1 routes
types Package types defines the interfaces for plugin	Package types defines the interfaces for plugin