cfg

README

A package for loading config data from AWS SecretsManager

Introduction

• Secure config loading.
• Support AWS SecretsManager.
• Easy JSON unmarshaling into a struct.

Example

package main

import (
	"context"

	"github.com/gofor-little/cfg"
)

type Config struct {
	SomeStringValue string `json:"someStringValue"`
	SomeIntValue    int    `json:"someIntValue"`
}

func main() {
	// Initialize the cfg package.
	if err := cfg.Initialize(context.Background(), "AWS_PROFILE", "AWS_REGION"); err != nil {
		panic(err)
	}

	// Load and parse the config data into the passed Config struct.
	config := &Config{}
	if err := cfg.Load(context.Background(), "AWS_SECRET_ARN", config); err != nil {
		panic(err)
	}
}

Testing

Ensure the following environment variables are set, usually with a .env file.

• AWS_PROFILE (an AWS CLI profile name)
• AWS_REGION (a valid AWS region)

Run go test -v ./... in the root directory.

Documentation

Index

• Variables
• func Initialize(ctx context.Context, profile string, region string) error
• func Load(ctx context.Context, secretARN string, v interface{}) error
• func LoadString(ctx context.Context, secretARN string) (string, error)

Variables

var (
	// SecretsManagerClient is used to fetch secrets from SecretsManager.
	SecretsManagerClient *secretsmanager.Client
)

Functions

func Initialize

func Initialize(ctx context.Context, profile string, region string) error

Initialize will initialize the cfg package. Both the profile and region parameters are optional if authentication can be achieved via another method. For example, environment variables or IAM roles.

func Load

func Load(ctx context.Context, secretARN string, v interface{}) error

Load fetches a secret from SecretsManager and parses the value into v using json.Unmarshal. To comply with json.Unmarshal's parameter requirements v cannot be nil or not a pointer.

func LoadString

func LoadString(ctx context.Context, secretARN string) (string, error)

Load fetches a secret from SecretsManager.