README
¶
Libswarm
libswarm is a toolkit for composing network services.
It defines a standard interface for services in a distributed system to communicate with each other. This lets you:
- Compose complex architectures from reusable building blocks
- Avoid vendor lock-in by swapping any service out with another
An extensive library of services is included, and you can also write your own using a simple API.
Here are some examples of what you can do with libswarm:
-
Aggregate all your Docker containers across multiple hosts and infrastructure providers, as if they were running on a single host.
-
Bridge your in-house DNS-based service discovery with that new shiny Consul deployment, without getting locked into either.
-
Swap in a new clustering and service discovery system, without changing any application code.
-
Collect logs across an in-house Mesos cluster, a Cloudfoundry deployment and individual servers staggered in 3 different datacenters, forward them to your legacy syslog deployment, then perform custom analytics on them.
-
Simulate your entire service topology in a single process, then scale it out simply by re-arranging adapters.
-
Organize your application as loosely coupled services from day 1, without over-engineering.
Installation
First get the go dependencies:
go get github.com/docker/libswarm/...
Then you can compile swarmd with:
go install github.com/docker/libswarm/swarmd
If $GOPATH/bin is in your PATH, you can invoke swarmd from the CLI.
$ swarmd -h
NAME:
swarmd - Compose distributed systems from lightweight services
USAGE:
swarmd [global options] command [command options] [arguments...]
VERSION:
0.0.1
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--version, -v print the version
--help, -h show help
Built-in services
Docker server
Maintainer: Ben Firshman
This service runs a Docker remote API server, allowing the Docker client and
other Docker tools to control libswarm services. With no arguments, it listens
on port 4243, but you can specify any port you like using tcp://0.0.0.0:9999,
unix:///tmp/docker etc.
Docker client
Maintainer: Aanand Prasad
This service can be used to control a Docker Engine from libswarm services. It takes one argument, the Docker host to connect to. For example: dockerclient tcp://10.1.2.3:4243
SSH tunnel
Help wanted!
Etcd
Help wanted!
Geard
Clayton Coleman
Fork-exec
Solomon Hykes
Mesos
Help wanted!
Shipyard
Brian Goff
Fleet
Help wanted!
Google Compute
Brendan Burns
Rackspace Cloud
John Hopper
Orchard
Maintainer: Aanand Prasad
Control an Orchard host from libswarm. It takes two arguments, an Orchard API token and the name of the Orchard host to control.
Amazon EC2
Aaron Feng
Consul
Help wanted!
OpenStack Nova
Help wanted!
Digital Ocean
Help wanted!
SoftLayer
Help wanted!
ZeroRPC
Help wanted!
Debug
The debug service simply catches all messages and prints them on the terminal for inspection.
Testing libswarm with swarmd
Libswarm ships with a simple daemon which can control services in your distributed system.
Usage example:
Run swarmd without arguments to list available services:
./swarmd
Pass a service name as argument to load it:
./swarmd fakeclient
You can pass arguments to the service, like a shell command:
./swarmd 'dockerserver tcp://localhost:4243'
You can call multiple services. They will be executed in parallel, with the output of each backend connected to the input of the next, just like unix pipelines.
This allows for very powerful composition.
./swarmd 'dockerserver tcp://localhost:4243' 'debug' 'dockerclient unix:///var/run/docker.sock'
Creators
Solomon Hykes
Copyright and license
Code and documentation copyright 2013-2014 Docker, inc. Code released under the Apache 2.0 license. Docs released under Creative commons.
Documentation
¶
Index ¶
- Variables
- func Copy(s Sender, r Receiver) (int, error)
- func Pipe() (Receiver, Sender)
- type Client
- func (c *Client) Attach(name string) (in Receiver, out *Client, err error)
- func (c *Client) Connect() (net.Conn, error)
- func (c *Client) Error(msg string, args ...interface{}) error
- func (c *Client) Get() (string, error)
- func (c *Client) Log(msg string, args ...interface{}) error
- func (c *Client) Ls() ([]string, error)
- func (c *Client) Set(vals ...string) error
- func (c *Client) SetJson(val interface{}) error
- func (c *Client) Spawn(cmd ...string) (out *Client, err error)
- func (c *Client) Start() error
- func (c *Client) Stop() error
- func (c *Client) Watch() (Receiver, error)
- type Message
- type Receiver
- type Sender
- type Server
- func (s *Server) Catchall(h Sender) *Server
- func (s *Server) Close() error
- func (s *Server) OnAttach(h func(name string, ret Sender) error) *Server
- func (s *Server) OnError(h func(...string) error) *Server
- func (s *Server) OnGet(h func() (string, error)) *Server
- func (s *Server) OnLog(h func(...string) error) *Server
- func (s *Server) OnLs(h func() ([]string, error)) *Server
- func (s *Server) OnSpawn(h func(cmd ...string) (Sender, error)) *Server
- func (s *Server) OnStart(h func() error) *Server
- func (s *Server) OnStop(h func() error) *Server
- func (s *Server) OnVerb(v Verb, h Sender) *Server
- func (s *Server) Send(msg *Message) (Receiver, error)
- func (s *Server) Unwrap() libchan.Sender
- type Verb
Constants ¶
This section is empty.
Variables ¶
var NotImplemented = WrapSender(libchan.Repeater(notImplementedMsg.LibchanMessage()))
var Ret = libchan.Ret
var RetPipe = WrapSender(libchan.RetPipe)
Functions ¶
Types ¶
type Message ¶
func (*Message) LibchanMessage ¶
type Receiver ¶
func WrapReceiver ¶
type Sender ¶
type Sender interface {
Send(msg *Message) (Receiver, error)
Close() error
Unwrap() libchan.Sender
}
Source Files
Directories