config

Documentation

Overview

Package config create AWS session and distribute it (alongside other config value) to any package interested.

Index

• Constants
• Variables
• func BackupOptions() []backup.Options
• func Connect(ignite, createConfigIfNotExist bool) error
• func Listen(listener Listener)
• type Config
• type Listener
• type ViperAWSName
  • func (v *ViperAWSName) ArchiveCacheBucketName() string
  • func (v *ViperAWSName) ArchiveJobsSNSARN() string
  • func (v *ViperAWSName) ArchiveJobsSQSURL() string
  • func (v *ViperAWSName) ArchiveMainBucketName() string
  • func (v *ViperAWSName) DynamoDBName() string

Constants

const (
	Localstack                  = "aws.localstack" // Localstack set to true will ignore AwsRegion, AwsKey, and AwsSecret
	AwsRegion                   = "aws.region"
	AwsKey                      = "aws.key"
	AwsSecret                   = "aws.secret"
	ArchiveDynamodbTable        = "archive.dynamodb.table"
	ArchiveMainBucketName       = "archive.main.bucketName"
	ArchiveCacheBucketName      = "archive.cache.bucketName"
	ArchiveJobsSNSARN           = "archive.sns.arn"
	ArchiveJobsSQSURL           = "archive.sqs.url"
	BackupCacheDirectory        = "backup.cache.dir"
	BackupConcurrencyAnalyser   = "backup.concurrency.analyser"
	BackupConcurrencyCataloguer = "backup.concurrency.cataloguer"
	BackupConcurrencyUploader   = "backup.concurrency.uploader"
	CatalogDynamodbTable        = "catalog.dynamodb.table"
	LocalHome                   = "home.dir"
	Owner                       = "owner"
)

Variables

var (
	ForcedConfigFile string // ForcedConfigFile is the path to the file of the config to use (instead of defaulting to ./dphoto.yml, $HOME/.dphoto/dphoto.yml, ...)
	Environment      string // Environment is used as suffix for the config file name.

)

Functions

func BackupOptions

func BackupOptions() []backup.Options

func Connect

func Connect(ignite, createConfigIfNotExist bool) error

Connect must be called by main function, it dispatches the config to all components requiring it. Set ignite to TRUE to connect to AWS (required for most commands)

func Listen

func Listen(listener Listener)

Listen registers a Listener that will be invoked when configuration will be provided.

Types

type Config

type Config interface {
	Get(key string) interface{}
	GetString(key string) string
	GetStringOrDefault(key string, defaultValue string) string
	GetBool(key string) bool
	GetInt(key string) int
	GetIntOrDefault(key string, defaultValue int) int
	GetAWSV2Config() aws.Config
}

type Listener

type Listener func(Config)

Listener function is called once config is loaded

type ViperAWSName

type ViperAWSName struct{}

func (*ViperAWSName) ArchiveCacheBucketName

func (v *ViperAWSName) ArchiveCacheBucketName() string

func (*ViperAWSName) ArchiveJobsSNSARN

func (v *ViperAWSName) ArchiveJobsSNSARN() string

func (*ViperAWSName) ArchiveJobsSQSURL

func (v *ViperAWSName) ArchiveJobsSQSURL() string

func (*ViperAWSName) ArchiveMainBucketName

func (v *ViperAWSName) ArchiveMainBucketName() string

func (*ViperAWSName) DynamoDBName

func (v *ViperAWSName) DynamoDBName() string