totem/cluster-orchestrator repository overview

⁠cluster-orchestrator

Provides orchestration for continuous deployment to Totem Cluster.

⁠Development Status

This project is ready to be used in production.

⁠Documentation

Project uses Sphinx for code/api documentation.

⁠Location

The latest code/api documentation can be found at: http://cluster-orchestrator.readthedocs.org/⁠

⁠Building documentation

To generate html documentation, use command:

cd docs && make html

The documentation will be generated in docs/build folder.

⁠Requirements

The project has following dependencies

• python 2.7.x or 3.4.x
• Virtualenv (Recommended)
• Python pip
• etcd 0.4.6
• docker 1.7+ (Required if using docker based deployment)

⁠Dependencies

To install dependencies for the project, run command:

pip install -r requirements.txt

In addition if you are developing on the project, run command:

pip install -r dev-requirements.txt

⁠Testing

Tests are located in tests folder. Project uses nose for testing.

⁠Unit Tests

To run all unit tests , run command :

nosetests -w tests/unit

⁠Running Server

⁠Local

To run the server locally , run command:

python local-server.py

To run celery locally, run command:

python local-celery.py

Once server is up you can access the root api using:
http://localhost:9400⁠

⁠Using Docker

In order to run fully integrated server using docker using latest docker , run command:

sudo docker run -it --rm -h cluster-orchestrator-${USER} --name cluster-orchestrator -v /dev/log:/dev/log -P totem/cluster-orchestrator

⁠Run Configuration (Environment Variables)

⁠Coding Standards and Guidelines

⁠flake8

In order to ensure that code follows PEP8 standards, run command:

flake8 .