s3

README

S3Cache

s3cache is an abstraction on top of Amazon Web Services (AWS) Simple Storage Service (S3) which implements the tegola cache interface. To use it, add the following minimum config to your tegola config file:

[cache]
type="s3"
bucket="tegola-test-data"

Properties

The s3cache config supports the following properties:

• bucket (string): [Required] the name of the S3 bucket to use.
• basepath (string): [Optional] a path prefix added to all cache operations inside of the S3 bucket. helpful so a bucket does not need to be dedicated to only this cache.
• region (string): [Optional] the region the bucket is in. defaults to 'us-east-1'
• aws_access_key_id (string): [Optional] the AWS access key id to use.
• aws_secret_access_key (string): [Optional] the AWS secret access key to use.
• max_zoom (int): [Optional] the max zoom the cache should cache to. After this zoom, Set() calls will return before doing work.
• endpoint (string): the endpoint where the S3 compliant backend is located. only necessary for non-AWS deployments. defaults to ''.
• access_control_list (string): the S3 access control to set on the file when putting the file. defaults to ''.
• cache_control (string): the HTTP cache control header to set on the file when putting the file. defaults to ''.
• content_type (string): the http MIME-type set on the file when putting the file. defaults to 'application/vnd.mapbox-vector-tile'.

Credential chain

If the aws_access_key_id and aws_secret_access_key are not set, then the credential provider chain will be used. The provider chain supports multiple methods for passing credentials, one of which is setting environment variables. For example:

$ export AWS_REGION=us-west-2
$ export AWS_ACCESS_KEY_ID=YOUR_AKID
$ export AWS_SECRET_ACCESS_KEY=YOUR_SECRET_KEY

Testing

Testing is designed to work against a live S3 bucket. To run the s3 cache tests, the following environment variables need to be set:

$ export RUN_S3_TESTS=yes
$ export AWS_TEST_BUCKET=YOUR_TEST_BUCKET_NAME
$ export AWS_REGION=TEST_BUCKET_REGION
$ export AWS_ACCESS_KEY_ID=YOUR_AKID
$ export AWS_SECRET_ACCESS_KEY=YOUR_SECRET_KEY

Documentation

Index

• Constants
• Variables
• func New(config dict.Dicter) (cache.Interface, error)
• type Cache
  • func (s3c *Cache) Get(key *cache.Key) ([]byte, bool, error)
  • func (s3c *Cache) Purge(key *cache.Key) error
  • func (s3c *Cache) Set(key *cache.Key, val []byte) error

Constants

const (
	// required
	ConfigKeyBucket = "bucket"
	// optional
	ConfigKeyBasepath       = "basepath"
	ConfigKeyMaxZoom        = "max_zoom"
	ConfigKeyRegion         = "region"   // defaults to "us-east-1"
	ConfigKeyEndpoint       = "endpoint" //	defaults to ""
	ConfigKeyAWSAccessKeyID = "aws_access_key_id"
	ConfigKeyAWSSecretKey   = "aws_secret_access_key"
	ConfigKeyACL            = "access_control_list" //	defaults to ""
	ConfigKeyCacheControl   = "cache_control"       //	defaults to ""
	ConfigKeyContentType    = "content_type"        //	defaults to "application/vnd.mapbox-vector-tile"
)

const (
	DefaultBasepath    = ""
	DefaultRegion      = "us-east-1"
	DefaultAccessKey   = ""
	DefaultSecretKey   = ""
	DefaultContentType = mvt.MimeType
	DefaultEndpoint    = ""
)

const CacheType = "s3"

Variables

var (
	ErrMissingBucket = errors.New("s3cache: missing required param 'bucket'")
)

Functions

func New

func New(config dict.Dicter) (cache.Interface, error)

Types

type Cache

type Cache struct {
	// Bucket is the name of the s3 bucket to operate on
	Bucket string

	// Basepath is a path prefix added to all cache operations inside of the S3 bucket
	// helpful so a bucket does not need to be dedicated to only this cache
	Basepath string

	// MaxZoom determines the max zoom the cache to persist. Beyond this
	// zoom, cache Set() calls will be ignored. This is useful if the cache
	// should not be leveraged for higher zooms when data changes often.
	MaxZoom uint

	// client holds a reference to the s3 client. it's expected the client
	// has an active session and read, write, delete permissions have been checked
	Client *s3.S3

	// ACL is the aws ACL, if the not set it will use the default value for aws.
	ACL string

	// CacheControl is the http Cache Control header, if the not set it will use the default value for aws.
	CacheControl string

	// ContentType is MIME content type of the tile. Default is "application/vnd.mapbox-vector-tile"
	ContentType string
}

func (*Cache) Get

func (s3c *Cache) Get(key *cache.Key) ([]byte, bool, error)

func (*Cache) Purge

func (s3c *Cache) Purge(key *cache.Key) error

func (*Cache) Set

func (s3c *Cache) Set(key *cache.Key, val []byte) error