config

Documentation

Overview

Copyright 2023 The Cloud-Barista Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func Init()
• func NewDynamoDBClient(accesskey, secretkey, region string) (*dynamodb.Client, error)
• func NewDynamoDBClientWithEndpoint(accesskey, secretkey, region string, endpoint string) (*dynamodb.Client, error)
• func NewFireStoreClient(credentialsJson, projectID, databaseID string) (*firestore.Client, error)
• func NewFireStoreClientWithDatabase(credentialsFile, projectID, databaseID string) (*firestore.Client, error)
• func NewGCPClient(credentialsJson string) (*storage.Client, error)
• func NewNCPMongoDBClient(username, password, host string, port int) (*mongo.Client, error)
• func NewS3Client(accesskey, secretkey, region string) (*s3.Client, error)
• func NewS3ClientWithEndpoint(accesskey, secretkey, region string, endpoint string) (*s3.Client, error)
• type ConfigManager
  • func NewConfigManager(configPath string) (*ConfigManager, error)
  • func (cm *ConfigManager) CreateConfig(configData map[string]interface{}) error
  • func (cm *ConfigManager) DeleteConfig() error
  • func (cm *ConfigManager) GetDefaultCredentials(provider string) (interface{}, error)
  • func (cm *ConfigManager) ReadConfig() (map[string]interface{}, error)
  • func (cm *ConfigManager) UpdateConfig(updatedData map[string]interface{}) error
• type FileProfileManager
  • func NewProfileManager(profileFilePath ...string) *FileProfileManager
  • func NewProfileManagerDefault() *FileProfileManager
  • func (fpm *FileProfileManager) CreateProfile(profileName string, credentials models.ProfileCredentials) error
  • func (fpm *FileProfileManager) DeleteProfile(profileName string) error
  • func (fpm *FileProfileManager) LoadAllProfiles() (map[string]models.ProfileCredentials, error)
  • func (fpm *FileProfileManager) LoadCredentialsByProfile(profileName string, provider string) (interface{}, error)
  • func (fpm *FileProfileManager) SaveAllProfiles(profiles map[string]models.ProfileCredentials) error
  • func (fpm *FileProfileManager) UpdateProfile(profileName string, credentials models.ProfileCredentials) error
  • func (fpm *FileProfileManager) ValidateProfiles() error
• type InitConfig
• type LogConfig
• type LumberConfig
• type ProfileConfig
• type ProfileManager
• type ZeroConfig

Functions

func Init

func Init()

init

func NewDynamoDBClient

func NewDynamoDBClient(accesskey, secretkey, region string) (*dynamodb.Client, error)

func NewDynamoDBClientWithEndpoint

func NewDynamoDBClientWithEndpoint(accesskey, secretkey, region string, endpoint string) (*dynamodb.Client, error)

func NewFireStoreClient

func NewFireStoreClient(credentialsJson, projectID, databaseID string) (*firestore.Client, error)

func NewFireStoreClientWithDatabase

func NewFireStoreClientWithDatabase(credentialsFile, projectID, databaseID string) (*firestore.Client, error)

func NewGCPClient

func NewGCPClient(credentialsJson string) (*storage.Client, error)

func NewNCPMongoDBClient

func NewNCPMongoDBClient(username, password, host string, port int) (*mongo.Client, error)

func NewS3Client

func NewS3Client(accesskey, secretkey, region string) (*s3.Client, error)

func NewS3ClientWithEndpoint

func NewS3ClientWithEndpoint(accesskey, secretkey, region string, endpoint string) (*s3.Client, error)

Types

type ConfigManager

type ConfigManager struct {
	DefaultProfile string
	ProfileManager ProfileManager
	// contains filtered or unexported fields
}

ConfigManager structure definition

func NewConfigManager

func NewConfigManager(configPath string) (*ConfigManager, error)

NewConfigManager loads the config from the specified path

func (*ConfigManager) CreateConfig

func (cm *ConfigManager) CreateConfig(configData map[string]interface{}) error

CreateConfig creates a new config.json file with the given data

func (*ConfigManager) DeleteConfig

func (cm *ConfigManager) DeleteConfig() error

DeleteConfig deletes the config.json file

func (*ConfigManager) GetDefaultCredentials

func (cm *ConfigManager) GetDefaultCredentials(provider string) (interface{}, error)

GetDefaultCredentials returns the default profile credentials

func (*ConfigManager) ReadConfig

func (cm *ConfigManager) ReadConfig() (map[string]interface{}, error)

ReadConfig reads the config.json file and returns the data

func (*ConfigManager) UpdateConfig

func (cm *ConfigManager) UpdateConfig(updatedData map[string]interface{}) error

UpdateConfig updates the config.json file with the given data

type FileProfileManager

type FileProfileManager struct {
	// contains filtered or unexported fields
}

func NewProfileManager

func NewProfileManager(profileFilePath ...string) *FileProfileManager

func NewProfileManagerDefault

func NewProfileManagerDefault() *FileProfileManager

func (*FileProfileManager) CreateProfile

func (fpm *FileProfileManager) CreateProfile(profileName string, credentials models.ProfileCredentials) error

C profile by name

func (*FileProfileManager) DeleteProfile

func (fpm *FileProfileManager) DeleteProfile(profileName string) error

D profile by name

func (*FileProfileManager) LoadAllProfiles

func (fpm *FileProfileManager) LoadAllProfiles() (map[string]models.ProfileCredentials, error)

R profiles

func (*FileProfileManager) LoadCredentialsByProfile

func (fpm *FileProfileManager) LoadCredentialsByProfile(profileName string, provider string) (interface{}, error)

R profile by name

func (*FileProfileManager) SaveAllProfiles

func (fpm *FileProfileManager) SaveAllProfiles(profiles map[string]models.ProfileCredentials) error

Save File with profiles

func (*FileProfileManager) UpdateProfile

func (fpm *FileProfileManager) UpdateProfile(profileName string, credentials models.ProfileCredentials) error

U profile by name

func (*FileProfileManager) ValidateProfiles

func (fpm *FileProfileManager) ValidateProfiles() error

ValidateProfiles checks that at least one profile exists, each profile has at least one credential, and that all provided credentials have non-empty required fields.

type InitConfig

type InitConfig struct {
	Profile ProfileConfig `mapstructure:"profile"`
	Logger  LogConfig     `mapstructure:"log"`
}

var Settings InitConfig

type LogConfig

type LogConfig struct {
	ZeroConfig `mapstructure:",squash"`
	File       LumberConfig `mapstructure:",squash"`
}

type LumberConfig

type LumberConfig struct {
	Path       string `mapstructure:"filepath"`
	MaxSize    int    `mapstructure:"maxsize"`
	MaxBackups int    `mapstructure:"maxbackups"`
	MaxAge     int    `mapstructure:"maxage"`
	Compress   bool   `mapstructure:"compress"`
}

type ProfileConfig

type ProfileConfig struct {
	Default string `mapstructure:"default"`
}

type ProfileManager

type ProfileManager interface {
	LoadAllProfiles() (map[string]models.ProfileCredentials, error)
	SaveAllProfiles(profiles map[string]models.ProfileCredentials) error
	CreateProfile(profileName string, credentials models.ProfileCredentials) error
	UpdateProfile(profileName string, credentials models.ProfileCredentials) error
	DeleteProfile(profileName string) error
	LoadCredentialsByProfile(profileName string, provider string) (interface{}, error)
}

type ZeroConfig

type ZeroConfig struct {
	LogLevel  string `mapstructure:"level"`
	LogWriter string `mapstructure:"writer"`
}