Governance Installation

This guide introduces installing Axual Governance, the control plane: the Platform Manager and Platform UI that provide Self-Service, the API Gateway in front of them, and the Keycloak, Vault, database, Topic Browse and Metrics Exposer components they depend on. Its counterpart, Streaming Installation, installs the data plane it manages. For what each governance component does, see Governance Components.

Type

Reference

Goal

Find the guide needed to install the governance layer and switch on its optional features.

Audience

Platform Operators with access to the target namespace and the Axual Helm registry.

When to use

Stage 4 of The installation order, after the streaming layer exists or an existing Kafka cluster is ready to onboard.

The pages in this section cover the governance layer, starting with the chart that deploys it:

Install Axual Governance creates the values file, selects the components to enable, and installs or removes the chart.
How to Enable Insights and Metrics switches on the Insights features, which need Kafka metrics, the gateway and the UI configured together.

To keep the credentials of Platform Manager and the other governance components out of the values file, see How to Store Component Credentials in a Kubernetes Secret.

Every value the chart accepts is listed per component, beside that component’s other details, from Platform Manager Chart Values Reference through to MySQL Chart Values Reference.

An installed governance layer still needs configuration before anyone can sign in to it. It has no Keycloak realm, no Vault secrets and no Self-Service resources until stage 6, Post-Installation Setup. When Self-Service does not come up, start from Troubleshooting.