abas Software AG

The abasfile describes the entire abas ERP system which is to be installed. It contains information on which software components are part of the system, how they are configured, on which host they are run and how they are connected. This description allows the abas Installer to check, create, edit and update the actual system.

The abasfile comprises four parts:

The abasfile can be expanded, e.g., by a host or client. Please note the formatting of the abasfiles (yaml syntax)
Further information on the expansions can be found here.

Structure of an 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

Only local modules can be installed. Therefore, no revision is used.

1.1. Structure

Metadata structure
Metadata: (1)
  Revision: none

1.2. Properties

Name Type Meaning

1

Revision

Text

Not used

2. Hosts

A host is a server

which is part of the described system. It must be possible to access the server via ssh as root or as a user with sudo permissions. Multiple hosts can be defined in the abasfile.

The following hosts are possible:

  • Physical machine

  • Virtual machine

  • Docker container

  • Other type of machine

2.1. Structure

Host structure
Hosts:
  <name>:
    Type: ssh
    Properties:
      ip: <ip>
      hostname: <hostname>
      user: abasmanage
      password: <password>

2.2. Properties

Name Meaning

1

ID

Name

Unique name. This name is used in the modules.

2

Type

Typ

Valid value: ssh

3

System
(optional)

Operating system

abas Installer recognizes the system automatically. With this parameter, the recognized system can be overwritten.

Valid values:
amazon 2, debian 8, debian 9, ubuntu 18.04, centos 7, redhat 7

Warning: Not all operating systems supported by abas Installer are also supported by abas ERP.

4

Phony
(optional)

Deactivating the check of the host

An "incorrect" host is known to the installation program, which it can, however, not access. The parameter can be used to configure modules in such a way that they work with services of the host which are already running, and which are not to be affected by abas Installer.

Default value: false

Valid values:
true, false

Properties

1

ip

IPv4 address for establishing the connection.

2

hostname

Name of the system host.

3

user

The user which is used by abas Installer for the installation. It must be root or must be able to become root via sudo.

Valid value: abasmanage

4

password

Use for SSH authentication, if key_mode is not activated.
For encrypted authentication (and the user root), the password is not required.

5

credentials

Name of the credentials in the Credentials scope (recommended: scope: local).
Instead of the user and password.

6

port
(optional)

Port on which the SSH server is ready to receive

Default value: 22

7

key_mode
(optional)

Definition of encrypted authentication. Can only be used in connection with the key parameter.

Default value: false

Valid values: true, false

8

key
(optional)

Specification of a private key. The value is the file name of the key without path.

3. Modules

A module is a component which is responsible for managing software on a system. abas Installer installs the module on the host and checks if the software works and is configured correctly. For this, all required configuration values must be defined. A module can also depend on another module.

In Version 2019r4n07, the modules Dashboard, free text editor and Rest API are integrated. The free text editor and the Dashboard are web applications. Therefore, they require a web server. Additionally, the Dashboard requires a database for storing the data. User authentication takes place using Keycloak. A connection of the LDAP or AD is possible. Furthermore, a license manager is installed. It checks if the licenses for abas ERP and abas Dashboard are valid.

The following figure shows how the individual modules are linked:

Further information on the configuration can be found here.

4. Credentials

Credentials can be used as parameters for modules or for the host. Instead of defining the credentials in the abasfile, you can also write them in the credentials.yml file. Each credential can define a scope, a user name, a password and its interactivity.

his file must be in the same folder as the abasfile.
If there are credentials with the same identification in the abasfile, the data of credentials.yml are ignored.

4.1. Structure

Credentials structure
Credentials:
  <credential identifier>:
    scope: <scope>
    username: <username>
    password: <password>
    interactive: <interactive>

4.2. Properties

Name Meaning

1

ID

Unique name. This is specified in the abasfile.

Properties

1

username

User name

2

password

Password

3

scope
(optional)

Storage type

Default value: local

local: No copy to the host. Use for host authentication.

module: Copy to all hosts. Use for host authentication and as a parameter value.

registry: Use as a parameter value. The data are replaced by a registry token. This is copied to all hosts and is valid for one hour. The user is prompted for the user name/password again every 15 minutes (as the installation may take 45 minutes and the password is required for it).

4

interactive
(optional)

User prompt

Default value: false

true: The user should be promoted for their credentials during the installation. Points 1 and 2 are not specified.

false: The credentials are specified for points 1 and 2.