| /* |
| Copyright 2014 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 etcd |
| |
| import ( |
| "context" |
| "errors" |
| "fmt" |
| "path" |
| "reflect" |
| "time" |
| |
| etcd "github.com/coreos/etcd/client" |
| "github.com/golang/glog" |
| |
| "k8s.io/apimachinery/pkg/api/meta" |
| "k8s.io/apimachinery/pkg/conversion" |
| "k8s.io/apimachinery/pkg/runtime" |
| utilcache "k8s.io/apimachinery/pkg/util/cache" |
| utilruntime "k8s.io/apimachinery/pkg/util/runtime" |
| "k8s.io/apimachinery/pkg/watch" |
| "k8s.io/apiserver/pkg/storage" |
| "k8s.io/apiserver/pkg/storage/etcd/metrics" |
| etcdutil "k8s.io/apiserver/pkg/storage/etcd/util" |
| utiltrace "k8s.io/apiserver/pkg/util/trace" |
| ) |
| |
| // ValueTransformer allows a string value to be transformed before being read from or written to the underlying store. The methods |
| // must be able to undo the transformation caused by the other. |
| type ValueTransformer interface { |
| // TransformStringFromStorage may transform the provided string from its underlying storage representation or return an error. |
| // Stale is true if the object on disk is stale and a write to etcd should be issued, even if the contents of the object |
| // have not changed. |
| TransformStringFromStorage(string) (value string, stale bool, err error) |
| // TransformStringToStorage may transform the provided string into the appropriate form in storage or return an error. |
| TransformStringToStorage(string) (value string, err error) |
| } |
| |
| type identityTransformer struct{} |
| |
| func (identityTransformer) TransformStringFromStorage(s string) (string, bool, error) { |
| return s, false, nil |
| } |
| func (identityTransformer) TransformStringToStorage(s string) (string, error) { return s, nil } |
| |
| // IdentityTransformer performs no transformation on the provided values. |
| var IdentityTransformer ValueTransformer = identityTransformer{} |
| |
| // Creates a new storage interface from the client |
| // TODO: deprecate in favor of storage.Config abstraction over time |
| func NewEtcdStorage(client etcd.Client, codec runtime.Codec, prefix string, quorum bool, cacheSize int, transformer ValueTransformer) storage.Interface { |
| return &etcdHelper{ |
| etcdMembersAPI: etcd.NewMembersAPI(client), |
| etcdKeysAPI: etcd.NewKeysAPI(client), |
| codec: codec, |
| versioner: APIObjectVersioner{}, |
| transformer: transformer, |
| pathPrefix: path.Join("/", prefix), |
| quorum: quorum, |
| cache: utilcache.NewCache(cacheSize), |
| } |
| } |
| |
| // etcdHelper is the reference implementation of storage.Interface. |
| type etcdHelper struct { |
| etcdMembersAPI etcd.MembersAPI |
| etcdKeysAPI etcd.KeysAPI |
| codec runtime.Codec |
| transformer ValueTransformer |
| // Note that versioner is required for etcdHelper to work correctly. |
| // The public constructors (NewStorage & NewEtcdStorage) are setting it |
| // correctly, so be careful when manipulating with it manually. |
| // optional, has to be set to perform any atomic operations |
| versioner storage.Versioner |
| // prefix for all etcd keys |
| pathPrefix string |
| // if true, perform quorum read |
| quorum bool |
| |
| // We cache objects stored in etcd. For keys we use Node.ModifiedIndex which is equivalent |
| // to resourceVersion. |
| // This depends on etcd's indexes being globally unique across all objects/types. This will |
| // have to revisited if we decide to do things like multiple etcd clusters, or etcd will |
| // support multi-object transaction that will result in many objects with the same index. |
| // Number of entries stored in the cache is controlled by maxEtcdCacheEntries constant. |
| // TODO: Measure how much this cache helps after the conversion code is optimized. |
| cache utilcache.Cache |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) Versioner() storage.Versioner { |
| return h.versioner |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) Create(ctx context.Context, key string, obj, out runtime.Object, ttl uint64) error { |
| trace := utiltrace.New("etcdHelper::Create " + getTypeName(obj)) |
| defer trace.LogIfLong(250 * time.Millisecond) |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| key = path.Join(h.pathPrefix, key) |
| data, err := runtime.Encode(h.codec, obj) |
| trace.Step("Object encoded") |
| if err != nil { |
| return err |
| } |
| if version, err := h.versioner.ObjectResourceVersion(obj); err == nil && version != 0 { |
| return errors.New("resourceVersion may not be set on objects to be created") |
| } |
| if err := h.versioner.PrepareObjectForStorage(obj); err != nil { |
| return fmt.Errorf("PrepareObjectForStorage returned an error: %v", err) |
| } |
| trace.Step("Version checked") |
| |
| startTime := time.Now() |
| opts := etcd.SetOptions{ |
| TTL: time.Duration(ttl) * time.Second, |
| PrevExist: etcd.PrevNoExist, |
| } |
| |
| newBody, err := h.transformer.TransformStringToStorage(string(data)) |
| if err != nil { |
| return storage.NewInternalError(err.Error()) |
| } |
| |
| response, err := h.etcdKeysAPI.Set(ctx, key, newBody, &opts) |
| trace.Step("Object created") |
| metrics.RecordEtcdRequestLatency("create", getTypeName(obj), startTime) |
| if err != nil { |
| return toStorageErr(err, key, 0) |
| } |
| if out != nil { |
| if _, err := conversion.EnforcePtr(out); err != nil { |
| panic("unable to convert output object to pointer") |
| } |
| _, _, _, err = h.extractObj(response, err, out, false, false) |
| } |
| return err |
| } |
| |
| func checkPreconditions(key string, preconditions *storage.Preconditions, out runtime.Object) error { |
| if preconditions == nil { |
| return nil |
| } |
| objMeta, err := meta.Accessor(out) |
| if err != nil { |
| return storage.NewInternalErrorf("can't enforce preconditions %v on un-introspectable object %v, got error: %v", *preconditions, out, err) |
| } |
| if preconditions.UID != nil && *preconditions.UID != objMeta.GetUID() { |
| errMsg := fmt.Sprintf("Precondition failed: UID in precondition: %v, UID in object meta: %v", preconditions.UID, objMeta.GetUID()) |
| return storage.NewInvalidObjError(key, errMsg) |
| } |
| return nil |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) Delete(ctx context.Context, key string, out runtime.Object, preconditions *storage.Preconditions) error { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| key = path.Join(h.pathPrefix, key) |
| v, err := conversion.EnforcePtr(out) |
| if err != nil { |
| panic("unable to convert output object to pointer") |
| } |
| |
| if preconditions == nil { |
| startTime := time.Now() |
| response, err := h.etcdKeysAPI.Delete(ctx, key, nil) |
| metrics.RecordEtcdRequestLatency("delete", getTypeName(out), startTime) |
| if !etcdutil.IsEtcdNotFound(err) { |
| // if the object that existed prior to the delete is returned by etcd, update the out object. |
| if err != nil || response.PrevNode != nil { |
| _, _, _, err = h.extractObj(response, err, out, false, true) |
| } |
| } |
| return toStorageErr(err, key, 0) |
| } |
| |
| // Check the preconditions match. |
| obj := reflect.New(v.Type()).Interface().(runtime.Object) |
| for { |
| _, node, res, _, err := h.bodyAndExtractObj(ctx, key, obj, false) |
| if err != nil { |
| return toStorageErr(err, key, 0) |
| } |
| if err := checkPreconditions(key, preconditions, obj); err != nil { |
| return toStorageErr(err, key, 0) |
| } |
| index := uint64(0) |
| if node != nil { |
| index = node.ModifiedIndex |
| } else if res != nil { |
| index = res.Index |
| } |
| opt := etcd.DeleteOptions{PrevIndex: index} |
| startTime := time.Now() |
| response, err := h.etcdKeysAPI.Delete(ctx, key, &opt) |
| metrics.RecordEtcdRequestLatency("delete", getTypeName(out), startTime) |
| if !etcdutil.IsEtcdTestFailed(err) { |
| if !etcdutil.IsEtcdNotFound(err) { |
| // if the object that existed prior to the delete is returned by etcd, update the out object. |
| if err != nil || response.PrevNode != nil { |
| _, _, _, err = h.extractObj(response, err, out, false, true) |
| } |
| } |
| return toStorageErr(err, key, 0) |
| } |
| |
| glog.V(4).Infof("deletion of %s failed because of a conflict, going to retry", key) |
| } |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) Watch(ctx context.Context, key string, resourceVersion string, pred storage.SelectionPredicate) (watch.Interface, error) { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| watchRV, err := h.versioner.ParseWatchResourceVersion(resourceVersion) |
| if err != nil { |
| return nil, err |
| } |
| key = path.Join(h.pathPrefix, key) |
| w := newEtcdWatcher(false, h.quorum, nil, pred, h.codec, h.versioner, nil, h.transformer, h) |
| go w.etcdWatch(ctx, h.etcdKeysAPI, key, watchRV) |
| return w, nil |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) WatchList(ctx context.Context, key string, resourceVersion string, pred storage.SelectionPredicate) (watch.Interface, error) { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| watchRV, err := h.versioner.ParseWatchResourceVersion(resourceVersion) |
| if err != nil { |
| return nil, err |
| } |
| key = path.Join(h.pathPrefix, key) |
| w := newEtcdWatcher(true, h.quorum, exceptKey(key), pred, h.codec, h.versioner, nil, h.transformer, h) |
| go w.etcdWatch(ctx, h.etcdKeysAPI, key, watchRV) |
| return w, nil |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) Get(ctx context.Context, key string, resourceVersion string, objPtr runtime.Object, ignoreNotFound bool) error { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| key = path.Join(h.pathPrefix, key) |
| _, _, _, _, err := h.bodyAndExtractObj(ctx, key, objPtr, ignoreNotFound) |
| return err |
| } |
| |
| // bodyAndExtractObj performs the normal Get path to etcd, returning the parsed node and response for additional information |
| // about the response, like the current etcd index and the ttl. |
| func (h *etcdHelper) bodyAndExtractObj(ctx context.Context, key string, objPtr runtime.Object, ignoreNotFound bool) (body string, node *etcd.Node, res *etcd.Response, stale bool, err error) { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| startTime := time.Now() |
| |
| opts := &etcd.GetOptions{ |
| Quorum: h.quorum, |
| } |
| |
| response, err := h.etcdKeysAPI.Get(ctx, key, opts) |
| metrics.RecordEtcdRequestLatency("get", getTypeName(objPtr), startTime) |
| if err != nil && !etcdutil.IsEtcdNotFound(err) { |
| return "", nil, nil, false, toStorageErr(err, key, 0) |
| } |
| body, node, stale, err = h.extractObj(response, err, objPtr, ignoreNotFound, false) |
| return body, node, response, stale, toStorageErr(err, key, 0) |
| } |
| |
| func (h *etcdHelper) extractObj(response *etcd.Response, inErr error, objPtr runtime.Object, ignoreNotFound, prevNode bool) (body string, node *etcd.Node, stale bool, err error) { |
| if response != nil { |
| if prevNode { |
| node = response.PrevNode |
| } else { |
| node = response.Node |
| } |
| } |
| if inErr != nil || node == nil || len(node.Value) == 0 { |
| if ignoreNotFound { |
| v, err := conversion.EnforcePtr(objPtr) |
| if err != nil { |
| return "", nil, false, err |
| } |
| v.Set(reflect.Zero(v.Type())) |
| return "", nil, false, nil |
| } else if inErr != nil { |
| return "", nil, false, inErr |
| } |
| return "", nil, false, fmt.Errorf("unable to locate a value on the response: %#v", response) |
| } |
| |
| body, stale, err = h.transformer.TransformStringFromStorage(node.Value) |
| if err != nil { |
| return body, nil, stale, storage.NewInternalError(err.Error()) |
| } |
| out, gvk, err := h.codec.Decode([]byte(body), nil, objPtr) |
| if err != nil { |
| return body, nil, stale, err |
| } |
| if out != objPtr { |
| return body, nil, stale, fmt.Errorf("unable to decode object %s into %v", gvk.String(), reflect.TypeOf(objPtr)) |
| } |
| // being unable to set the version does not prevent the object from being extracted |
| _ = h.versioner.UpdateObject(objPtr, node.ModifiedIndex) |
| return body, node, stale, err |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) GetToList(ctx context.Context, key string, resourceVersion string, pred storage.SelectionPredicate, listObj runtime.Object) error { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| trace := utiltrace.New("GetToList " + getTypeName(listObj)) |
| listPtr, err := meta.GetItemsPtr(listObj) |
| if err != nil { |
| return err |
| } |
| key = path.Join(h.pathPrefix, key) |
| startTime := time.Now() |
| trace.Step("About to read etcd node") |
| |
| opts := &etcd.GetOptions{ |
| Quorum: h.quorum, |
| } |
| response, err := h.etcdKeysAPI.Get(ctx, key, opts) |
| trace.Step("Etcd node read") |
| metrics.RecordEtcdRequestLatency("get", getTypeName(listPtr), startTime) |
| if err != nil { |
| if etcdutil.IsEtcdNotFound(err) { |
| if etcdErr, ok := err.(etcd.Error); ok { |
| return h.versioner.UpdateList(listObj, etcdErr.Index, "") |
| } |
| return fmt.Errorf("unexpected error from storage: %#v", err) |
| } |
| return toStorageErr(err, key, 0) |
| } |
| |
| nodes := make([]*etcd.Node, 0) |
| nodes = append(nodes, response.Node) |
| |
| if err := h.decodeNodeList(nodes, pred, listPtr); err != nil { |
| return err |
| } |
| trace.Step("Object decoded") |
| if err := h.versioner.UpdateList(listObj, response.Index, ""); err != nil { |
| return err |
| } |
| return nil |
| } |
| |
| // decodeNodeList walks the tree of each node in the list and decodes into the specified object |
| func (h *etcdHelper) decodeNodeList(nodes []*etcd.Node, pred storage.SelectionPredicate, slicePtr interface{}) error { |
| trace := utiltrace.New("decodeNodeList " + getTypeName(slicePtr)) |
| defer trace.LogIfLong(400 * time.Millisecond) |
| v, err := conversion.EnforcePtr(slicePtr) |
| if err != nil || v.Kind() != reflect.Slice { |
| // This should not happen at runtime. |
| panic("need ptr to slice") |
| } |
| for _, node := range nodes { |
| if node.Dir { |
| // IMPORTANT: do not log each key as a discrete step in the trace log |
| // as it produces an immense amount of log spam when there is a large |
| // amount of content in the list. |
| if err := h.decodeNodeList(node.Nodes, pred, slicePtr); err != nil { |
| return err |
| } |
| continue |
| } |
| if obj, found := h.getFromCache(node.ModifiedIndex, pred); found { |
| // obj != nil iff it matches the pred function. |
| if obj != nil { |
| v.Set(reflect.Append(v, reflect.ValueOf(obj).Elem())) |
| } |
| } else { |
| body, _, err := h.transformer.TransformStringFromStorage(node.Value) |
| if err != nil { |
| // omit items from lists and watches that cannot be transformed, but log the error |
| utilruntime.HandleError(fmt.Errorf("unable to transform key %q: %v", node.Key, err)) |
| continue |
| } |
| |
| obj, _, err := h.codec.Decode([]byte(body), nil, reflect.New(v.Type().Elem()).Interface().(runtime.Object)) |
| if err != nil { |
| return err |
| } |
| // being unable to set the version does not prevent the object from being extracted |
| _ = h.versioner.UpdateObject(obj, node.ModifiedIndex) |
| if matched, err := pred.Matches(obj); err == nil && matched { |
| v.Set(reflect.Append(v, reflect.ValueOf(obj).Elem())) |
| } |
| if node.ModifiedIndex != 0 { |
| h.addToCache(node.ModifiedIndex, obj) |
| } |
| } |
| } |
| trace.Step(fmt.Sprintf("Decoded %v nodes", len(nodes))) |
| return nil |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) List(ctx context.Context, key string, resourceVersion string, pred storage.SelectionPredicate, listObj runtime.Object) error { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| trace := utiltrace.New("List " + getTypeName(listObj)) |
| defer trace.LogIfLong(400 * time.Millisecond) |
| listPtr, err := meta.GetItemsPtr(listObj) |
| if err != nil { |
| return err |
| } |
| key = path.Join(h.pathPrefix, key) |
| startTime := time.Now() |
| trace.Step("About to list etcd node") |
| nodes, index, err := h.listEtcdNode(ctx, key) |
| trace.Step("Etcd node listed") |
| metrics.RecordEtcdRequestLatency("list", getTypeName(listPtr), startTime) |
| if err != nil { |
| return err |
| } |
| if err := h.decodeNodeList(nodes, pred, listPtr); err != nil { |
| return err |
| } |
| trace.Step("Node list decoded") |
| if err := h.versioner.UpdateList(listObj, index, ""); err != nil { |
| return err |
| } |
| return nil |
| } |
| |
| func (h *etcdHelper) listEtcdNode(ctx context.Context, key string) ([]*etcd.Node, uint64, error) { |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| opts := etcd.GetOptions{ |
| Recursive: true, |
| Sort: true, |
| Quorum: h.quorum, |
| } |
| result, err := h.etcdKeysAPI.Get(ctx, key, &opts) |
| if err != nil { |
| var index uint64 |
| if etcdError, ok := err.(etcd.Error); ok { |
| index = etcdError.Index |
| } |
| nodes := make([]*etcd.Node, 0) |
| if etcdutil.IsEtcdNotFound(err) { |
| return nodes, index, nil |
| } else { |
| return nodes, index, toStorageErr(err, key, 0) |
| } |
| } |
| return result.Node.Nodes, result.Index, nil |
| } |
| |
| // Implements storage.Interface. |
| func (h *etcdHelper) GuaranteedUpdate( |
| ctx context.Context, key string, ptrToType runtime.Object, ignoreNotFound bool, |
| preconditions *storage.Preconditions, tryUpdate storage.UpdateFunc, _ ...runtime.Object) error { |
| // Ignore the suggestion about current object. |
| if ctx == nil { |
| glog.Errorf("Context is nil") |
| } |
| v, err := conversion.EnforcePtr(ptrToType) |
| if err != nil { |
| // Panic is appropriate, because this is a programming error. |
| panic("need ptr to type") |
| } |
| key = path.Join(h.pathPrefix, key) |
| for { |
| obj := reflect.New(v.Type()).Interface().(runtime.Object) |
| origBody, node, res, stale, err := h.bodyAndExtractObj(ctx, key, obj, ignoreNotFound) |
| if err != nil { |
| return toStorageErr(err, key, 0) |
| } |
| if err := checkPreconditions(key, preconditions, obj); err != nil { |
| return toStorageErr(err, key, 0) |
| } |
| meta := storage.ResponseMeta{} |
| if node != nil { |
| meta.TTL = node.TTL |
| meta.ResourceVersion = node.ModifiedIndex |
| } |
| // Get the object to be written by calling tryUpdate. |
| ret, newTTL, err := tryUpdate(obj, meta) |
| if err != nil { |
| return toStorageErr(err, key, 0) |
| } |
| |
| index := uint64(0) |
| ttl := uint64(0) |
| if node != nil { |
| index = node.ModifiedIndex |
| if node.TTL != 0 { |
| ttl = uint64(node.TTL) |
| } |
| if node.Expiration != nil && ttl == 0 { |
| ttl = 1 |
| } |
| } else if res != nil { |
| index = res.Index |
| } |
| |
| if newTTL != nil { |
| if ttl != 0 && *newTTL == 0 { |
| // TODO: remove this after we have verified this is no longer an issue |
| glog.V(4).Infof("GuaranteedUpdate is clearing TTL for %q, may not be intentional", key) |
| } |
| ttl = *newTTL |
| } |
| |
| // Since update object may have a resourceVersion set, we need to clear it here. |
| if err := h.versioner.PrepareObjectForStorage(ret); err != nil { |
| return errors.New("resourceVersion cannot be set on objects store in etcd") |
| } |
| |
| newBodyData, err := runtime.Encode(h.codec, ret) |
| if err != nil { |
| return err |
| } |
| newBody := string(newBodyData) |
| data, err := h.transformer.TransformStringToStorage(newBody) |
| if err != nil { |
| return storage.NewInternalError(err.Error()) |
| } |
| |
| // First time this key has been used, try creating new value. |
| if index == 0 { |
| startTime := time.Now() |
| opts := etcd.SetOptions{ |
| TTL: time.Duration(ttl) * time.Second, |
| PrevExist: etcd.PrevNoExist, |
| } |
| response, err := h.etcdKeysAPI.Set(ctx, key, data, &opts) |
| metrics.RecordEtcdRequestLatency("create", getTypeName(ptrToType), startTime) |
| if etcdutil.IsEtcdNodeExist(err) { |
| continue |
| } |
| _, _, _, err = h.extractObj(response, err, ptrToType, false, false) |
| return toStorageErr(err, key, 0) |
| } |
| |
| // If we don't send an update, we simply return the currently existing |
| // version of the object. However, the value transformer may indicate that |
| // the on disk representation has changed and that we must commit an update. |
| if newBody == origBody && !stale { |
| _, _, _, err := h.extractObj(res, nil, ptrToType, ignoreNotFound, false) |
| return err |
| } |
| |
| startTime := time.Now() |
| // Swap origBody with data, if origBody is the latest etcd data. |
| opts := etcd.SetOptions{ |
| PrevIndex: index, |
| TTL: time.Duration(ttl) * time.Second, |
| } |
| response, err := h.etcdKeysAPI.Set(ctx, key, data, &opts) |
| metrics.RecordEtcdRequestLatency("compareAndSwap", getTypeName(ptrToType), startTime) |
| if etcdutil.IsEtcdTestFailed(err) { |
| // Try again. |
| continue |
| } |
| _, _, _, err = h.extractObj(response, err, ptrToType, false, false) |
| return toStorageErr(err, key, int64(index)) |
| } |
| } |
| |
| func (*etcdHelper) Count(pathPerfix string) (int64, error) { |
| return 0, fmt.Errorf("Count is unimplemented for etcd2!") |
| } |
| |
| // etcdCache defines interface used for caching objects stored in etcd. Objects are keyed by |
| // their Node.ModifiedIndex, which is unique across all types. |
| // All implementations must be thread-safe. |
| type etcdCache interface { |
| getFromCache(index uint64, pred storage.SelectionPredicate) (runtime.Object, bool) |
| addToCache(index uint64, obj runtime.Object) |
| } |
| |
| func getTypeName(obj interface{}) string { |
| return reflect.TypeOf(obj).String() |
| } |
| |
| func (h *etcdHelper) getFromCache(index uint64, pred storage.SelectionPredicate) (runtime.Object, bool) { |
| startTime := time.Now() |
| defer func() { |
| metrics.ObserveGetCache(startTime) |
| }() |
| obj, found := h.cache.Get(index) |
| if found { |
| if matched, err := pred.Matches(obj.(runtime.Object)); err != nil || !matched { |
| return nil, true |
| } |
| // We should not return the object itself to avoid polluting the cache if someone |
| // modifies returned values. |
| objCopy := obj.(runtime.Object).DeepCopyObject() |
| metrics.ObserveCacheHit() |
| return objCopy.(runtime.Object), true |
| } |
| metrics.ObserveCacheMiss() |
| return nil, false |
| } |
| |
| func (h *etcdHelper) addToCache(index uint64, obj runtime.Object) { |
| startTime := time.Now() |
| defer func() { |
| metrics.ObserveAddCache(startTime) |
| }() |
| objCopy := obj.DeepCopyObject() |
| isOverwrite := h.cache.Add(index, objCopy) |
| if !isOverwrite { |
| metrics.ObserveNewEntry() |
| } |
| } |
| |
| func toStorageErr(err error, key string, rv int64) error { |
| if err == nil { |
| return nil |
| } |
| switch { |
| case etcdutil.IsEtcdNotFound(err): |
| return storage.NewKeyNotFoundError(key, rv) |
| case etcdutil.IsEtcdNodeExist(err): |
| return storage.NewKeyExistsError(key, rv) |
| case etcdutil.IsEtcdTestFailed(err): |
| return storage.NewResourceVersionConflictsError(key, rv) |
| case etcdutil.IsEtcdUnreachable(err): |
| return storage.NewUnreachableError(key, rv) |
| default: |
| return err |
| } |
| } |