Cherami is a distributed, scalable, durable, and highly available message queue system we developed at Uber Engineering to transport asynchronous tasks.
This repo contains the source code of Cherami server, cross-zone replicator server, and several tools. Your application needs to use the client to interact with the server. The client can be found here.
To get cherami-server:
git clone firstname.lastname@example.org:uber/cherami-server.git $GOPATH/src/github.com/uber/cherami-server
glide to manage Go dependencies. Please make sure
glide is in your PATH before you attempt to build.
- Build the
cherami-serverand other binaries (will not run test):
We need a Cassandra running locally in order to run the integration tests. Please make sure
cqlsh is in
/usr/local/bin, and it can connect to the local Cassandra server.
Run Cherami locally
- Setup the cherami keyspace for metadata:
- The service can be started as follows:
CHERAMI_ENVIRONMENT=local ./cherami-server start all
cherami-server is configured via
config/base.yaml with some parameters overriden by
config/local.yaml. In this config, Cherami is bound to
One can use the CLI to verify if Cherami is running properly:
./cherami-cli --env=prod --hostport=127.0.0.1:4922 create destination /test/cherami
Deploy Cherami as a cluster
Documentation coming soon....
We'd love your help in making Cherami great. If you find a bug or need a new feature, open an issue and we will respond as fast as we can. If you want to implement new feature(s) and/or fix bug(s) yourself, open a pull request with the appropriate unit tests and we will merge it after review.
Note: All contributors also need to fill out the Uber Contributor License Agreement before we can merge in any of your changes.
Interested in learning more about Cherami? Read the blog post: eng.uber.com/cherami
MIT License, please see LICENSE for details.