bddef32193
In order to support graceful deletion, the resource object will need access to the TTL value in etcd. Also, in the future we may want to get the creation index (distinct from modifiedindex) and expose it to clients. Change EtcdResourceVersioner to be more type specific (objects vs lists) and provide a default implementation that relies on the internal API convention. Also, rename etcd_tools.go to etcd_helper.go and split a few things up.
78 lines
3.4 KiB
Go
78 lines
3.4 KiB
Go
/*
|
|
Copyright 2014 Google 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 tools
|
|
|
|
import (
|
|
"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
|
|
"github.com/coreos/go-etcd/etcd"
|
|
)
|
|
|
|
const (
|
|
EtcdErrorCodeNotFound = 100
|
|
EtcdErrorCodeTestFailed = 101
|
|
EtcdErrorCodeNodeExist = 105
|
|
EtcdErrorCodeValueRequired = 200
|
|
)
|
|
|
|
var (
|
|
EtcdErrorNotFound = &etcd.EtcdError{ErrorCode: EtcdErrorCodeNotFound}
|
|
EtcdErrorTestFailed = &etcd.EtcdError{ErrorCode: EtcdErrorCodeTestFailed}
|
|
EtcdErrorNodeExist = &etcd.EtcdError{ErrorCode: EtcdErrorCodeNodeExist}
|
|
EtcdErrorValueRequired = &etcd.EtcdError{ErrorCode: EtcdErrorCodeValueRequired}
|
|
)
|
|
|
|
// EtcdClient is an injectable interface for testing.
|
|
type EtcdClient interface {
|
|
GetCluster() []string
|
|
AddChild(key, data string, ttl uint64) (*etcd.Response, error)
|
|
Get(key string, sort, recursive bool) (*etcd.Response, error)
|
|
Set(key, value string, ttl uint64) (*etcd.Response, error)
|
|
Create(key, value string, ttl uint64) (*etcd.Response, error)
|
|
CompareAndSwap(key, value string, ttl uint64, prevValue string, prevIndex uint64) (*etcd.Response, error)
|
|
Delete(key string, recursive bool) (*etcd.Response, error)
|
|
// I'd like to use directional channels here (e.g. <-chan) but this interface mimics
|
|
// the etcd client interface which doesn't, and it doesn't seem worth it to wrap the api.
|
|
Watch(prefix string, waitIndex uint64, recursive bool, receiver chan *etcd.Response, stop chan bool) (*etcd.Response, error)
|
|
}
|
|
|
|
// EtcdGetSet interface exposes only the etcd operations needed by EtcdHelper.
|
|
type EtcdGetSet interface {
|
|
GetCluster() []string
|
|
Get(key string, sort, recursive bool) (*etcd.Response, error)
|
|
Set(key, value string, ttl uint64) (*etcd.Response, error)
|
|
Create(key, value string, ttl uint64) (*etcd.Response, error)
|
|
Delete(key string, recursive bool) (*etcd.Response, error)
|
|
CompareAndSwap(key, value string, ttl uint64, prevValue string, prevIndex uint64) (*etcd.Response, error)
|
|
Watch(prefix string, waitIndex uint64, recursive bool, receiver chan *etcd.Response, stop chan bool) (*etcd.Response, error)
|
|
}
|
|
|
|
// EtcdVersioner abstracts setting and retrieving fields from the etcd response onto the object
|
|
// or list.
|
|
type EtcdVersioner interface {
|
|
// UpdateObject sets etcd storage metadata into an API object. Returns an error if the object
|
|
// cannot be updated correctly. May return nil if the requested object does not need metadata
|
|
// from etcd.
|
|
UpdateObject(obj runtime.Object, node *etcd.Node) error
|
|
// UpdateList sets the resource version into an API list object. Returns an error if the object
|
|
// cannot be updated correctly. May return nil if the requested object does not need metadata
|
|
// from etcd.
|
|
UpdateList(obj runtime.Object, resourceVersion uint64) error
|
|
// ObjectResourceVersion returns the resource version (for persistence) of the specified object.
|
|
// Should return an error if the specified object does not have a persistable version.
|
|
ObjectResourceVersion(obj runtime.Object) (uint64, error)
|
|
}
|