Documentation
¶
Index ¶
- Constants
- type Container
- func (c *Container) Copy(files []*types.File) error
- func (c *Container) Create() error
- func (c *Container) Delete() error
- func (c *Container) Exists() bool
- func (c *Container) IsRunning() bool
- func (c *Container) Read(srcPath []string) ([]*types.File, error)
- func (c *Container) Start() error
- func (c *Container) Stat(paths []string) (map[string]*os.FileMode, error)
- func (c *Container) Stop() error
- func (c *Container) ToInstance() (InstanceInterface, error)
- func (c *Container) UpdateStatus() error
- func (c *Container) Validate() error
- type Containers
- type ContainersInterface
- type ContainersState
- type ContainersStateInterface
- type Hook
- type Hooks
- type HostConfiguredContainer
- type HostConfiguredContainerInterface
- type InstanceInterface
- type Interface
- type ResourceInstance
- type RuntimeConfig
Constants ¶
const (
// ConfigMountpoint is where host file-system is mounted in the -config container.
ConfigMountpoint = "/mnt/host"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Container ¶
type Container struct {
// Stores runtime configuration of the container.
Config types.ContainerConfig `json:"config" yaml:"config"`
// Status of the container
Status *types.ContainerStatus `json:"status" yaml:"status"`
// Runtime stores configuration for various container runtimes
Runtime RuntimeConfig `json:"runtime,omitempty" yaml:"runtime,omitempty"`
}
Container represents public, serializable version of the container object.
It should be used for persisting and restoring container state with combination with New(), which make sure that the configuration is actually correct.
func (*Container) Stat ¶
Stat checks if files exist in the container. It returns map of files mode for each requested file.
func (*Container) ToInstance ¶
func (c *Container) ToInstance() (InstanceInterface, error)
ToInstance returns containerInstance directly from Container
func (*Container) UpdateStatus ¶
UpdateStatus reads container existing status and updates it by communicating with container daemon This is a helper function, which simplifies calling containerInstance.Status() from Container.
type Containers ¶
type Containers struct {
// PreviousState stores previous state of the containers, which should be obtained and persisted
// after containers modifications.
PreviousState ContainersState `json:"previousState" yaml:"previousState"`
// DesiredState is a user-defined desired containers configuration.
DesiredState ContainersState `json:"desiredState" yaml:"desiredState"`
}
Containers allow to orchestrate and update multiple containers spread across multiple hosts and update their configurations.
func (*Containers) CheckCurrentState ¶
func (c *Containers) CheckCurrentState() error
CheckCurrentState checks the state of existing containers and updates their state.
func (*Containers) New ¶
func (c *Containers) New() (ContainersInterface, error)
New validates Containers configuration and returns "executable" containers object.
func (*Containers) Validate ¶
func (c *Containers) Validate() error
Validate validates Containers struct and all structs used underneath.
type ContainersInterface ¶
type ContainersInterface interface {
CheckCurrentState() error
Execute() error
CurrentStateToYaml() ([]byte, error)
ToExported() *Containers
}
ContainersInterface represents capabilities of containers struct.
func FromYaml ¶
func FromYaml(c []byte) (ContainersInterface, error)
FromYaml allows to restore containers state from YAML.
type ContainersState ¶
type ContainersState map[string]*HostConfiguredContainer
ContainersState represents states of multiple containers
func (ContainersState) New ¶
func (s ContainersState) New() (ContainersStateInterface, error)
New validates ContainersState struct and returns operational containerState.
type ContainersStateInterface ¶
type ContainersStateInterface interface {
CheckState() error
RemoveContainer(containerName string) error
CreateAndStart(containerName string) error
Export() ContainersState
}
ContainersStateInterface exports constainersState capabilities.
type Hook ¶
type Hook func() error
Hook is an action, which may be called before or after certain container operation, like starting or creating.
type Hooks ¶
type Hooks struct {
PostStart *Hook
}
Hooks defines type of hooks HostConfiguredContainer supports.
type HostConfiguredContainer ¶
type HostConfiguredContainer struct {
Container Container `json:"container" yaml:"container"`
Host host.Host `json:"host" yaml:"host"`
ConfigFiles map[string]string `json:"configFiles,omitempty" yaml:"configFiles,omitempty"`
Hooks *Hooks `json:"-" yaml:"-"`
}
HostConfiguredContainer represents single container, running on remote host with it's configuration files
func (*HostConfiguredContainer) New ¶
func (m *HostConfiguredContainer) New() (HostConfiguredContainerInterface, error)
New validates HostConfiguredContainer struct and return it's executable version
func (*HostConfiguredContainer) Validate ¶
func (m *HostConfiguredContainer) Validate() error
Validate validates HostConfiguredContainer struct. All validation rules should be placed here.
type HostConfiguredContainerInterface ¶
type HostConfiguredContainerInterface interface {
ConfigurationStatus() error
Configure(paths []string) error
Create() error
Status() error
Start() error
Stop() error
Delete() error
}
HostConfiguredContainerInterface exports hostConfiguredContainer capabilities.
type InstanceInterface ¶
type InstanceInterface interface {
Status() (*types.ContainerStatus, error)
Read(srcPath []string) ([]*types.File, error)
Copy(files []*types.File) error
Stat(paths []string) (map[string]*os.FileMode, error)
Start() error
Stop() error
Delete() error
}
InstanceInterface represents containerInstance capabilities.
type Interface ¶
type Interface interface {
GetRuntimeAddress() string
SetRuntimeAddress(string)
Create() (InstanceInterface, error)
FromStatus() (InstanceInterface, error)
}
Interface represents container capabilities.
type ResourceInstance ¶
type ResourceInstance interface {
ToHostConfiguredContainer() (*HostConfiguredContainer, error)
}
ResourceInstance interface represents struct, which can be converted to HostConfiguredContainer.
type RuntimeConfig ¶
type RuntimeConfig struct {
Docker *docker.Config `json:"docker,omitempty" yaml:"docker,omitempty"`
}
RuntimeConfig is a collection of various runtime configurations which can be defined by user.
Source Files
Directories