config

Golang.hr Platform configuration package

Base configuration package for Golang.hr Platform. Package is designed to be used with etcd.

NOTICE: Package under active development. No ETA atm...

Why Etcd?

etcd we will just copy out what they said without much of complications...

etcd is a distributed, consistent key-value store for shared configuration and service discovery, with a focus on being:

Simple: curl'able user facing API (HTTP+JSON)
Secure: optional SSL client cert authentication
Fast: benchmarked 1000s of writes/s per instance
Reliable: properly distributed using Raft

You can see more at etcd github

Key Functionalities

• Configuration manager based on environment and etcd directory.
• Saving and updating configuration key/values directly on etcd instance
• Auto reload configuration once it's changed (watching)

NOTICE: This package wrapper is designed to manage configuration. If you wish to manage roles or anything else you will need to use custom logic. You can retrieve Etcd client by manager.Etcd()

Prerequisites

You will need to have fully functional etcd service setup and accessible by www.

Installation

First you'll have to fetch platform

go get -u github.com/golanghr/platform

than you'll have to include it in your go script

import (
	"github.com/golanghr/platform/config"
)

and than checkout examples :)

Examples

Bellow you can find some useful examples of how to use this package

Example 1 - Initializing struct

manager, err := config.New(map[string]interface{}{
	 // Useful for if you wish to have "sandbox", "production" or any other
	"env": "environment_name",

	// We use it as project name. Or so, golanghr
	"folder": "folder_name",

	// Do we want to auto sync existing configuration from the etcd or not
	"auto_sync": true,

	// The recommended sync interval is 10 seconds to 1 minute, which does
	// not bring too much overhead to server and makes client catch up the
	// cluster change in time.
	"auto_sync_interval": 10 * time.Second,

	"etcd": map[string]interface{}{
		// Etcd API version
		"version":  								  "v2",
		// list of etcd endpoints separated by comma
		"endpoints":                  []string{"127.0.0.1:2379"},
		// Transport is used by the Client to drive HTTP requests. If not
		// provided, DefaultTransport will be used.
		"transport":                  etcdc.DefaultTransport,
		// Username specifies the user credential to add as an authorization header
		"username":                   "",
		// Password is the password for the specified user to add as an authorization header
		// to the request.
		"password":                   "",
		// set timeout per request to fail fast when the target endpoint is unavailable
		"header_timeout_per_request": time.Second,
	},
})

if err != nil {
  panic(err)
}

Example 2 - Enable cURL debugging

This is useful if there are issues with setting or getting keys from Etcd

import (
		etcd "github.com/coreos/etcd/client"
)

etcd.EnablecURLDebug()

License

The MIT License (MIT)

Copyright (c) 2015 Golang Croatia

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.