container

Documentation

Index

• Constants
• Variables
• func NewDirectory(containerName string) (directory string, err error)
• func RemoveDirectory(containerName string) error
• type Initialiser
• type LXDProfileManager
• type LXDProfileNameRetriever
• type Manager
• type ManagerConfig
  • func (m ManagerConfig) PopValue(key string) string
  • func (m ManagerConfig) WarnAboutUnused()
• type NetworkConfig
  • func BridgeNetworkConfig(mtu int, interfaces network.InterfaceInfos) *NetworkConfig
• type StorageConfig
• type TestLXDManager

Constants

const (
	ConfigModelUUID        = "model-uuid"
	ConfigLogDir           = "log-dir"
	ConfigAvailabilityZone = "availability-zone"
)

const (
	// BridgeNetwork will have the container use the network bridge.
	BridgeNetwork = "bridge"
)

Variables

var (
	ContainerDir        = "/var/lib/juju/containers"
	RemovedContainerDir = "/var/lib/juju/removed-containers"
)

Functions

func NewDirectory

func NewDirectory(containerName string) (directory string, err error)

NewDirectory creates a new directory for the container name in the directory identified by `ContainerDir`.

func RemoveDirectory

func RemoveDirectory(containerName string) error

RemoveDirectory moves the container directory from `ContainerDir` to `RemovedContainerDir` and makes sure that the names don't clash.

Types

type Initialiser

type Initialiser interface {
	// Initialise installs all required packages, sync any images etc so
	// that the host machine can run containers.
	Initialise() error
}

Initialiser is responsible for performing the steps required to initialise a host machine so it can run containers.

type LXDProfileManager

type LXDProfileManager interface {
	// AssignLXDProfiles assigns the given profile names to the lxd instance
	// provided.  The slice of ProfilePosts provides details for adding to
	// and removing profiles from the lxd server.
	AssignLXDProfiles(instID string, profilesNames []string, profilePosts []lxdprofile.ProfilePost) ([]string, error)

	// MaybeWriteLXDProfile, write given LXDProfile to machine if not already
	// there.
	MaybeWriteLXDProfile(pName string, put lxdprofile.Profile) error
}

LXDProfileManager defines an interface for dealing with lxd profiles used to deploy juju containers.

type LXDProfileNameRetriever

type LXDProfileNameRetriever interface {
	// LXDProfileNames returns the list of available LXDProfile names from the
	// manager.
	LXDProfileNames(string) ([]string, error)
}

LXDProfileNameRetriever defines an interface for dealing with lxd profile names used to deploy juju containers.

type Manager

type Manager interface {
	// CreateContainer creates and starts a new container for the specified
	// machine.
	CreateContainer(
		ctx context.Context,
		instanceConfig *instancecfg.InstanceConfig,
		cons constraints.Value,
		base corebase.Base,
		network *NetworkConfig,
		storage *StorageConfig,
		callback environs.StatusCallbackFunc) (instances.Instance, *instance.HardwareCharacteristics, error)

	// DestroyContainer stops and destroys the container identified by
	// instance id.
	DestroyContainer(instance.Id) error

	// ListContainers return a list of containers that have been started by
	// this manager.
	ListContainers() ([]instances.Instance, error)

	// IsInitialized checks whether the required packages have been installed
	// to support this manager.
	IsInitialized() bool

	// Namespace returns the namespace of the manager. This namespace defines the
	// prefix of all the hostnames.
	Namespace() instance.Namespace
}

Manager is responsible for starting containers, and stopping and listing containers that it has started.

type ManagerConfig

type ManagerConfig map[string]string

ManagerConfig contains the initialization parameters for the ContainerManager. The name of the manager is used to namespace the containers on the machine.

func (ManagerConfig) PopValue

func (m ManagerConfig) PopValue(key string) string

PopValue returns the requested key from the config map. If the value doesn't exist, the function returns the empty string. If the value does exist, the value is returned, and the element removed from the map.

func (ManagerConfig) WarnAboutUnused

func (m ManagerConfig) WarnAboutUnused()

WarnAboutUnused emits a warning about each value in the map.

type NetworkConfig

type NetworkConfig struct {
	NetworkType string
	MTU         int

	Interfaces network.InterfaceInfos
}

NetworkConfig defines how the container network will be configured.

func BridgeNetworkConfig

func BridgeNetworkConfig(mtu int, interfaces network.InterfaceInfos) *NetworkConfig

BridgeNetworkConfig returns a valid NetworkConfig to use the specified device as a network bridge for the container. It also allows passing in specific configuration for the container's network interfaces and default MTU to use.

type StorageConfig

type StorageConfig struct {

	// AllowMount is true is the container is required to allow
	// mounting block devices.
	AllowMount bool
}

StorageConfig defines how the container will be configured to support storage requirements.

type TestLXDManager

type TestLXDManager interface {
	Manager
	LXDProfileManager
	LXDProfileNameRetriever
}

TestLXDManager for use in worker/provisioner tests