Documentation
¶
Index ¶
Constants ¶
const ( NONE = ContainerType("none") LXC = ContainerType("lxc") KVM = ContainerType("kvm") )
const ( // MachineScope is a special scope name that is used // for machine placement directives (e.g. --to 0). MachineScope = "#" )
Variables ¶
var ContainerTypes []ContainerType = []ContainerType{ LXC, KVM, }
ContainerTypes is used to validate add-machine arguments.
var ErrPlacementScopeMissing = fmt.Errorf("placement scope missing")
Functions ¶
This section is empty.
Types ¶
type ContainerType ¶
type ContainerType string
func ParseContainerType ¶
func ParseContainerType(ctype string) (ContainerType, error)
ParseContainerType converts the specified string into a supported ContainerType instance or returns an error if the container type is invalid.
func ParseContainerTypeOrNone ¶
func ParseContainerTypeOrNone(ctype string) (ContainerType, error)
ParseContainerTypeOrNone converts the specified string into a supported ContainerType instance or returns an error if the container type is invalid. For this version of the function, 'none' is a valid value.
type HardwareCharacteristics ¶
type HardwareCharacteristics struct {
Arch *string `json:",omitempty" yaml:"arch,omitempty"`
Mem *uint64 `json:",omitempty" yaml:"mem,omitempty"`
RootDisk *uint64 `json:",omitempty" yaml:"rootdisk,omitempty"`
CpuCores *uint64 `json:",omitempty" yaml:"cpucores,omitempty"`
CpuPower *uint64 `json:",omitempty" yaml:"cpupower,omitempty"`
Tags *[]string `json:",omitempty" yaml:"tags,omitempty"`
}
HardwareCharacteristics represents the characteristics of the instance (if known). Attributes that are nil are unknown or not supported.
func MustParseHardware ¶
func MustParseHardware(args ...string) HardwareCharacteristics
MustParseHardware constructs a HardwareCharacteristics from the supplied arguments, as Parse, but panics on failure.
func ParseHardware ¶
func ParseHardware(args ...string) (HardwareCharacteristics, error)
ParseHardware constructs a HardwareCharacteristics from the supplied arguments, each of which must contain only spaces and name=value pairs. If any name is specified more than once, an error is returned.
func (*HardwareCharacteristics) Set ¶
func (hc *HardwareCharacteristics) Set(s string) error
Implement gnuflag.Value
func (HardwareCharacteristics) String ¶
func (hc HardwareCharacteristics) String() string
type Id ¶
type Id string
An instance Id is a provider-specific identifier associated with an instance (physical or virtual machine allocated in the provider).
type Instance ¶
type Instance interface {
// Id returns a provider-generated identifier for the Instance.
Id() Id
// Status returns the provider-specific status for the instance.
Status() string
// Refresh refreshes local knowledge of the instance from the provider.
Refresh() error
// Addresses returns a list of hostnames or ip addresses
// associated with the instance.
Addresses() ([]network.Address, error)
// OpenPorts opens the given ports on the instance, which
// should have been started with the given machine id.
OpenPorts(machineId string, ports []network.Port) error
// ClosePorts closes the given ports on the instance, which
// should have been started with the given machine id.
ClosePorts(machineId string, ports []network.Port) error
// Ports returns the set of ports open on the instance, which
// should have been started with the given machine id.
// The ports are returned as sorted by SortPorts.
Ports(machineId string) ([]network.Port, error)
}
Instance represents the the realization of a machine in state.
type Placement ¶
type Placement struct {
// Scope is the scope of the placement directive. Scope may
// be a container type (lxc, kvm), instance.MachineScope, or
// an environment name.
//
// If Scope is empty, then it must be inferred from the context.
Scope string
// Directive is a scope-specific placement directive.
//
// For MachineScope or a container scope, this may be empty or
// the ID of an existing machine.
Directive string
}
Placement defines a placement directive, which has a scope and a value that is scope-specific.
func MustParsePlacement ¶
MustParsePlacement attempts to parse the specified string and create a corresponding Placement structure, panicking if an error occurs.
func ParsePlacement ¶
ParsePlacement attempts to parse the specified string and create a corresponding Placement structure.
If the placement directive is non-empty and missing a scope, ErrPlacementScopeMissing will be returned as well as a Placement with an empty Scope field.
Source Files
Directories