Docker container orchestration platform
Java Shell Other
Switch branches/tags
Clone or download
caipre Fix cli help text for `create --volume` flag (#1223)
This commit corrects some confusion resulting from the misordering of
volume path arguments. This was first reported in [this issue][0], then
a "fix" was [applied here][1]. In fact, as reported in [this issue][2],
the documentation from that fix was incorrect.

The `--volume` flag is inconsistent with how job configuration files are
parsed; at least the documentation will be correct.

For `--volume`, left is host source, right is container path:
https://github.com/spotify/helios/blob/dbcbe17d1a2a2da650c09deb92b1dc7f58143464/helios-tools/src/main/java/com/spotify/helios/cli/command/JobCreateCommand.java#L481-L483

For job config files, left is container path, right is host source:
https://github.com/spotify/helios/blob/dbcbe17d1a2a2da650c09deb92b1dc7f58143464/helios-services/src/main/java/com/spotify/helios/agent/TaskConfig.java#L324-L357

[0]: #486
[1]: #503
[2]: #789
Latest commit 7d893de Jul 18, 2018
Permalink
Failed to load latest commit information.
.circleci Update config.yml Jul 3, 2018
.mvn/wrapper Adds maven wrapper Apr 18, 2017
bin Adds environment variable to allow for passing in jvm args to helios … Jun 16, 2017
docs Relax volume validation requirements (#1222) Jul 11, 2018
helios-client Relax volume validation requirements (#1222) Jul 11, 2018
helios-integration-tests Removes uses of deprecated 'HostAndPort.getHostText' method. Feb 21, 2018
helios-service-registration Add equals(), hashCode(), and toString() to ServiceRegistration Dec 15, 2017
helios-services Relax volume validation requirements (#1222) Jul 11, 2018
helios-system-tests Relax volume validation requirements (#1222) Jul 11, 2018
helios-testing-common replace deprecated guava Throwable methods Oct 26, 2017
helios-testing Removes uses of deprecated 'HostAndPort.getHostText' method. Feb 21, 2018
helios-tools Fix cli help text for `create --volume` flag (#1223) Jul 18, 2018
solo [solo] Disable unbound using IPv6; we don't need it May 3, 2017
src/deb Include new docker-ce as possible dependency Nov 10, 2017
.gitignore shade/relocate dns dependencies of helios-client Oct 28, 2015
.test-excludes Further parallelize the CircleCI build Feb 6, 2015
AUTHORS Add Matt Brown to list of devs Nov 19, 2015
CONTRIBUTING.md Update CONTRIBUTING.md Aug 21, 2015
LICENSE opensource Jun 6, 2014
NOTICE opensource Jun 6, 2014
README.md remove old documentation on how to install helios Jun 19, 2018
circle.sh migrating from circleci 1.0 to 2.0 Jul 3, 2018
codecov.yml fix small typo in codecov.yml Jun 1, 2016
create_artifacts.sh helios-solo: Create and collect helios-solo.zip Mar 9, 2015
findbugs-exclude.xml Run code reformatting tool and optimize imports (#1132) Aug 1, 2017
mvnw Adds maven wrapper Apr 18, 2017
mvnw.cmd Adds maven wrapper Apr 18, 2017
pom.xml Upgrade docker-client dep from 8.9.0 to 8.11.3 May 21, 2018
pubkey.asc [deploy] fix so it properly can deploy to sonatype Aug 8, 2014

README.md

Helios Circle CI Slack Status

Status: Bug-fix only

This project was created when there were no open source container orchestration frameworks. Since the advent of Kubernetes and other tools, we've stopped adding new features to helios and are now switching to other tools like Kubernetes. This project will no longer have new features or accept PRs for new features. We will continue to accept bug fixes, however.

Helios is a Docker orchestration platform for deploying and managing containers across an entire fleet of servers. Helios provides a HTTP API as well as a command-line client to interact with servers running your containers. It also keeps a history of events in your cluster including information such as deploys, restarts and version changes.

Usage Example

# Create an nginx job using the nginx container image, exposing it on the host on port 8080
$ helios create nginx:v1 nginx:1.7.1 -p http=80:8080

# Check that the job is listed
$ helios jobs

# List helios hosts
$ helios hosts

# Deploy the nginx job on one of the hosts
$ helios deploy nginx:v1 <host>

# Check the job status
$ helios status

# Curl the nginx container when it's started running
$ curl <host>:8080

# Undeploy the nginx job
$ helios undeploy -a nginx:v1

# Remove the nginx job
$ helios remove nginx:v1

Getting Started

If you're looking for how to use Helios, see the docs directory. Most probably the User Manual is what you're looking for.

If you're looking for how to download, build, install and run Helios, keep reading.

Prerequisities

The binary release of Helios is built for Ubuntu 14.04.1 LTS, but Helios should be buildable on any platform with at least Java 8 and a recent Maven 3 available.

Other components that are required for a helios installation are:

Install & Run

Quick start for local usage

Use helios-solo to launch a local environment with a Helios master and agent.

First, ensure you have Docker installed locally. Test this by making sure docker info works. Then install helios-solo:

# add the helios apt repository
$ sudo apt-key adv --keyserver hkp://keys.gnupg.net:80 --recv-keys 6F75C6183FF5E93D
$ echo "deb https://dl.bintray.com/spotify/deb trusty main" | sudo tee -a /etc/apt/sources.list.d/helios.list

# install helios-solo on Debian/Ubuntu
$ sudo apt-get update && sudo apt-get install helios-solo

# install helios-solo on OS X
$ brew tap spotify/public && brew install helios-solo

Once you've got it installed, bring up the helios-solo cluster:

# launch a helios cluster in a Docker container
$ helios-up

# check if it worked and the solo agent is registered
$ helios-solo hosts

You can now use helios-solo as your local Helios cluster. If you have issues, see the detailed helios-solo documentation.

Production on Debian, Ubuntu, etc.

Prebuilt Debian packages are available for production use. To install:

# add the helios apt repository
$ sudo apt-key adv --keyserver hkp://keys.gnupg.net:80 --recv-keys 6F75C6183FF5E93D
$ echo "deb https://dl.bintray.com/spotify/deb trusty main" | sudo tee -a /etc/apt/sources.list.d/helios.list

# install Helios command-line tools
$ sudo apt-get install helios

# install Helios master (assumes you have zookeeperd installed)
$ sudo apt-get install helios-master

# install Helios agent (assumes you have Docker installed)
$ sudo apt-get install helios-agent

Note that the Helios master and agent services both try to connect to ZooKeeper at localhost:2181 by default. We recommend reading the Helios configuration & deployment guide before starting a production cluster.

Manual approach

The launcher scripts are in bin/. After you've built Helios following the instructions below, you should be able to start the agent and master:

$ bin/helios-master &
$ bin/helios-agent &

If you see any issues, make sure you have the prerequisites (Docker and Zookeeper) installed.

Build & Test

First, make sure you have Docker installed locally. If you're using OS X, we recommend using docker-machine.

Actually building Helios and running its tests should be a simple matter of running:

$ mvn clean package

For more info on setting up a development environment and an introduction to the source code, see the Developer Guide.

How it all fits together

The helios command line tool connects to your helios master via HTTP. The Helios master is connected to a Zookeeper cluster that is used both as persistent storage and as a communications channel to the agents. The helios agent is a java process that typically lives on the same host as the Docker daemon, connecting to it via a Unix socket or optionally TCP socket.

Helios is designed for high availability, with execution state being confined to a potentially highly available Zookeeper cluster. This means that several helios-master services can respond to HTTP requests concurrently, removing any single point of failure in the helios setup using straight forward HTTP load balancing strategies.

Production Readiness

We at Spotify are running Helios in production (as of October 2015) with dozens of critical backend services, so we trust it. Whether you should trust it to not cause smoking holes in your infrastructure is up to you.

Why Helios?

There are a number of Docker orchestration systems, why should you choose Helios?

  • Helios is pragmatic. We're not trying to solve everything today, but what we have, we try hard to ensure is rock-solid. So we don't have things like resource limits or dynamic scheduling yet. Today, for us, it has been more important to get the CI/CD use cases, and surrounding tooling solid first. That said, we eventually want to do dynamic scheduling, composite jobs, etc. (see below for more). But what we provide, we use (i.e. we eat our own dogfood), so you can have reasonable assurances that anything that's been in the codebase for more than a week or two is pretty solid as we release frequently (usually, at least weekly) into production here at Spotify.

  • Helios should be able to fit in the way you already do ops. Of the popular Docker orchestration frameworks, Helios is the only one we're aware of that doesn't have anything much in the way of system dependencies. That is, we don't require that you run in AWS or GCE, etc. We don't require a specific network topology. We don't require you run a specific operating system. We don't require that you're using Mesos. Our only requirement is that you have a ZooKeeper cluster somewhere and a JVM on the machines which Helios runs on. So if you're using Puppet, Chef, etc., to manage the rest of the OS install and configuration, you can still continue to do so with whatever Linux OS you're using.

  • Don't have to drink all the Kool-Aid. Generally, we try to make it so you only have to take the features you want to use, and should be able to ignore the rest. For example, Helios doesn't prescribe a discovery service: we happen to provide a plugin for SkyDNS, and we hear that someone else is working on one for another service, but if you don't want to even use a discovery service, you don't have to.

  • Scalability. We're already at hundreds of machines in production, but we're nowhere near the limit before the existing architecture would need to be revisited. Helios can also scale down well in that you can run a single machine instance if you want to run it all locally.

Other Software You Might Want To Consider

Here are a few other things you probably want to consider using alongside Helios:

  • docker-gc Garbage collects dead containers and removes unused images.
  • helios-skydns Makes it so you can auto register services in SkyDNS. If you use leading underscores in your SRV record names, let us know, we have a patch for etcd which disables the "hidden" node feature which makes this use case break.
  • skygc When using SkyDNS, especially if you're using the Helios Testing Framework, can leave garbage in the skydns tree within etcd. This will clean out dead stuff.
  • docker-maven-plugin Simplifies the building of Docker containers if you're using Maven (and most likely Java).

Findbugs

To run findbugs on the helios codebase, do mvn clean compile site. This will build helios and then run an analysis, emitting reports in helios-*/target/site/findbugs.html.

To silence an irrelevant warning, add a filter match along with a justification in findbugs-exclude.xml.

The Nickel Tour

The sources for the Helios master and agent are under helios-services. The CLI source is under helios-tools. The Helios Java client is under helios-client.

The main meat of the Helios agent is in Supervisor.java, which revolves around the lifecycle of managing individual running Docker containers.

For the master, the HTTP response handlers are in src/main/java/com/spotify/helios/master/resources.

Interactions with ZooKeeper for the agent and master are mainly in ZookeeperAgentModel.java and ZooKeeperMasterModel.java, respectively.

The Helios services use Dropwizard which is a bundle of Jetty, Jersey, Jackson, Yammer Metrics, Guava, Logback and other Java libraries.

Community Ideas

These are things we want, but haven't gotten to. If you feel inspired, we'd love to talk to you about these (in no particular order):

  • Host groups
  • ACLs - on jobs, hosts, and deployments
  • Composite jobs -- be able to deploy related containers as a unit on a machine
  • Run once jobs -- for batch jobs
  • Resource specification and enforcement -- That is: restrict my container to X MB of RAM, X CPUs, and X MB disk and perhaps other things like IOPs, network bandwidth, etc.
  • Dynamic scheduling of jobs -- either within Helios itself or as a layer on top
  • Packaging/Config for other Linux distributions such as RedHat, CoreOS, etc.