Загрузка документации#
| Версия | Дата релиза | Документация (zip) |
|---|---|---|
| v.5.57.0 | 01.02.24 | lp_rus_docs_v.5.57.0 |
Документация комплекта поставки#
В данном разделе описывается пакет документации из комплекта поставки LUNA PLATFORM. Все документы находятся в папке "/docs" комплекта поставки.
Руководства по эксплуатации#
Нижеперечисленные руководства описывают общие процессы LP, её архитектуру и развертывание.
Большинство документов представлены в форматах PDF и HTML. Навигация в PDF документе проще, однако в HTML документе удобнее копировать команды.
| Документ | Описание |
|---|---|
| LP_Release_Notes_Rus.* | Примечания к выпуску LUNA PLATFORM |
| LP_Administrator_Manual_Rus.pdf | Руководство администратора LUNA PLATFORM |
| LP_Installation_Manual_Rus.* | Руководство по ручной установке LUNA PLATFORM с использованием Docker-контейнеров. В данном руководстве приведен пример установки LP 5 на единый сервер |
| LP_License_Activation_Manual_Rus.* | Руководство по активации лицензии |
| LP_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 - единственный документ, предоставляющий актуальную информацию о API сервисов. Спецификация может использоваться:
- Инструментами создания документации для визуализации API.
- Инструментами генерации кода.
Все документы и код, созданные с использованием этой спецификации, могут содержать неточности, и их следует тщательно проверять.
В настоящее время на русском языке доступна только спецификация OpenAPI для сервиса API. Документация расположена в директории "./docs/ReferenceManuals/APIReferenceManual.pdf/html. Документ в формате YML содержит запросы ко всем сервисам LUNA PLATFORM. Их можно использовать для автоматической генерации запросов в инструментах для тестирования API, например, Postman (не описано в документации LUNA PLATFORM). Не гарантируется, что все запросы будут импортированы правильно, может потребоваться ручное редактирование. Документы в формате HTML используются для визуализации данных спецификации и могут быть не полными.
Спецификацию OpenAPI можно получить с помощью запроса "get openapi documentation" к сервисам LP. Заголовок "Accept" должен принимать значение "application/x-yaml".