bixby-sd
v0.0.6
Published
Service discovery components of the Bixby framework.
Downloads
14
Maintainers
Readme
bixby-sd
This suite of components provides service discovery functionality to applications using Bixby.js. Service discovery is the cornerstone of an effective microservices architecture. Each service advertises its capabilities, allowing other services to utilize that functionality when needed.
Install
$ npm install bixby-sd
Usage
To utilize service discovery components, register them with the IoC container.
The standard namespace for these components is sd
.
IoC.use('sd', require('bixby-sd'));
Table of Contents
Components
Registry
exports['@require'] = [ 'sd/registry' ];
The registry component provides a service registry where a service can announce
its capabilities as well as resolve other services. The interface supported by
this component is defined by Registry
.
Support for service registries is pluggable, allowing engineering teams to choose the registry that best meets their requirements. The type of registry to use is determined via configuration settings.
ZooKeeper
Apache ZooKeeper can be used as a service
registry by specifying a zk://
URL in the [sd]
section. The Registry
instance is constructed from the sd-zookeeper
module.
[sd]
url = "zk://127.0.0.1:2181"
etcd
etcd can be used as a service registry by
specifying an etcd://
URL in the [sd]
section. The Registry
instance is
constructed from the sd-etcd
module.
[sd]
url = "etcd://127.0.0.1:4001"
When using etcd, the following settings are also supported:
{integer} [ttl]
- TTL of any announced services, auto updated by heartbeats
Tests
$ make test
License
Copyright (c) 2014 NodePrime, Inc. <http://www.nodeprime.com/>
Copyright (c) 2014 Jared Hanson <http://www.jaredhanson.net/>