fig is now deprecated

Change-Id: Idbd010695cd07a3ea1e56021c0a7157141cd0bd6
This commit is contained in:
aviau 2015-04-03 17:53:04 -04:00
parent f05a47ffea
commit 598071592f
4 changed files with 38 additions and 32 deletions

View File

@ -1,12 +1,3 @@
down:
- sudo fig kill
up:
sudo fig up -d
build:
sudo fig build
test: clean
tox

View File

@ -1,4 +1,7 @@
=======
.. role:: bash(code)
:language: bash
======
Surveil
=======
Monitoring as a Service
@ -12,3 +15,37 @@ Project Info
* Wiki: https://wiki.openstack.org/wiki/Surveil
* IRC: #surveil at freenode
* Documentation: https://surveil.readthedocs.org/
===============
Getting Started
===============
Developpement environnement
===========================
Surveil's developpement environnement is based on Docker and docker-compose.
You can install docker-compose with the following command:
:bash:`sudo pip install -U docker-compose`
You will then be able to use the environment with the following commands:
* :bash:`sudo docker-compose up`: Launch Surveil and its dependencies in containers.
* :bash:`sudo docker-compose down`: Kill the active docker containers, if any.
* :bash:`sudo docker-compose rm`: Remove all containers, if any.
* :bash:`sudo docker-compose`: Build the docker images.
Configuration for the different services running in the Docker containers are
stored in tools/docker.
After running :bash:`sudo docker-compose up`, you should be able to acces all
services at the ports configured in the docker-compose.yml file.
* Surveil API: http://localhost:8080/v1/hello
* InfluxDB: http://localhost:8083
* Grafana: http://localhost:80/grafana
* Shinken WebUI: http://localhost:7767/all
The Surveil container mounts your local project folder and pecan reloads every
time the project files change thus providing a proper development environment.

View File

@ -1,22 +0,0 @@
.. role:: bash(code)
:language: bash
===============
Getting Started
===============
Developpement environnement
===========================
Surveil's developpement environnement is based on Docker and fig. There is a Makefile
at the root of the repository with commands to make it easier to use:
* :bash:`make up`: Launch Surveil and its dependencies in containers.
* :bash:`make down`: Kill the active docker containers, if any.
* :bash:`build`: Build the surveil container.
Configuration for the different services running in the Docker container are
stored in tools/docker.
Surveil container mounts your local project folder and pecan reloads every
time the project files change thus providing a proper development environment.