control

Documentation

Index

• type Config
  • func NewConfigFor(platform string) Config
  • func (instance *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (instance Config) Validate() error
• type Control
  • func NewControl(conf Config, ks *keyStore.KeyStore) (*Control, error)
  • func (instance *Control) Access() *access.Access
  • func (instance *Control) ConfigObject() interface{}

Types

type Config

type Config struct {
	// Configures the permission of caretakerctl to control caretakerd remotely
	// and how to obtain the credentials for it.
	//
	// For details see {@ref github.com/echocat/caretakerd/access.Config}.
	Access access.Config `json:"access" yaml:"access,omitempty"`
}

Description

Defines the access rights of caretakerctl to caretakerd.

func NewConfigFor

func NewConfigFor(platform string) Config

NewConfigFor creates a new instance of Config.

func (*Config) UnmarshalYAML

func (instance *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML is used until yaml unmarshalling. Do not call this method directly.

func (Config) Validate

func (instance Config) Validate() error

Validate validates the action on this object and returns an error object if there are any.

type Control

type Control struct {
	// contains filtered or unexported fields
}

Control indicates how a remote caretakerctl/control process is able to control the current caretakerd instance.

func NewControl

func NewControl(conf Config, ks *keyStore.KeyStore) (*Control, error)

NewControl creates a new instance of Control with the given config.

func (*Control) Access

func (instance *Control) Access() *access.Access

Access returns the enclosed Access instance.

func (*Control) ConfigObject

func (instance *Control) ConfigObject() interface{}

ConfigObject returns the Config object this control was created with.