diff --git a/README.rst b/README.rst index cc88bb316..685f35a10 100644 --- a/README.rst +++ b/README.rst @@ -4,36 +4,42 @@ Mistral Task Orchestration and Scheduling service for OpenStack cloud -Running in development mode ---------------------------- +Installation +------------ -### Installation First of all, in a shell run: -*tox* + tox This will install necessary virtual environments and run all the project tests. Installing virtual environments may take significant time (~10-15 mins). -### Running Mistral API server +Running Mistral API server +-------------------------- + To run Mistral API server perform the following command in a shell: -*tox -evenv -- python mistral/cmd/launch.py --server api --config-file path_to_config* + tox -evenv -- python mistral/cmd/launch.py --server api --config-file path_to_config* Note that an example configuration file can be found in etc/mistral.conf.example. -### Running Mistral Engines +Running Mistral Engines +----------------------- + To run Mistral Engine perform the following command in a shell: -*tox -evenv -- python mistral/cmd/launch.py --server engine --config-file path_to_config* + tox -evenv -- python mistral/cmd/launch.py --server engine --config-file path_to_config* -### Running Mistral Task Executors +Running Mistral Task Executors +------------------------------ To run Mistral Task Executor instance perform the following command in a shell: -*tox -evenv -- python mistral/cmd/launch.py --server executor --config-file path_to_config* + tox -evenv -- python mistral/cmd/launch.py --server executor --config-file path_to_config Note that at least one Engine instance and one Executor instance should be running so that workflow tasks are processed by Mistral. -### Debugging +Debugging +--------- + To debug using a local engine and executor without dependencies such as RabbitMQ, create etc/mistral.conf with the following settings:: [DEFAULT] @@ -46,6 +52,7 @@ and run in pdb, PyDev or PyCharm:: mistral/cmd/launch.py --server all --config-file etc/mistral.conf --use-debugger -### Running examples +Running examples +---------------- To run the examples find them in mistral-extra repository (https://github.com/stackforge/mistral-extra) and follow the instructions on each example.