Загрузка офлайн документации#
| Версия | Документация (zip) |
|---|---|
| v.5.185.0 | lvm_docs_v.5.185.0 |
Документация комплекта поставки#
В данном разделе описывается пакет документации из комплекта поставки LVM. Все документы находятся в папке "/docs" комплекта поставки.
Руководства по эксплуатации#
Нижеперечисленные руководства описывают общие процессы LVM, архитектуру, системные требования, информацию о совместимости LUNA Vinder Module и LUNA PLATFORM, а также примечания к выпуску.
Документы представлены в формате HTML.
| Документ | Описание |
|---|---|
| LVM_Administrator_Manual | Руководство администратора. |
| LVM_Release_Notes | Примечания к выпуску. |
| LVM_System_Requirements | Системные требования. |
Руководства по установке#
Нижеперечисленные руководства описывают развертывание разными способами.
Руководства можно найти в каталоге "./docs/Installation".
Документы представлены в формате HTML.
| Документ | Описание |
|---|---|
| LVM_Installation_Manual | Ручная установка. Описывает подготовку окружения и запуск всех Docker-контейнеров вручную на отдельном сервере. |
| LVM_Docker_Compose_Deployment_Example | Пример развертывания с помощью Docker Compose. Описывает установку на пустой сервер с нуля с помощью примера скрипта Docker Compose из комплекта поставки. |
| LVM_Kubernetes_Helm_Deployment_Example | Пример развертывания в кластере Kubernetes. Описывает установку в кластере Kubernetes с использованием примеров Helm чартов из комплекта поставки. |
Справочные руководства#
В настоящее время все справочные руководства доступны только на английском языке.
Нижеперечисленные руководства описывают спецификации OpenAPI для сервисов LVM. Спецификация OpenAPI — единственный документ, предоставляющий актуальную информацию о API сервисов. Спецификация может использоваться:
- Инструментами создания документации для визуализации API.
- Инструментами генерации кода.
Все документы и код, созданные с использованием этой спецификации, могут содержать неточности, и их следует тщательно проверять.
Данные руководства расположены в директории "./docs/ReferenceManuals". В этой директории расположены документы в формате YML и HTML. Документы в формате YML содержат запросы ко всем сервисам LVM. Их можно использовать для автоматической генерации запросов в Postman. Не гарантируется, что все запросы будут импортированы правильно, может потребоваться ручное редактирование. Документы в формате HTML используются для визуализации данных спецификации и могут быть не полными.
| Руководство | Описание |
|---|---|
| MatcherReferenceManual | Описание API сервиса Matcher |
| ProjectorReferenceManual | Описание API сервиса Projector |
Руководство для разработчиков#
Для LVM доступно руководство разработчика. Руководство можно найти в директории "./docs/ServiceManuals".