config

README

crypt/config

Usage

Get configuration from a backend

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/DoNewsCode/crypt/config"
)

var (
	key           = "/app/config"
	secretKeyring = ".secring.gpg"
)

func main() {
	kr, err := os.Open(secretKeyring)
	if err != nil {
		log.Fatal(err)
	}
	defer kr.Close()
	machines := []string{"http://127.0.0.1:2379"}
	cm, err := config.NewConfigManager("etcd", machines, kr)
	if err != nil {
        log.Fatal(err)
    }
	value, err := cm.Get(context.TODO(), key)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", value)
}

Monitor backend for configuration changes

package main

import (
	"context"
	"fmt"
	"io/ioutil"
	"log"
	"os"
	"time"

	"github.com/DoNewsCode/crypt/config"
)

var (
	key           = "/app/config"
	secretKeyring = ".secring.gpg"
)

func main() {
	kr, err := os.Open(secretKeyring)
	if err != nil {
		log.Fatal(err)
	}
	defer kr.Close()
	secret, err := ioutil.ReadAll(kr)
	if err != nil {
		log.Fatal(err)
	}
	cfg := config.Config{
		Name:          "etcd",
		Machines:      []string{"http://127.0.0.1:2379"},
		Secret:        secret,
		WatchInterval: 5 * time.Second,
	}
	cm, err := config.NewConfigManager(cfg)
	if err != nil {
		log.Fatal(err)
	}
	
	value, err := cm.Get(context.TODO(), key)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", value)
	
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	resp := cm.Watch(ctx, key)
	if err != nil {
		log.Fatal(err)
	}
	for {
		select {
		case r := <-resp:
			if r.Error != nil {
				fmt.Println(r.Error.Error())
			}
			fmt.Printf("%s\n", r.Value)
		}
	}
}

Documentation

Index

• func NewStore(name string, machines []string, watchInterval time.Duration) (backend.Store, error)
• type Config
• type KVPair
• type KVPairs
• type Manager
  • func NewConfigManager(cfg Config) (Manager, error)
  • func NewConfigManagerWithStore(store backend.Store, opts ...OptionFunc) (Manager, error)
• type OptionFunc
  • func WithSecretKey(secret []byte) OptionFunc
• type Response

Functions

func NewStore

func NewStore(name string, machines []string, watchInterval time.Duration) (backend.Store, error)

Types

type Config

type Config struct {
	Name          string
	Machines      []string
	Secret        []byte
	WatchInterval time.Duration
}

type KVPair

type KVPair struct {
	backend.KVPair
}

type KVPairs

type KVPairs []*KVPair

type Manager

type Manager interface {
	Get(ctx context.Context, key string) ([]byte, error)
	Set(ctx context.Context, key string, value []byte) error
	Watch(ctx context.Context, key string) <-chan *Response
}

Manager A ConfigManager retrieves and decrypts configuration from a key/value store.

func NewConfigManager

func NewConfigManager(cfg Config) (Manager, error)

func NewConfigManagerWithStore

func NewConfigManagerWithStore(store backend.Store, opts ...OptionFunc) (Manager, error)

type OptionFunc

type OptionFunc func(c *configManager)

func WithSecretKey

func WithSecretKey(secret []byte) OptionFunc

type Response

type Response struct {
	Value []byte
	Error error
}