S3 blobstore implementation (#1863)

Gopkg.toml

@@ -150,3 +150,7 @@ ignored = ["github.com/uber/cadence/.gen"]
 [[constraint]]
   name = "github.com/valyala/fastjson"
   version = "1.4.1"
+
+[[constraint]]
+  name = "github.com/aws/aws-sdk-go"
+  version = "1.19.31"

cmd/server/server.go

@@ -29,6 +29,7 @@ import (
 	"github.com/uber/cadence/client"
 	"github.com/uber/cadence/common"
 	"github.com/uber/cadence/common/blobstore/filestore"
+	"github.com/uber/cadence/common/blobstore/s3store"
 	"github.com/uber/cadence/common/elasticsearch"
 	"github.com/uber/cadence/common/log/loggerimpl"
 	"github.com/uber/cadence/common/log/tag"
@@ -184,7 +185,18 @@ func (s *server) startService() common.Daemon {
 	params.PublicClient = workflowserviceclient.New(dispatcher.ClientConfig(common.FrontendServiceName))
 
 	if params.ClusterMetadata.ArchivalConfig().ConfiguredForArchival() {
-		params.BlobstoreClient, err = filestore.NewClient(&s.cfg.Archival.Filestore)
+		if s.cfg.Archival.Filestore != nil && s.cfg.Archival.S3store != nil {
+			log.Fatalf("cannot config both filestore and s3store")
+		}
+		if s.cfg.Archival.Filestore != nil {
+			params.BlobstoreClient, err = filestore.NewClient(s.cfg.Archival.Filestore)
+		}
+		if s.cfg.Archival.S3store != nil {
+			s3cli, err := s3store.ClientFromConfig(s.cfg.Archival.S3store)
+			if err != nil {
+				params.BlobstoreClient = s3store.NewClient(s3cli)
+			}
+		}
 		if err != nil {
 			log.Fatalf("error creating blobstore: %v", err)
 		}

common/blobstore/filestore/client.go

@@ -51,8 +51,6 @@ var (
 	ErrDeleteFile = &shared.BadRequestError{Message: "could not delete file"}
 	// ErrListFiles could not list files
 	ErrListFiles = &shared.BadRequestError{Message: "could not list files"}
-	// ErrConstructKey could not construct key
-	ErrConstructKey = &shared.BadRequestError{Message: "could not construct key"}
 	// ErrBucketConfigDeserialization bucket config could not be deserialized
 	ErrBucketConfigDeserialization = &shared.BadRequestError{Message: "bucket config could not be deserialized"}
 )
@@ -192,7 +190,7 @@ func (c *client) ListByPrefix(_ context.Context, bucket string, prefix string) (
 		if strings.HasPrefix(f, prefix) {
 			key, err := blob.NewKeyFromString(f)
 			if err != nil {
-				return nil, ErrConstructKey
+				return nil, blobstore.ErrConstructKey
 			}
 			matchingKeys = append(matchingKeys, key)
 		}

common/blobstore/interface.go

@@ -37,6 +37,8 @@ var (
 	ErrBlobSerialization = &shared.BadRequestError{Message: "failed to serialize blob"}
 	// ErrBlobDeserialization indicates that a failure occurred in deserializing blob
 	ErrBlobDeserialization = &shared.BadRequestError{Message: "failed to deserialize blob"}
+	// ErrConstructKey could not construct key
+	ErrConstructKey = &shared.BadRequestError{Message: "could not construct key"}
 )
 
 // BucketMetadataResponse contains information relating to a bucket's configuration

common/blobstore/s3store/README.md

@@ -0,0 +1,22 @@
+# 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
+```
+
+
+
+