abas Software AG

1. Requirements

  • abas Installer requires Puppet-agent version 5 on every host which it accesses.
    This is automatically installed in the Installation of the modules with the step prepare-host.
    If another puppet-agent version is already installed, the installation cannot be carried out. This also applies to higher versions!

    If conflicting versions are required on a host, the abas installation program cannot be used yet.
  • abas Installer can be used on most Linux systems.

  • Docker must be installed, and the user must have the permission to use Docker.

    Make sure that users s3 and abasmanage are in the docker group.

2. host and abasmanage user

abas Installer can install software on hosts to which it has access. In your abasfile, you must configure which hosts are to be accessed and how. All these hosts must meet the following minimum requirements:

  • The hosts must be run on a supported Linux distribution.

  • An SSH server must be run.

  • sudo ust be installed.

  • A user called abasmanage with sudo permissions and ssh access must be available.

You can create the user abasmanage by executing the following commands:

sudo useradd --create-home --shell /bin/bash abasmanage
sudo usermod -aG sudo abasmanage
sudo passwd abasmanage

If no sudo group is available on your system, you must configure sudo access for administration by editing /etc/sudoers with visudo and adding the following line:

abasmanage  ALL=(ALL:ALL) ALL

If you have to create the user automatically using a script, you can set the password using the following command:

sudo bash -c 'echo <password> | passwd abasmanage --stdin'

3. Installation of the abas installer

abas Installer must be installed at least in version 0.10.1. To do this, do the following:

  1. Log in as abasmanage user
    su - abasmanage

  2. Downloaden abas Installer here (e.g. in the directory /tmp/)
    wget -O abas-installer.tgz https://registry.abas.sh/artifactory/abas.downloads/abas-installer/abas-installer.tar.gz

  3. Unpack
    tar -xvf abas-installer.tgz

  4. Run the script
    sudo abas-installer/install.sh

  5. Restart the terminal
    If Tab completion does not work, install the bash-completion-extras package.

You only need the abas-installer.tgz to install the abas installer. You can put it in the home directory of the abasmanage user, extract it there and run the install.sh script.

4. Update of the abas installer

If you have already installed abas Installer, you can update it using the abas-installer-manage-tool:

  • update-wrapper: complete re-installation of all included tools (ONLY required up to version 0.10.0)

  • update-installer: only retrieval of the latest Installer image

sudo abas-installer-manage -a update-installer

5. Configuration of the abas installer (optional)

After the installation, abas Installer does not have to be configured. However, you can create a configuration file to change the standard behavior of the installation program. All permissible configuration options are listed in the following example. They behave in the same way as the corresponding command options.

user: <registry-user> (1)
password: <registry-password>
logdir: project (2)
trace: true (3)
verbose: true (4)
logclear: true  (5)
1 Login information for the access to the registry
2 Directory in which the log file is stored (here: in project/abas-installer.log in the current working directory)
3 Print a stack trace, if the installation program has an error
4 Extended output
5 Overwrite the log file instead of attaching it

The conf.yml file must be created in a folder called .abas-installer in the home directory of your user.

With the abas Installer flag -- noconfig, you can ensure that the installation program ignores all configuration files.

6. Installation of the modules

  1. Log in as s3 user
    su - s3

  2. Download the abas Installer modules
    Download and unpack using this link or perform the following steps:

The tgz file is saved under "archives" and unpacked in "Messages/installerModules". From version 2019r4n07, a "Messages/modules" directory is automatically created, in which the extracted modules have already been stored. We chose the folder "Messages/installerModules" for the manual installation in order to separate them properly during the installation. If you are using a 2019r4 version, instead of downloading and unpacking the tgz file manually, you can simply use the "Messages/modules" folder for the following steps.

  1. Ensure module code
    Ensure that the module code is available in the following path: ${HOMEDIR}/Message/installerModules/abas/
    IMPORTANT: This is not the software itself! The modules install the software.
    Example: The Keycloak module is not Keycloak! The Keycloak module installs Keycloak.

  2. Create abasfile.yml

    • Copy the abasfile.yml file to your ${HOMEDIR} directory.
      This file contains the configuration of the dashboard and all modules that depend on it.

    • Open the file and enter all required information.
      IMPORTANT: The entry Revision: none must not be changed!
      Please note the formatting of the abasfiles (yaml syntax)

  3. Check and install abas modules
    Go to the HOMEDIR directory and execute the following commands:

    • abas-installer check-configuration -m Messages/installerModules
      If this does not work, use the full path:
      /usr/local/bin/abas-installer check-configuration -m Messages/installerModules

    • /usr/local/bin/abas-installer check-hosts -m Messages/installerModules

    • /usr/local/bin/abas-installer prepare-hosts -m Messages/installerModules

    • /usr/local/bin/abas-installer install-modules -m Messages/installerModules

  4. Check the Docker containers

    • Use the docker ps command for this.

7. Update installed modules

The update currently specifically affects the abas dashboard and the components used for this (e.g. Keycloak, web server, etc.). From version 0.12.0, the abas installer provides an automatic update routine.
Go to the update information.

8. Creating a Keycloak user

By default, Keycloak can be accessed via port 8087 after the installation.

If a different port was used, you can look it up in the abasfile.yml Use the http_port in the keycloak section.
  1. Open Keycloak

    • Check if the "abas" realm exists (top left). If not, the installation of Keycloak was not successful.

    • Open Keycloak in the browser in incognito mode (Ctrl+Shift+N).

    • Click Administration Console

    • Enter the user name and password from the abasfile (default: admin/admin).

  2. Create the user

    • Open Users

    • Compare the user data with the abas ERP admin password

      • Definition Email address must correspond.

      • Operator ID ` and `Username must correspond.

    • Define `First Name.

    • Define Last Name.

    • User Enabeld and Email Verified must be set to ON.

    • In abas ERP, SSO Login must be activated and contain an email address.

    • Click Save.

  3. Define a password

    • Open the created user.

    • Open Credentials.

    • Enter the Password (the same login as for abas ERP).

    • Set Temporary to Off.

    • Click Reset Password.

  4. Assign the user the admin group

    • Open the created user.

    • Open Groups.

    • Click Join for Available Groups.

For the BPM installation, follow the instructions from step 5 Start BPM.