config

Documentation

Index

• type Common
  • func (c *Common) GetPluginConfig(pl plugin.Plugin, cfg interface{}) error
  • func (c *Common) SetPluginConfig(pl plugin.Plugin, cfg interface{}) error
• type EngineConfig

Types

type Common

type Common struct {
	EngineName  string `json:"engineName"`
	ContainerID string `json:"containerID"`
	// EngineConfig is the raw JSON representation of the Engine's underlying config.
	EngineConfig EngineConfig `json:"engineConfig"`

	// PluginConfig is the JSON raw representation of the plugin configurations.
	PluginConfig map[string]json.RawMessage `json:"plugin"`

	// Apptheus connection, this field will be ignored
	ApptheusSocket *metric.Apptheus `json:"-"`
}

Common provides the basis for all engine configs. Anything that can not be properly described through the OCI config can be stored as a generic JSON []byte.

func (*Common) GetPluginConfig

func (c *Common) GetPluginConfig(pl plugin.Plugin, cfg interface{}) error

GetPluginConfig retrieves the configuration for the corresponding plugin.

func (*Common) SetPluginConfig

func (c *Common) SetPluginConfig(pl plugin.Plugin, cfg interface{}) error

SetPluginConfig sets the configuration for the corresponding plugin.

type EngineConfig

type EngineConfig interface{}

EngineConfig is a generic interface to represent the implementations of an EngineConfig.