agent

Documentation

Index

• Constants
• type Agent
  • func New(mgr unit.UnitManager, reg registry.Registry, mach machine.Machine, ttl string, ...) (*Agent, error)
  • func (a *Agent) HasConflict(potentialJobName string, potentialConflicts []string) (bool, string)
  • func (a *Agent) Heartbeat(stop chan bool)
  • func (a *Agent) Initialize()
  • func (a *Agent) JobScheduledElsewhere(jobName string)
  • func (a *Agent) JobScheduledLocally(jobName string)
  • func (a *Agent) JobUnscheduled(jobName string)
  • func (a *Agent) MarshalJSON() ([]byte, error)
  • func (a *Agent) MaybeBid(jo job.JobOffer)
  • func (a *Agent) Purge()
  • func (a *Agent) ReportUnitState(jobName string, us *unit.UnitState)
  • func (a *Agent) StartJob(jobName string)
  • func (a *Agent) StopJob(jobName string)
• type AgentState
  • func NewState() *AgentState
  • func (as *AgentState) GetJobsByPeer(peerName string) []string
  • func (as *AgentState) GetOffersWithoutBids() []job.JobOffer
  • func (as *AgentState) HasBid(name string) bool
  • func (as *AgentState) LaunchedJobs() []string
  • func (as *AgentState) Lock()
  • func (as *AgentState) MarshalJSON() ([]byte, error)
  • func (as *AgentState) PurgeJob(jobName string)
  • func (as *AgentState) PurgeOffer(name string)
  • func (as *AgentState) ScheduledHere(jobName string) bool
  • func (as *AgentState) ScheduledJobs() []string
  • func (as *AgentState) SetTargetState(jobName string, state job.JobState)
  • func (as *AgentState) TrackBid(name string)
  • func (as *AgentState) TrackJob(j *job.Job)
  • func (as *AgentState) TrackOffer(offer job.JobOffer)
  • func (as *AgentState) Unlock()
• type EventHandler
  • func NewEventHandler(agent *Agent) *EventHandler
  • func (eh *EventHandler) HandleCommandStartJob(ev event.Event)
  • func (eh *EventHandler) HandleCommandStopJob(ev event.Event)
  • func (eh *EventHandler) HandleEventJobDestroyed(ev event.Event)
  • func (eh *EventHandler) HandleEventJobOffered(ev event.Event)
  • func (eh *EventHandler) HandleEventJobScheduled(ev event.Event)
  • func (eh *EventHandler) HandleEventJobUnscheduled(ev event.Event)
  • func (eh *EventHandler) HandleEventUnitStateUpdated(ev event.Event)

Constants

const (
	// TTL to use with all state pushed to Registry
	DefaultTTL = "30s"
)

Types

type Agent

type Agent struct {
	Machine machine.Machine
	// contains filtered or unexported fields
}

The Agent owns all of the coordination between the Registry, the local Machine, and the local UnitManager.

func New

func New(mgr unit.UnitManager, reg registry.Registry, mach machine.Machine, ttl string, verifier *sign.SignatureVerifier) (*Agent, error)

func (*Agent) HasConflict

func (a *Agent) HasConflict(potentialJobName string, potentialConflicts []string) (bool, string)

HasConflict determines whether there are any known conflicts with the given argument

func (*Agent) Heartbeat

func (a *Agent) Heartbeat(stop chan bool)

Heartbeat updates the Registry periodically with this Agent's presence information as well as an acknowledgement of the jobs it is expected to be running.

func (*Agent) Initialize

func (a *Agent) Initialize()

Initialize prepares the Agent for normal operation by doing three things: 1. Announce presence to the Registry 2. Discover any jobs that are scheduled locally, loading/starting them if they can run locally 3. Cache all unresolved job offers and bid for any that can be run locally

func (*Agent) JobScheduledElsewhere

func (a *Agent) JobScheduledElsewhere(jobName string)

JobScheduledElsewhere clears all state related to the indicated job before bidding for all oustanding jobs that can be run locally.

func (*Agent) JobScheduledLocally

func (a *Agent) JobScheduledLocally(jobName string)

JobScheduledLocally clears all state related to the indicated job's offers/bids before attempting to load and possibly start the job. The ability to run the job will be revalidated before loading, and unscheduled if such validation fails.

func (*Agent) JobUnscheduled

func (a *Agent) JobUnscheduled(jobName string)

JobUnscheduled attempts to unload the indicated job only if it were scheduled here in the first place, otherwise the event is ignored. If unloading is necessary, all jobs that can be run locally will also be bid upon.

func (*Agent) MarshalJSON

func (a *Agent) MarshalJSON() ([]byte, error)

func (*Agent) MaybeBid

func (a *Agent) MaybeBid(jo job.JobOffer)

MaybeBid bids for the given JobOffer only if the Agent determines that it is able to run the JobOffer's Job

func (*Agent) Purge

func (a *Agent) Purge()

Purge removes the Agent's state from the Registry

func (*Agent) ReportUnitState

func (a *Agent) ReportUnitState(jobName string, us *unit.UnitState)

ReportUnitState attaches the current state of the Agent's Machine to the given unit.UnitState object, then persists that state in the Registry

func (*Agent) StartJob

func (a *Agent) StartJob(jobName string)

StartJob starts the indicated Job after first acquiring the state mutex

func (*Agent) StopJob

func (a *Agent) StopJob(jobName string)

StopJob stops the indicated Job after first acquiring the state mutex

type AgentState

type AgentState struct {

	// index of local payload conflicts to the job they belong to
	Conflicts map[string][]string
	// contains filtered or unexported fields
}

func NewState

func NewState() *AgentState

func (*AgentState) GetJobsByPeer

func (as *AgentState) GetJobsByPeer(peerName string) []string

Retrieve all Jobs that share a given Peer

func (*AgentState) GetOffersWithoutBids

func (as *AgentState) GetOffersWithoutBids() []job.JobOffer

GetOffersWithoutBids returns all tracked JobOffers that have no corresponding JobBid tracked in the same AgentState object.

func (*AgentState) HasBid

func (as *AgentState) HasBid(name string) bool

func (*AgentState) LaunchedJobs

func (as *AgentState) LaunchedJobs() []string

func (*AgentState) Lock

func (as *AgentState) Lock()

func (*AgentState) MarshalJSON

func (as *AgentState) MarshalJSON() ([]byte, error)

func (*AgentState) PurgeJob

func (as *AgentState) PurgeJob(jobName string)

PurgeJob removes all state tracked on behalf of a given job

func (*AgentState) PurgeOffer

func (as *AgentState) PurgeOffer(name string)

func (*AgentState) ScheduledHere

func (as *AgentState) ScheduledHere(jobName string) bool

func (*AgentState) ScheduledJobs

func (as *AgentState) ScheduledJobs() []string

func (*AgentState) SetTargetState

func (as *AgentState) SetTargetState(jobName string, state job.JobState)

func (*AgentState) TrackBid

func (as *AgentState) TrackBid(name string)

func (*AgentState) TrackJob

func (as *AgentState) TrackJob(j *job.Job)

TrackJob extracts and stores information about the given job for later reference

func (*AgentState) TrackOffer

func (as *AgentState) TrackOffer(offer job.JobOffer)

func (*AgentState) Unlock

func (as *AgentState) Unlock()

type EventHandler

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

func NewEventHandler

func NewEventHandler(agent *Agent) *EventHandler

func (*EventHandler) HandleCommandStartJob

func (eh *EventHandler) HandleCommandStartJob(ev event.Event)

func (*EventHandler) HandleCommandStopJob

func (eh *EventHandler) HandleCommandStopJob(ev event.Event)

func (*EventHandler) HandleEventJobDestroyed

func (eh *EventHandler) HandleEventJobDestroyed(ev event.Event)

func (*EventHandler) HandleEventJobOffered

func (eh *EventHandler) HandleEventJobOffered(ev event.Event)

func (*EventHandler) HandleEventJobScheduled

func (eh *EventHandler) HandleEventJobScheduled(ev event.Event)

func (*EventHandler) HandleEventJobUnscheduled

func (eh *EventHandler) HandleEventJobUnscheduled(ev event.Event)

func (*EventHandler) HandleEventUnitStateUpdated

func (eh *EventHandler) HandleEventUnitStateUpdated(ev event.Event)