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 system deployment and architecture.
Most of the documents are provided in PDF and HTML formats. The PDF document is easier for navigation, the HTML document is more convenient to copy the commands.
If there is no access to the Internet, then for the correct visualization of HTML documents, the presence of the template_VL.css file located next to the HTML document is required. This file is located in the /docs directory.
| File | Description |
|---|---|
| WhatsNew.* | Information about new features of LUNA PLATFORM 5 |
| ReleaseNotes.* | LUNA PLATFORM Release Notes |
| LP_Administrator_Manual.pdf | Administrator manual for LUNA PLATFORM |
| LP_Docker_Installation_Manual.* | General concepts for the full installation of LUNA PLATFORM using Docker containers. The example for installation on a single server is given in the manual |
| LP_Docker_Upgrade_Manual.* | General steps for upgrading from the previous LP build |
| LP_Docker_Compose_Example.* | General concepts for the full installation of LUNA PLATFORM using Docker Compose. The example for installation on a single server is given in the manual |
| LP_Migration_from_LP3.* | The manual includes general steps for migration from LUNA PLATFORM 3 to LUNA PLATFORM 5 Backport 3 |
| LP_Migration_from_LP4.* | The manual includes general steps for migration from LUNA PLATFORM 4 to LUNA PLATFORM 5 Backport 4 |
* pdf and html formats
Reference manuals#
These manuals describe the Open API 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 |
* yml and html formats
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. |
| AdminManual/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 |
| ConfiguratorDevopsManual/index.html | Configurator service description |
| EventsDevopsManual/ Index.html | Events service description |
| FacesDevopsManual/Index.html | Faces service description |
| HandlersDevelopmentManual/index.html | Handlers service description |
| ImageStoreDevopsManual/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 |