Skip to content

Commit

Permalink
Forgot to git add in previous commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mistercrunch committed Oct 13, 2014
1 parent c24ce82 commit ce58b42
Show file tree
Hide file tree
Showing 7 changed files with 493 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/code.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Code / API
==========

Models
------
Models are built on top of th SQLAlchemy ORM Base class, instance are
persisted in the database.

.. automodule:: models
:members: DAG, BaseOperator, TaskInstance, DagBag, DatabaseConnection

Operators
---------
Operators allows to generate a certain type of task on the graph.

.. automodule:: operators
:members: MySqlOperator, BashOperator, MySqlSensorOperator, ExternalTaskSensor

Hooks
-----
.. automodule:: hooks
:members: MySqlHook

Executors
---------
.. automodule:: executors
:members: LocalExecutor, SequentialExecutor
Binary file added docs/img/gantt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@

Installation
------------
Installation should be quick and straightforwad.

Debian packages
'''''''''''''''

::

sudo apt-get install virtualenv python-dev
sudo apt-get install libmysqlclient-dev mysql-server
sudo apt-get g++

Required environment variable, add this to your .bashrc
'''''''''''''''''''''''''''''''''''''''''''''''''''''''

::

export FLUX_HOME=~/Flux
export PATH=$PATH:$FLUX_HOME/flux/bin

Create a python virtualenv
''''''''''''''''''''''''''

::

virtualenv env # creates the environment
source init.sh # activates the environment

Use pip to install the python packages required by Flux
'''''''''''''''''''''''''''''''''''''''''''''''''''''''

::

pip install -r requirements.txt

Setup the metdata database
''''''''''''''''''''''''''

Here are steps to get started using MySQL as a backend for the metadata
database, though any backend supported by SqlAlquemy should work just
fine.

::

$ mysql -u root -p
mysql> CREATE DATABASE flux;
CREATE USER 'flux'@'localhost' IDENTIFIED BY 'flux';
GRANT ALL PRIVILEGES ON flux.* TO 'flux'@'localhost';

Start the web server
''''''''''''''''''''

::

flux webserver --port 8080
Loading

0 comments on commit ce58b42

Please sign in to comment.