Download offline documentation#
| Version | Release date | Documentation (zip) |
|---|---|---|
| 13.09.24 | lp_docs_ |
Distribution documentation#
This section covers the documentation package for LUNA PLATFORM. All the documents can be found in "/docs" folder of the distribution package.
Operation manuals#
These manuals cover general LP processes, architecture, user interface, system requirements and release notes.
Documents are provided in PDF and HTML formats.
| File | Description |
|---|---|
| LP_Release_Notes | Release notes. |
| LP_User_Interface_Manual | User interface manual. |
| LP_Administrator_Manual | Administrator manual. |
| LP_System_Requirements | System requirements. |
Installation manuals#
The following manuals describe how to deploy and upgrade in a variety of ways, as well as how to activate your license and use the Storages utility.
The manuals can be found in the "./docs/InstallationManuals" directory.
Documents are provided in PDF and HTML formats.
| File | Description |
|---|---|
| LP_Docker_Compose_Deployment_Example | Deployment example using Docker Compose. Describes installing on a bare-metal server from scratch using an example Docker Compose script in the distribution package. |
| LP_Kubernetes_Helm_Deployment_Example | Deployment example in Kubernetes cluster. Describes installing in a Kubernetes cluster using the Helm charts examples in the distribution package. |
| LP_Installation_Manual_Using_Storages | Manual installation using Storages utility. Describes preparing the environment using the Storages utility and launching Docker containers manually on a separate server. |
| LP_Upgrade_Manual_Using_Storages | Manual upgrade using Storages utility. Describes upgrading the environment using the Storages utility and launching new Docker containers manually on a separate server. |
| LP_Installation_Manual | Manual installation. Describes preparing the environment and launching all Docker containers manually on a separate server. |
| LP_Upgrade_Manual | Manual upgrade. Describes updating the environment and launching new Docker containers manually on a separate server. |
| LP_Migration_from_LP3 | Manual migration from LP 3 to LP 5. Describes migration of LP 3 environment and launching LP 5 Docker contents manually on a separate server. |
| LP_Migration_from_LP4 | Manual migration from LP 4 to LP 5. Describes migration of LP 4 environment and launching LP 5 Docker contents manually on a separate server. |
| LP_License_Activation_Manual | License activation manual. |
| LP_Storages_Utility_Manual | Storages utility manual. |
Storages utility enables you to check and/or prepare the environment for LUNA PLATFORM services version 5.46.1 and higher before launching them manually. It is recommended to use the installation/upgrade manuals with the Storages utility for LUNA PLATFORM versions 5.46.1 and higher.
Reference manuals#
These manuals describe the OpenAPI specifications for LUNA PLATFORM 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 LUNA PLATFORM services. You can use them to automatically generate requests in API testing tools, for example, Postman (not described in LUNA PLATFORM documentation). 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.
The OpenAPI specification for the LUNA PLATFORM services can be obtained from the "get openapi documentation" request to each service. The "Accept" header should take the value "application/x-yaml".
| File | Description |
|---|---|
| APIReferenceManual | This manual describes all general requests to LUNA PLATFORM services using API service |
| AdminReferenceManual | Admin service API description. Describes tasks run by the administrator |
| AccountsReferenceManual | Accounts service API description |
| Backport3ReferenceManual | Backport 3 API description |
| Backport4ReferenceManual | Backport 4 API description |
| ConfiguratorReferenceManual | Configurator service API description |
| EventsReferenceManual | Events service API description |
| FacesReferenceManual | Faces service API description |
| HandlersReferenceManual | Handlers service API description |
| ImageStoreReferenceManual | Image Store service API description |
| LicensesReferenceManual | Licenses service API description |
| PythonMatcherReferenceManual | Python Matcher service API description |
| SenderReferenceManual | Sender service API description. Describes receiving event notifications using web sockets |
| TasksReferenceManual | Tasks service API description. Describes requests for execution of long tasks |
| LambdaReferenceManual | Lambda service API description. Describes requests for execution of long tasks |
Developer manuals#
These interactive reference guides are intended for developers and DevOps. The manuals can be found in the "./docs/ServiceManuals" directory. The manuals contains a description of the work of LUNA PLATFORM services with a detailed disclosure of technical nuances.
| File | Description |
|---|---|
| APIDevelopmentManual/index.html | Server installation, documentation of tornado-handlers, PostgreSQL usage, admin statistics, etc. |
| AdminDevelopmentManual/index.html | Common administrative routines |
| AccountsDevelopmentManual/index.html | Accounts service description |
| Backport3DevelopmentManual/index.html | Backport 3 service description |
| Backport4DevelopmentManual/index.html | Backport 4 service description |
| ConfiguratorDevelopmentManual/index.html | Configurator service description |
| EventsDevelopmentManual/ Index.html | Events service description |
| FacesDevelopmentManual/Index.html | Faces service description |
| HandlersDevelopmentManual/index.html | Handlers service description |
| ImageStoreDevelopmentManual/index.html | Image Store service description |
| LicensesDevelopmentManual/index.html | Licenses service description |
| PythonMatcherDevelopmentManual/index.html | Python Matcher service description |
| SenderDevelopmentManual/index.html | Sender service description |
| TasksReferenceManual/index.html | Tasks service description |
| LambdaReferenceManual.index.html | Lambda service description |