client-go: k8s.io/client-go/tools/leaderelection/resourcelock Index | Files

package resourcelock

import "k8s.io/client-go/tools/leaderelection/resourcelock"

Index

Package Files

configmaplock.go endpointslock.go interface.go leaselock.go multilock.go

Constants

const (
    LeaderElectionRecordAnnotationKey = "control-plane.alpha.kubernetes.io/leader"
    EndpointsResourceLock             = "endpoints"
    ConfigMapsResourceLock            = "configmaps"
    LeasesResourceLock                = "leases"
    EndpointsLeasesResourceLock       = "endpointsleases"
    ConfigMapsLeasesResourceLock      = "configmapsleases"
)
const (
    UnknownLeader = "leaderelection.k8s.io/unknown"
)

func ConcatRawRecord Uses

func ConcatRawRecord(primaryRaw, secondaryRaw []byte) []byte

func LeaderElectionRecordToLeaseSpec Uses

func LeaderElectionRecordToLeaseSpec(ler *LeaderElectionRecord) coordinationv1.LeaseSpec

type ConfigMapLock Uses

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 Uses

func (cml *ConfigMapLock) Create(ctx context.Context, ler LeaderElectionRecord) error

Create attempts to create a LeaderElectionRecord annotation

func (*ConfigMapLock) Describe Uses

func (cml *ConfigMapLock) Describe() string

Describe is used to convert details on current resource lock into a string

func (*ConfigMapLock) Get Uses

func (cml *ConfigMapLock) Get(ctx context.Context) (*LeaderElectionRecord, []byte, error)

Get returns the election record from a ConfigMap Annotation

func (*ConfigMapLock) Identity Uses

func (cml *ConfigMapLock) Identity() string

Identity returns the Identity of the lock

func (*ConfigMapLock) RecordEvent Uses

func (cml *ConfigMapLock) RecordEvent(s string)

RecordEvent in leader election while adding meta-data

func (*ConfigMapLock) Update Uses

func (cml *ConfigMapLock) Update(ctx context.Context, ler LeaderElectionRecord) error

Update will update an existing annotation on a given resource.

type EndpointsLock Uses

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 Uses

func (el *EndpointsLock) Create(ctx context.Context, ler LeaderElectionRecord) error

Create attempts to create a LeaderElectionRecord annotation

func (*EndpointsLock) Describe Uses

func (el *EndpointsLock) Describe() string

Describe is used to convert details on current resource lock into a string

func (*EndpointsLock) Get Uses

func (el *EndpointsLock) Get(ctx context.Context) (*LeaderElectionRecord, []byte, error)

Get returns the election record from a Endpoints Annotation

func (*EndpointsLock) Identity Uses

func (el *EndpointsLock) Identity() string

Identity returns the Identity of the lock

func (*EndpointsLock) RecordEvent Uses

func (el *EndpointsLock) RecordEvent(s string)

RecordEvent in leader election while adding meta-data

func (*EndpointsLock) Update Uses

func (el *EndpointsLock) Update(ctx context.Context, ler LeaderElectionRecord) error

Update will update and existing annotation on a given resource.

type EventRecorder Uses

type EventRecorder interface {
    Eventf(obj runtime.Object, eventType, reason, message string, args ...interface{})
}

EventRecorder records a change in the ResourceLock.

type Interface Uses

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
}

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 Uses

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 Uses

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.

type LeaderElectionRecord Uses

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 Uses

func LeaseSpecToLeaderElectionRecord(spec *coordinationv1.LeaseSpec) *LeaderElectionRecord

type LeaseLock Uses

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 Uses

func (ll *LeaseLock) Create(ctx context.Context, ler LeaderElectionRecord) error

Create attempts to create a Lease

func (*LeaseLock) Describe Uses

func (ll *LeaseLock) Describe() string

Describe is used to convert details on current resource lock into a string

func (*LeaseLock) Get Uses

func (ll *LeaseLock) Get(ctx context.Context) (*LeaderElectionRecord, []byte, error)

Get returns the election record from a Lease spec

func (*LeaseLock) Identity Uses

func (ll *LeaseLock) Identity() string

Identity returns the Identity of the lock

func (*LeaseLock) RecordEvent Uses

func (ll *LeaseLock) RecordEvent(s string)

RecordEvent in leader election while adding meta-data

func (*LeaseLock) Update Uses

func (ll *LeaseLock) Update(ctx context.Context, ler LeaderElectionRecord) error

Update will update an existing Lease spec.

type MultiLock Uses

type MultiLock struct {
    Primary   Interface
    Secondary Interface
}

MultiLock is used for lock's migration

func (*MultiLock) Create Uses

func (ml *MultiLock) Create(ctx context.Context, ler LeaderElectionRecord) error

Create attempts to create both primary lock and secondary lock

func (*MultiLock) Describe Uses

func (ml *MultiLock) Describe() string

Describe is used to convert details on current resource lock into a string

func (*MultiLock) Get Uses

func (ml *MultiLock) Get(ctx context.Context) (*LeaderElectionRecord, []byte, error)

Get returns the older election record of the lock

func (*MultiLock) Identity Uses

func (ml *MultiLock) Identity() string

Identity returns the Identity of the lock

func (*MultiLock) RecordEvent Uses

func (ml *MultiLock) RecordEvent(s string)

RecordEvent in leader election while adding meta-data

func (*MultiLock) Update Uses

func (ml *MultiLock) Update(ctx context.Context, ler LeaderElectionRecord) error

Update will update and existing annotation on both two resources.

type ResourceLockConfig Uses

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

Package resourcelock imports 15 packages (graph) and is imported by 187 packages. Updated 2020-10-29. Refresh now. Tools for package owners.