Перейти к содержанию

# Введение

Глава "Начало работы" поможет вам начать работу с LUNA Index Module.

В главе "Структура комплекта поставки" описывается содержимое комплекта поставки.

В главе "Документация комплекта поставки" перечислены все документы, входящие в комплект поставки.

# Начало работы

Существует несколько полезных руководств с описанием установки LUNA Index Module. Данные руководства перечислены в разделе "Руководства по эксплуатации".

Документ "LIM_Administrator_Manual_Rus" включает в себя всю общую информацию о LIM, а именно:

- терминологию,
- процесс создания индексов и выполнения сравнения
- создаваемые объекты и выполняемые задачи,
- архитектуру и взаимодействие сервисов,
- описание настроек сервисов.

> Рекомендуется начать знакомство с этого документа, чтобы понять общие принципы работы с LIM.

В комплект поставки не входят Docker-контейнеры, их необходимо скачать самостоятельно. Сервисы LIM являются необязательными и требуют запуска некоторых сервисов LP. См. документ "LIM_Installation_Manual_Rus" для получения дополнительной информации.

После того, как LIM будет запущен, обратитесь к разделу "Справочные руководства", который содержит описание спецификаций OpenAPI для сервисов LIM.

# Структура комплекта поставки

Комплект поставки состоит из следующих директорий:

Имя директории | Описание
--- | ---
/example-docker | Директория включает в себя все файлы, необходимые для запуска Docker-контейнеров сервисов LIM с помощью скрипта Docker Compose
/docs | Документация для LIM

Директория "example-docker" содержит необходимые файлы для запуска LIM с помощью скрипта Docker Compose и папку "configs", в которой находятся настройки LIM, загружаемые в сервис Configurator.

# Документация комплекта поставки

В данном разделе описывается пакет документации из комплекта поставки LIM. Все документы находятся в папке "/docs" комплекта поставки.

## Руководства по эксплуатации

Нижеперечисленные руководства описывают общие процессы LIM, архитектуру, системные требования, информация о совместимости LUNA Index Module и LUNA PLATFORM, а также примечания к выпуску.

Документы представлены в формате HTML.

Документ | Описание
--- | ---
LIM_Administrator_Manual | Руководство администратора.
LIM_Release_Notes | Примечания к выпуску.
LIM_System_Requirements | Системные требования.

## Руководства по установке

Нижеперечисленные руководства описывают развертывание и обновление разными способами.

Руководства можно найти в каталоге "./docs/InstallationManuals".

Документы представлены в формате HTML.

Документ | Описание
--- | ---
LIM_Installation_Manual | Ручная установка. Описывает подготовку окружения и запуск всех Docker-контейнеров вручную на отдельном сервере.
LIM_Upgrade_Manual | Ручное обновление. Описывает обновление окружения и запуск новых Docker-контейнеров вручную на отдельном сервере.
LIM_Docker_Compose_Deployment_Example | Пример развертывания с помощью Docker Compose. Описывает установку на пустой сервер с нуля с помощью примера скрипта Docker Compose из комплекта поставки.

## Справочные руководства

В настоящее время все справочные руководства доступны только на английском языке в английской поставке.

Нижеперечисленные руководства описывают спецификации OpenAPI для сервисов LIM. Спецификация OpenAPI — единственный документ, предоставляющий актуальную информацию о API сервисов. Спецификация может использоваться:

- Инструментами создания документации для визуализации API.
- Инструментами генерации кода.

Все документы и код, созданные с использованием этой спецификации, могут содержать неточности, и их следует тщательно проверять.

Данные руководства расположены в директории "./docs/ReferenceManuals". В этой директории расположены документы в формате YML и HTML. Документы в формате YML содержат запросы ко всем сервисам LIM. Их можно использовать для автоматической генерации запросов в Postman. Не гарантируется, что все запросы будут импортированы правильно, может потребоваться ручное редактирование. Документы в формате HTML используются для визуализации данных спецификации и могут быть не полными.

Спецификацию OpenAPI можно получить с помощью ресурса "/docs/spec". Заголовок "Accept" должен принимать значение "application/x-yaml".

Руководство | Описание
--- | ---
IndexedMatcherReferenceManual | Описание API сервиса Indexed Matcher
IndexerReferenceManual | Описание API сервиса Indexer
IndexManagerReferenceManual | Описание API сервиса Index Manager

## Руководство для разработчиков

Для LIM доступно руководство разработчика. Руководство можно найти в директории "./docs/ServiceManuals" английской поставки LIM.