leases

package
v1.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 7, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// GRPCHeader defines the header name for specifying a containerd lease.
	GRPCHeader = "containerd-lease"
)

Variables

This section is empty.

Functions

func FromContext added in v1.2.0

func FromContext(ctx context.Context) (string, bool)

FromContext returns the lease from the context.

func SynchronousDelete added in v1.2.0

func SynchronousDelete(ctx context.Context, o *DeleteOptions) error

SynchronousDelete is used to indicate that a lease deletion and removal of any unreferenced resources should occur synchronously before returning the result.

func WithLease

func WithLease(ctx context.Context, lid string) context.Context

WithLease sets a given lease on the context

Types

type DeleteOpt added in v1.2.0

type DeleteOpt func(context.Context, *DeleteOptions) error

DeleteOpt allows configuring a delete operation

type DeleteOptions added in v1.2.0

type DeleteOptions struct {
	Synchronous bool
}

DeleteOptions provide options on image delete

type Lease

type Lease struct {
	ID        string
	CreatedAt time.Time
	Labels    map[string]string
}

Lease retains resources to prevent cleanup before the resources can be fully referenced.

type Manager added in v1.2.0

type Manager interface {
	Create(context.Context, ...Opt) (Lease, error)
	Delete(context.Context, Lease, ...DeleteOpt) error
	List(context.Context, ...string) ([]Lease, error)
	AddResource(context.Context, Lease, Resource) error
	DeleteResource(context.Context, Lease, Resource) error
	ListResources(context.Context, Lease) ([]Resource, error)
}

Manager is used to create, list, and remove leases

type Opt added in v1.2.0

type Opt func(*Lease) error

Opt is used to set options on a lease

func WithExpiration added in v1.2.0

func WithExpiration(d time.Duration) Opt

WithExpiration sets an expiration on the lease

func WithID added in v1.2.0

func WithID(id string) Opt

WithID sets the ID for the lease

func WithLabels added in v1.2.0

func WithLabels(labels map[string]string) Opt

WithLabels sets labels on a lease

func WithRandomID added in v1.2.0

func WithRandomID() Opt

WithRandomID sets the lease ID to a random unique value

type Resource added in v1.3.0

type Resource struct {
	ID   string
	Type string
}

Resource represents low level resource of image, like content, ingest and snapshotter.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL