Страница загрузки документации#
| Версия | Дата релиза | Документация (zip) |
|---|---|---|
| v.5.51.4 | 26.10.23 | luna_docs_rus_v.5.51.4 |
Документация комплекта поставки#
В данном разделе описывается пакет документации из комплекта поставки LUNA PLATFORM. Все документы находятся в папке "/docs" комплекта поставки.
Руководства по эксплуатации#
Нижеперечисленные руководства описывают общие процессы LP, её архитектуру и развертывание.
Большинство документов представлены в форматах PDF и HTML. Навигация в PDF документе проще, однако в HTML документе удобнее копировать команды.
| Документ | Описание |
|---|---|
| LP_Release_Notes_Rus.* | Примечания к выпуску LUNA PLATFORM |
| LP_Administrator_Manual_Rus.pdf | Руководство администратора LUNA PLATFORM |
| LP_Docker_Installation_Manual_Rus.* | Руководство по ручной установке LUNA PLATFORM с использованием Docker-контейнеров. В данном руководстве приведен пример установки LP 5 на единый сервер |
| LP_License_Activation_Manual_Rus.* | Руководство по активации лицензии |
| LP_Docker_Upgrade_Manual_Rus.* | Руководство по обновлению LP с предыдущей сборки |
| LP_Docker_Compose_Example_Rus.* | Руководство по установке LUNA PLATFORM 5 с помощью Docker Compose. В данном руководстве приведен пример установки LP 5 на единый сервер |
| LP_Migration_from_LP3_Rus.* | Руководство по миграции с LUNA PLATFORM 3 на LUNA PLATFORM 5 Backport 3 |
| LP_Migration_from_LP4_Rus.* | Руководство по миграции с LUNA PLATFORM 4 на LUNA PLATFORM 5 Backport 4 |
* форматы pdf и html
Спецификации OpenAPI#
Нижеперечисленные руководства описывают спецификации OpenAPI для сервисов LUNA PLATFORM. Спецификация OpenAPI - единственный документ, предоставляющий актуальную информацию о API сервисов. Спецификация может использоваться:
- Инструментами создания документации для визуализации API.
- Инструментами генерации кода.
Все документы и код, созданные с использованием этой спецификации, могут содержать неточности, и их следует тщательно проверять.
Данные руководства расположены в директории "./docs/ReferenceManuals". В этой директории расположены документы в формате YML и HTML. Документы в формате YML содержат запросы ко всем сервисам LUNA PLATFORM. Их можно использовать для автоматической генерации запросов в инструментах для тестирования API, например, Postman (не описано в документации LUNA PLATFORM). Не гарантируется, что все запросы будут импортированы правильно, может потребоваться ручное редактирование. Документы в формате HTML используются для визуализации данных спецификации и могут быть не полными.
Спецификацию OpenAPI можно получить с помощью запроса "get openapi documentation" к сервисам LP. Заголовок "Accept" должен принимать значение "application/x-yaml".
| Руководство | Описание |
|---|---|
| APIReferenceManual.* | Общие запросы к сервисам LUNA PLATFORM с использованием сервиса API |
| AdminReferenceManual.* | Описание API сервиса Admin. Описывает задачи, выполняемые администратором |
| AccountsReferenceManual.* | Описание API сервиса Accounts |
| Backport3ReferenceManual.* | Описание API Backport 3 |
| Backport4ReferenceManual.* | Описание API Backport 4 |
| ConfiguratorReferenceManual.* | Описание API сервиса Configurator |
| EventsReferenceManual.* | Описание API сервиса Events |
| FacesReferenceManual.* | Описание API сервиса Faces |
| RemoteSDKReferenceManual.* | Описание API сервиса Remote SDK |
| HandlersReferenceManual.* | Описание API сервиса Handlers |
| ImageStoreReferenceManual.* | Описание API сервиса Image Store |
| LicensesReferenceManual.* | Описание API сервиса Licenses |
| PythonMatcherReferenceManual.* | Описание API сервиса Python Matcher |
| SenderReferenceManual.* | Описание API сервиса Sender. Описывает получение уведомлений о событиях с помощью веб-сокетов |
| TasksReferenceManual.* | Описание API сервиса Tasks. Описывает запросы на выполнение длительных задач |
* форматы yml и html
Руководства для разработчиков#
Нижеперечисленные руководства предназначены для разработчиков и DevOps-инженеров. Они расположены в директории "./docs/ServiceManuals". Руководства содержат описание работы сервисов LUNA PLATFORM с детальным раскрытием технических нюансов.
| Руководство | Описание |
|---|---|
| APIDevelopmentManual/index.html | Установка сервера, использование PostgreSQL, административная статистика и т.д. |
| AdminDevelopmentManual/index.html | Общие административные процедуры |
| AccountsDevelopmentManual/index.html | Описание сервиса Accounts |
| Backport3DevelopmentManual/index.html | Описание сервиса Backport 3 |
| Backport4DevelopmentManual/index.html | Описание сервиса Backport 4 |
| ConfiguratorDevelopmentManual/index.html | Описание сервиса Configurator |
| EventsDevelopmentManual/index.html | Описание сервиса Events |
| FacesDevelopmentManual/index.html | Описание сервиса Faces |
| RemoteSDKDevelopmentManual/index.html | Описание сервиса Remote SDK |
| HandlersDevelopmentManual/index.html | Описание сервиса Handlers |
| ImageStoreDevelopmentManual/index.html | Описание сервиса Image Store |
| LicensesDevelopmentManual/index.html | Описание сервиса Licenses |
| PythonMatcherDevelopmentManual/index.html | Описание сервиса Python Matcher |
| SenderDevelopmentManual/index.html | Описание сервиса Sender |
| TasksReferenceManual/index.html | Описание сервиса Tasks |