Added internal architecture diagram and fixed some doc errors
Added solar internal architecture diagram. Fixed doc generation errors. Change-Id: I0be39d9dbae7c19c633d6378f332bd8a14db3997 Closes-bug: #1538168
This commit is contained in:
parent
3067b5126d
commit
4cdf55a6bb
BIN
doc/source/_static/solar_internal_architecture.png
Normal file
BIN
doc/source/_static/solar_internal_architecture.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 66 KiB |
7
doc/source/architecture.rst
Normal file
7
doc/source/architecture.rst
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
.. _architecture:
|
||||||
|
|
||||||
|
===========================
|
||||||
|
Solar Internal Architecture
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. image:: _static/solar_internal_architecture.png
|
@ -7,12 +7,12 @@ FAQ
|
|||||||
|
|
||||||
.. _faq_hardcoded_params:
|
.. _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.
|
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::
|
Just update resource for example::
|
||||||
@ -36,9 +36,15 @@ Just update resource::
|
|||||||
How can I run solar celery worker ?
|
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 use `vagrant` then you can just `service solar-celery start|restart`
|
||||||
- If you have `gevent` installed then you can use utils/solar-celery script. You may need to adjust log files etc.
|
as `vagrant` user.
|
||||||
- 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 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::
|
.. note::
|
||||||
|
|
||||||
@ -50,9 +56,11 @@ How can I configure solar ?
|
|||||||
There are several places where we search for config values:
|
There are several places where we search for config values:
|
||||||
|
|
||||||
1. `.config` file in CWD or in path from `SOLAR_CONFIG` env variable
|
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
|
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:
|
.. _faq_using_sqlbackend:
|
||||||
|
|
||||||
@ -69,11 +77,13 @@ For simplicity, but nothing stops you from changing these defaults::
|
|||||||
What database can I use with solar ?
|
What database can I use with solar ?
|
||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
By default for simplicity we use `sqlite`. On our vagrant environment we use single node `riak`.
|
By default for simplicity we use `sqlite`. On our vagrant environment we use
|
||||||
You can also use multiple node `riak`, with some strong consistent buckets.
|
single node `riak`.
|
||||||
|
You can also use multiple nodes `riak`, with some strong consistent buckets.
|
||||||
|
|
||||||
|
|
||||||
Where can I find solar examples ?
|
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
|
||||||
|
@ -15,6 +15,7 @@ Contents:
|
|||||||
usage
|
usage
|
||||||
tutorials/index
|
tutorials/index
|
||||||
glossary
|
glossary
|
||||||
|
architecture
|
||||||
resource
|
resource
|
||||||
resource_repository
|
resource_repository
|
||||||
orchestration
|
orchestration
|
||||||
|
@ -23,14 +23,15 @@ Additional software
|
|||||||
`VirtualBox <https://www.virtualbox.org/wiki/Downloads/>`_ 5.x,
|
`VirtualBox <https://www.virtualbox.org/wiki/Downloads/>`_ 5.x,
|
||||||
`Vagrant <http://www.vagrantup.com/downloads.html/>`_ 1.7.x
|
`Vagrant <http://www.vagrantup.com/downloads.html/>`_ 1.7.x
|
||||||
|
|
||||||
Note: Make sure that `Vagrant VirtualBox Guest plugin <https://github.com/dotless-de/vagrant-vbguest/>`_ is installed
|
Note: Make sure that `Vagrant VirtualBox Guest plugin
|
||||||
|
<https://github.com/dotless-de/vagrant-vbguest/>`_ is installed
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
vagrant plugin install vagrant-vbguest
|
vagrant plugin install vagrant-vbguest
|
||||||
|
|
||||||
Note: If you are using VirtualBox 5.0 on Linux system, it's worth uncommenting paravirtprovider
|
Note: If you are using VirtualBox 5.0 on Linux system, it's worth uncommenting
|
||||||
setting in `vagrant-settings.yaml` for speed improvements:
|
paravirtprovider setting in `vagrant-settings.yaml` for speed improvements:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user