Commit 85073695 authored by Anael Beutot's avatar Anael Beutot
Browse files

Updated documentation.

parent 4e33955e

docs/dev/source/architecture.rst

+48 −0
Original line number Diff line number Diff line
@@ -4,6 +4,54 @@ Architecture 
Start up proccess

-----------------



See ``bin/cc-node``.



Summary of the steps:



* First parse command line options and configuration file

* Then register signal handling for ``SIG_USR1`` (reload configuration) and

  ``SIG_TERM`` (terminate process).

* Switch to a daemon context

* Reload logging configuration

* Instanciate and launch a :class:`ccnode.node.Node` in background

* Enter main loop that consist of waiting for signals and reloading configuration

  if needed.





Organisation of modules/packages

--------------------------------



.. code-block:: text



    |-- config.py

    |-- exc.py

    |-- host

    |   |-- __init__.py

    |   |-- tags.py

    |-- hypervisor

    |   |-- __init__.py

    |   `-- tags.py

    |-- __init__.py

    |-- jobs.py

    |-- node.py

    |-- tags.py

    |-- utils.py



TODO



Node

----



Summary of the :class:`ccnode.node.Node` main loop:



* TODO



.. automodule:: ccnode.node

    :members:



Tags

----



.. automodule:: ccnode.tags

    :members:

docs/dev/source/conf.py

+5 −0
Original line number Diff line number Diff line
@@ -214,3 +214,8 @@ man_pages = [ 
    ('index', 'cloudcontrolnode', u'Cloud Control node Documentation',

     [u'Smartjog'], 1)

]





# -- Options for autodoc ------------------------------------------------------

autoclass_content = 'both'

autodoc_member_order = 'bysource'

docs/dev/source/host.rst

+2 −2
Original line number Diff line number Diff line
@@ -7,8 +7,8 @@ Tags 
.. automodule:: ccnode.host.tags

    :members:



Handlers

--------

Handler

-------



.. autoclass:: ccnode.host.Handler

    :members: