Back to godoc.org
github.com/juju/juju/api/provisioner

package provisioner

v0.0.0 (4dcf1d7)
Latest Go to latest
Published: 1 day ago | License: AGPL-3.0 | Module: github.com/juju/juju

Index

type DistributionGroupResult

type DistributionGroupResult struct {
	MachineIds []string
	Err        *params.Error
}

DistributionGroupResult provides a slice of machine.Ids in the distribution group and any Error related to finding it.

type LXDProfileResult

type LXDProfileResult struct {
	Config      map[string]string            `json:"config" yaml:"config"`
	Description string                       `json:"description" yaml:"description"`
	Devices     map[string]map[string]string `json:"devices" yaml:"devices"`
	Name        string                       `json:"name" yaml:"name"`
}

LXDProfileResult provides a charm.LXDProfile, adding the name.

type Machine

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

Machine represents a juju machine as seen by the provisioner worker.

func (*Machine) AvailabilityZone

func (m *Machine) AvailabilityZone() (string, error)

AvailabilityZone implements MachineProvisioner.AvailabilityZone.

func (*Machine) DistributionGroup

func (m *Machine) DistributionGroup() ([]instance.Id, error)

DistributionGroup implements MachineProvisioner.DistributionGroup.

func (*Machine) EnsureDead

func (m *Machine) EnsureDead() error

EnsureDead implements MachineProvisioner.EnsureDead.

func (*Machine) Id

func (m *Machine) Id() string

Id implements MachineProvisioner.Id.

func (*Machine) InstanceId

func (m *Machine) InstanceId() (instance.Id, error)

InstanceId implements MachineProvisioner.InstanceId.

func (*Machine) InstanceStatus

func (m *Machine) InstanceStatus() (status.Status, string, error)

InstanceStatus implements MachineProvisioner.InstanceStatus.

func (*Machine) KeepInstance

func (m *Machine) KeepInstance() (bool, error)

KeepInstance implements MachineProvisioner.KeepInstance.

func (*Machine) Life

func (m *Machine) Life() life.Value

Life implements MachineProvisioner..

func (*Machine) MachineTag

func (m *Machine) MachineTag() names.MachineTag

MachineTag implements MachineProvisioner.MachineTag.

func (*Machine) MarkForRemoval

func (m *Machine) MarkForRemoval() error

MarkForRemoval implements MachineProvisioner.MarkForRemoval.

func (*Machine) ModelAgentVersion

func (m *Machine) ModelAgentVersion() (*version.Number, error)

ModelAgentVersion implements MachineProvisioner.ModelAgentVersion.

func (*Machine) ProvisioningInfo

func (m *Machine) ProvisioningInfo() (*params.ProvisioningInfoV10, error)

ProvisioningInfo implements MachineProvisioner.ProvisioningInfo.

func (*Machine) Refresh

func (m *Machine) Refresh() error

Refresh implements MachineProvisioner.Refresh.

func (*Machine) Remove

func (m *Machine) Remove() error

Remove implements MachineProvisioner.Remove.

func (*Machine) SetCharmProfiles

func (m *Machine) SetCharmProfiles(profiles []string) error

SetCharmProfiles implements MachineProvisioner.SetCharmProfiles.

func (*Machine) SetInstanceInfo

func (m *Machine) SetInstanceInfo(
	id instance.Id, displayName string, nonce string, characteristics *instance.HardwareCharacteristics,
	networkConfig []params.NetworkConfig, volumes []params.Volume,
	volumeAttachments map[string]params.VolumeAttachmentInfo, charmProfiles []string,
) error

SetInstanceInfo implements MachineProvisioner.SetInstanceInfo.

func (*Machine) SetInstanceStatus

func (m *Machine) SetInstanceStatus(status status.Status, message string, data map[string]interface{}) error

SetInstanceStatus implements MachineProvisioner.SetInstanceStatus.

func (*Machine) SetModificationStatus

func (m *Machine) SetModificationStatus(status status.Status, info string, data map[string]interface{}) error

SetModificationStatus implements MachineProvisioner.SetModificationStatus.

func (*Machine) SetPassword

func (m *Machine) SetPassword(password string) error

SetPassword implements MachineProvisioner.SetPassword.

func (*Machine) SetStatus

func (m *Machine) SetStatus(status status.Status, info string, data map[string]interface{}) error

SetStatus implements MachineProvisioner.SetStatus.

func (*Machine) SetSupportedContainers

func (m *Machine) SetSupportedContainers(containerTypes ...instance.ContainerType) error

SetSupportedContainers implements MachineProvisioner.SetSupportedContainers.

func (*Machine) Status

func (m *Machine) Status() (status.Status, string, error)

Status implements MachineProvisioner.Status.

func (*Machine) String

func (m *Machine) String() string

String implements MachineProvisioner.String.

func (*Machine) SupportedContainers

func (m *Machine) SupportedContainers() ([]instance.ContainerType, bool, error)

SupportedContainers implements MachineProvisioner.SupportedContainers.

func (*Machine) SupportsNoContainers

func (m *Machine) SupportsNoContainers() error

SupportsNoContainers implements MachineProvisioner.SupportsNoContainers.

func (*Machine) Tag

func (m *Machine) Tag() names.Tag

Tag implements MachineProvisioner.Tag.

func (*Machine) WatchAllContainers

func (m *Machine) WatchAllContainers() (watcher.StringsWatcher, error)

WatchAllContainers implements MachineProvisioner.WatchAllContainers.

func (*Machine) WatchContainers

func (m *Machine) WatchContainers(ctype instance.ContainerType) (watcher.StringsWatcher, error)

WatchContainers implements MachineProvisioner.WatchContainers.

type MachineProvisioner

type MachineProvisioner interface {
	// Tag returns the machine's tag.
	Tag() names.Tag

	// ModelAgentVersion returns the agent version the machine's model is currently
	// running or an error.
	ModelAgentVersion() (*version.Number, error)

	// MachineTag returns the identifier for the machine as the most specific type.
	MachineTag() names.MachineTag

	// Id returns the machine id.
	Id() string

	// String returns the machine as a string.
	String() string

	// Life returns the machine's lifecycle value.
	Life() life.Value

	// Refresh updates the cached local copy of the machine's data.
	Refresh() error

	// ProvisioningInfo returns the information required to provision a machine.
	ProvisioningInfo() (*params.ProvisioningInfoV10, error)

	// SetInstanceStatus sets the status for the provider instance.
	SetInstanceStatus(status status.Status, message string, data map[string]interface{}) error

	// InstanceStatus returns the status of the provider instance.
	InstanceStatus() (status.Status, string, error)

	// SetStatus sets the status of the machine.
	SetStatus(status status.Status, info string, data map[string]interface{}) error

	// Status returns the status of the machine.
	Status() (status.Status, string, error)

	// SetModificationStatus sets the status of the machine changes whilst it's
	// running. Example of this could be LXD profiles being applied.
	SetModificationStatus(status status.Status, message string, data map[string]interface{}) error

	// EnsureDead sets the machine lifecycle to Dead if it is Alive or
	// Dying. It does nothing otherwise.
	EnsureDead() error

	// Remove removes the machine from state. It will fail if the machine
	// is not Dead.
	Remove() error

	// MarkForRemoval indicates that the machine is ready to have any
	// provider-level resources cleaned up and be removed.
	MarkForRemoval() error

	// AvailabilityZone returns an underlying provider's availability zone
	// for a machine.
	AvailabilityZone() (string, error)

	// DistributionGroup returns a slice of instance.Ids
	// that belong to the same distribution group as this
	// Machine. The provisioner may use this information
	// to distribute instances for high availability.
	DistributionGroup() ([]instance.Id, error)

	// SetInstanceInfo sets the provider specific instance id, nonce, metadata,
	// network config for this machine. Once set, the instance id cannot be changed.
	SetInstanceInfo(
		id instance.Id, displayName string, nonce string, characteristics *instance.HardwareCharacteristics,
		networkConfig []params.NetworkConfig, volumes []params.Volume,
		volumeAttachments map[string]params.VolumeAttachmentInfo, charmProfiles []string,
	) error

	// InstanceId returns the provider specific instance id for the
	// machine or an CodeNotProvisioned error, if not set.
	InstanceId() (instance.Id, error)

	// KeepInstance returns the value of the keep-instance
	// for the machine.
	KeepInstance() (bool, error)

	// SetPassword sets the machine's password.
	SetPassword(password string) error

	// WatchContainers returns a StringsWatcher that notifies of changes
	// to the lifecycles of containers of the specified type on the machine.
	WatchContainers(ctype instance.ContainerType) (watcher.StringsWatcher, error)

	// WatchAllContainers returns a StringsWatcher that notifies of changes
	// to the lifecycles of all containers on the machine.
	WatchAllContainers() (watcher.StringsWatcher, error)

	// SetSupportedContainers updates the list of containers supported by this machine.
	SetSupportedContainers(containerTypes ...instance.ContainerType) error

	// SupportsNoContainers records the fact that this machine doesn't support any containers.
	SupportsNoContainers() error

	// SupportedContainers returns a list of containers supported by this machine.
	SupportedContainers() ([]instance.ContainerType, bool, error)

	// SetCharmProfiles records the given slice of charm profile names.
	SetCharmProfiles([]string) error
}

MachineProvisioner defines what provisioner needs to provision a machine.

type MachineResult

type MachineResult struct {
	Machine MachineProvisioner
	Err     *params.Error
}

MachineResult provides a found Machine and any Error related to finding it.

type MachineStatusResult

type MachineStatusResult struct {
	Machine MachineProvisioner
	Status  params.StatusResult
}

MachineStatusResult provides a found Machine and Status Results for it.

type State

type State struct {
	*common.ModelWatcher
	*common.APIAddresser
	*common.ControllerConfigAPI
	// contains filtered or unexported fields
}

State provides access to the Machiner API facade.

func NewState

func NewState(caller base.APICaller) *State

NewState creates a new provisioner facade using the input caller.

func NewStateFromFacade

func NewStateFromFacade(facadeCaller base.FacadeCaller) *State

NewStateFromFacade creates a new provisioner facade using the input facade caller.

func (*State) CACert

func (a *State) CACert() (string, error)

CACert returns the certificate used to validate the API and state connections.

func (*State) ContainerConfig

func (st *State) ContainerConfig() (result params.ContainerConfig, err error)

ContainerConfig returns information from the model config that is needed for container cloud-init.

func (*State) ContainerManagerConfig

func (st *State) ContainerManagerConfig(args params.ContainerManagerConfigParams) (result params.ContainerManagerConfig, err error)

ContainerManagerConfig returns information from the model config that is needed for configuring the container manager.

func (*State) DistributionGroupByMachineId

func (st *State) DistributionGroupByMachineId(tags ...names.MachineTag) ([]DistributionGroupResult, error)

DistributionGroupByMachineId returns a slice of machine.Ids that belong to the same distribution group as the given Machine. The provisioner may use this information to distribute instances for high availability.

func (*State) FindTools

func (st *State) FindTools(v version.Number, series string, arch string) (tools.List, error)

FindTools returns al ist of tools matching the specified version number and series, and, arch. If arch is blank, a default will be used.

func (*State) GetContainerInterfaceInfo

func (st *State) GetContainerInterfaceInfo(containerTag names.MachineTag) (corenetwork.InterfaceInfos, error)

GetContainerInterfaceInfo returns information to configure networking for a container. It accepts container tags as arguments.

func (*State) GetContainerProfileInfo

func (st *State) GetContainerProfileInfo(containerTag names.MachineTag) ([]*LXDProfileResult, error)

GetContainerProfileInfo returns a slice of ContainerLXDProfile, 1 for each unit's charm which contains an lxd-profile.yaml.

func (*State) HostChangesForContainer

func (st *State) HostChangesForContainer(containerTag names.MachineTag) ([]network.DeviceToBridge, int, error)

func (*State) Machines

func (st *State) Machines(tags ...names.MachineTag) ([]MachineResult, error)

Machine provides access to methods of a state.Machine through the facade for the given tags.

func (*State) MachinesWithTransientErrors

func (st *State) MachinesWithTransientErrors() ([]MachineStatusResult, error)

MachinesWithTransientErrors returns a slice of machines and corresponding status information for those machines which have transient provisioning errors.

func (*State) PrepareContainerInterfaceInfo

func (st *State) PrepareContainerInterfaceInfo(containerTag names.MachineTag) (corenetwork.InterfaceInfos, error)

PrepareContainerInterfaceInfo allocates an address and returns information to configure networking for a container. It accepts container tags as arguments.

func (*State) ReleaseContainerAddresses

func (st *State) ReleaseContainerAddresses(containerTag names.MachineTag) (err error)

ReleaseContainerAddresses releases a static IP address allocated to a container.

func (*State) SetHostMachineNetworkConfig

func (st *State) SetHostMachineNetworkConfig(hostMachineTag names.MachineTag, netConfig []params.NetworkConfig) error

SetHostMachineNetworkConfig sets the network configuration of the machine with netConfig

func (*State) StateAddresses

func (st *State) StateAddresses() ([]string, error)

StateAddresses returns the list of addresses used to connect to the state.

func (*State) WatchMachineErrorRetry

func (st *State) WatchMachineErrorRetry() (watcher.NotifyWatcher, error)

func (*State) WatchModelMachines

func (st *State) WatchModelMachines() (watcher.StringsWatcher, error)

WatchModelMachines returns a StringsWatcher that notifies of changes to the lifecycles of the machines (but not containers) in the current model.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
f or F : Jump to identifier