s3

Documentation

Index

• type Client
  • func NewClient(config *Config) (*Client, error)
• type Config
  • func NewConfig(storage *v1.Storage, creds map[string]string) *Config
  • func (c *Config) Validate() error
• type Provider
  • func NewStorage(config *v1.Storage, creds map[string]string) (*Provider, error)
  • func (p *Provider) Retrieve(key string) (io.ReadCloser, error)
  • func (p *Provider) Store(key string, body io.ReadCloser) error

Types

type Client

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

Client is an S3 client and configured Uploader.

func NewClient

func NewClient(config *Config) (*Client, error)

NewClient constructs a new S3 backup upload provider client that can upload/download backups to any S3 compliant API e.g. OCI, AWS, GCE.

type Config

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

Config holds the credentials required to authenticate with an S3 compliant API.

func NewConfig

func NewConfig(storage *v1.Storage, creds map[string]string) *Config

NewConfig creates an S3 configuration based on the input parameters.

func (*Config) Validate

func (c *Config) Validate() error

Validate checks the required S3 configuration parameters are set.

type Provider

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

Provider is storage implementation of provider.Interface.

func NewStorage

func NewStorage(config *v1.Storage, creds map[string]string) (*Provider, error)

NewStorage creates a provider capable of storing and retreiving objects against the specified 's3' storage configuration and credentials.

func (*Provider) Retrieve

func (p *Provider) Retrieve(key string) (io.ReadCloser, error)

Retrieve will provide a data stream on the specified object from S3.

func (*Provider) Store

func (p *Provider) Store(key string, body io.ReadCloser) error

Store will upload the content of the data stream to S3.