Kommandozeilenwerkzeug für Serversteuerung

Alle Microservices werden im Rahmen eines charly-Updates durch den charly-Updater registriert und gestartet. Für den Fall, dass ein Microservice z.B. für eine Konfigurationsänderung manuell gestoppt und wieder gestartet werden muss, gibt es das Tool ACD.

Das ACD-Tool besteht aus jeweils einer Skriptdatei für Windows (acd.bat) und macOS (acd.sh). Die Skriptdateien sind grundsätzlich in Funktion und Oberfläche identisch. Das Skript muss über die Kommandozeile im Administratormodus ausgeführt werden. Dazu muss in der Kommandozeile der Pfad zu dem Verzeichnis geöffnet sein, in dem die Skripdateien (acd.bat bzw. acd.sh) liegen.

Die Skriptdateien befinden sich unter: \Solutio\Server\ncjs.

Aufruf

Der Aufruf beginnt immer mit der Angabe des Skripts gefolgt von dem eigentlichen Befehl. Die Syntax lautet wie folgt:

Es gibt Befehle, die für alle bekannten Microservices gleichzeitig durchgeführt werden und Befehle, mit denen Sie nur einen bestimmten Microservice ansprechen. Für diese „Einzelbefehle“ müssen Sie den Short Name des Microservices angeben. Die Short Names der Microservices finden Sie heraus, indem Sie in der Kommandozeile folgenden Befehl eingeben:

Als Ergebnis erhalten Sie eine Liste aller bekannten Microservices.

Beispiel: Im Folgenden ein Beispiel für den Auth-Microservice. Der Short Name ist die Angabe hinter Name. In diesem Fall auth: 
     Name: auth
   Memory: 32m/256m
 Filename: auth-service-app-1.3.0-SNAPSHOT.jar
Full name: NCJS Auth
    State: RUNNING

Mit dem Short Name können Sie nun einen „Einzelbefehl“ für den Auth-Microservice absetzen.

Beispiel: Der Microservice mit dem Short Name auth soll über ACD gestoppt werden.

  • Windows 

    acd.bat stop auth

  • macOS 

    sudo ./acd.sh stop auth

Befehle

Befehl Beschreibung
list Listet alle bekannten Microservices mit folgenden Informationen: Name (= Short Name), Speicher, Dateiname, voller Name und Status.
register Registriert einen Microservice als Systemdienst. Der Name (= Short Name) des Microservices muss angegeben werden.
registerall Funktioniert wie der Befehl register, wird jedoch für alle bekannten Microservices ausgeführt.
start Startet einen Microservice. Der Name (= Short Name) des Microservices muss angegeben werden. Um den Start-Befehl erfolgreich auszuführen, muss der Microservice bereits registriert sein.
startall Funktioniert wie der Befehl start, wird jedoch für alle bekannten Microservices ausgeführt. Um den Start-Befehl erfolgreich auszuführen, müssen die Microservices bereits registriert sein.
stop Stoppt einen Microservice als Systemdienst. Der Name (= Short Name) des Microservices muss angegeben werden.
stopall Funktioniert wie der Befehl stop, wird jedoch für alle bekannten Microservices ausgeführt.
unregister Meldet einen Microservice als Systemdienst ab. Der Name (= Short Name) des Microservices muss angegeben werden. Falls der Microservice noch läuft, führt diesen Befehl vor dem unregister ein stop durch.
unregisterall Funktioniert wie der Befehl unregister, wird jedoch für alle bekannten Microservices ausgeführt. Für Microservices, die noch laufen, führt diesen Befehl vor dem unregister ein stop durch.

How-to

Windows

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Stoppen Sie die Microservices mit folgendem Befehl:

    acd.bat stopall

  6. Drücken Sie die Enter-Taste.

    • Die Microservices werden gestoppt.

Alle Microservices starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen der Microservices. Einziger Unterschied ist der Befehl, mit dem Sie die Microservices starten:

acd.bat startall
Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Diese Funktionalität benötigen Sie beispielsweise, um für einen Microservice eine kundenspezifische Konfiguration in der Konfigurationsdatei (application.yml) zu hinterlegen.

Voraussetzungen

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Stoppen Sie den Microservice mit folgendem Befehl:

    acd.bat stop <Short Name>
    Beispiel: 

    acd.bat stop ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird gestoppt.

Einzelnen Microservice starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice starten:

acd.bat start <Short Name>
Beispiel: 

acd.bat start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Beim Deregistrieren, wird der Microservice zuvor automatisch gestoppt.

Voraussetzungen

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Deregistrieren Sie den Microservice mit folgendem Befehl:

    acd.bat unregister <Short Name>
    Beispiel: 

    acd.bat unregister ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird deregistriert.

Einzelnen Microservice registrieren

Die Vorgehensweise ist dieselbe, wie beim Deregistrieren des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice registrieren:

acd.bat register <Short Name>
Beispiel: 

acd.bat register ehkp

Einzelnen Microservice starten 

acd.bat start <Short Name>
Beispiel: 

acd.bat start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Geben Sie folgenden Befehl ein:

    acd.bat list
    • Als Ergebnis erhalten Sie eine Liste aller bekannten Microservices.

Mac

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Stoppen Sie die Microservices mit folgendem Befehl:

    sudo ./acd.sh stopall

  6. Drücken Sie die Enter-Taste.

    • Die Microservices werden gestoppt.

Alle Microservices starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen der Microservices. Einziger Unterschied ist der Befehl, mit dem Sie die Microservices starten:

sudo ./acd.sh startall
Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Diese Funktionalität benötigen Sie beispielsweise, um für einen Microservice eine kundenspezifische Konfiguration in der Konfigurationsdatei (application.yml) zu hinterlegen.

Voraussetzungen

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Stoppen Sie den Microservice mit folgendem Befehl:

    sudo ./acd.sh stop <Short Name>
    Beispiel: 

    sudo ./acd.sh stop ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird gestoppt.

Einzelnen Microservice starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice starten:

sudo ./acd.sh start <Short Name>
Beispiel: 

sudo ./acd.sh start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Beim Deregistrieren, wird der Microservice zuvor automatisch gestoppt.

Voraussetzungen

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Deregistrieren Sie den Microservice mit folgendem Befehl:

    sudo ./acd.sh unregister <Short Name>
    Beispiel: 

    sudo ./acd.sh unregister ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird deregistriert.

Einzelnen Microservice registrieren

Die Vorgehensweise ist dieselbe, wie beim Deregistrieren des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice registrieren:

sudo ./acd.sh register <Short Name>
Beispiel: 

sudo ./acd.sh register ehkp

Einzelnen Microservice starten 

sudo ./acd.sh start <Short Name>
Beispiel: 

sudo ./acd.sh start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Geben Sie folgenden Befehl ein:

    sudo ./acd.sh list
    • Als Ergebnis erhalten Sie eine Liste aller bekannten Microservices.