• This repository has been archived on 29/Sep/2021
  • Stars
    star
    2,097
  • Rank 20,026 (Top 0.5 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created over 9 years ago
  • Updated about 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Docker container orchestration platform

Helios Circle CI Slack Status Download

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.

Prerequisites

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.

More Repositories

1

luigi

Luigi is a Python module that helps you build complex pipelines of batch jobs. It handles dependency resolution, workflow management, visualization etc. It also comes with Hadoop support built in.
Python
16,893
star
2

annoy

Approximate Nearest Neighbors in C++/Python optimized for memory usage and loading/saving to disk
C++
12,131
star
3

docker-gc

INACTIVE: Docker garbage collection of containers and images
Shell
5,068
star
4

pedalboard

๐ŸŽ› ๐Ÿ”Š A Python library for working with audio.
C++
4,573
star
5

chartify

Python library that makes it easy for data scientists to create charts.
Python
3,404
star
6

dockerfile-maven

MATURE: A set of Maven tools for dealing with Dockerfiles
Java
2,717
star
7

docker-maven-plugin

INACTIVE: A maven plugin for Docker
Java
2,652
star
8

basic-pitch

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection
Python
2,502
star
9

scio

A Scala API for Apache Beam and Google Cloud Dataflow.
Scala
2,485
star
10

web-api-examples

Basic examples to authenticate and fetch data using the Spotify Web API
HTML
1,871
star
11

HubFramework

DEPRECATED โ€“ Spotifyโ€™s component-driven UI framework for iOS
Objective-C
1,864
star
12

apollo

Java libraries for writing composable microservices
Java
1,648
star
13

dh-virtualenv

Python virtualenvs in Debian packages
Python
1,584
star
14

docker-client

INACTIVE: A simple docker client for the JVM
Java
1,428
star
15

docker-kafka

Kafka (and Zookeeper) in Docker
Shell
1,398
star
16

SPTPersistentCache

Everyone tries to implement a cache at some point in their iOS appโ€™s lifecycle, and this is ours.
Objective-C
1,244
star
17

mobius

A functional reactive framework for managing state evolution and side-effects.
Java
1,184
star
18

ruler

Gradle plugin which helps you analyze the size of your Android apps.
Kotlin
1,075
star
19

XCMetrics

XCMetrics is the easiest way to collect Xcode build metrics and improve developer productivity.
Swift
1,052
star
20

sparkey

Simple constant key/value storage library, for read-heavy systems with infrequent large bulk inserts.
C
1,019
star
21

web-api

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web API โžก๏ธ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
RAML
981
star
22

echoprint-codegen

Codegen for Echoprint
C++
948
star
23

snakebite

A pure python HDFS client
Python
859
star
24

heroic

The Heroic Time Series Database
Java
843
star
25

klio

Smarter data pipelines for audio.
Python
813
star
26

XCRemoteCache

Swift
802
star
27

voyager

๐Ÿ›ฐ๏ธ Voyager is an approximate nearest-neighbor search library for Python and Java with a focus on ease of use, simplicity, and deployability.
C++
791
star
28

SPTDataLoader

The HTTP library used by the Spotify iOS client
Objective-C
623
star
29

apps-tutorial

A Spotify App that contains working examples of the use of Spotify Apps API
621
star
30

ios-sdk

Spotify SDK for iOS
Objective-C
590
star
31

postgresql-metrics

Tool that extracts and provides metrics on your PostgreSQL database
Python
580
star
32

JniHelpers

Tools for writing great JNI code
C++
578
star
33

reactochart

๐Ÿ“ˆ React chart component library ๐Ÿ“‰
JavaScript
544
star
34

Mobius.swift

A functional reactive framework for managing state evolution and side-effects [Swift implementation]
Swift
523
star
35

dockerfile-mode

An emacs mode for handling Dockerfiles
Emacs Lisp
505
star
36

threaddump-analyzer

A JVM threaddump analyzer
JavaScript
478
star
37

featran

A Scala feature transformation library for data science and machine learning
Scala
467
star
38

android-sdk

Spotify SDK for Android
HTML
434
star
39

echoprint-server

Server for the Echoprint audio fingerprint system
Java
396
star
40

web-scripts

A collection of base configs and CLI wrappers used to speed up development @ Spotify.
TypeScript
380
star
41

completable-futures

Utilities for working with futures in Java 8
Java
374
star
42

SpotifyLogin

Swift framework for authenticating with the Spotify API
Swift
344
star
43

ratatool

A tool for data sampling, data generation, and data diffing
Scala
332
star
44

fmt-maven-plugin

Opinionated Maven Plugin that formats your Java code.
Java
294
star
45

trickle

A small library for composing asynchronous code
Java
285
star
46

big-data-rosetta-code

Code snippets for solving common big data problems in various platforms. Inspired by Rosetta Code
Scala
283
star
47

pythonflow

๐Ÿ Dataflow programming for python.
Python
279
star
48

coordinator

A visual interface for turning an SVG into XY coรถrdinates.
HTML
278
star
49

styx

"The path to execution", Styx is a service that schedules batch data processing jobs in Docker containers on Kubernetes.
Java
267
star
50

cstar

Apache Cassandra cluster orchestration tool for the command line
Python
252
star
51

netty-zmtp

A Netty implementation of ZMTP, the ZeroMQ Message Transport Protocol.
Java
243
star
52

ios-style

Guidelines for iOS development in use at Spotify
241
star
53

cassandra-reaper

Software to run automated repairs of cassandra
234
star
54

docker-cassandra

Cassandra in Docker with fast startup
Shell
218
star
55

confidence

Python
217
star
56

terraform-gke-kubeflow-cluster

Terraform module for creating GKE clusters to run Kubeflow
HCL
209
star
57

linux

Spotify's Linux kernel for Debian-based systems
C
203
star
58

git-test

test your commits
Shell
200
star
59

dns-java

DNS wrapper library that provides SRV lookup functionality
Java
200
star
60

SPStackedNav

[DEPRECATED] Navigation controller which represents its content in stacks of panes, rather than one at a time
Objective-C
197
star
61

quickstart

A CommonJS module resolver, loader and compiler for node.js and browsers.
JavaScript
193
star
62

spotify-json

Fast and nice to use C++ JSON library.
C++
186
star
63

dbeam

DBeam exports SQL tables into Avro files using JDBC and Apache Beam
Java
179
star
64

flink-on-k8s-operator

Kubernetes operator for managing the lifecycle of Apache Flink and Beam applications.
Go
174
star
65

basic-pitch-ts

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection.
TypeScript
167
star
66

spotify-web-api-ts-sdk

A Typescript SDK for the Spotify Web API with types for returned data.
TypeScript
167
star
67

bazel-tools

Tools for dealing with very large Bazel-managed repositories
Java
163
star
68

lingon

A user friendly tool for building single-page JavaScript applications
JavaScript
161
star
69

dataenum

Algebraic data types in Java.
Java
157
star
70

async-google-pubsub-client

[SUNSET] Async Google Pubsub Client
Java
156
star
71

magnolify

A collection of Magnolia add-on modules
Scala
154
star
72

gcp-audit

A tool for auditing security properties of GCP projects.
Python
154
star
73

spark-bigquery

Google BigQuery support for Spark, SQL, and DataFrames
Scala
154
star
74

flo

A lightweight workflow definition library
Java
146
star
75

folsom

An asynchronous memcache client for Java
Java
142
star
76

zoltar

Common library for serving TensorFlow, XGBoost and scikit-learn models in production.
Java
142
star
77

missinglink

Build time tool for detecting link problems in java projects
Java
140
star
78

should-up

Remove most of the "should" noise from your tests
JavaScript
139
star
79

android-auth

Spotify authentication and authorization for Android. Part of the Spotify Android SDK.
HTML
138
star
80

proto-registry

An implementation of the Protobuf Registry API
TypeScript
137
star
81

futures-extra

Java library for working with Guava futures
Java
134
star
82

annoy-java

Approximate nearest neighbors in Java
Java
134
star
83

spydra

Ephemeral Hadoop clusters using Google Compute Platform
Java
132
star
84

docker-stress

Simple docker stress test and monitoring tools
Python
124
star
85

spotify-tensorflow

Provides Spotify-specific TensorFlow helpers
Python
120
star
86

crtauth

a public key backed client/server authentication system
Python
119
star
87

redux-location-state

Utilities for reading & writing Redux store state to & from the URL
JavaScript
117
star
88

sparkey-java

Java implementation of the Sparkey key value store
Java
113
star
89

rspec-dns

Easily test your DNS with RSpec
Ruby
108
star
90

web-playback-sdk

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web Playback SDK โžก๏ธ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
108
star
91

ffwd-ruby

An event and metrics fast-forwarding agent.
Ruby
106
star
92

spotify-web-playback-sdk-example

React based example app that creates a new player in Spotify Connect to play music from in the browse using Spotify Web Playback SDK.
JavaScript
105
star
93

gimme

Creating time bound IAM Conditions with ease and flair
Python
103
star
94

realbook

Easier audio-based machine learning with TensorFlow.
Python
100
star
95

super-smash-brogp

Sends and withdraws BGP prefixes for fun.
Python
98
star
96

github-java-client

A Java client to Github API
Java
98
star
97

noether

Scala Aggregators used for ML Model metrics monitoring
Scala
91
star
98

lighthouse-audit-service

TypeScript
89
star
99

python-graphwalker

Python re-implementation of the graphwalker testing tool
Python
89
star
100

spotify-js-challenge

JavaScript
86
star