Skip to main content

Manage a small OAR developpement cluster with docker.

Project description

Build your own OAR cluster with docker
--------------------------------------

oar-docker is a set of docker images especially configured for deploying
your own OAR cluster. The main idea is to have a mini development cluster with
a frontend, a server and some nodes that launch in just a few seconds on a
simple laptop.


Why use oar-docker ?
--------------------

Various case scenarios may affect you:
- Quickly test OAR on a cluster
- Gain time: a ten-node cluster (or more) is launched in just a
few seconds and is cleaned in less than a second.
- Save resources: docker allows the user to pool the node between
various systems, resource utilization is thus considerably reduced.
- Synced volume : allowing you to continue working on your host machine, but
use the resources in the guest machine to compile or run your project.


Demo
----

.. image:: docs/screenshot.png
:align: center
:target: https://asciinema.org/a/8353


Installation
------------

You can install, upgrade, uninstall oar-docker with these commands::

$ pip install oar-docker
$ pip install --upgrade oar-docker
$ pip uninstall oar-docker

Or from git (last development version)::

$ pip install git+https://github.com/oar-team/oar-docker.git

Or if you already pulled the sources::

$ pip install path/to/sources

Or if you don't have pip::

$ easy_install oar-docker

Usage
-----

::

Usage: oardocker [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Manage a small OAR developpement cluster with docker.

Options:
--workdir DIRECTORY Changes the folder to operate on.
--docker-host TEXT
--help Show this message and exit.

Commands:
build Build base images
clean Remove all stopped containers and untagged...
destroy Stop containers and remove all images
init Initialize a new environment.
install Install and configure OAR from src
logs Fetch the logs of all containers.
ssh Connect to machine via SSH.
ssh-config Output OpenSSH valid configuration to connect...
start Start the cluster
status Output status of the cluster
stop Stop the running cluster


Security
--------

oar-docker is a development project and a testing one. It is in no way secure.
Besides, the private ssh key used is also insecured since it is public (you can
find it in the sources).


Related resources
-----------------

- `A minimal Ubuntu base image modified for Docker-friendliness`_
- `Got a Minute? Spin up a Spark cluster on your laptop with Docker`_


oar-docker CHANGELOG
====================

version 0.1.3
=============

Released on Sep 10 2014

- Added `oar reset` cmd to restart containers
- Added a better comments about oardocker images with git information
- Used default job_resource_manager script (from oar sources)
- Mount the host cgroup path in the containers (default path is /sys/fs/cgroup)
- Removed stopped containers from ssh_config
- Remove dnsmasq and mount a custom /etc/hosts for the nodes (need docker >= 1.2.0)


version 0.1.2
=============

Released on Sep 16th 2014

- Keep compatible with older versions of git
- Don't name the containers
- Mounting OAR src as Copy-on-Write directory with unionfs-fuse
- Stopped installation when container failed during ``oardocker install``
- Added option to print version
- Allow ssh connection with different user

version 0.1.1
=============

Released on Sep 11th 2014

- Minor bug fixes

version 0.1
===========

Released on Sep 11th 2014

Initial public release of oar-docker

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oar-docker-0.1.3.tar.gz (45.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page