temp commit
This commit is contained in:
magicsong
434
vendor/github.com/projectcalico/libcalico-go/lib/clientv3/resources.go
generated
vendored
Normal file
434
vendor/github.com/projectcalico/libcalico-go/lib/clientv3/resources.go
generated
vendored
Normal file
@@ -0,0 +1,434 @@
|
||||
// Copyright (c) 2017 Tigera, Inc. All rights reserved.
|
||||
|
||||
// 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 clientv3
|
||||
|
||||
import (
|
||||
"context"
|
||||
"sync/atomic"
|
||||
|
||||
log "github.com/sirupsen/logrus"
|
||||
"k8s.io/apimachinery/pkg/api/meta"
|
||||
"k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
"k8s.io/apimachinery/pkg/runtime/schema"
|
||||
"k8s.io/apimachinery/pkg/util/uuid"
|
||||
|
||||
apiv3 "github.com/projectcalico/libcalico-go/lib/apis/v3"
|
||||
bapi "github.com/projectcalico/libcalico-go/lib/backend/api"
|
||||
"github.com/projectcalico/libcalico-go/lib/backend/model"
|
||||
cerrors "github.com/projectcalico/libcalico-go/lib/errors"
|
||||
"github.com/projectcalico/libcalico-go/lib/namespace"
|
||||
"github.com/projectcalico/libcalico-go/lib/options"
|
||||
"github.com/projectcalico/libcalico-go/lib/watch"
|
||||
)
|
||||
|
||||
const (
|
||||
noNamespace = ""
|
||||
defaultNamespace = "default"
|
||||
maxApplyRetries = 10
|
||||
)
|
||||
|
||||
// All Calico resources implement the resource interface.
|
||||
type resource interface {
|
||||
runtime.Object
|
||||
v1.ObjectMetaAccessor
|
||||
}
|
||||
|
||||
// All Calico resource lists implement the resourceList interface.
|
||||
type resourceList interface {
|
||||
runtime.Object
|
||||
v1.ListMetaAccessor
|
||||
}
|
||||
|
||||
// resourceInterface has methods to work with generic resource types.
|
||||
type resourceInterface interface {
|
||||
Create(ctx context.Context, opts options.SetOptions, kind string, in resource) (resource, error)
|
||||
Update(ctx context.Context, opts options.SetOptions, kind string, in resource) (resource, error)
|
||||
Delete(ctx context.Context, opts options.DeleteOptions, kind, ns, name string) (resource, error)
|
||||
Get(ctx context.Context, opts options.GetOptions, kind, ns, name string) (resource, error)
|
||||
List(ctx context.Context, opts options.ListOptions, kind, listkind string, inout resourceList) error
|
||||
Watch(ctx context.Context, opts options.ListOptions, kind string, converter watcherConverter) (watch.Interface, error)
|
||||
}
|
||||
|
||||
// resources implements resourceInterface.
|
||||
type resources struct {
|
||||
backend bapi.Client
|
||||
}
|
||||
|
||||
// Create creates a resource in the backend datastore.
|
||||
func (c *resources) Create(ctx context.Context, opts options.SetOptions, kind string, in resource) (resource, error) {
|
||||
// Resource must have a Name. Currently we do not support GenerateName.
|
||||
if len(in.GetObjectMeta().GetName()) == 0 {
|
||||
var generateNameMessage string
|
||||
if len(in.GetObjectMeta().GetGenerateName()) != 0 {
|
||||
generateNameMessage = " (GenerateName is not supported)"
|
||||
}
|
||||
return nil, cerrors.ErrorValidation{
|
||||
ErroredFields: []cerrors.ErroredField{{
|
||||
Name: "Metadata.Name",
|
||||
Reason: "field must be set for a Create request" + generateNameMessage,
|
||||
Value: in.GetObjectMeta().GetName(),
|
||||
}},
|
||||
}
|
||||
}
|
||||
|
||||
// A ResourceVersion should never be specified on a Create.
|
||||
if len(in.GetObjectMeta().GetResourceVersion()) != 0 {
|
||||
logWithResource(in).Info("Rejecting Create request with non-empty resource version")
|
||||
return nil, cerrors.ErrorValidation{
|
||||
ErroredFields: []cerrors.ErroredField{{
|
||||
Name: "Metadata.ResourceVersion",
|
||||
Reason: "field must not be set for a Create request",
|
||||
Value: in.GetObjectMeta().GetResourceVersion(),
|
||||
}},
|
||||
}
|
||||
}
|
||||
if err := c.checkNamespace(in.GetObjectMeta().GetNamespace(), kind); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Add in the UID and creation timestamp for the resource if needed.
|
||||
creationTimestamp := in.GetObjectMeta().GetCreationTimestamp()
|
||||
if creationTimestamp.IsZero() {
|
||||
in.GetObjectMeta().SetCreationTimestamp(v1.Now())
|
||||
}
|
||||
if in.GetObjectMeta().GetUID() == "" {
|
||||
in.GetObjectMeta().SetUID(uuid.NewUUID())
|
||||
}
|
||||
|
||||
// Convert the resource to a KVPair and pass that to the backend datastore, converting
|
||||
// the response (if we get one) back to a resource.
|
||||
kvp, err := c.backend.Create(ctx, c.resourceToKVPair(opts, kind, in))
|
||||
if kvp != nil {
|
||||
return c.kvPairToResource(kvp), err
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Update updates a resource in the backend datastore.
|
||||
func (c *resources) Update(ctx context.Context, opts options.SetOptions, kind string, in resource) (resource, error) {
|
||||
// A ResourceVersion should always be specified on an Update.
|
||||
if len(in.GetObjectMeta().GetResourceVersion()) == 0 {
|
||||
logWithResource(in).Info("Rejecting Update request with empty resource version")
|
||||
return nil, cerrors.ErrorValidation{
|
||||
ErroredFields: []cerrors.ErroredField{{
|
||||
Name: "Metadata.ResourceVersion",
|
||||
Reason: "field must be set for an Update request",
|
||||
Value: in.GetObjectMeta().GetResourceVersion(),
|
||||
}},
|
||||
}
|
||||
}
|
||||
if err := c.checkNamespace(in.GetObjectMeta().GetNamespace(), kind); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
creationTimestamp := in.GetObjectMeta().GetCreationTimestamp()
|
||||
if creationTimestamp.IsZero() {
|
||||
return nil, cerrors.ErrorValidation{
|
||||
ErroredFields: []cerrors.ErroredField{{
|
||||
Name: "Metadata.CreationTimestamp",
|
||||
Reason: "field must be set for an Update request",
|
||||
Value: in.GetObjectMeta().GetCreationTimestamp(),
|
||||
}},
|
||||
}
|
||||
}
|
||||
if in.GetObjectMeta().GetUID() == "" {
|
||||
return nil, cerrors.ErrorValidation{
|
||||
ErroredFields: []cerrors.ErroredField{{
|
||||
Name: "Metadata.UID",
|
||||
Reason: "field must be set for an Update request",
|
||||
Value: in.GetObjectMeta().GetUID(),
|
||||
}},
|
||||
}
|
||||
}
|
||||
|
||||
// Convert the resource to a KVPair and pass that to the backend datastore, converting
|
||||
// the response (if we get one) back to a resource.
|
||||
kvp, err := c.backend.Update(ctx, c.resourceToKVPair(opts, kind, in))
|
||||
if kvp != nil {
|
||||
return c.kvPairToResource(kvp), err
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Delete deletes a resource from the backend datastore.
|
||||
func (c *resources) Delete(ctx context.Context, opts options.DeleteOptions, kind, ns, name string) (resource, error) {
|
||||
if err := c.checkNamespace(ns, kind); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// Create a ResourceKey and pass that to the backend datastore.
|
||||
key := model.ResourceKey{
|
||||
Kind: kind,
|
||||
Name: name,
|
||||
Namespace: ns,
|
||||
}
|
||||
kvp, err := c.backend.Delete(ctx, key, opts.ResourceVersion)
|
||||
if kvp != nil {
|
||||
return c.kvPairToResource(kvp), err
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Get gets a resource from the backend datastore.
|
||||
func (c *resources) Get(ctx context.Context, opts options.GetOptions, kind, ns, name string) (resource, error) {
|
||||
if err := c.checkNamespace(ns, kind); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
key := model.ResourceKey{
|
||||
Kind: kind,
|
||||
Name: name,
|
||||
Namespace: ns,
|
||||
}
|
||||
kvp, err := c.backend.Get(ctx, key, opts.ResourceVersion)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
out := c.kvPairToResource(kvp)
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// List lists a resource from the backend datastore.
|
||||
func (c *resources) List(ctx context.Context, opts options.ListOptions, kind, listKind string, listObj resourceList) error {
|
||||
list := model.ResourceListOptions{
|
||||
Kind: kind,
|
||||
Name: opts.Name,
|
||||
Namespace: opts.Namespace,
|
||||
Prefix: opts.Prefix,
|
||||
}
|
||||
|
||||
// Query the backend.
|
||||
kvps, err := c.backend.List(ctx, list, opts.ResourceVersion)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Convert the slice of KVPairs to a slice of Objects.
|
||||
resources := []runtime.Object{}
|
||||
for _, kvp := range kvps.KVPairs {
|
||||
resources = append(resources, c.kvPairToResource(kvp))
|
||||
}
|
||||
err = meta.SetList(listObj, resources)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Finally, set the resource version and api group version of the list object.
|
||||
listObj.GetListMeta().SetResourceVersion(kvps.Revision)
|
||||
listObj.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{
|
||||
Group: apiv3.Group,
|
||||
Version: apiv3.VersionCurrent,
|
||||
Kind: listKind,
|
||||
})
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Watch watches a specific resource or resource type.
|
||||
func (c *resources) Watch(ctx context.Context, opts options.ListOptions, kind string, converter watcherConverter) (watch.Interface, error) {
|
||||
list := model.ResourceListOptions{
|
||||
Kind: kind,
|
||||
Name: opts.Name,
|
||||
Namespace: opts.Namespace,
|
||||
}
|
||||
|
||||
// Create the backend watcher. We need to process the results to add revision data etc.
|
||||
ctx, cancel := context.WithCancel(ctx)
|
||||
backend, err := c.backend.Watch(ctx, list, opts.ResourceVersion)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
w := &watcher{
|
||||
results: make(chan watch.Event, 100),
|
||||
client: c,
|
||||
cancel: cancel,
|
||||
context: ctx,
|
||||
backend: backend,
|
||||
converter: converter,
|
||||
}
|
||||
go w.run()
|
||||
return w, nil
|
||||
}
|
||||
|
||||
// resourceToKVPair converts the resource to a KVPair that can be consumed by the
|
||||
// backend datastore client.
|
||||
func (c *resources) resourceToKVPair(opts options.SetOptions, kind string, in resource) *model.KVPair {
|
||||
// Prepare the resource to remove non-persisted fields.
|
||||
rv := in.GetObjectMeta().GetResourceVersion()
|
||||
in.GetObjectMeta().SetResourceVersion("")
|
||||
in.GetObjectMeta().SetSelfLink("")
|
||||
|
||||
// Make sure the kind and version are set before storing.
|
||||
in.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{
|
||||
Group: apiv3.Group,
|
||||
Version: apiv3.VersionCurrent,
|
||||
Kind: kind,
|
||||
})
|
||||
|
||||
// Create a KVPair using the "generic" resource Key, and the actual object as
|
||||
// the value.
|
||||
return &model.KVPair{
|
||||
TTL: opts.TTL,
|
||||
Value: in,
|
||||
Key: model.ResourceKey{
|
||||
Kind: kind,
|
||||
Name: in.GetObjectMeta().GetName(),
|
||||
Namespace: in.GetObjectMeta().GetNamespace(),
|
||||
},
|
||||
Revision: rv,
|
||||
}
|
||||
}
|
||||
|
||||
// kvPairToResource converts a KVPair returned by the backend datastore client to a
|
||||
// resource.
|
||||
func (c *resources) kvPairToResource(kvp *model.KVPair) resource {
|
||||
// Extract the resource from the returned value - the backend will already have
|
||||
// decoded it.
|
||||
out := kvp.Value.(resource)
|
||||
|
||||
// Remove the SelfLink which Calico does not use, and set the ResourceVersion from the
|
||||
// value returned from the backend datastore.
|
||||
out.GetObjectMeta().SetSelfLink("")
|
||||
out.GetObjectMeta().SetResourceVersion(kvp.Revision)
|
||||
|
||||
return out
|
||||
}
|
||||
|
||||
// checkNamespace checks that the namespace is supplied on a namespaced resource type.
|
||||
func (c *resources) checkNamespace(ns, kind string) error {
|
||||
|
||||
if namespace.IsNamespaced(kind) && len(ns) == 0 {
|
||||
return cerrors.ErrorValidation{
|
||||
ErroredFields: []cerrors.ErroredField{{
|
||||
Name: "Metadata.Namespace",
|
||||
Reason: "namespace is not specified on namespaced resource",
|
||||
}},
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// watcher implements the watch.Interface.
|
||||
type watcher struct {
|
||||
backend bapi.WatchInterface
|
||||
context context.Context
|
||||
cancel context.CancelFunc
|
||||
results chan watch.Event
|
||||
client *resources
|
||||
terminated uint32
|
||||
converter watcherConverter
|
||||
}
|
||||
|
||||
func (w *watcher) Stop() {
|
||||
w.cancel()
|
||||
}
|
||||
|
||||
func (w *watcher) ResultChan() <-chan watch.Event {
|
||||
return w.results
|
||||
}
|
||||
|
||||
// run is the main watch loop, pulling events from the backend watcher and sending
|
||||
// down the results channel.
|
||||
func (w *watcher) run() {
|
||||
log.Info("Main client watcher loop")
|
||||
|
||||
// Make sure we terminate resources if we exit.
|
||||
defer w.terminate()
|
||||
|
||||
for {
|
||||
select {
|
||||
case event, ok := <-w.backend.ResultChan():
|
||||
if !ok {
|
||||
log.Debug("Watcher results channel closed by remote")
|
||||
return
|
||||
}
|
||||
e := w.convertEvent(event)
|
||||
select {
|
||||
case w.results <- e:
|
||||
case <-w.context.Done():
|
||||
log.Info("Process backend watcher done event during watch event in main client")
|
||||
return
|
||||
}
|
||||
case <-w.context.Done(): // user cancel
|
||||
log.Info("Process backend watcher done event in main client")
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// terminate all resources associated with this watcher.
|
||||
func (w *watcher) terminate() {
|
||||
log.Info("Terminating main client watcher loop")
|
||||
w.cancel()
|
||||
close(w.results)
|
||||
atomic.AddUint32(&w.terminated, 1)
|
||||
}
|
||||
|
||||
// convertEvent converts a backend watch event into a client watch event.
|
||||
func (w *watcher) convertEvent(backendEvent bapi.WatchEvent) watch.Event {
|
||||
apiEvent := watch.Event{
|
||||
Error: backendEvent.Error,
|
||||
}
|
||||
switch backendEvent.Type {
|
||||
case bapi.WatchError:
|
||||
apiEvent.Type = watch.Error
|
||||
case bapi.WatchAdded:
|
||||
apiEvent.Type = watch.Added
|
||||
case bapi.WatchDeleted:
|
||||
apiEvent.Type = watch.Deleted
|
||||
case bapi.WatchModified:
|
||||
apiEvent.Type = watch.Modified
|
||||
}
|
||||
|
||||
if backendEvent.Old != nil {
|
||||
res := w.client.kvPairToResource(backendEvent.Old)
|
||||
if w.converter != nil {
|
||||
res = w.converter.Convert(res)
|
||||
}
|
||||
apiEvent.Previous = res
|
||||
}
|
||||
if backendEvent.New != nil {
|
||||
res := w.client.kvPairToResource(backendEvent.New)
|
||||
if w.converter != nil {
|
||||
apiEvent.Object = w.converter.Convert(res)
|
||||
}
|
||||
apiEvent.Object = res
|
||||
}
|
||||
|
||||
return apiEvent
|
||||
}
|
||||
|
||||
// hasTerminated returns true if the watcher has terminated, release all resources.
|
||||
// Used for test purposes.
|
||||
func (w *watcher) hasTerminated() bool {
|
||||
t := atomic.LoadUint32(&w.terminated) != 0
|
||||
bt := w.backend.HasTerminated()
|
||||
log.Infof("hasTerminated() terminated=%v; backend-terminated=%v", t, bt)
|
||||
return t && bt
|
||||
}
|
||||
|
||||
// logWithResource returns a logrus entry with key resource attributes included.
|
||||
func logWithResource(res resource) *log.Entry {
|
||||
return log.WithFields(log.Fields{
|
||||
"Kind": res.GetObjectKind().GroupVersionKind(),
|
||||
"Name": res.GetObjectMeta().GetName(),
|
||||
"Namespace": res.GetObjectMeta().GetNamespace(),
|
||||
"ResourceVersion": res.GetObjectMeta().GetResourceVersion(),
|
||||
})
|
||||
}
|
||||
|
||||
// watcherConverter represents a formatter for calico resources returned by Watch.
|
||||
type watcherConverter interface {
|
||||
// Convert the internal representation of a resource to a readable format.
|
||||
Convert(resource) resource
|
||||
}
|
||||
Reference in New Issue
Block a user