diff --git a/doc/source/_static/solar_internal_architecture.png b/doc/source/_static/solar_internal_architecture.png new file mode 100644 index 00000000..d631f0e5 Binary files /dev/null and b/doc/source/_static/solar_internal_architecture.png differ diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst new file mode 100644 index 00000000..753fd692 --- /dev/null +++ b/doc/source/architecture.rst @@ -0,0 +1,7 @@ +.. _architecture: + +=========================== +Solar Internal Architecture +=========================== + +.. image:: _static/solar_internal_architecture.png diff --git a/doc/source/faq.rst b/doc/source/faq.rst index 2e79fbef..1b00e7a1 100644 --- a/doc/source/faq.rst +++ b/doc/source/faq.rst @@ -7,12 +7,12 @@ FAQ .. _faq_hardcoded_params: -Why nodes/transports have hardcoded keys ip and other inputs ? +Why nodes/transports have hardcoded keys, ips and other inputs ? -------------------------------------------------------------- This is temporary situation, we will improve it in near future. -I want to use different keys +I want to use different SSH keys ---------------------------- Just update resource for example:: @@ -36,9 +36,15 @@ Just update resource:: How can I run solar celery worker ? ----------------------------------- -- If you use `vagrant` then you can just `service solar-celery start|restart` as `vagrant` user. -- If you have `gevent` installed then you can use utils/solar-celery script. You may need to adjust log files etc. -- You can spawn celery by hand too: ``celery multi start 2 -A solar.orchestration.runner -P prefork -c:1 1 -c:2 2 -Q:1 scheduler,system_log -Q:2 celery`` +- If you use `vagrant` then you can just `service solar-celery start|restart` +as `vagrant` user. +- If you have `gevent` installed then you can use utils/solar-celery script. +You may need to adjust log files etc. +- You can spawn celery by hand too: + +.. code-block:: bash + + celery multi start 2 -A solar.orchestration.runner -P prefork -c:1 1 -c:2 2 -Q:1 scheduler,system_log -Q:2 celery .. note:: @@ -50,9 +56,11 @@ How can I configure solar ? There are several places where we search for config values: 1. `.config` file in CWD or in path from `SOLAR_CONFIG` env variable -2. if env `SOLAR_CONFIG_OVERRIDE` contains valid path then it override previous values +2. if env `SOLAR_CONFIG_OVERRIDE` contains valid path then it override previous +values 3. `.config.override` in CWD -4. You can also set upper-cased env variable which matches one of those in config +4. You can also set upper-cased env variable which matches one of those in +config .. _faq_using_sqlbackend: @@ -69,11 +77,13 @@ For simplicity, but nothing stops you from changing these defaults:: What database can I use with solar ? ------------------------------------ -By default for simplicity we use `sqlite`. On our vagrant environment we use single node `riak`. -You can also use multiple node `riak`, with some strong consistent buckets. +By default for simplicity we use `sqlite`. On our vagrant environment we use +single node `riak`. +You can also use multiple nodes `riak`, with some strong consistent buckets. Where can I find solar examples ? --------------------------------- -Example resources, composer templates and examples itself are located: https://github.com/Mirantis/solar-resources +Example resources, composer templates and examples itself are located: +https://github.com/Mirantis/solar-resources diff --git a/doc/source/index.rst b/doc/source/index.rst index 984e25e9..8c0dc161 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,6 +15,7 @@ Contents: usage tutorials/index glossary + architecture resource resource_repository orchestration diff --git a/doc/source/installation.rst b/doc/source/installation.rst index fe121aa6..3279d8ac 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -23,14 +23,15 @@ Additional software `VirtualBox `_ 5.x, `Vagrant `_ 1.7.x -Note: Make sure that `Vagrant VirtualBox Guest plugin `_ is installed +Note: Make sure that `Vagrant VirtualBox Guest plugin +`_ is installed .. code-block:: bash vagrant plugin install vagrant-vbguest -Note: If you are using VirtualBox 5.0 on Linux system, it's worth uncommenting paravirtprovider -setting in `vagrant-settings.yaml` for speed improvements: +Note: If you are using VirtualBox 5.0 on Linux system, it's worth uncommenting +paravirtprovider setting in `vagrant-settings.yaml` for speed improvements: .. code-block:: bash