Chiminey Installation Guide¶
This document describes how to install a Chiminey platform via Docker, which is an automatic software deployment tool.
Requirements¶
Docker 1.7+ is needed. Follow the links below to install docker on your machine.
Mac OS X and Windows¶
Here, we create a virtual machine that runs docker.
- Download Docker Toolbox from https://www.docker.com/toolbox.
- When the download is complete, open the installation dialog box by double-clicking the downloaded file.
- Follow the on-screen prompts to install the Docker toolbox. You may be prompted for password just before the installation begins. You need to enter your password to continue.
- When the installation is completed, press
Close
to exit. - Verify that
docker-engine
anddocker-compose
are installed correctly.
- Open Docker Quickstart Terminal from your application folder. The resulting output looks like the following:
Run docker engine:
$ docker run hello-world
You will see a message similar to the one below:
Unable to find image ’hello-world:latest’ locally latest: Pulling from library/hello-world 03f4658f8b78: Pull complete a3ed95caeb02: Pull complete Digest: sha256:8be990ef2aeb16dbcb92... Status: Downloaded newer image for hello-world:latest Hello from Docker. This message shows that your installation appears to be working correctly. ...Run docker-compose:
$ docker-compose --version
The output will be
docker-compose version x.x.x, build xxxxxxx
For users with an older Mac, you will get
Illegal instruction: 4
. This error can be fixed by upgrading docker-compose:$ pip install --upgrade docker-compose
Linux¶
Docker, specifically docker-engine
and docker-compose
, needs to be installed directly on your linux-based OS. Refer to the Docker online documentation to install the two packages:
- Install docker-engine
- Install docker-compose
Installation¶
For Mac OS X and Windows users, open Docker Quickstart Terminal. For linux-based OS users, login to your machine and open a terminal.
Check if
git
is installed. Typegit
on your terminal.If git is installed, the following message will be shown:
usage: git [--version] [--help] [-C <path>] .. [--exec-path[=<path>]] [--html-path] [... [-p|--paginate|--no-pager] [--no- ... [--git-dir=<path>] [--work-tree=<path>]... <command> [<args>] ...
If git is not installed, you will see
git: command not found
. Download and installgit
from http://git-scm.com/download
Clone the
docker-chiminey
source code from http://github.com.au:$ git clone https://github.com/chiminey/docker-chiminey.git
Change your working directory:
$ cd docker-chiminey
Setup a self-signed certificate. You will be prompted to enter country code, state, city, and etc:
$ sh makecert
Deploy the Chiminey platform:
$ docker-compose up -d
Verify Chiminey was deployed successfully.
Retrieve the IP address of your machine
- For Mac and Windows users, type
env | grep DOCKER_HOST
. The expected output has a formatDOCKER_HOST=tcp://IP:port
, for example.DOCKER_HOST=tcp://192.168.99.100:2376
. Thus, your IP address is 192.168.99.100.- For linux users, the command
ifconfig
prints your our machine’s IP address.Open a browser and visit the Chiminey portal at IP, in our example, http://192.168.99.100. After a while, the Chiminey portal will be shown.
Configuration¶
Here, we will configure the Chiminey deployment by creating a superuser, initialising the database, and signing up a regular user.
For Mac OS X and Windows users, open Docker Quickstart Terminal. For linux-based OS users, login to your machine and open a terminal.
Change to
docker-chiminey
directory:$ cd docker-chiminey
Create a superuser:
$ ./createsuper
Initialise the database:
$ ./init
Create a regular user:
$ ./createuser
Verify the Chiminey platform is configured correctly.
- Open a browser and visit the Chiminey portal.
- Login with your regular username and password. After successful login, you will be redirected to a webpage that displays a list of jobs. Since no jobs are run yet, the list is empty.
Smart Connectors Activation¶
When a Chiminey platform is deployed, each smart connector <smart_connector_desc>, which is the core concept within Chiminey that enables endusers to perform complex computations on distributed computing facilities with minimal effort, needs to be explicitly activated.
For Mac OS X and Windows users, open Docker Quickstart Terminal. For linux-based OS users, login to your machine and open a terminal.
Change to
docker-chiminey
directory:$ cd docker-chiminey
List all available smart connectors:
$ ./listsc NAME: DESCRIPTION hrmclite: Hybrid Reverse Monte Carlo without PSD randnum: Randnum generator, with timestamp wordcount: Counting words via Hadoop
Activate a smart connector. The syntax to activate a smart connector is ./activatesc smart-connector-name. Thus, activate randnum smart connector as follows:
$ ./activatesc randnum
Verify the smart connector is successfully activated.
- Open a browser and visit the Chiminey portal.
- Login with your regular username and password.
- Click Create Job. randnum will appear under the Smart Connectors list.
See also
- https://www.djangoproject.com/
- The Django Project
- https://docs.djangoproject.com/en/1.4/intro/install/
- Django Quick Install Guide