Skip to content
Snippets Groups Projects
architecture.rst 1006 B
Newer Older
Architecture
============

Start up proccess
-----------------

Anael Beutot's avatar
Anael Beutot committed
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
--------------------------------
Anael Beutot's avatar
Anael Beutot committed

.. 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: