Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE". Everything contained within the table is displayed in the (INTERNAL) Reports page. | Product Version | 2.4 |
|---|
| Report Note |
|
|---|
| Assignee | Antje & Inga |
|---|
Resources & Remarks
Commander Service for System Maintenance  The Commander service for yuuvis® allows you as a DevOp to perform low-level maintenance on your core system. You can adjust the differences between the DBMS, Elasticsearch, and your repository, you can access the database and carry out Elasticsearch queries to e.g. rebuild the full text index from the database.
Möglichkeit, Differenzen zwischen den einzelnen Datenspeichern erkennen und beheben zu können. - die Funktion steht als Aufruf im CommanderService zur Verfügung
- es kann über Parameter gesteuert werden, was gemacht werden soll
- Parameter können, wenn sinnvoll kombiniert werden
- Ergebnisse werden in einem Protokoll bereitgestellt
- eine Überprüfung von überflüssigen ContentStreams erfolgt nicht in diesem Task
Für einzelne Audit-Trails einstellen, wann diese aus der Audit-Tabelle entfernt werden, um ein zu starkes Anwachsen der Audit-Tabelle mit nicht mehr benötigten Einträgen zu vermeiden. - es existiert eine Konfiguration in der für allen Audit-Typen eine Retention-Zeit eingestellt werden kann
- die Zeit kann auf Tage genau konfiguriert werden
- Audit-Typen ohne Konfiguration werden nicht gelöscht
- Funktion steht als Aufruf im CommanderService zur Verfügung
- Aufruf über Cron-Job möglich (optional; wenn nicht dann neuer Task)
Remarks - v2.3 - New tooling option added (OKTO-4423)
- Antje: writing started
Modification History Add a new line to this table and fill it whenever you edit the page. | Name | Date | Product Version | Action |
|---|
| Antje | 08 FEB 2021 | 2.4 | New page properties macro. | | Antje | 05 MAR 2021 | 2020 Winter | Commands maintain compare & maintain repository added. | | Antje | 09 NOV 2021 | 2021 Winter | Version update. |
|
Perform low-level maintenance on your core system, access the database and carry out Elasticsearch queries. |
Table of Contents
|
|
Introduction
The COMMANDER service for yuuvis® allows you as a DevOp to perform low-level maintenance on your core system. You can adjust the differences between the DBMS, Elasticsearch, and your repository. You can access the database and carry out Elasticsearch queries to ,e.g., rebuild the full-text index from the database. The COMMANDER service itself does not support a REST interface of its own, but a connection via Secure Shell (SSH) instead. Thus, the COMMANDER service provides a SSH server at runtime. If you are connected to an SSH client, you can execute predefined commands with self-imposed parameters.
Service Configuration Parameters
The COMMMANDER service configuration can be adjusted via a YAML configuration file. Find available parameters and an example configuration here:
>> commander-prod.yml
COMMANDER Set Up
To use the COMMANDER service, an SSH connection is required. The recommended parameters for the configuration of the SSH connection are given in this section.
Port Redirection
The COMMANDER Service starts the SSH server per default on port 8022. If there are pods in the Kubernetes final destination platform, a forwarding has to be started for port 8022.
localhost@root:~$ kubectl port-forward -n sanity commander-0000000000-00000 8022
Connecting to SSH Client
Since the connection has to persist during long-term operations without user interactions, keepalives should be enabled. Furthermore, the COMMANDER output might contain important information and thus should be stored in a file.
Setup under Windows
Under a Windows operating system, the usage of PuTTY is recommended. The screenshot below shows the recommended PuTTY configuration enabling the keepalives on the left, and activating the output in a file on the right.
Setup under Linux
The standard SSH client can be used. The keepalive function can be activated with the option "ServerAliveInterval 20". The output in a file can be achieved by forwarding to the tee command.
localhost@root:~$ ssh -o "ServerAliveInterval 20" -l root -p 8022 127.0.0.1 2>&1 | tee commander-output.log
Executing Commands
The command help lists all available commands that are supported by the COMMANDER service.
Information on parameters of individual commands can be displayed via help <command>.
All commands related to yuuvis Momentum functionality are described here:
>> Commands
Summary
This article introduced the COMMANDER service and its functionality for yuuvis® Momentum. The available commands enable maintenance in different situations such as cleaning up the audit trail.
