echo

README

go-cloud-blob-echo

Go package for echoing data to and from Go Cloud blob sources.

Example

import (
       "context"
       "github.com/sfomuseum/go-cloud-blob-echo"
)

ctx := context.Background()

from := ""	// STDIN
to := "file:///tmp/test"

echo.Echo(ctx, from, to)

Tools

To build binary versions of these tools run the cli Makefile target. For example:

$> make cli
go build -mod vendor -o bin/echo cmd/echo/main.go

echo

$> bin/echo -h
Usage of ./bin/echo:
  -from string
    	A valid Go Cloud blob URI. If empty data will be read from STDIN.
  -to string
    	A valid Go Cloud blob URI. If empty data will be written to STDOUT.

$> echo 'hello world' | bin/echo 
hello world

$> echo 'hello world' | bin/echo -to 'file:///usr/local/data/test'

$> cat /usr/local/data/test
hello world

$> bin/echo -from 'file:///usr/local/data/test'
hello world

This packages imports the go-cloud-s3blob package; it is a thin wrapper around the default go-cloud S3 blob opener to check for a credentials parameter (in blob URIs) and use it to assign AWS S3 session credentials. For example:

$> echo 'this is a test' \

   | ./bin/echo \
   	-to 's3blob://s3-bucket/misc/test.txt?region=us-east-1&credentials=default'

$> bin/echo \
	-from 's3blob://s3-bucket/misc/test.txt?region=us-east-1&credentials=default'
this is a test

Credentials

Credentials for s3blob:/// URIs are defined as string labels. They are:

Label	Description
env:	Read credentials from AWS defined environment variables.
iam:	Assume AWS IAM credentials are in effect.
{AWS_PROFILE_NAME}	This this profile from the default AWS credentials location.
{AWS_CREDENTIALS_PATH}:{AWS_PROFILE_NAME}	This this profile from a user-defined AWS credentials location.

Known knowns

• By default the cmd/echo/main.go tool has support for the Go Cloud fileblob://, s3:// and s3blob:// URI schemes. This reflects the nature of the work at SFO Museum.
• By default the Go Cloud blob writers create files with restrictive permissions. The Go Cloud blob interfaces don't have an interface for setting permissions (by design) to doing so is left to developers to implement themselves.

See also

• https://godoc.org/gocloud.dev/blob
• https://github.com/aaronland/go-cloud-s3blob

Documentation

Index

• func Echo(ctx context.Context, from string, to string) (int64, error)

Functions

func Echo

func Echo(ctx context.Context, from string, to string) (int64, error)