registry

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 31, 2015 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Occurs when any Job's target is touched
	JobTargetChangeEvent = pkg.Event("JobTargetChangeEvent")
	// Occurs when any Job's target state is touched
	JobTargetStateChangeEvent = pkg.Event("JobTargetStateChangeEvent")
)
View Source 
const DefaultKeyPrefix = "/_coreos.com/fleet/"

Variables

This section is empty.

Functions

func NewEtcdEventStream added in v0.7.0 

func NewEtcdEventStream(client etcd.Client, rootPrefix string) pkg.EventStream

Types

type ClusterRegistry added in v0.8.2 

type ClusterRegistry interface {
	LatestDaemonVersion() (*semver.Version, error)

	// EngineVersion returns the current version of the cluster. If the
	// cluster does not yet have a version, zero will be returned. If
	// any error occurs, an error object will be returned. In this case,
	// the returned version number should be ignored.
	EngineVersion() (int, error)

	// UpdateEngineVersion attempts to compare-and-swap the cluster version
	// from one value to another. Any failures in this process will be
	// indicated by the returned error object. A nil value will be returned
	// on success.
	UpdateEngineVersion(from, to int) error
}

type EtcdRegistry added in v0.3.1 

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

EtcdRegistry fulfils the Registry interface and uses etcd as a backend

func NewEtcdRegistry added in v0.8.2 

func NewEtcdRegistry(client etcd.Client, keyPrefix string) *EtcdRegistry

func (*EtcdRegistry) AcquireLease added in v0.8.2 

func (r *EtcdRegistry) AcquireLease(name string, machID string, ver int, period time.Duration) (Lease, error)

func (*EtcdRegistry) ClearUnitHeartbeat added in v0.7.0 

func (r *EtcdRegistry) ClearUnitHeartbeat(name string)

func (*EtcdRegistry) CreateUnit added in v0.7.0 

func (r *EtcdRegistry) CreateUnit(u *job.Unit) (err error)

CreateUnit attempts to store a Unit and its associated unit file in the registry

func (*EtcdRegistry) DestroyUnit added in v0.7.0 

func (r *EtcdRegistry) DestroyUnit(name string) error

DestroyUnit removes a Job object from the repository. It does not yet remove underlying UnitFiles from the repository.

func (*EtcdRegistry) EngineVersion added in v0.8.2 

func (r *EtcdRegistry) EngineVersion() (int, error)

EngineVersion implements the ClusterRegistry interface

func (*EtcdRegistry) GetLease added in v0.8.2 

func (r *EtcdRegistry) GetLease(name string) (Lease, error)

func (*EtcdRegistry) LatestDaemonVersion added in v0.8.2 

func (r *EtcdRegistry) LatestDaemonVersion() (*semver.Version, error)

LatestDaemonVersion attempts to retrieve the latest version of fleetd that has been registered in the Registry. It returns the version if it can be determined (or nil otherwise), and any error encountered.

func (*EtcdRegistry) Machines added in v0.5.1 

func (r *EtcdRegistry) Machines() (machines []machine.MachineState, err error)

func (*EtcdRegistry) RemoveMachineState added in v0.3.1 

func (r *EtcdRegistry) RemoveMachineState(machID string) error

func (*EtcdRegistry) RemoveUnitState added in v0.3.1 

func (r *EtcdRegistry) RemoveUnitState(jobName string) error

Delete the state from the Registry for the given Job's Unit

func (*EtcdRegistry) SaveUnitState added in v0.3.1 

func (r *EtcdRegistry) SaveUnitState(jobName string, unitState *unit.UnitState, ttl time.Duration)

SaveUnitState persists the given UnitState to the Registry

func (*EtcdRegistry) Schedule added in v0.7.0 

func (r *EtcdRegistry) Schedule() ([]job.ScheduledUnit, error)

Schedule returns all ScheduledUnits known by fleet, ordered by name

func (*EtcdRegistry) ScheduleUnit added in v0.7.0 

func (r *EtcdRegistry) ScheduleUnit(name string, machID string) error

func (*EtcdRegistry) ScheduledUnit added in v0.7.0 

func (r *EtcdRegistry) ScheduledUnit(name string) (*job.ScheduledUnit, error)

ScheduledUnit retrieves the ScheduledUnit by the given name from the Registry. Returns nil if no such ScheduledUnit exists, and any error encountered.

func (*EtcdRegistry) SetMachineState added in v0.3.1 

func (r *EtcdRegistry) SetMachineState(ms machine.MachineState, ttl time.Duration) (uint64, error)

func (*EtcdRegistry) SetUnitTargetState added in v0.7.0 

func (r *EtcdRegistry) SetUnitTargetState(name string, state job.JobState) error

func (*EtcdRegistry) StealLease added in v0.8.2 

func (r *EtcdRegistry) StealLease(name, machID string, ver int, period time.Duration, idx uint64) (Lease, error)

func (*EtcdRegistry) Unit added in v0.7.0 

func (r *EtcdRegistry) Unit(name string) (*job.Unit, error)

Unit retrieves the Unit by the given name from the Registry. Returns nil if no such Unit exists, and any error encountered.

func (*EtcdRegistry) UnitHeartbeat added in v0.7.0 

func (r *EtcdRegistry) UnitHeartbeat(name, machID string, ttl time.Duration) error

func (*EtcdRegistry) UnitStates added in v0.7.0 

func (r *EtcdRegistry) UnitStates() (states []*unit.UnitState, err error)

UnitStates returns a list of all UnitStates stored in the registry, sorted by unit name and then machine ID.

func (*EtcdRegistry) Units added in v0.7.0 

func (r *EtcdRegistry) Units() ([]job.Unit, error)

Units lists all Units stored in the Registry, ordered by name. This includes both global and non-global units.

func (*EtcdRegistry) UnscheduleUnit added in v0.7.0 

func (r *EtcdRegistry) UnscheduleUnit(name, machID string) error

func (*EtcdRegistry) UpdateEngineVersion added in v0.8.2 

func (r *EtcdRegistry) UpdateEngineVersion(from, to int) error

UpdateEngineVersion implements the ClusterRegistry interface

type FakeClusterRegistry added in v0.8.2 

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

func NewFakeClusterRegistry added in v0.8.2 

func NewFakeClusterRegistry(dVersion *semver.Version, eVersion int) *FakeClusterRegistry

func (*FakeClusterRegistry) EngineVersion added in v0.8.2 

func (fc *FakeClusterRegistry) EngineVersion() (int, error)

func (*FakeClusterRegistry) LatestDaemonVersion added in v0.8.2 

func (fc *FakeClusterRegistry) LatestDaemonVersion() (*semver.Version, error)

func (*FakeClusterRegistry) UpdateEngineVersion added in v0.8.2 

func (fc *FakeClusterRegistry) UpdateEngineVersion(from, to int) error

type FakeLeaseRegistry added in v0.8.2 

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

func NewFakeLeaseRegistry added in v0.8.2 

func NewFakeLeaseRegistry() *FakeLeaseRegistry

func (*FakeLeaseRegistry) AcquireLease added in v0.8.2 

func (fl *FakeLeaseRegistry) AcquireLease(name, machID string, ver int, ttl time.Duration) (Lease, error)

func (*FakeLeaseRegistry) GetLease added in v0.8.2 

func (fl *FakeLeaseRegistry) GetLease(name string) (Lease, error)

func (*FakeLeaseRegistry) SetLease added in v0.8.2 

func (fl *FakeLeaseRegistry) SetLease(name, machID string, ver int, ttl time.Duration) *fakeLease

func (*FakeLeaseRegistry) StealLease added in v0.8.2 

func (fl *FakeLeaseRegistry) StealLease(name, machID string, ver int, ttl time.Duration, idx uint64) (Lease, error)

type FakeRegistry added in v0.4.0 

type FakeRegistry struct {
	// Not all methods required by the Registry interface are implemented
	// by the FakeRegistry. Any calls to these unimplemented methods will
	// result in a panic.
	Registry
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewFakeRegistry added in v0.4.0 

func NewFakeRegistry() *FakeRegistry

func (*FakeRegistry) ClearUnitHeartbeat added in v0.7.0 

func (f *FakeRegistry) ClearUnitHeartbeat(string)

func (*FakeRegistry) CreateUnit added in v0.7.0 

func (f *FakeRegistry) CreateUnit(u *job.Unit) error

func (*FakeRegistry) DestroyUnit added in v0.7.0 

func (f *FakeRegistry) DestroyUnit(name string) error

func (*FakeRegistry) Machines added in v0.5.1 

func (f *FakeRegistry) Machines() ([]machine.MachineState, error)

func (*FakeRegistry) RemoveUnitState added in v0.6.0 

func (f *FakeRegistry) RemoveUnitState(jobName string) error

func (*FakeRegistry) SaveUnitState added in v0.4.0 

func (f *FakeRegistry) SaveUnitState(jobName string, unitState *unit.UnitState, ttl time.Duration)

func (*FakeRegistry) Schedule added in v0.7.0 

func (f *FakeRegistry) Schedule() ([]job.ScheduledUnit, error)

func (*FakeRegistry) ScheduleUnit added in v0.7.0 

func (f *FakeRegistry) ScheduleUnit(name string, machID string) error

func (*FakeRegistry) ScheduledUnit added in v0.7.0 

func (f *FakeRegistry) ScheduledUnit(name string) (*job.ScheduledUnit, error)

func (*FakeRegistry) SetJobs added in v0.4.0 

func (f *FakeRegistry) SetJobs(jobs []job.Job)

func (*FakeRegistry) SetMachines added in v0.4.0 

func (f *FakeRegistry) SetMachines(machines []machine.MachineState)

func (*FakeRegistry) SetUnitStates added in v0.4.0 

func (f *FakeRegistry) SetUnitStates(states []unit.UnitState)

func (*FakeRegistry) SetUnitTargetState added in v0.7.0 

func (f *FakeRegistry) SetUnitTargetState(name string, target job.JobState) error

func (*FakeRegistry) Unit added in v0.7.0 

func (f *FakeRegistry) Unit(name string) (*job.Unit, error)

func (*FakeRegistry) UnitHeartbeat added in v0.7.0 

func (f *FakeRegistry) UnitHeartbeat(name, machID string, ttl time.Duration) error

func (*FakeRegistry) UnitStates added in v0.7.0 

func (f *FakeRegistry) UnitStates() ([]*unit.UnitState, error)

func (*FakeRegistry) Units added in v0.7.0 

func (f *FakeRegistry) Units() ([]job.Unit, error)

type Lease added in v0.5.4 

type Lease interface {
	// Renew attempts to extend the Lease TTL to the provided duration.
	// The operation will succeed only if the Lease has not changed in
	// the LeaseRegistry since it was last renewed or first acquired.
	// An error is returned if the Lease has already expired, or if the
	// operation fails for any other reason.
	Renew(time.Duration) error

	// Release relinquishes the ownership of a Lease back to the Registry.
	// After calling Release, the Lease object should be discarded. An
	// error is returned if the Lease has already expired, or if the
	// operation fails for any other reason.
	Release() error

	// MachineID returns the ID of the Machine that holds this Lease. This
	// value must be considered a cached value as it is not guaranteed to
	// be correct.
	MachineID() string

	// Version returns the current version at which the lesse is operating.
	// This value has the same correctness guarantees as MachineID.
	// It is up to the caller to determine what this Version means.
	Version() int

	// Index exposes the relative time at which the Lease was created or
	// renewed. For example, this could be implemented as the ModifiedIndex
	// field of a node in etcd.
	Index() uint64

	// TimeRemaining represents the amount of time left on the Lease when
	// it was fetched from the LeaseRegistry.
	TimeRemaining() time.Duration
}

Lease proxies to an auto-expiring lease stored in a LeaseRegistry. The creator of a Lease must repeatedly call Renew to keep their lease from expiring.

type LeaseRegistry added in v0.8.2 

type LeaseRegistry interface {
	// GetLease fetches a Lease only if it exists. If it does not
	// exist, a nil Lease will be returned. Any other failures
	// result in non-nil error and nil Lease objects.
	GetLease(name string) (Lease, error)

	// AcquireLease acquires a named lease only if the lease is not
	// currently held. If a Lease cannot be acquired, a nil Lease
	// object is returned. An error is returned only if there is a
	// failure communicating with the Registry.
	AcquireLease(name, machID string, ver int, period time.Duration) (Lease, error)

	// StealLease attempts to replace the lessee of the Lease identified
	// by the provided name and index with a new lessee. This function
	// will fail if the named Lease has progressed past the given index.
	StealLease(name, machID string, ver int, period time.Duration, idx uint64) (Lease, error)
}

type MUSKey added in v0.7.0 

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

MUSKey is used to index UnitStates by name + machineID

type MUSKeys added in v0.7.0 

type MUSKeys []MUSKey

MUSKeys provides for sorting of UnitStates by their MUSKey

func (MUSKeys) Len added in v0.7.0 

func (mk MUSKeys) Len() int

func (MUSKeys) Less added in v0.7.0 

func (mk MUSKeys) Less(i, j int) bool

func (MUSKeys) Swap added in v0.7.0 

func (mk MUSKeys) Swap(i, j int)

type Registry 

type Registry interface {
	ClearUnitHeartbeat(name string)
	CreateUnit(*job.Unit) error
	DestroyUnit(string) error
	UnitHeartbeat(name, machID string, ttl time.Duration) error
	Machines() ([]machine.MachineState, error)
	RemoveMachineState(machID string) error
	RemoveUnitState(jobName string) error
	SaveUnitState(jobName string, unitState *unit.UnitState, ttl time.Duration)
	ScheduleUnit(name, machID string) error
	SetUnitTargetState(name string, state job.JobState) error
	SetMachineState(ms machine.MachineState, ttl time.Duration) (uint64, error)
	UnscheduleUnit(name, machID string) error

	UnitRegistry
}

type UnitRegistry added in v0.7.0 

type UnitRegistry interface {
	Schedule() ([]job.ScheduledUnit, error)
	ScheduledUnit(name string) (*job.ScheduledUnit, error)
	Unit(name string) (*job.Unit, error)
	Units() ([]job.Unit, error)
	UnitStates() ([]*unit.UnitState, error)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.