config

Documentation

Index

• Constants
• func AWSHostToRegion(host string) string
• func AlicloudHostToRegion(host string) string
• func Provider(host string) string
• type S3Cli
  • func NewFromReader(reader io.Reader) (S3Cli, error)
  • func (c *S3Cli) S3Endpoint() string
  • func (c *S3Cli) UseRegion() bool

Constants

const EmptyRegion = " "

EmptyRegion is required to allow us to use the AWS SDK against S3 compatible blobstores which do not have the concept of a region

const NoneCredentialsSource = "none"

NoneCredentialsSource specifies that credentials will be empty. The blobstore client operates in read only mode.

const StaticCredentialsSource = "static"

StaticCredentialsSource specifies that credentials will be supplied using access_key_id and secret_access_key

Functions

func AWSHostToRegion

func AWSHostToRegion(host string) string

func AlicloudHostToRegion

func AlicloudHostToRegion(host string) string

func Provider

func Provider(host string) string

Provider returns one of (aws, alicloud, google) based on a host name. Returns "" if a known provider cannot be detected.

Types

type S3Cli

type S3Cli struct {
	AccessKeyID          string `json:"access_key_id"`
	SecretAccessKey      string `json:"secret_access_key"`
	BucketName           string `json:"bucket_name"`
	FolderName           string `json:"folder_name"`
	CredentialsSource    string `json:"credentials_source"`
	Host                 string `json:"host"`
	Port                 int    `json:"port"` // 0 means no custom port
	Region               string `json:"region"`
	SSLVerifyPeer        bool   `json:"ssl_verify_peer"`
	UseSSL               bool   `json:"use_ssl"`
	SignatureVersion     int    `json:"signature_version,string"`
	ServerSideEncryption string `json:"server_side_encryption"`
	SSEKMSKeyID          string `json:"sse_kms_key_id"`
	AssumeRoleArn        string `json:"assume_role_arn"`
	MultipartUpload      bool   `json:"multipart_upload"`
	UseV2SigningMethod   bool
	HostStyle            bool   `json:"host_style"`
	SwiftAuthAccount     string `json:"swift_auth_account"`
	SwiftTempURLKey      string `json:"swift_temp_url_key"`
}

The S3Cli represents configuration for the s3cli

func NewFromReader

func NewFromReader(reader io.Reader) (S3Cli, error)

NewFromReader returns a new s3cli configuration struct from the contents of reader. reader.Read() is expected to return valid JSON

func (*S3Cli) S3Endpoint

func (c *S3Cli) S3Endpoint() string

S3Endpoint returns the S3 URI to use if custom host information has been provided

func (*S3Cli) UseRegion

func (c *S3Cli) UseRegion() bool

UseRegion signals to users of the S3Cli whether to use Region information