36 lines
961 B
Go
36 lines
961 B
Go
package base
|
|
|
|
import (
|
|
"github.com/hashicorp/nomad/plugins/shared/hclspec"
|
|
)
|
|
|
|
// BasePlugin is the interface that all Nomad plugins must support.
|
|
type BasePlugin interface {
|
|
// PluginInfo describes the type and version of a plugin.
|
|
PluginInfo() (*PluginInfoResponse, error)
|
|
|
|
// ConfigSchema returns the schema for parsing the plugins configuration.
|
|
ConfigSchema() (*hclspec.Spec, error)
|
|
|
|
// SetConfig is used to set the configuration by passing a MessagePack
|
|
// encoding of it.
|
|
SetConfig(data []byte) error
|
|
}
|
|
|
|
// PluginInfoResponse returns basic information about the plugin such that Nomad
|
|
// can decide whether to load the plugin or not.
|
|
type PluginInfoResponse struct {
|
|
// Type returns the plugins type
|
|
Type string
|
|
|
|
// PluginApiVersion returns the version of the Nomad plugin API it is built
|
|
// against.
|
|
PluginApiVersion string
|
|
|
|
// PluginVersion is the version of the plugin.
|
|
PluginVersion string
|
|
|
|
// Name is the plugins name.
|
|
Name string
|
|
}
|