Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.

Latest commit

 

History

History
85 lines (53 loc) · 3.74 KB

README.md

File metadata and controls

85 lines (53 loc) · 3.74 KB
Raw

Mesos-DNS Circle CI velocity Coverage Status GoDoc Gitter

Mesos-DNS enables DNS-based service discovery in Apache Mesos clusters.

Architecture Diagram

Compatibility

mesos-N tags mark the start of support for a specific Mesos version while maintaining backwards compatibility with the previous major version.

Installing

The official release binaries are available at Github releases.

Building

Building the master branch from source should always succeed but doesn't provide the same stability and compatibility guarantees as releases.

All branches and pull requests are tested by CircleCI, which also outputs artifacts for Mac OS X, Windows, and Linux via cross-compilation.

You will need Go 1.6 or later to build the project. All dependencies are tracked using godep.

# Install godep
$ go get github.com/tools/godep

# Save new dependencies
$ godep save ./...

# Build
$ go build ./...

Building a release

  1. Cut a branch.
  2. Tag it with the relevant version, and push the tags along with the branch.
  3. If the build doesn't trigger automatically, go to CircleCI, find your branch, and trigger the build.

Making a private build

  1. Fork the repo on Github.
  2. Customize that repo.
  3. Add it to CircleCI. Please note that CircleCI allows for private repositories to be kept, and built in private.
  4. Go to the build steps.

Releasing

  1. Download the artifacts from CircleCI.
  2. Cut a release based on the tag on Github.
  3. Upload the artifacts back to Github. Ensure you upload all the artifacts, including the .asc files.

Code signing

This repo uses code signing. There is an armored, encrypted GPG key in the repo in build/private.key. This file includes the Mesos-DNS GPG signing key. The passphrase for the key is stored in Circle-CI's environment. This makes it fairly difficult to leak both components without detectable maliciousness.

There are only very few users with access to the private key, and they also have access to a revocation certificate in case the private key leaks.

Testing

go test -race ./...

Documentation

The detailed documentation on how to configure, operate and use Mesos-DNS under different scenarios and environments is available at the project's home page.

Contributing

Contributions are welcome. Please refer to CONTRIBUTING.md for guidelines.

Contact

For any discussion that isn't well suited for Github issues, please use our mailing list or our public chat room.

License

This project is licensed under Apache License 2.0.