Update documentation

Vovaman · Oct 26, 2024 · dac6502 · dac6502
commit dac6502
Show file tree

Hide file tree

Showing 165 changed files with 21,314 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 87a177b1e73838c010114f2605fd89c8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/01.add_new_connection.png b/_images/01.add_new_connection.png
diff --git a/_images/02.json_api.png b/_images/02.json_api.png
diff --git a/_images/03.install_json_api.png b/_images/03.install_json_api.png
diff --git a/_images/04.add_new_ds.png b/_images/04.add_new_ds.png
diff --git a/_images/05.setup_ds.png b/_images/05.setup_ds.png
diff --git a/_images/06.save_and_test.png b/_images/06.save_and_test.png
diff --git a/_images/07.new_dashboard.png b/_images/07.new_dashboard.png
diff --git a/_images/08.new_panel.png b/_images/08.new_panel.png
diff --git a/_images/09.select_ds.png b/_images/09.select_ds.png
diff --git a/_images/10.panel_settings.png b/_images/10.panel_settings.png
diff --git a/_images/11.set_path.png b/_images/11.set_path.png
diff --git a/_images/12.set_params.png b/_images/12.set_params.png
diff --git a/_images/13.query_inspector.png b/_images/13.query_inspector.png
diff --git a/_images/14.refresh.png b/_images/14.refresh.png
diff --git a/_images/15.got_data.png b/_images/15.got_data.png
diff --git a/_images/16.fields.png b/_images/16.fields.png
diff --git a/_images/17.trend.png b/_images/17.trend.png
diff --git a/_images/18.periods.png b/_images/18.periods.png
diff --git a/_images/architecture_01.png b/_images/architecture_01.png
diff --git a/_images/architecture_02.png b/_images/architecture_02.png
diff --git a/_images/architecture_03.png b/_images/architecture_03.png
diff --git a/_images/architecture_04.png b/_images/architecture_04.png
diff --git a/_images/architecture_05.png b/_images/architecture_05.png
diff --git a/_images/architecture_06.png b/_images/architecture_06.png
diff --git a/_images/architecture_07.png b/_images/architecture_07.png
diff --git a/_images/architecture_08.png b/_images/architecture_08.png
diff --git a/_images/architecture_09.png b/_images/architecture_09.png
diff --git a/_images/architecture_10.png b/_images/architecture_10.png
diff --git a/_images/datapool.png b/_images/datapool.png
diff --git a/_images/exchanges_01.png b/_images/exchanges_01.png
diff --git a/_images/exchanges_02.png b/_images/exchanges_02.png
diff --git a/_images/fromAndCount.png b/_images/fromAndCount.png
diff --git a/_images/fromAndCount2.png b/_images/fromAndCount2.png
diff --git a/_images/fromAndCountActual.png b/_images/fromAndCountActual.png
diff --git a/_images/methods_01.png b/_images/methods_01.png
diff --git a/_images/period_fromAfterData.png b/_images/period_fromAfterData.png
diff --git a/_images/period_fromAndToReal.png b/_images/period_fromAndToReal.png
diff --git a/_images/period_fromAndToRealActual.png b/_images/period_fromAndToRealActual.png
diff --git a/_images/period_fromBeforeData.png b/_images/period_fromBeforeData.png
diff --git a/_images/period_fromNotReal.png b/_images/period_fromNotReal.png
diff --git a/_images/period_fromStepFalse.png b/_images/period_fromStepFalse.png
diff --git a/_images/period_fromStepTrue.png b/_images/period_fromStepTrue.png
diff --git a/_images/period_fromToOutside.png b/_images/period_fromToOutside.png
diff --git a/_images/period_to.png b/_images/period_to.png
diff --git a/_images/period_toBefore.png b/_images/period_toBefore.png
diff --git a/_images/subscribers_01.png b/_images/subscribers_01.png
diff --git a/_images/subscribers_02.png b/_images/subscribers_02.png
diff --git a/_images/subscribers_03.png b/_images/subscribers_03.png
diff --git a/_images/subscribers_04.png b/_images/subscribers_04.png
diff --git a/_images/tagId_step.png b/_images/tagId_step.png
diff --git a/_images/tagId_stepFalse.png b/_images/tagId_stepFalse.png
diff --git a/_images/tagId_stepTrue.png b/_images/tagId_stepTrue.png
diff --git a/_images/timeStepAndCount.png b/_images/timeStepAndCount.png
diff --git a/_images/timeStepFromCount.png b/_images/timeStepFromCount.png
diff --git a/_images/timeStepFromTo.png b/_images/timeStepFromTo.png
diff --git a/_images/timestep_count_2.png b/_images/timestep_count_2.png
diff --git a/_images/timestep_none_1.png b/_images/timestep_none_1.png
diff --git a/_images/timestep_none_2.png b/_images/timestep_none_2.png
diff --git a/_images/toAndCount.png b/_images/toAndCount.png
diff --git a/_images/toAndCount2.png b/_images/toAndCount2.png
diff --git a/_images/toAndCount3.png b/_images/toAndCount3.png
diff --git a/_images/toAndCountActual.png b/_images/toAndCountActual.png
diff --git a/_images/value.png b/_images/value.png
diff --git a/_images/withNull.png b/_images/withNull.png
diff --git a/_images/withNull2.png b/_images/withNull2.png
diff --git a/_images/withNull3.png b/_images/withNull3.png
diff --git a/_images/withNull4.png b/_images/withNull4.png
diff --git a/_sources/alerts.rst.txt b/_sources/alerts.rst.txt
@@ -0,0 +1,6 @@
+Тревоги
+~~~~~~~
+
+.. automodule:: alerts_api_crud_svc
+   :members:
+   :exclude-members: AlertCreateAttributes, AlertCreate, AlertRead, AlertUpdate, AlertsAPICRUD
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,82 @@
+API Платформы Пересвет
+======================
+
+Правила API
+-----------
+
+.. warning:: Внимание!
+   При создании любых сущностей (тэги, объекты, тревоги и т.д.) в их именах
+   допустимы любые символы. При этом обратный слэш (\) и кавычки должны предваряться символом обратного слэша.
+
+Есть несколько базовых правил, на которых основывается API платформы:
+
+#. Имена атрибутов в json-объектах, названия запросов придерживаются
+   правил camelCase.
+
+   Пример:
+
+   .. code-block:: json
+
+      {
+         "parentId": "...",
+         "tagName": "..."
+      }
+
+#. Тело запроса к платформе содержит только один json-объект.
+   Массивы данных передаются внутри этого объекта.
+#. Ответ на запрос также содержит только один json-объект.
+#. В случае ошибки обработки запроса в json-объекте ответа 
+   на запрос есть ключ ``detail```, значение
+   которого - список пояснений к ошибке:
+
+   .. code-block:: json
+
+      {
+        "detail": [
+            {
+                  "type": "type_of_error",
+                  "loc": [
+                     "place_of_error"
+                  ],
+                  "msg": "message",
+                  "input": {},
+                  "ctx": {
+                     "error": "name_of_error"
+                  }
+            }
+         ]
+      }
+
+   либо строка:
+
+   .. code-block:: json
+
+      {
+        "detail": "описание ошибки"
+      }
+
+#. По возможности все команды платформы работают с массивами данных.
+   См. документацию на каждую команду.
+
+#. В связи с использованием ldap-сервера для хранения иерархий
+   имена всех сущностей представлены в виде атрибута ``cn``.
+
+#. У каждого узла в иерархии присутствует атрибут ``entryUUID``.
+   Это специальный неизменяемый атрибут, содержащий уникальный идентификатор узла.
+   Платформа сама присваивает значение этому атрибуту при создании нового узла.
+   При перемещении узла по иерархии этот атрибут сохраняется без изменений.
+
+Модули
+------
+
+.. toctree::
+   :maxdepth: 6
+
+   Тревоги<alerts>
+   Теги<tags>
+   Обьекты<objects>
+   Коннекторы<connectors>
+   Хранилища данных<dataStorages_api_doc>
+   Расписания<schedules>
+   Методы<methods_api_doc>
+   Запись/получение данных<data_api>
diff --git a/_sources/architecture.rst.txt b/_sources/architecture.rst.txt
diff --git a/_sources/common_classes.rst.txt b/_sources/common_classes.rst.txt
@@ -0,0 +1,36 @@
+Общие классы
+------------
+В этом разделе описаны общие классы, от которых наследуются все сервисы,
+а также классы, используемые всеми сервисами.
+
+Модуль ``hierarchy``
+~~~~~~~~~~~~~~~~~~~~
+.. automodule:: src.common.hierarchy
+   :members:
+   :private-members:
+   :show-inheritance:
+   :noindex:
+
+Модуль ``logger``
+~~~~~~~~~~~~~~~~~
+.. automodule:: src.common.logger
+   :members:
+   :private-members:
+   :exclude-members: InterceptHandler
+   :show-inheritance:
+   :noindex:
+
+Модуль ``svc``
+~~~~~~~~~~~~~~
+.. automodule:: src.common.svc
+    :members:
+    :private-members:
+    :show-inheritance:
+    :noindex:
+
+Модуль ``svc_settings``
+~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: src.common.svc_settings
+    :members:
+    :show-inheritance:
+    :noindex:
diff --git a/_sources/components.rst.txt b/_sources/components.rst.txt
@@ -0,0 +1,33 @@
+Компоненты
+----------
+Компоненты платформы:
+
+#. **Сервисы платформы**.
+
+   Исходный код платформы. Может быть запущен в виде одного приложения или как набор микросервисов.
+#. **OpenLDAP**.
+
+   Иерархическая модель автоматизируемого объекта, 
+   модель информационной системы. 
+
+   Аутентификация и авторизация пользователей.
+#. **RabbitMQ**. 
+
+   Брокер сообщений. Микросервисы ядра общаются между собой с его помощью.
+#. **Nginx**.
+
+   Прокси сервер, балансировщик нагрузки, TLS-прокси.
+   Распределяет HTTP-запросы между микросервисами платформы, Grafan'ой и конфигуратором.
+#. **Redis**.
+
+   Кэш-сервер.
+#. **PostgreSQL**.
+
+   По умолчанию платформа содержит СУБД PostgreSQL в качестве исторической базы данных.
+   В общем случае исторические данные могут храниться в нескольких базах, причём разных типов. 
+#. **Grafana**.
+
+   Инструмент для создания экранов мониторинга.
+#. **Конфигуратор**.
+
+   Приложение для создания моделей объектов.
diff --git a/_sources/configurator.rst.txt b/_sources/configurator.rst.txt
@@ -0,0 +1,5 @@
+.. _configurator:
+
+Конфигуратор модели
+-------------------
+Работайте с конфигуратором модели.
diff --git a/_sources/connectors.rst.txt b/_sources/connectors.rst.txt
@@ -0,0 +1,6 @@
+Коннекторы
+~~~~~~~~~~
+
+.. automodule:: connectors_api_crud_svc
+   :members:
+   :exclude-members: LinkTagAttributes, LinkTag, ConnectorAttributes, ConnectorCreate, ConnectorRead, OneConnectorInReadResult, ConnectorReadResult, ConnectorUpdate, ConnectorsAPICRUD