MySQL

Functionality

Overview

MySQL, whether MySQL or MariaDB, is used by Axual Self-Service to store state of the platform. There are two databases used:

  • self-service-db: stores groups, topic configurations, permissions and more of the Platform Manager.

  • keycloak-db: stores configuration and user details of Keycloak

README & Changelog

The MySQL charts are taken from Bitnami and are not changed by Axual.

Example use

For a local installation of Axual Platform, a developer needs to store the state of Self Service, so they enable this component.

API

No direct interaction with the database should be needed and left to Keycloak and Platform Manager.
In some troubleshooting scenarios where access is required, starting a Pod with phpmyadmin for example would be serviceable.

Installation

SQL is a standalone component that is not dependent on another component. In a production setting, a managed database is preferred.

The Helm charts part of MySQL are aimed for local installations, NOT production setups.

Helm Charts

As part of the Governance charts, the component can be installed following the guide Axual Streaming & Governance Installation.

Configuration

Helm configuration

Logging

MySQL is not an Axual component nor written in Java, so MySQL logs will be formatted differently than the other components.
Log configurations are not described here, because the use of a managed MySQL DB is expected. The log configurations should be done by the responsible team.

Metrics

Everything in the logging section above applies to metrics as well.