Skip to content

# Introduction

Welcome to LUNA Index Module!

The "Getting started" section will help you to get started with LUNA Index Module.

The "Distribution package structure" section describes the distribution package content.

The "Documentation" section lists all the documents included in the distribution package.

# Getting started

There are several useful manuals describing the installation of the LUNA Index Module. These manuals are listed in the section "Operation manuals".

LIM_Administrator_Manual includes all general information about LIM:

- terminology,
- process of creating indexes and performing matching
- objects created and tasks performed,
- architecture and interaction of services,
- description of the service settings.

> We recommend beginning with this document to understand the general principles of working with LIM.

The distribution package does not include the docker containers. You need to download them from the Internet. LIM services are optional and require some running LP services. See the "LIM_Installation_Manual" for more information.

Once LIM is up and running, refer to the "Reference manuals" section, which describes the OpenAPI specifications for LIM services.

# Distribution package structure

The package consist of the following directories:

Directory name | Description
--- | ---
/example-docker | The directory includes all the files required for launching LIM docker containers using Docker Compose script
/docs | Documentation for LUNA Index Module

The "example-docker" directory contains the necessary files to run LIM using the Docker Compose script and the "configs" folder, which contains the LIM settings that will need to be loaded into the Configurator.

# Distribution documentation

This section covers the documentation package for LIM. All the documents can be found in "/docs" folder of the distribution package.

## Operation manuals

These manuals cover general LIM processes, architecture, system requirements, information about compatibility of LUNA Index Module and LUNA PLATFORM and release notes.

Documents are provided in HTML format.

File | Description
--- | ---
LIM_Release_Notes | Release notes.
LIM_Administrator_Manual | Administrator manual.
LIM_System_Requirements | System requirements.

## Installation manuals

The following manuals describe how to deploy and upgrade in a variety of ways.

The manuals can be found in the "./docs/InstallationManuals" directory.

Documents are provided in HTML format.

File | Description
--- | ---
LIM_Installation_Manual | Manual installation. Describes preparing the environment and launching all Docker containers manually on a separate server.
LIM_Upgrade_Manual | Manual upgrade. Describes updating the environment and launching new Docker containers manually on a separate server.
LIM_Docker_Compose_Deployment_Example | Example deployment using Docker Compose. Describes installing on a bare-metal server from scratch using an example Docker Compose script in the distribution package.

## Reference manuals

These manuals describe the OpenAPI specifications for LIM services. OpenAPI specification is the only valid document providing up-to-date information about the service API. The specification can be used:

- By documentation generation tools to visualize the API.
- By code generation tools.

All the documents and code generated using this specification can include inaccuracies and should be carefully checked.

The manuals can be found in the "./docs/ReferenceManuals" directory. This directory includes documents in the YML and HTML format. Documents in YML format contain requests to all LIM services. You can use them to automatically generate requests in Postman. It is not guaranteed that all requests will be imported correctly, manual editing may be required. Documents in HTML format are used to visualize these specification and may not be complete.

File | Description
--- | ---
IndexedMatcherReferenceManual | Indexed Matcher service API description
IndexerReferenceManual | Indexer service API description
IndexManagerReferenceManual | Index Manager service API description

## Developer manual

The LIM developer manual for developers and DevOps is available for LIM. The manual can be found in the "./docs/ServiceManuals" directory.