cloud

Documentation

Overview

Package cloud defines provider-neutral capabilities shared by Podmin consumers.

Index

• Variables
• type Bucket
• type Client
• type Compute
• type ObjectInfo
• type ObjectStore

Variables

var ErrExists = fs.ErrExist

ErrExists identifies an object or secret that already exists.

var ErrNotFound = errors.Join(fs.ErrNotExist, s3lect.ErrStorageNotFound)

ErrNotFound identifies a missing object to generic callers and s3lect.

var ErrPrecondition = s3lect.ErrStoragePrecondition

ErrPrecondition identifies a failed conditional object write.

Types

type Bucket

type Bucket interface {
	EnsureBucket(context.Context) error
	EmptyAndDeleteBucket(context.Context) error
}

Bucket manages the object-storage container owned by a cluster.

type Client

type Client struct {
	Bucket        Bucket
	Objects       ObjectStore
	SecretStores  map[secrets.Provider]secrets.Manager
	SystemSecrets secrets.Manager
	Compute       Compute
}

Client contains provider-neutral CLI capabilities.

type Compute

type Compute interface {
	Architecture(context.Context, string) (string, error)
	SubnetCIDRs(context.Context, string, netip.Prefix, []string) (map[string]string, bool, error)
}

Compute provides the infrastructure discovery needed during setup.

type ObjectInfo

type ObjectInfo struct {
	Key      string
	Modified time.Time
}

ObjectInfo describes a listed object without its body.

type ObjectStore

type ObjectStore interface {
	Get(context.Context, string) ([]byte, string, error)
	PutStream(context.Context, string, io.Reader, int64) error
	PutIfMatch(context.Context, string, []byte, string) error
	List(context.Context, string) ([]ObjectInfo, error)
	Delete(context.Context, string) error
}

ObjectStore provides the object operations used by the CLI.