If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

Quickstart Guide

Overview

The RDM solution consists of four components:

Keycloak - Third-party identity and access management tool.
RDM Server - The Ataccama RDM processing engine.
RDM Webapp - The Ataccama RDM web application.
Relational database (PostgreSQL, MS SQL, or Oracle), which acts as the backend database for the RDM solution.

Each of these components is configured as a Linux service which can be restarted independently and which has its own logs that can be used for identifying issues.

Databases

RDM supports PostgreSQL, MS SQL, and Oracle relational databases. Only the PostgreSQL Standalone installation is supported by Ataccama. Other options (Oracle, MS SQL, RDM from Amazon, Azure SQL Services) should be prepared, provided, and maintained by the client.

The following description applies to the maintenance of the PostgreSQL Standalone solution.

Architecture

Depending on the desired architecture, there can be a different number of servers. Due to this, the following information should be interpreted according to your environment architecture, and the commands should be executed on the relevant server, where a specific component is installed.

Common architectures are:

Small schema:
- RDM server: With Keycloak, RDM Server, and RDM Webapp installed.
- Database server or service: Relational database on a dedicated server.
Medium Schema:
- Web server: With Keycloak and RDM Webapp installed.
- App server: With RDM Server installed.
- Database server or service: Relational database on a dedicated server.
Large Schema:
- Keycloak server: With Keycloak installed.
- Web server: With RDM Webapp installed.
- App server: With RDM Server installed.
- Database server or service: Relational database on a dedicated server.

Dependencies

The core element of the RDM solution is the relational database. If the database is not available, none of the further components can start.
The Keycloak component is a hard requirement, without which the RDM engine and the RDM webapp cannot work.
The RDM engine is a hard requirement, without which the RDM webapp does not show any content, as the content should be provided by a project started by the RDM engine.

Using this dependencies flow, troubleshooting can be narrowed down to a specific part of the RDM solution.

Applications as services

Every application is configured as a Linux service, and its service file can be found in the default Linux folder for services. This folder is /etc/systemd/system and the service names are as follows:

Keycloak service name: keycloak-server.service.
RDM Server service name: server-rdm.service.
RDM Webapp service name: rdm-webapp.service.
Standalone PostgreSQL (optional) service name: postgresql-<version>.service.

Start, stop, restart

As standard Linux services, Ataccama services can be maintained via the systemctl command.

Use the following commands:

To start the application: systemctl start <service-name>.
To stop the application: systemctl stop <service-name>.
To restart the application: systemctl restart <service-name>.
To see the status of the application: systemctl status <service-name>.

Where <service-name> is one of the service names mentioned in Applications as services.

Logs

Each component of the solution has a dedicated folder to store log files.

Keycloak: /<path-to-keycloak>/standalone/log with log file server.xml.
RDM Server: /<path-to-rdm-server>/runtime/server/log with log file server.out.
RDM Webapp: /<path-to-rdm-webapp>/log with log file spring-boot-logger.json.log. Alternatively, access the component log using the Linux service journal logs command journalctl.

For example, if you want to read the entire log of the service, use the following command: journalctl -u <service-name>.

To see live logs, use the following command: journalctl -u <service-name> -f.

To see logs immediately once you start the service, you can combine the start, stop, restart, and log commands in the following way:

systemctl start <service-name> && journalctl -u <service-name> -f

systemctl stop <service-name> && journalctl -u <service-name> -f

systemctl restart <service-name> && journalctl -u <service-name> -f

Configuration files

All configuration files of the solution are provided in the following list and can be used in order to identify component-to-component connection information, connection to the databases, etc.

Keycloak

The only Keycloak configuration file containing connection details for the relational database is the standalone.xml file located in /<path-to-keycloak>/standalone/ configuration.

RDM Server

Configuration for the RDM server is always provided within the RDM Project created in ONE Desktop.

Inside the project, the Files/etc folder can be found. This folder contains the two configuration files required to start the RDM Server application:

Server Configuration - Files/etc/rdm.serverConfig, contains:
- The application startup details.
  - TLS options.
  - Ports to be used by the application.
  - Security Filters (Keycloak Identity Provider).
- Project configuration.
  - Location of the Workflows folder.
  - Location of the Schedulers folder.
  - Location of the Resources folder.
Runtime Configuration - Files/etc/rdm.runtimeConfig, contains:
- Network connection details.
  - Connection to Keycloak.
  - Connection to the relational database.
- Other projects-related configuration.

RDM Web App

The only configuration file used by the RDM webapp is application.properties, stored in the /<path-to-rdm-webapp>/etc/ folder.

This file contains the following important properties which might be helpful for troubleshooting:

server.port - Specifies on which port the RDM webapp is running.
ataccama.one.rdm.server.url - The RDM Server URL.
ataccama.authentication.keycloak - Set of properties which specify Keycloak connection URL and other Keycloak-related details.
server.ssl.key-store - Set of modules which contain TLS certificates with which the RDM webapp starts.

Was this page useful?