Загрузка офлайн документации#
| Версия | Дата релиза | Документация (zip) |
|---|---|---|
| v.5.86.0 | 29.11.24 | lp_docs_v.5.86.0 |
Документация комплекта поставки#
В данном разделе описывается пакет документации из комплекта поставки LUNA PLATFORM. Все документы находятся в папке "/docs" комплекта поставки.
Руководства по эксплуатации#
Нижеперечисленные руководства описывают общие процессы LP, её архитектуру, интерфейс системные требования и примечания к выпуску.
Документы представлены в форматах PDF и HTML.
| Документ | Описание |
|---|---|
| LP_Release_Notes | Примечания к выпуску. |
| LP_Administrator_Manual | Руководство администратора. |
| LP_User_Interface_Manual | Руководство по пользовательскому интерфейсу. |
| LP_System_Requirements | Системные требования. |
Руководства по установке#
Нижеперечисленные руководства описывают развертывание и обновление разными способами, а также активацию лицензии и использование утилиты Storages.
Руководства можно найти в каталоге "./docs/InstallationManuals".
Документы представлены в форматах PDF и HTML.
| Документ | Описание |
|---|---|
| LP_Docker_Compose_Deployment_Example | Пример развертывания с помощью Docker Compose. Описывает установку на пустой сервер с нуля с помощью примера скрипта Docker Compose из комплекта поставки. |
| LP_Kubernetes_Helm_Deployment_Example | Пример развертывания в кластере Kubernetes. Описывает установку в кластере Kubernetes с использованием примеров Helm чартов из комплекта поставки. |
| LP_Installation_Manual_Using_Storages | Ручная установка с помощью утилиты Storages. Описывает подготовку окружения с помощью утилиты Storages и запуск Docker-контейнеров вручную на отдельном сервере. |
| LP_Upgrade_Manual_Using_Storages | Ручное обновление с помощью утилиты Storages. Описывает обновление окружения с помощью утилиты Storages и запуск новых Docker-контейнеров вручную на отдельном сервере. |
| LP_Installation_Manual | Ручная установка. Описывает подготовку окружения и запуск всех Docker-контейнеров вручную на отдельном сервере. |
| LP_Upgrade_Manual | Ручное обновление. Описывает обновление окружения и запуск новых Docker-контейнеров вручную на отдельном сервере. |
| LP_Migration_from_LP3 | Ручная миграция с LP 3 до LP 5. Описывает миграцию окружения LP 3 и запуск Docker-контейнеров LP 5 вручную на отдельном сервере. |
| LP_Migration_from_LP4 | Ручная миграция с LP 4 до LP 5. Описывает миграцию окружения LP 4 и запуск Docker-контейнеров LP 5 вручную на отдельном сервере. |
| LP_License_Activation_Manual | Руководство по активации лицензии. |
| LP_Storages_Utility_Manual | Руководство по утилите Storages. |
Утилита Storages позволяет проверить и/или подготовить окружение для сервисов LUNA PLATFORM версии 5.46.1 и выше перед их непосредственным запуском. Рекомендуется использовать руководства по установке/обновлению с помощью утилиты Storages для версий 5.46.1 и выше.
Спецификация 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".