s3store

README

Amazon S3 blobstore

Using localstack for local development

1. Install awscli from [here][https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html]
2. Install localstack from [here][https://github.com/localstack/localstack#installing]
3. Launch localstack with SERVICES=s3 localstack start
4. Create a bucket using aws --endpoint-url=http://localhost:4572 s3 mb s3://cadence-development
5. Configure archival with the following configuration

archival:
  status: "enabled"
  enableReadFromArchival: true
  defaultBucket: "cadence-development"
  s3store:
    region: "us-east-1"
    endpoint: "http://127.0.0.1:4572"
    s3ForcePathStyle: true

Documentation

Index

• func ClientFromConfig(cfg *Config) (s3iface.S3API, error)
• func NewClient(s3cli s3iface.S3API) blobstore.Client
• type Config
  • func (c *Config) Validate() error

Functions

func ClientFromConfig

func ClientFromConfig(cfg *Config) (s3iface.S3API, error)

ClientFromConfig create client from config

func NewClient

func NewClient(s3cli s3iface.S3API) blobstore.Client

NewClient returns a new Client backed by S3

Types

type Config

type Config struct {
	Region           string  `yaml:"region"`
	Endpoint         *string `yaml:"endpoint"`
	S3ForcePathStyle bool    `yaml:"s3ForcePathStyle"`
}

Config describes the configuration needed to construct a blobstore client backed by S3

func (*Config) Validate

func (c *Config) Validate() error

Validate validates config