Deprecated

This repository is now deprecated. This project will not receive new changes from Rapid7.

Propsd

Propsd does dynamic property management at scale, across thousands of servers and changes from hundreds of developers.

We built Propsd with lessons learned from years of running Conqueso on large scale systems. High availability is achieved by leveraging Amazon S3 to deliver properties and Consul to handle service discovery. Composable layering lets you set properties for an organization, a single server, and everything in between. Plus, flat file storage makes backups and audits a breeze.

So if your Conqueso server's starting to heat up or you just want an audit trail when things change, give Propsd a try.

Features

Propsd allows the user to supply a index file which defines the layering of configuration sources. Propsd expects these configuration sources to be in json format.

Propsd will serve up this layering of configuration (last in, first out) in combination of other services (including a given Consul catalog) via HTTP to any requesting services.

For example, if you have a configuration layering schema like this:

global
|_global.json (foo = global)
|_regional
  |_region-1
    |_region.json (foo = region-1)
    |_service
      |_service_name.json (foo = service_specific)

Propsd would return flattened configuration where the service_name.json value would win (netting a foo value of service_specific).

Propsd can also consume from various source locations. This ranges from a Consul catalog, to local files, to remote S3 buckets. This feature helps the user package once and let the configuration source location contain the differences between environments. Said another way - with Propsd, you won't find yourself repackaging your software in order to move it through your environments.

Propsd will regularly inspect and reload these configuration settings, include new layers, etc. - no restarts of Propsd required.

Usage

See the getting started guide for help installing, configuring, and using Propsd.

Development

To run Propsd locally without dependencies on the AWS Instance Metadata Service or AWS S3, you can run local test versions of both. Currently these services are only tested on OS X.

The services listed below are wrapped up in an npm task which allows you to get up and running quickly. Simply clone the repository, run npm install and run npm run dev-server. That's it!

Metadata Service

To run the test metadata server:

npm run metadata-server

The server will listen on http://127.0.0.1:8080. It can be used in the same way that you would use the AWS Instance Metadata Service (e.g. curl http://127.0.0.1:8080/latest/meta-data/ami-id). To specify the metadata service host and port that Propsd will use modify the config file:

{
  ...
  "metadata": {
    "host": "127.0.0.1:8080"
  }
  ...
}

S3 Server

To run the test S3 server:

npm run s3-server -- -d <data directory>

The -d or --data argument is required. If you need to specify different server options you can view the S3 server help by running npm run s3-server -- --help.

Sample data ships with the Propsd project for the test suite to use but the same data can be served from the test server as well. Run the following command to start with test data:

npm run s3-server -- -d test/data/s3

This will start the test server and serve S3 objects from the test/data/s3 directory. Because of some peculiarities in the library being used for the server, you cannot live-edit the test data. Instead, you must shut down the server, edit the data, then restart it.

The bucket the objects are served from is propsd-<final directory in path> and the endpoint is the server IP address. So, for example, if you use the provided test data, the relevant section of the config file would be:

{
  ...
  "index": {
    "endpoint": "http://127.0.0.1:4569",
     "path": "index.json",
     "interval": 30000
  }
  ...
}

If an endpoint key is provided, the S3 source and it's underlying client will assume that you are serving data from another location and will ignore the region key, if provided.

Releasing

To cut a release do the following:

Bump the version
Build and upload a package
Create a new release on github.com

This can be accomplished by running the following commands:

$ npm version minor
$ bundle exec rake default

To be able to create a new release on github.com, you must have the following environment variables set:

GITHUB_CLIENT_ID
GITHUB_CLIENT_TOKEN

and the user and token must have the appropriate permissions in this repository.

rapid7/propsd