README
¶
Roster: A library for simple service discovery using Dynamodb for Golang
Instead of having to manage a separate distributed key store like etcd or ZooKeeper, leverage AWS's own Dynamodb so you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.
As the only dependency is Dynamodb, it has the added benefit of allowing service discovery between applications running on EC2 and dockerized applications running within ECS.
Another service discovery tool...why??
Wanting to leverage as much of the managed AWS services as possible - less to go wrong (hopefully). Also a good exercise in using the AWS SDK for Go - there's not many examples out there using Dyanamodb from Go using the offical SDK, so seemed like a good project to try it out.
Requirements
- Go 1.5 or above
- AWS credentials setup as per AWS SDK documentation. It seems the Go SDK needs credentials even for 100% local access; however these can be dummy values (see the example Docker Compose yml file.)
Usage
Examples
Within the examples folder there is an example echo client and server that demonstrate basic registry and discovery. Ensuring you have Docker Compose installed, simply run docker-compose up. This creates 1 client and 2 instances of the server service - when one of these servers is stopped, the client should remain operational and shouldn't drop any requests.
Using a local Dynamodb instance for development
The easiest way to get a local instance of Dynamodb running is to pull down this docker image. Then the following steps (assumes Docker Machine is being used with default name):
docker pull tutum/dynamodbdocker run -d -p 8000:8000 tutum/dynamodb- 'export DYNAMODB_PORT=http://$(docker-machine ip default):8000'
- Run your Go app.
Contributing
This is very much experimental at present...so please feel free to contribute any bugs (and even better PR's with fixes!)
Installation
- Clone the repository
- Install Glide which is used to handle vendoring and dependency management
- Install dependencies
$ glide install
Running tests
go test . will run tests. By default the tests will connect to the Amazon hosted Dynamodb in the default region. You can override the region by setting AWS_REGION environment variable as per the AWS SDK. Also if the DYNAMODB_PORT environment variable is set, tests will be run against the local dynamodb instance.
Documentation
¶
Index ¶
Constants ¶
const ( HeartbeatInterval = 1000 * time.Millisecond ServiceTTL = 5 )
Variables ¶
var ( ErrServiceNotFound = errors.New("roster: No matching service found") ErrLocalIpNotFound = errors.New("roster: No non loopback local IP address could be found") )
var (
ErrRegistryNotActive = errors.New("roster: Registry table has taken longer than expected to reach ACTIVE state")
)
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
Registry *Registry
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(config ClientConfig) *Client
func (*Client) GetLocalIP ¶
Returns the non loopback local IP of the host the client is running on
type ClientConfig ¶
func (ClientConfig) GetConfig ¶
func (cc ClientConfig) GetConfig() *aws.Config
func (ClientConfig) GetRegistryName ¶
func (cc ClientConfig) GetRegistryName() *string
Source Files
Directories