s3

README

Amazon S3 plugin

The S3 plugin will use Amazon S3 to persist backups.

Kargo does not provide a mechanism to track backup ages and initiate a bulk deletion process. Therefore it is advised to set up a lifecycle policy on the S3 bucket to clean old backups from time to time.

Configuration:

[processors.s3]
  id = "<your_id>"
  secret = "<your_secret>"
  token = "<your_token>"
  folder = ""
  region = "eu-central-1"
  bucket = "db-backups"
  debug = false

Fields

• id
• secret
• token (optional)
• folder (optional)
• region
• bucket
• debug

Documentation

Overview

Package s3 stores backups on AWS S3

Index

• type Store
  • func (s *Store) Info(ctx *context.Context, key string) (os.FileInfo, error)
  • func (s *Store) Init() error
  • func (s *Store) Name() string
  • func (s *Store) Pull(ctx *context.Context, key string) (io.ReadCloser, os.FileInfo, error)
  • func (s *Store) Push(ctx *context.Context, key string, r io.Reader) error
  • func (s *Store) Walk(ctx *context.Context, filter *storage.WalkFilter, ...)

Types

type Store

type Store struct {
	ID     string `toml:"id"`
	Secret string `toml:"secret"`
	Token  string `toml:"token"`
	Folder string `toml:"folder"`
	Region string `toml:"region"`
	Bucket string `toml:"bucket"`
	Debug  bool   `toml:"debug"`

	Sesh *session.Session
	S3   *s3.S3
}

Store is an S3 store

func (*Store) Info

func (s *Store) Info(ctx *context.Context, key string) (os.FileInfo, error)

func (*Store) Init

func (s *Store) Init() error

func (*Store) Name

func (s *Store) Name() string

func (*Store) Pull

func (s *Store) Pull(
	ctx *context.Context, key string,
) (io.ReadCloser, os.FileInfo, error)

func (*Store) Push

func (s *Store) Push(ctx *context.Context, key string, r io.Reader) error

func (*Store) Walk

func (s *Store) Walk(
	ctx *context.Context,
	filter *storage.WalkFilter,
	walkFn func(key string, f os.FileInfo, err error) error,
)