Now that we have most of the services required for use with containerd, it was found that common patterns were used throughout services. By defining a central `errdefs` package, we ensure that services will map errors to and from grpc consistently and cleanly. One can decorate an error with as much context as necessary, using `pkg/errors` and still have the error mapped correctly via grpc. We make a few sacrifices. At this point, the common errors we use across the repository all map directly to grpc error codes. While this seems positively crazy, it actually works out quite well. The error conditions that were specific weren't super necessary and the ones that were necessary now simply have better context information. We lose the ability to add new codes, but this constraint may not be a bad thing. Effectively, as long as one uses the errors defined in `errdefs`, the error class will be mapped correctly across the grpc boundary and everything will be good. If you don't use those definitions, the error maps to "unknown" and the error message is preserved. Signed-off-by: Stephen J Day <stephen.day@docker.com>
275 lines
6.7 KiB
Go
275 lines
6.7 KiB
Go
package metadata
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/boltdb/bolt"
|
|
"github.com/containerd/containerd/containers"
|
|
"github.com/containerd/containerd/errdefs"
|
|
"github.com/containerd/containerd/identifiers"
|
|
"github.com/containerd/containerd/namespaces"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
type containerStore struct {
|
|
tx *bolt.Tx
|
|
}
|
|
|
|
func NewContainerStore(tx *bolt.Tx) containers.Store {
|
|
return &containerStore{
|
|
tx: tx,
|
|
}
|
|
}
|
|
|
|
func (s *containerStore) Get(ctx context.Context, id string) (containers.Container, error) {
|
|
namespace, err := namespaces.NamespaceRequired(ctx)
|
|
if err != nil {
|
|
return containers.Container{}, err
|
|
}
|
|
|
|
bkt := getContainerBucket(s.tx, namespace, id)
|
|
if bkt == nil {
|
|
return containers.Container{}, errors.Wrapf(errdefs.ErrNotFound, "bucket name %q")
|
|
}
|
|
|
|
container := containers.Container{ID: id}
|
|
if err := readContainer(&container, bkt); err != nil {
|
|
return containers.Container{}, errors.Wrapf(err, "failed to read container %v", id)
|
|
}
|
|
|
|
return container, nil
|
|
}
|
|
|
|
func (s *containerStore) List(ctx context.Context, filter string) ([]containers.Container, error) {
|
|
namespace, err := namespaces.NamespaceRequired(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var (
|
|
m []containers.Container
|
|
bkt = getContainersBucket(s.tx, namespace)
|
|
)
|
|
if bkt == nil {
|
|
return m, nil
|
|
}
|
|
if err := bkt.ForEach(func(k, v []byte) error {
|
|
cbkt := bkt.Bucket(k)
|
|
if cbkt == nil {
|
|
return nil
|
|
}
|
|
container := containers.Container{ID: string(k)}
|
|
|
|
if err := readContainer(&container, cbkt); err != nil {
|
|
return errors.Wrap(err, "failed to read container")
|
|
}
|
|
m = append(m, container)
|
|
return nil
|
|
}); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return m, nil
|
|
}
|
|
|
|
func (s *containerStore) Create(ctx context.Context, container containers.Container) (containers.Container, error) {
|
|
namespace, err := namespaces.NamespaceRequired(ctx)
|
|
if err != nil {
|
|
return containers.Container{}, err
|
|
}
|
|
|
|
if err := identifiers.Validate(container.ID); err != nil {
|
|
return containers.Container{}, err
|
|
}
|
|
|
|
bkt, err := createContainersBucket(s.tx, namespace)
|
|
if err != nil {
|
|
return containers.Container{}, err
|
|
}
|
|
|
|
cbkt, err := bkt.CreateBucket([]byte(container.ID))
|
|
if err != nil {
|
|
if err == bolt.ErrBucketExists {
|
|
err = errors.Wrapf(errdefs.ErrAlreadyExists, "content %q")
|
|
}
|
|
return containers.Container{}, err
|
|
}
|
|
|
|
container.CreatedAt = time.Now()
|
|
container.UpdatedAt = container.CreatedAt
|
|
if err := writeContainer(&container, cbkt); err != nil {
|
|
return containers.Container{}, errors.Wrap(err, "failed to write container")
|
|
}
|
|
|
|
return container, nil
|
|
}
|
|
|
|
func (s *containerStore) Update(ctx context.Context, container containers.Container) (containers.Container, error) {
|
|
namespace, err := namespaces.NamespaceRequired(ctx)
|
|
if err != nil {
|
|
return containers.Container{}, err
|
|
}
|
|
|
|
if container.ID == "" {
|
|
return containers.Container{}, errors.Wrapf(errdefs.ErrInvalidArgument, "must specify a container id")
|
|
}
|
|
|
|
bkt := getContainersBucket(s.tx, namespace)
|
|
if bkt == nil {
|
|
return containers.Container{}, errors.Wrapf(errdefs.ErrNotFound, "container %q", container.ID)
|
|
}
|
|
|
|
cbkt := bkt.Bucket([]byte(container.ID))
|
|
if cbkt == nil {
|
|
return containers.Container{}, errors.Wrapf(errdefs.ErrNotFound, "container %q", container.ID)
|
|
}
|
|
|
|
container.UpdatedAt = time.Now()
|
|
if err := writeContainer(&container, cbkt); err != nil {
|
|
return containers.Container{}, errors.Wrap(err, "failed to write container")
|
|
}
|
|
|
|
return container, nil
|
|
}
|
|
|
|
func (s *containerStore) Delete(ctx context.Context, id string) error {
|
|
namespace, err := namespaces.NamespaceRequired(ctx)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
bkt := getContainersBucket(s.tx, namespace)
|
|
if bkt == nil {
|
|
return errors.Wrapf(errdefs.ErrNotFound, "cannot delete container %v, bucket not present", id)
|
|
}
|
|
|
|
if err := bkt.DeleteBucket([]byte(id)); err == bolt.ErrBucketNotFound {
|
|
return errors.Wrapf(errdefs.ErrNotFound, "container %v", id)
|
|
}
|
|
return err
|
|
}
|
|
|
|
func readContainer(container *containers.Container, bkt *bolt.Bucket) error {
|
|
return bkt.ForEach(func(k, v []byte) error {
|
|
switch string(k) {
|
|
case string(bucketKeyImage):
|
|
container.Image = string(v)
|
|
case string(bucketKeyRuntime):
|
|
rbkt := bkt.Bucket(bucketKeyRuntime)
|
|
if rbkt == nil {
|
|
return nil // skip runtime. should be an error?
|
|
}
|
|
|
|
n := rbkt.Get(bucketKeyName)
|
|
if n != nil {
|
|
container.Runtime.Name = string(n)
|
|
}
|
|
|
|
obkt := rbkt.Bucket(bucketKeyOptions)
|
|
if obkt == nil {
|
|
return nil
|
|
}
|
|
|
|
container.Runtime.Options = map[string]string{}
|
|
return obkt.ForEach(func(k, v []byte) error {
|
|
container.Runtime.Options[string(k)] = string(v)
|
|
return nil
|
|
})
|
|
case string(bucketKeySpec):
|
|
container.Spec = make([]byte, len(v))
|
|
copy(container.Spec, v)
|
|
case string(bucketKeyRootFS):
|
|
container.RootFS = string(v)
|
|
case string(bucketKeyCreatedAt):
|
|
if err := container.CreatedAt.UnmarshalBinary(v); err != nil {
|
|
return err
|
|
}
|
|
case string(bucketKeyUpdatedAt):
|
|
if err := container.UpdatedAt.UnmarshalBinary(v); err != nil {
|
|
return err
|
|
}
|
|
case string(bucketKeyLabels):
|
|
lbkt := bkt.Bucket(bucketKeyLabels)
|
|
if lbkt == nil {
|
|
return nil
|
|
}
|
|
container.Labels = map[string]string{}
|
|
if err := lbkt.ForEach(func(k, v []byte) error {
|
|
container.Labels[string(k)] = string(v)
|
|
return nil
|
|
}); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
})
|
|
}
|
|
|
|
func writeContainer(container *containers.Container, bkt *bolt.Bucket) error {
|
|
createdAt, err := container.CreatedAt.MarshalBinary()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
updatedAt, err := container.UpdatedAt.MarshalBinary()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, v := range [][2][]byte{
|
|
{bucketKeyImage, []byte(container.Image)},
|
|
{bucketKeySpec, container.Spec},
|
|
{bucketKeyRootFS, []byte(container.RootFS)},
|
|
{bucketKeyCreatedAt, createdAt},
|
|
{bucketKeyUpdatedAt, updatedAt},
|
|
} {
|
|
if err := bkt.Put(v[0], v[1]); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if rbkt := bkt.Bucket(bucketKeyRuntime); rbkt != nil {
|
|
if err := bkt.DeleteBucket(bucketKeyRuntime); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
rbkt, err := bkt.CreateBucket(bucketKeyRuntime)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := rbkt.Put(bucketKeyName, []byte(container.Runtime.Name)); err != nil {
|
|
return err
|
|
}
|
|
|
|
obkt, err := rbkt.CreateBucket(bucketKeyOptions)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for k, v := range container.Runtime.Options {
|
|
if err := obkt.Put([]byte(k), []byte(v)); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
// Remove existing labels to keep from merging
|
|
if lbkt := bkt.Bucket(bucketKeyLabels); lbkt != nil {
|
|
if err := bkt.DeleteBucket(bucketKeyLabels); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
lbkt, err := bkt.CreateBucket(bucketKeyLabels)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
for k, v := range container.Labels {
|
|
if err := lbkt.Put([]byte(k), []byte(v)); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|