abas Software AG

Das abasfile beschreibt das gesamte abas ERP System, welches installiert werden soll. Das abasfile enthält Informationen darüber, welche Softwarekomponenten Teil des Systems sind, welche Konfiguration sie haben, auf welchem ​​Host sie ausgeführt werden und wie sie verbunden sind. Diese Beschreibung ermöglicht dem abas Installer, das tatsächliche System zu überprüfen, zu erstellen, zu bearbeiten und zu aktualisieren.

Das abasfile besteht aus vier Teilen:

Das abasfile kann erweitert werden, z.B. um einen Host oder Mandanten. Bitte achten Sie bei der Erweiterung auf die Formatierung des abasfiles (yaml Syntax)
Weitere Informationen bezüglich der Erweiterungen erhalten Sie hier.

Aufbau eines abasfiles
Metadata: (1)
  Revision: none

Hosts: (2)
  main:
    Type: <type>
    System: <system>
    Properties:
      hostname: <hostname>
      ip: <ip>
      user: <user>
      password: <password>

Modules: (3)
  <Modulename>:
    Type: <type>
    Host: <host>
    Properties:
      <property_1>: <value of property_1>
      <property_2>: <value of property_2>
      <depenet_module_1>: <name of depenet_module_1>
      <credentials>: <name of credentials>

Credentials: (4)
  <name of credentials>:
    username: <username>
    password: <password>
    scope: <scope>

1. Metadata

Nur lokale Module können installiert werden. Daher wird keine Reversion verwendet.

1.1. Aufbau

Aufbau der Metadata
Metadata: (1)
  Revision: none

1.2. Properties

Name Typ Bedeutung

1

Revision

Text

Wird nicht verwendet

2. Hosts

Ein Host ist ein Server, der ein Teil des beschriebenen Systems ist. Der Server muss über ssh als root oder als Benutzer mit sudo-Berechtigungen zugänglich sein. Im abasfile können mehrere Hosts definiert werden.

Folgende Hosts sind möglich:

  • Physische Maschine

  • Virtuelle Maschine

  • Docker-Container

  • Andere Arte von Maschine

2.1. Aufbau

Aufbau der Hosts
Hosts:
  <name>:
    Type: ssh
    Properties:
      ip: <ip>
      hostname: <hostname>
      user: abasmanage
      password: <password>

2.2. Properties

Name Bedeutung

1

ID

Name

Eindeutiger Name. Dieser wird in den Modulen verwendet.

2

Type

Typ

Gültiger Wert: ssh

3

System
(optional)

Betriebssystem

Der abas Installer erkennt das System automatisch. Mit diesem Parameter kann das erkannte System überschrieben werden.

Gültige Werte:
amazon 2, debian 8, debian 9, ubuntu 18.04, centos 7, redhat 7

Achtung: Nicht alle vom abas Installer unterstützten Betriebssysteme werden auch von abas ERP unterstützt.

4

Phony
(optional)

Abschaltung der Überprüfung des Hosts

Ein "falscher" Host ist dem Installationsprogramm bekannt, auf den er jedoch nicht zugreifen kann. Der Parameter kann verwendet werden, um Module so zu konfigurieren, dass sie mit bereits ausgeführten Diensten des Hosts arbeiten, die vom abas Installer nicht berührt werden sollen.

Standardwert: false

Gültige Werte:
true, false

Properties

1

ip

IP

IPv4-Adresse zur Herstellung der Verbindung.

2

hostname

Name des Systemhosts.

3

user

Benutzer

Der Benutzer, den der abas Installer zur Installation verwendet. Er muss root sein oder über sudo root werden können.

Gültiger Wert: abasmanage

4

password

Passwort

Verwendung für die SSH-Authentifizierung, wenn key_mode nicht aktiviert ist.
Bei der verschlüsselten Authentifizierung (und des benutzers: root) ist das Kennwort nicht erforderlich.

5

credentials

Anmeldeinformation

Name der Anmeldeinformation im Bereich Credentials (Empfehlung: scope: local).
Anstelle von Benutzer und Passwort.

6

port
(optional)

Port

Der Port, an dem der SSH-Server empfangsbereit ist.

Standardwert: 22

7

key_mode
(optional)

Verschlüsselungsmodus

Festlegung einer verschlüsselten Authentifizierung. Nur in Verbindung mit dem Parameter key nutzbar.

Standardwert: false

Gültige Werte: true, false

8

key
(optional)

Schlüssel

Angabe eines privaten Schlüssels. Der Wert ist der Dateiname des Schlüssels ohne Pfad.

3. Modules

Ein Modul ist ein Baustein, der eine Software auf dem System verwalten soll. Der abas Installer installiert das Modul auf dem Host und überprüft, ob die Software funktioniert und korrekt konfiguriert ist. Dazu müssen alle erforderlichen Konfigurationswerte definiert werden. Ein Modul kann auch von einem anderen Modul abhängen.

In der Version 2019r4n07 sind die Module Dashboard, Freitexteditor und Rest API integriert. Der Freitexteditor und das Dashboard sind Webanwendungen. Daher benötigen Sie einen Webserver. Zusätzlich benötigt das Dashboard noch eine Datenbank zur Speicherung der Daten. Die Benutzerauthentifizierung wird von Keycloak übernommen. Hier ist eine Anbindung des LDAPs oder ADs möglich. Außerdem wird ein Lizenzverwalter installiert. Dieser prüft, ob die Lizenzen für abas ERP und abas Dashboard gültig sind.

Die Verknüpfungen der einzelnen Module sind in der folgenden Abbildung ersichtlich:

Weitere Informationen bezüglich der Konfiguration erhalten Sie hier.

4. Credentials

Anmeldeinformationen (engl. Credentials) können als Parameter für Module oder für den Host verwendet werden. Anstatt die Anmeldeinformationen im abasfile zu definieren, können sie auch in die Datei credentials.yml geschrieben werden. Jeder Anmeldeinformation kann einen Bereich, einen Benutzernamen, ein Kennwort und dessen Interaktivität definieren.

Diese Datei muss im selben Ordner wie das abasfile liegen.
Befinden sich Anmeldeinformationen mit derselben Kennung im abasfile.yml, werden die Daten vom credentials.yml ignoriert.

4.1. Aufbau

Aufbau der Credentials
Credentials:
  <credential identifier>:
    scope: <scope>
    username: <username>
    password: <password>
    interactive: <interactive>

4.2. Properties

Name Bedeutung

1

ID

Eindeutiger Name. Dieser wird im abasfile angegeben.

Properties

1

username

Benutzername

2

password

Passwort

3

scope
(optional)

Speicherart

Standardwert: local

local: Keine Kopie auf den Host. Nutzung zur Hostauthentifizierung.

module: Kopie auf alle Hosts. Nutzung zur Hostauthentifizierung und als Parameterwert.

registry: Nutzung als Parameterwert. Die Daten werden durch ein Registrierungstoken ersetzt. Dieser wird auf alle Hosts kopiert und ist 1 Stunde gültig. Alle 15 Minuten wird der Benutzer erneut nach dem Benutzernamen/Passwort gefragt (da die Installation 45 Minuten dauern kann und das Passwort dabei benötigt wird).

4

interactive
(optional)

Abfrage des Benutzers

Standardwert: false

true: Benutzer soll nach seinen Anmeldeinformationen während der Installation gefragt werden. Punkt 1 und Punkt 2 sind nicht angegeben.

false: Anmeldeinformationen sind bei Punkt 1 und Punkt 2 angegeben.