Skip to content

Commit

Permalink
Mention mailing-list in the front-page README.
Browse files Browse the repository at this point in the history
  • Loading branch information
riccardomurri committed Dec 4, 2015
2 parents 850fd71 + 9ebfbdc commit 9c40d15
Showing 1 changed file with 34 additions and 30 deletions.
64 changes: 34 additions & 30 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
========================================================================
Elasticluster |trevis-ci-status|
ElastiCluster |trevis-ci-status|
========================================================================

.. |trevis-ci-status| image:: https://travis-ci.org/gc3-uzh-ch/elasticluster.svg?branch=master

.. This file follows reStructuredText markup syntax; see
http://docutils.sf.net/rst.html for more information
.. |trevis-ci-status| image:: https://travis-ci.org/gc3-uzh-ch/elasticluster.svg?branch=master


`Elasticluster`_ aims to provide a user-friendly command line tool to
`ElastiCluster`_ aims to provide a user-friendly command line tool to
create, manage and setup computing clusters hosted on cloud
infrastructures (like `Amazon's Elastic Compute Cloud EC2`_ or `Google
Compute Engine`_)
or a private `OpenStack`_ cloud). Its main goal
is to get your own private cluster up and running with just a few commands; a `YouTube video`_
demoes the basic features of elasticluster.

This project is an effort of the
`Grid Computing Competence Center`_ at the
`University of Zurich`_, licensed under the
Compute Engine`_) or a private `OpenStack`_ cloud). Its main goal is
to get your own private cluster up and running with just a few
commands; a `YouTube video`_ demoes the basic features of
elasticluster.

Documentation for ElastiCluster is available on the `Read The Docs
<http://elasticluster.readthedocs.org/>`_ website. General discussion
over ElastiCluster's usage, features, and bugs takes also place on the
`elasticluster@googlegroups.com
<https://groups.google.com/forum/#!forum/elasticluster>`_ mailing-list
(only subscribers can post).

This project is an effort of the `Services and Support for Science
IT`_ (S3IT) unit at the `University of Zurich`_, licensed under the
`GNU General Public License version 3`_.

Documentation for elasticluster is available on the `Read The Docs
<http://elasticluster.readthedocs.org/>`_ website

Features
========

`Elasticluster`_ is in active development, but offers the following features at the current state:
`ElastiCluster`_ is in active development, but offers the following features at the current state:

* Simple configuration file to define cluster templates
* Can start and manage multiple independent clusters at the same time
Expand All @@ -43,7 +47,7 @@ Features
* ...or anything that you can install with an `Ansible`_ playbook!
* Grow and shrink a running cluster

`Elasticluster`_ is currently in active development: please use the
`ElastiCluster`_ is currently in active development: please use the
GitHub issue tracker to `file enhancement requests and ideas`_

We appreciate pull requests for new features and enhancements. Please
Expand All @@ -56,33 +60,32 @@ Quickstart
Installing from PyPI
--------------------

`Elasticluster`_ is a `Python`_ program; Python
version 2.6 is required to run it.
`ElastiCluster`_ is a `Python`_ program; Python version 2.6 or 2.7 is
required to run it.

It's quite easy to install `elasticluster` using
`pip`_; the command below is all you
need to install `elasticluster` on your system::
It's quite easy to install `elasticluster` using `pip`_; the command
below is all you need to install `elasticluster` on your system::

pip install elasticluster

If you want to run `elasticluster` from source you have to **install**
`Ansible`_ **first:**

::
`Ansible`_ **first**::

pip install ansible
python setup.py install


Installing the development version from github
----------------------------------------------

The source code of elasticluster is `github`_, if you want to test the
latest development version you can clone the `github elasticluster repository`_.
The source code of elasticluster is on `GitHub`_, if you want to test
the latest development version you should clone the `github elasticluster
repository`_.

You need the ``git`` command in order to be able to clone it, and we
suggest you to use `python virtualenv`_ in order to create a
controlled environment in which you can install elasticluster as
normal user.
normal user.

Assuming you already have ``virtualenv`` installed on your machine,
you first need to create a virtualenv and install `ansible`, which is
Expand All @@ -91,7 +94,7 @@ needed by elasticluster::
virtualenv elasticluster
. elasticluster/bin/activate
pip install ansible

Then you have to download the software. We suggest you to download it
*within* the created virtualenv::

Expand All @@ -100,13 +103,14 @@ Then you have to download the software. We suggest you to download it
cd src
python setup.py install

Now the ``elasticluster`` should be available in your current
Now the ``elasticluster`` command should be available in your current
environment.

.. References
.. _`elasticluster`: http://gc3-uzh-ch.github.io/elasticluster/
.. _`Grid Computing Competence Center`: http://www.gc3.uzh.ch/
.. _`Services and Support for Science IT`: http://www.s3it.uzh.ch/
.. _`University of Zurich`: http://www.uzh.ch
.. _`GC3 Hobbes cloud`: http://www.gc3.uzh.ch/infrastructure/hobbes
.. _`configuration template`: https://raw.github.com/gc3-uzh-ch/elasticluster/master/docs/config.template.ini
Expand All @@ -129,7 +133,7 @@ environment.
.. _`GlusterFS`: http://www.gluster.org/
.. _`Ceph`: http://ceph.com/
.. _`OrangeFS`: http://orangefs.org/
.. _`Ansible`: http://ansible.cc
.. _`Ansible`: http://ansible.cc
.. _`file enhancement requests and ideas`: https://github.com/gc3-uzh-ch/elasticluster/issues

.. _`Python`: http://www.python.org
Expand Down

0 comments on commit 9c40d15

Please sign in to comment.