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 Internet connection, the HTML version requires template_VL.css.
| 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_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 |
* PDF and HTML formats
Reference manuals#
These manuals describe the public API of services. The documents in YML format includes the requests to LUNA PLATFORM services in YML format. You can use them to automatically generate requests, i. e. in Postman. It is not guaranteed that all the requests will be imported properly. Manual editing may be required.
The manuals can be found in the "./docs/ReferenceManuals" directory.
| 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.
| 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 |