cnm

package

v1.15.22 Latest Latest Go to latest Published: Feb 12, 2024 License: MIT Imports: 5 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

This section is empty.

This section is empty.

This section is empty.

type ActivateResponse struct {
	Err        string
	Implements []string
}

Response sent by plugin for activation.

type OptionMap map[string]interface{}

type Plugin struct {
	*common.Plugin
	EndpointType string
	Listener     *common.Listener
}

Plugin is the parent class for CNM plugins.

func NewPlugin(name, version, endpointType string) (*Plugin, error)

NewPlugin creates a new Plugin object.

func (plugin *Plugin) DisableDiscovery()

DisableDiscovery disables discovery by deleting the plugin spec file.

func (plugin *Plugin) EnableDiscovery() error

EnableDiscovery enables Docker to discover the plugin by creating the plugin spec file.

func (plugin *Plugin) Initialize(config *common.PluginConfig) error

Initialize initializes the plugin and starts the listener.

func (plugin *Plugin) ParseOptions(options OptionMap) OptionMap

ParseOptions returns generic options from a libnetwork request.

func (plugin *Plugin) SendErrorResponse(w http.ResponseWriter, errMsg error)

SendErrorResponse sends and logs an error response.

func (plugin *Plugin) Uninitialize()

Uninitialize cleans up the plugin.