193abed96e
The split between provider and ingester was a long standing division reflecting the client-side use cases. For the most part, we were differentiating these for the algorithms that operate them, but it made instantation and use of the types challenging. On the server-side, this distinction is generally less important. This change unifies these types and in the process we get a few benefits. The first is that we now completely access the content store over GRPC. This was the initial intent and we have now satisfied this goal completely. There are a few issues around listing content and getting status, but we resolve these with simple streaming and regexp filters. More can probably be done to polish this but the result is clean. Several other content-oriented methods were polished in the process of unification. We have now properly seperated out the `Abort` method to cancel ongoing or stalled ingest processes. We have also replaced the `Active` method with a single status method. The transition went extremely smoothly. Once the clients were updated to use the new methods, every thing worked as expected on the first compile. Signed-off-by: Stephen J Day <stephen.day@docker.com>
110 lines
2.8 KiB
Go
110 lines
2.8 KiB
Go
package content
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/opencontainers/go-digest"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
var (
|
|
// ErrNotFound is returned when an item is not found.
|
|
//
|
|
// Use IsNotFound(err) to detect this condition.
|
|
ErrNotFound = errors.New("content: not found")
|
|
|
|
// ErrExists is returned when something exists when it may not be expected.
|
|
//
|
|
// Use IsExists(err) to detect this condition.
|
|
ErrExists = errors.New("content: exists")
|
|
|
|
bufPool = sync.Pool{
|
|
New: func() interface{} {
|
|
return make([]byte, 1<<20)
|
|
},
|
|
}
|
|
)
|
|
|
|
type Provider interface {
|
|
Reader(ctx context.Context, dgst digest.Digest) (io.ReadCloser, error)
|
|
}
|
|
|
|
type Ingester interface {
|
|
Writer(ctx context.Context, ref string, size int64, expected digest.Digest) (Writer, error)
|
|
}
|
|
|
|
// TODO(stevvooe): Consider a very different name for this struct. Info is way
|
|
// to general. It also reads very weird in certain context, like pluralization.
|
|
type Info struct {
|
|
Digest digest.Digest
|
|
Size int64
|
|
CommittedAt time.Time
|
|
}
|
|
|
|
type Status struct {
|
|
Ref string
|
|
Offset int64
|
|
Total int64
|
|
Expected digest.Digest
|
|
StartedAt time.Time
|
|
UpdatedAt time.Time
|
|
}
|
|
|
|
// WalkFunc defines the callback for a blob walk.
|
|
type WalkFunc func(Info) error
|
|
|
|
// Manager provides methods for inspecting, listing and removing content.
|
|
type Manager interface {
|
|
// Info will return metadata about content available in the content store.
|
|
//
|
|
// If the content is not present, ErrNotFound will be returned.
|
|
Info(ctx context.Context, dgst digest.Digest) (Info, error)
|
|
|
|
// Walk will call fn for each item in the content store.
|
|
Walk(ctx context.Context, fn WalkFunc) error
|
|
|
|
// Delete removes the content from the store.
|
|
Delete(ctx context.Context, dgst digest.Digest) error
|
|
|
|
// Status returns the status of any active ingestions whose ref match the
|
|
// provided regular expression. If empty, all active ingestions will be
|
|
// returned.
|
|
//
|
|
// TODO(stevvooe): Status may be slighly out of place here. If this remains
|
|
// here, we should remove Manager and just define these on store.
|
|
Status(ctx context.Context, re string) ([]Status, error)
|
|
|
|
// Abort completely cancels the ingest operation targeted by ref.
|
|
//
|
|
// TODO(stevvooe): Same consideration as above. This should really be
|
|
// restricted to an ingest management interface.
|
|
Abort(ctx context.Context, ref string) error
|
|
}
|
|
|
|
type Writer interface {
|
|
io.WriteCloser
|
|
Status() (Status, error)
|
|
Digest() digest.Digest
|
|
Commit(size int64, expected digest.Digest) error
|
|
Truncate(size int64) error
|
|
}
|
|
|
|
// Store combines the methods of content-oriented interfaces into a set that
|
|
// are commonly provided by complete implementations.
|
|
type Store interface {
|
|
Manager
|
|
Ingester
|
|
Provider
|
|
}
|
|
|
|
func IsNotFound(err error) bool {
|
|
return errors.Cause(err) == ErrNotFound
|
|
}
|
|
|
|
func IsExists(err error) bool {
|
|
return errors.Cause(err) == ErrExists
|
|
}
|