https://github.com/github/multibinder

multibinder is a tiny ruby server that makes writing zero-downtime-reload services simpler.
https://github.com/github/multibinder

Last synced: 9 days ago
JSON representation

multibinder is a tiny ruby server that makes writing zero-downtime-reload services simpler.

• Host: GitHub
• URL: https://github.com/github/multibinder
• Owner: github
• License: mit
• Archived: true
• Created: 2015-12-07T22:32:06.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-23T00:33:22.000Z (over 6 years ago)
• Last Synced: 2024-09-30T00:06:05.975Z (4 months ago)
• Language: Shell
• Homepage:
• Size: 33.2 KB
• Stars: 237
• Watchers: 288
• Forks: 16
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-repositories - github/multibinder - multibinder is a tiny ruby server that makes writing zero-downtime-reload services simpler. (Shell)

README

        
### multibinder

multibinder is a tiny ruby server that makes writing zero-downtime-reload services simpler. It accepts connections on a UNIX domain socket and binds an arbitrary number of LISTEN sockets given their ip+port combinations. When a bind is requested, the LISTEN socket is sent over the UNIX domain socket using ancillary data. Subsequent identical binds receive the same LISTEN socket.

multibinder runs on its own, separate from the daemons that use the sockets. multibinder can be re-exec itself to take upgrades by sending it a `SIGUSR1` - existing binds will be retained across re-execs.

#### Server usage

After installing multibinder, you can run the multibinder daemon:

```

bundle exec multibinder /path/to/control.sock

```

#### Client usage

The multibinder library retrieves a socket from a local multibinder server, communicating over the socket you specify in the `MULTIBINDER_SOCK` environment variable (which has to be the same as specified when running multibinder, and the user must have permission to access the file).

```ruby

require 'multibinder'

server = MultiBinder.bind '127.0.0.1', 8000

# use the server socket

# ... server.accept ...

```

The socket has close-on-exec disabled and is ready to be used in Ruby or passed on to a real service like haproxy via spawn/exec. For an example of using multibinder with haproxy (there are a couple of tricks), see [the haproxy test shim](https://github.com/theojulienne/multibinder/blob/master/test/haproxy_shim.rb).