mirror of
https://github.com/kubernetes/client-go.git
synced 2026-07-01 06:25:55 +00:00
30b06a83d6
The current code simply exits without continuing to renew the lease, which means participants using a slower lease duration might have to wait multiple minutes before a new leader is elected. Allow an optional flag to be set on LeaderElectionConfig that will release the lease when the calling context is cancelled. Callers *must* ensure their lease guarded code has completed before the context is cancelled, or other processes may acquire the lease before this lease has released. Add an example command that demonstrates how cancellation could be done. As a convenience to users, make event recorder optional - not all users of the lock code will need a recorder. Kubernetes-commit: 09890b6c48da8e85237a5674d6256900f482b0a5
108 lines
3.3 KiB
Go
108 lines
3.3 KiB
Go
/*
|
|
Copyright 2016 The Kubernetes Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package resourcelock
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"k8s.io/api/core/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
|
|
)
|
|
|
|
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
|
|
e *v1.Endpoints
|
|
}
|
|
|
|
// Get returns the election record from a Endpoints Annotation
|
|
func (el *EndpointsLock) Get() (*LeaderElectionRecord, error) {
|
|
var record LeaderElectionRecord
|
|
var err error
|
|
el.e, err = el.Client.Endpoints(el.EndpointsMeta.Namespace).Get(el.EndpointsMeta.Name, metav1.GetOptions{})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if el.e.Annotations == nil {
|
|
el.e.Annotations = make(map[string]string)
|
|
}
|
|
if recordBytes, found := el.e.Annotations[LeaderElectionRecordAnnotationKey]; found {
|
|
if err := json.Unmarshal([]byte(recordBytes), &record); err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return &record, nil
|
|
}
|
|
|
|
// Create attempts to create a LeaderElectionRecord annotation
|
|
func (el *EndpointsLock) Create(ler LeaderElectionRecord) error {
|
|
recordBytes, err := json.Marshal(ler)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
el.e, err = el.Client.Endpoints(el.EndpointsMeta.Namespace).Create(&v1.Endpoints{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: el.EndpointsMeta.Name,
|
|
Namespace: el.EndpointsMeta.Namespace,
|
|
Annotations: map[string]string{
|
|
LeaderElectionRecordAnnotationKey: string(recordBytes),
|
|
},
|
|
},
|
|
})
|
|
return err
|
|
}
|
|
|
|
// Update will update and existing annotation on a given resource.
|
|
func (el *EndpointsLock) Update(ler LeaderElectionRecord) error {
|
|
if el.e == nil {
|
|
return errors.New("endpoint not initialized, call get or create first")
|
|
}
|
|
recordBytes, err := json.Marshal(ler)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
el.e.Annotations[LeaderElectionRecordAnnotationKey] = string(recordBytes)
|
|
el.e, err = el.Client.Endpoints(el.EndpointsMeta.Namespace).Update(el.e)
|
|
return err
|
|
}
|
|
|
|
// RecordEvent in leader election while adding meta-data
|
|
func (el *EndpointsLock) RecordEvent(s string) {
|
|
if el.LockConfig.EventRecorder == nil {
|
|
return
|
|
}
|
|
events := fmt.Sprintf("%v %v", el.LockConfig.Identity, s)
|
|
el.LockConfig.EventRecorder.Eventf(&v1.Endpoints{ObjectMeta: el.e.ObjectMeta}, v1.EventTypeNormal, "LeaderElection", events)
|
|
}
|
|
|
|
// Describe is used to convert details on current resource lock
|
|
// into a string
|
|
func (el *EndpointsLock) Describe() string {
|
|
return fmt.Sprintf("%v/%v", el.EndpointsMeta.Namespace, el.EndpointsMeta.Name)
|
|
}
|
|
|
|
// returns the Identity of the lock
|
|
func (el *EndpointsLock) Identity() string {
|
|
return el.LockConfig.Identity
|
|
}
|