machine

Documentation

Overview

The machiner package implements the API interface used by the machiner worker.

Index

• type MachinerAPI
  • func NewMachinerAPI(ctx facade.Context) (*MachinerAPI, error)
  • func NewMachinerAPIForState(ctrlSt, st *state.State, resources facade.Resources, ...) (*MachinerAPI, error)
  • func (api *MachinerAPI) Jobs(args params.Entities) (params.JobsResults, error)
  • func (api *MachinerAPI) RecordAgentStartInformation(args params.RecordAgentStartInformationArgs) (params.ErrorResults, error)
  • func (api *MachinerAPI) RecordAgentStartTime(args params.Entities) (params.ErrorResults, error)
  • func (api *MachinerAPI) SetMachineAddresses(args params.SetMachinesAddresses) (params.ErrorResults, error)

Types

type MachinerAPI

type MachinerAPI struct {
	*common.LifeGetter
	*common.StatusSetter
	*common.DeadEnsurer
	*common.AgentEntityWatcher
	*common.APIAddresser
	*networkingcommon.NetworkConfigAPI
	// contains filtered or unexported fields
}

MachinerAPI implements the API used by the machiner worker.

func NewMachinerAPI

func NewMachinerAPI(ctx facade.Context) (*MachinerAPI, error)

NewMachinerAPI creates a new instance of the Machiner API.

func NewMachinerAPIForState

func NewMachinerAPIForState(ctrlSt, st *state.State, resources facade.Resources, authorizer facade.Authorizer) (*MachinerAPI, error)

NewMachinerAPIForState creates a new instance of the Machiner API.

func (*MachinerAPI) Jobs

func (api *MachinerAPI) Jobs(args params.Entities) (params.JobsResults, error)

Jobs returns the jobs assigned to the given entities.

func (*MachinerAPI) RecordAgentStartInformation

func (api *MachinerAPI) RecordAgentStartInformation(args params.RecordAgentStartInformationArgs) (params.ErrorResults, error)

RecordAgentStartInformation syncs the machine model with information reported by a machine agent when it starts.

func (*MachinerAPI) RecordAgentStartTime

func (api *MachinerAPI) RecordAgentStartTime(args params.Entities) (params.ErrorResults, error)

RecordAgentStartTime updates the agent start time field in the machine doc.

func (*MachinerAPI) SetMachineAddresses

func (api *MachinerAPI) SetMachineAddresses(args params.SetMachinesAddresses) (params.ErrorResults, error)