s3

Documentation

Index

• Constants
• func NewBucketClient(cfg Config, name string, logger log.Logger) (objstore.Bucket, error)
• func NewBucketReaderClient(cfg Config, name string, logger log.Logger) (objstore.BucketReader, error)
• type BucketWithRetries
  • func (b *BucketWithRetries) Attributes(ctx context.Context, name string) (attributes objstore.ObjectAttributes, err error)
  • func (b *BucketWithRetries) Close() error
  • func (b *BucketWithRetries) Delete(ctx context.Context, name string) error
  • func (b *BucketWithRetries) Exists(ctx context.Context, name string) (exists bool, err error)
  • func (b *BucketWithRetries) Get(ctx context.Context, name string) (reader io.ReadCloser, err error)
  • func (b *BucketWithRetries) GetRange(ctx context.Context, name string, off, length int64) (closer io.ReadCloser, err error)
  • func (b *BucketWithRetries) IsObjNotFoundErr(err error) bool
  • func (b *BucketWithRetries) Iter(ctx context.Context, dir string, f func(string) error, ...) error
  • func (b *BucketWithRetries) Name() string
  • func (b *BucketWithRetries) Upload(ctx context.Context, name string, r io.Reader) error
• type Config
  • func (cfg *Config) RegisterFlags(f *flag.FlagSet)
  • func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
  • func (cfg *Config) Validate() error
• type HTTPConfig
  • func (cfg *HTTPConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
• type SSEConfig
  • func (cfg *SSEConfig) BuildMinioConfig() (encrypt.ServerSide, error)
  • func (cfg *SSEConfig) BuildThanosConfig() (s3.SSEConfig, error)
  • func (cfg *SSEConfig) RegisterFlags(f *flag.FlagSet)
  • func (cfg *SSEConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
  • func (cfg *SSEConfig) Validate() error

Constants

const (
	SignatureVersionV4 = "v4"
	SignatureVersionV2 = "v2"

	// SSEKMS config type constant to configure S3 server side encryption using KMS
	// https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
	SSEKMS = "SSE-KMS"

	// SSES3 config type constant to configure S3 server side encryption with AES-256
	// https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
	SSES3 = "SSE-S3"

	BucketAutoLookup        = "auto"
	BucketVirtualHostLookup = "virtual-hosted"
	BucketPathLookup        = "path"
)

Functions

func NewBucketClient

func NewBucketClient(cfg Config, name string, logger log.Logger) (objstore.Bucket, error)

NewBucketClient creates a new S3 bucket client

func NewBucketReaderClient

func NewBucketReaderClient(cfg Config, name string, logger log.Logger) (objstore.BucketReader, error)

NewBucketReaderClient creates a new S3 bucket client

Types

type BucketWithRetries

type BucketWithRetries struct {
	// contains filtered or unexported fields
}

func (*BucketWithRetries) Attributes

func (b *BucketWithRetries) Attributes(ctx context.Context, name string) (attributes objstore.ObjectAttributes, err error)

func (*BucketWithRetries) Close

func (b *BucketWithRetries) Close() error

func (*BucketWithRetries) Delete

func (b *BucketWithRetries) Delete(ctx context.Context, name string) error

func (*BucketWithRetries) Exists

func (b *BucketWithRetries) Exists(ctx context.Context, name string) (exists bool, err error)

func (*BucketWithRetries) Get

func (b *BucketWithRetries) Get(ctx context.Context, name string) (reader io.ReadCloser, err error)

func (*BucketWithRetries) GetRange

func (b *BucketWithRetries) GetRange(ctx context.Context, name string, off, length int64) (closer io.ReadCloser, err error)

func (*BucketWithRetries) IsObjNotFoundErr

func (b *BucketWithRetries) IsObjNotFoundErr(err error) bool

func (*BucketWithRetries) Iter

func (b *BucketWithRetries) Iter(ctx context.Context, dir string, f func(string) error, options ...objstore.IterOption) error

func (*BucketWithRetries) Name

func (b *BucketWithRetries) Name() string

func (*BucketWithRetries) Upload

func (b *BucketWithRetries) Upload(ctx context.Context, name string, r io.Reader) error

type Config

type Config struct {
	Endpoint         string         `yaml:"endpoint"`
	Region           string         `yaml:"region"`
	BucketName       string         `yaml:"bucket_name"`
	SecretAccessKey  flagext.Secret `yaml:"secret_access_key"`
	AccessKeyID      string         `yaml:"access_key_id"`
	Insecure         bool           `yaml:"insecure"`
	SignatureVersion string         `yaml:"signature_version"`
	BucketLookupType string         `yaml:"bucket_lookup_type"`

	SSE  SSEConfig  `yaml:"sse"`
	HTTP HTTPConfig `yaml:"http"`
}

Config holds the config options for an S3 backend

func (*Config) RegisterFlags

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers the flags for s3 storage with the provided prefix

func (*Config) RegisterFlagsWithPrefix

func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix registers the flags for s3 storage with the provided prefix

func (*Config) Validate

func (cfg *Config) Validate() error

Validate config and returns error on failure

type HTTPConfig

type HTTPConfig struct {
	bucket_http.Config `yaml:",inline"`

	// Allow upstream callers to inject a round tripper
	Transport http.RoundTripper `yaml:"-"`
}

HTTPConfig stores the http.Transport configuration for the s3 minio client.

func (*HTTPConfig) RegisterFlagsWithPrefix

func (cfg *HTTPConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix registers the flags for s3 storage with the provided prefix

type SSEConfig

type SSEConfig struct {
	Type                 string `yaml:"type"`
	KMSKeyID             string `yaml:"kms_key_id"`
	KMSEncryptionContext string `yaml:"kms_encryption_context"`
}

SSEConfig configures S3 server side encryption struct that is going to receive user input (through config file or CLI)

func (*SSEConfig) BuildMinioConfig

func (cfg *SSEConfig) BuildMinioConfig() (encrypt.ServerSide, error)

BuildMinioConfig builds the SSE config expected by the Minio client.

func (*SSEConfig) BuildThanosConfig

func (cfg *SSEConfig) BuildThanosConfig() (s3.SSEConfig, error)

BuildThanosConfig builds the SSE config expected by the Thanos client.

func (*SSEConfig) RegisterFlags

func (cfg *SSEConfig) RegisterFlags(f *flag.FlagSet)

func (*SSEConfig) RegisterFlagsWithPrefix

func (cfg *SSEConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix adds the flags required to config this to the given FlagSet

func (*SSEConfig) Validate

func (cfg *SSEConfig) Validate() error