Documentation
¶
Index ¶
- Constants
- func LeaderElectionRecordToLeaseSpec(ler *LeaderElectionRecord) coordinationv1.LeaseSpec
- type ConfigMapLock
- func (cml *ConfigMapLock) Create(ler LeaderElectionRecord) error
- func (cml *ConfigMapLock) Describe() string
- func (cml *ConfigMapLock) Get() (*LeaderElectionRecord, error)
- func (cml *ConfigMapLock) Identity() string
- func (cml *ConfigMapLock) RecordEvent(s string)
- func (cml *ConfigMapLock) Update(ler LeaderElectionRecord) error
- type EndpointsLock
- func (el *EndpointsLock) Create(ler LeaderElectionRecord) error
- func (el *EndpointsLock) Describe() string
- func (el *EndpointsLock) Get() (*LeaderElectionRecord, error)
- func (el *EndpointsLock) Identity() string
- func (el *EndpointsLock) RecordEvent(s string)
- func (el *EndpointsLock) Update(ler LeaderElectionRecord) error
- type EventRecorder
- type Interface
- type LeaderElectionRecord
- type LeaseLock
- type ResourceLockConfig
Constants ¶
const ( LeaderElectionRecordAnnotationKey = "control-plane.alpha.kubernetes.io/leader" EndpointsResourceLock = "endpoints" ConfigMapsResourceLock = "configmaps" LeasesResourceLock = "leases" )
Variables ¶
This section is empty.
Functions ¶
func LeaderElectionRecordToLeaseSpec ¶ added in v1.14.1
func LeaderElectionRecordToLeaseSpec(ler *LeaderElectionRecord) coordinationv1.LeaseSpec
Types ¶
type ConfigMapLock ¶
type ConfigMapLock struct { // ConfigMapMeta should contain a Name and a Namespace of a // ConfigMapMeta object that the LeaderElector will attempt to lead. ConfigMapMeta metav1.ObjectMeta Client corev1client.ConfigMapsGetter LockConfig ResourceLockConfig // contains filtered or unexported fields }
func (*ConfigMapLock) Create ¶
func (cml *ConfigMapLock) Create(ler LeaderElectionRecord) error
Create attempts to create a LeaderElectionRecord annotation
func (*ConfigMapLock) Describe ¶
func (cml *ConfigMapLock) Describe() string
Describe is used to convert details on current resource lock into a string
func (*ConfigMapLock) Get ¶
func (cml *ConfigMapLock) Get() (*LeaderElectionRecord, error)
Get returns the election record from a ConfigMap Annotation
func (*ConfigMapLock) Identity ¶
func (cml *ConfigMapLock) Identity() string
returns the Identity of the lock
func (*ConfigMapLock) RecordEvent ¶
func (cml *ConfigMapLock) RecordEvent(s string)
RecordEvent in leader election while adding meta-data
func (*ConfigMapLock) Update ¶
func (cml *ConfigMapLock) Update(ler LeaderElectionRecord) error
Update will update an existing annotation on a given resource.
type EndpointsLock ¶
type EndpointsLock struct { // EndpointsMeta should contain a Name and a Namespace of an // Endpoints object that the LeaderElector will attempt to lead. EndpointsMeta metav1.ObjectMeta Client corev1client.EndpointsGetter LockConfig ResourceLockConfig // contains filtered or unexported fields }
func (*EndpointsLock) Create ¶
func (el *EndpointsLock) Create(ler LeaderElectionRecord) error
Create attempts to create a LeaderElectionRecord annotation
func (*EndpointsLock) Describe ¶
func (el *EndpointsLock) Describe() string
Describe is used to convert details on current resource lock into a string
func (*EndpointsLock) Get ¶
func (el *EndpointsLock) Get() (*LeaderElectionRecord, error)
Get returns the election record from a Endpoints Annotation
func (*EndpointsLock) Identity ¶
func (el *EndpointsLock) Identity() string
returns the Identity of the lock
func (*EndpointsLock) RecordEvent ¶
func (el *EndpointsLock) RecordEvent(s string)
RecordEvent in leader election while adding meta-data
func (*EndpointsLock) Update ¶
func (el *EndpointsLock) Update(ler LeaderElectionRecord) error
Update will update and existing annotation on a given resource.
type EventRecorder ¶ added in v1.14.1
type EventRecorder interface {
Eventf(obj runtime.Object, eventType, reason, message string, args ...interface{})
}
EventRecorder records a change in the ResourceLock.
type Interface ¶
type Interface interface { // Get returns the LeaderElectionRecord Get() (*LeaderElectionRecord, error) // Create attempts to create a LeaderElectionRecord Create(ler LeaderElectionRecord) error // Update will update and existing LeaderElectionRecord Update(ler LeaderElectionRecord) error // RecordEvent is used to record events RecordEvent(string) // Identity will return the locks Identity Identity() string // Describe is used to convert details on current resource lock // into a string Describe() string }
Interface offers a common interface for locking on arbitrary resources used in leader election. The Interface is used to hide the details on specific implementations in order to allow them to change over time. This interface is strictly for use by the leaderelection code.
func New ¶
func New(lockType string, ns string, name string, coreClient corev1.CoreV1Interface, coordinationClient coordinationv1.CoordinationV1Interface, rlc ResourceLockConfig) (Interface, error)
Manufacture will create a lock of a given type according to the input parameters
type LeaderElectionRecord ¶
type LeaderElectionRecord struct { // HolderIdentity is the ID that owns the lease. If empty, no one owns this lease and // all callers may acquire. Versions of this library prior to Kubernetes 1.14 will not // attempt to acquire leases with empty identities and will wait for the full lease // interval to expire before attempting to reacquire. This value is set to empty when // a client voluntarily steps down. HolderIdentity string `json:"holderIdentity"` LeaseDurationSeconds int `json:"leaseDurationSeconds"` AcquireTime metav1.Time `json:"acquireTime"` RenewTime metav1.Time `json:"renewTime"` LeaderTransitions int `json:"leaderTransitions"` }
LeaderElectionRecord is the record that is stored in the leader election annotation. This information should be used for observational purposes only and could be replaced with a random string (e.g. UUID) with only slight modification of this code. TODO(mikedanese): this should potentially be versioned
func LeaseSpecToLeaderElectionRecord ¶ added in v1.14.1
func LeaseSpecToLeaderElectionRecord(spec *coordinationv1.LeaseSpec) *LeaderElectionRecord
type LeaseLock ¶ added in v1.14.1
type LeaseLock struct { // LeaseMeta should contain a Name and a Namespace of a // LeaseMeta object that the LeaderElector will attempt to lead. LeaseMeta metav1.ObjectMeta Client coordinationv1client.LeasesGetter LockConfig ResourceLockConfig // contains filtered or unexported fields }
func (*LeaseLock) Create ¶ added in v1.14.1
func (ll *LeaseLock) Create(ler LeaderElectionRecord) error
Create attempts to create a Lease
func (*LeaseLock) Describe ¶ added in v1.14.1
Describe is used to convert details on current resource lock into a string
func (*LeaseLock) Get ¶ added in v1.14.1
func (ll *LeaseLock) Get() (*LeaderElectionRecord, error)
Get returns the election record from a Lease spec
func (*LeaseLock) RecordEvent ¶ added in v1.14.1
RecordEvent in leader election while adding meta-data
func (*LeaseLock) Update ¶ added in v1.14.1
func (ll *LeaseLock) Update(ler LeaderElectionRecord) error
Update will update an existing Lease spec.
type ResourceLockConfig ¶
type ResourceLockConfig struct { // Identity is the unique string identifying a lease holder across // all participants in an election. Identity string // EventRecorder is optional. EventRecorder EventRecorder }
ResourceLockConfig common data that exists across different resource locks