seed_stack

Meta-module for deploying the Seed Stack

Praekelt Foundation

praekeltfoundation

16,530 downloads

6,494 latest version

5.0 quality score

Version information

  • 0.10.1 (latest)
  • 0.10.0
  • 0.9.8
  • 0.9.7
  • 0.9.6
  • 0.9.5
  • 0.9.4
  • 0.9.3
  • 0.9.2
  • 0.9.1
  • 0.9.0
  • 0.8.0
  • 0.7.0
  • 0.6.2
  • 0.6.1
  • 0.6.0
  • 0.5.0
  • 0.4.0
  • 0.3.0
  • 0.2.3
  • 0.2.2
  • 0.2.1
released Jun 3rd 2016
This version is compatible with:
  • Puppet Enterprise 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=3.4.0
  • Ubuntu

Start using this module

Documentation

praekeltfoundation/seed_stack โ€” version 0.10.1 Jun 3rd 2016

puppet-seed_stack

Puppet meta-module for deploying the Seed Stack. This module uses other Puppet modules to install all the basic parts of Praekelt Foundation's Seed Stack.

The module installs and configures:

This module is not designed for complete configurability of the stack and instead takes an opinionated approach to setting up all the parts of the system to work together. This module should be the quickest way to set up a Seed Stack cluster (or even a standalone development host).

To try out Seed Stack, a Vagrant Box is available here.

This module was designed for use on Ubuntu 14.04.

Work in progress

This module is still a work in progress. We are waiting on new releases of a few of its dependencies. Some things are not done as nicely as they could be yet. There are no tests.

Usage

A Seed Stack node can either be a controller (i.e. a Mesos master), a worker (a Mesos slave), or a combination of the two.

Controller

The seed_stack::controller class is responsible for configuring a Seed Stack controller. For a full list of available parameters, see the class source.

class { 'seed_stack::controller':
  advertise_addr   => '192.168.0.2',
  controller_addrs => ['192.168.0.2'],
}

Worker

The seed_stack::worker class is responsible for configuring a Seed Stack worker. For a full list of available parameters, see the class source.

class { 'seed_stack::worker':
  advertise_addr   => '192.168.0.3',
  controller_addrs => ['192.168.0.2'],
}

Combination controller/worker

A node can be both a controller and a worker. This is useful for single-node setups.

class { 'seed_stack::controller':
  advertise_addr    => $ipaddress_eth0,
  controller_addrs  => [$ipaddress_eth0],
  controller_worker => true,
}
class { 'seed_stack::worker':
  advertise_addr    => $ipaddress_eth0,
  controller_addrs  => [$ipaddress_eth0],
  controller_worker => true,
}

NOTE: For combination controller/workers it is necessary to set controller_worker => true for both the seed_stack::controller class and the seed_stack::worker class so that the two classes do not conflict.

External load balancers and routers

We use Nginx to load balance and route between containers. Sometimes it is useful to do this outside of the Mesos cluster itself. For instance, an external host could be the load balancer for a web service or some service running on the host could need to be routed to containers directly.

Nginx is dynamically configured using Consul Template in these cases. First, set that up:

class { 'seed_stack::template_nginx':
  consul_address => '192.168.0.5', # Consul address for Consul Template to connect to
}

Then you can set up either set up a load balancer or a router (or both):

include seed_stack::load_balancer
include seed_stack::router

Consul DNS

It's often useful to use Consul's DNS for service discovery on nodes that aren't controllers or workers. For example, a database node could advertise it's service to other nodes using Consul. To do this, use the seed_stack::consul_dns class. The class needs a few parameters so that it knows how to join the Consul cluster:

class { 'seed_stack::consul_dns':
  advertise_addr => $ipaddress_eth0, # Address to advertise for services on this node
  join           => ['10.215.32.11', '10.215.32.12'], # List of any Consul nodes already in the cluster
}

consul::service { 'postgresql':
  port   => 5432,
  checks => [{
    script   => '/usr/bin/pg_isready',
    interval => '30s',
  }],
}

After the above example is applied, the address postgresql.service.consul is available in the Consul cluster and will point to the node's advertise address. For full documentation on all the configuration parameters available for Consul, see the manifest source.

Upstream modules

We make use of quite a few Puppet modules to manage all the various pieces of software that make up Seed Stack. See the metadata file for a complete listing with version information.

Firstly, we wrote some modules ourselves:

Then there are some 3rd party modules:

Java 8

Java 8 is a dependency of Marathon version 0.12.0+. Ubuntu 14.04 does not have a package for this in the standard repositories. seed_stack::controller will install Oracle Java 8 from the WebUpd8 PPA. This can be disabled by passing install_java => false.

Note that Java is also a dependency of Mesos and Zookeeper. If you are managing your own Java installation you should ensure that Java is installed before any of the packages that depend on it so as to prevent multiple versions of Java being installed.

Default package versions

The package versions can be seen in the params class source. All of these versions can be adjusted using parameters in the controller and worker classes. These versions are reasonably well-tested and known to work together.

Package Version
Mesos 0.28.1
Marathon 1.1.1
Zookeeper System
Docker 1.11.1
Consul 0.6.4
Consular 1.2.1
Consul Template 0.14.0
Nginx System