const (
LeaderElectionRecordAnnotationKey = "control-plane.alpha.kubernetes.io/leader"
LeasesResourceLock = "leases"
)
const (
UnknownLeader = "leaderelection.k8s.io/unknown"
)
func ConcatRawRecord(primaryRaw, secondaryRaw []byte) []byte
func LeaderElectionRecordToLeaseSpec(ler *LeaderElectionRecord) coordinationv1.LeaseSpec
EventRecorder records a change in the ResourceLock.
type EventRecorder interface {
Eventf(obj runtime.Object, eventType, reason, message string, args ...interface{})
}
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.
type Interface interface {
// Get returns the LeaderElectionRecord
Get(ctx context.Context) (*LeaderElectionRecord, []byte, error)
// Create attempts to create a LeaderElectionRecord
Create(ctx context.Context, ler LeaderElectionRecord) error
// Update will update and existing LeaderElectionRecord
Update(ctx context.Context, 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
}
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
func NewFromKubeconfig(lockType string, ns string, name string, rlc ResourceLockConfig, kubeconfig *restclient.Config, renewDeadline time.Duration) (Interface, error)
NewFromKubeconfig will create a lock of a given type according to the input parameters. Timeout set for a client used to contact to Kubernetes should be lower than RenewDeadline to keep a single hung request from forcing a leader loss. Setting it to max(time.Second, RenewDeadline/2) as a reasonable heuristic.
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
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"`
}
func LeaseSpecToLeaderElectionRecord(spec *coordinationv1.LeaseSpec) *LeaderElectionRecord
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 (ll *LeaseLock) Create(ctx context.Context, ler LeaderElectionRecord) error
Create attempts to create a Lease
func (ll *LeaseLock) Describe() string
Describe is used to convert details on current resource lock into a string
func (ll *LeaseLock) Get(ctx context.Context) (*LeaderElectionRecord, []byte, error)
Get returns the election record from a Lease spec
func (ll *LeaseLock) Identity() string
Identity returns the Identity of the lock
func (ll *LeaseLock) RecordEvent(s string)
RecordEvent in leader election while adding meta-data
func (ll *LeaseLock) Update(ctx context.Context, ler LeaderElectionRecord) error
Update will update an existing Lease spec.
MultiLock is used for lock's migration
type MultiLock struct {
Primary Interface
Secondary Interface
}
func (ml *MultiLock) Create(ctx context.Context, ler LeaderElectionRecord) error
Create attempts to create both primary lock and secondary lock
func (ml *MultiLock) Describe() string
Describe is used to convert details on current resource lock into a string
func (ml *MultiLock) Get(ctx context.Context) (*LeaderElectionRecord, []byte, error)
Get returns the older election record of the lock
func (ml *MultiLock) Identity() string
Identity returns the Identity of the lock
func (ml *MultiLock) RecordEvent(s string)
RecordEvent in leader election while adding meta-data
func (ml *MultiLock) Update(ctx context.Context, ler LeaderElectionRecord) error
Update will update and existing annotation on both two resources.
ResourceLockConfig common data that exists across different resource locks
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
}