bosh-registry

BOSH Registry

This is an experimental BOSH Registry Client and Server.

Disclaimer

This is NOT presently a production ready BOSH Registry. This is a work in progress. It is suitable for experimentation and may not become supported in the future.

BOSH Registry Client

For usage and examples see the Godoc.

BOSH Registry Server

Installation

Using the standard go get:

$ go get github.com/frodenas/bosh-registry/main

Usage

Create a configuration file:

{
  "server": {
    "protocol": "http",
    "address": "0.0.0.0",
    "port": 25777,
    "username": "admin",
    "password": "admin",
    "tls": {
      "_comment": "TLS options only apply when using HTTPS protocol",
      "certfile": "./test/assets/public.pem",
      "keyfile": "./test/assets/private.pem",
      "cacertfile": "./test/assets/ca.pem"
    }
  },
  "store": {
    "adapter": "bolt",
    "options": {
      "dbfile": "registry.db"
    }
  }
}

Run the registry using the previously created configuration file:

$ bosh-registry -configFile="Path to configuration file"

Docker

If you want to run the BOSH Registry on a Docker container, you can use the frodenas/bosh-registry Docker image.

$ docker run -d --name bosh-registry -p 25777:25777 frodenas/bosh-registry

Caveats

• The server has only support for the bolt (a low-level key/value database) store adapter. The store model is extensible, so contributions to add additional store adapters will be very welcomed.

• The server only authenticates clients (based on credentials) on PUT and DELETE requests. The Ruby BOSH Registry performs also IP validation on GET requests, this doesn't happen in this registry.

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

• by using alpha, beta, and prerelease versions
• by reporting bugs
• by suggesting new features
• by writing or editing documentation
• by writing specifications
• by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
• by refactoring code
• by closing issues
• by reviewing patches

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issue by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

1. Fork the project.
2. Create a topic branch.
3. Implement your feature or bug fix.
4. Commit and push your changes.
5. Submit a pull request.

Copyright

Copyright (c) 2015 Ferran Rodenas. See LICENSE for details.