How to Enable Flink in Axual Governance
This guide shows you how to switch on the Flink screens in Platform UI, optionally tune Flink application deployments in Platform Manager, apply the change to the Axual Governance release, and confirm Self-Service offers Flink.
Type |
How-to guide |
Goal |
Make Flink available in Self-Service so a Tenant Admin can enable it for an Instance. |
Audience |
Platform Operator with Helm access to the Axual Governance release and credentials for the Axual registry. |
When to use |
Once per installation, when adding Flink SQL support to Axual Platform 2026.3 or later after Ververica Platform is running. |
Prerequisites
Confirm the following before you begin.
Access and permissions required
You need the following access and permissions:
-
Helm permission to upgrade the Axual Governance release in its namespace.
-
Credentials for the Axual chart registry,
registry.axual.io. Contact Axual support if you have none. -
A Tenant Admin account in Self-Service, or a colleague holding one, for the Instance check in Step 4.
Tools and versions required
You need the following tools:
-
helm>= 3.12, with OCI registry support. -
kubectl>= 1.28, configured for the target cluster.
Resources that must exist before starting
The following must already exist:
-
Axual Governance installed with chart version
1.6.0or later, the first version with Flink support. To get there, see Install Axual Governance or Upgrading Streaming and Governance Charts to 2026.3. -
A Ververica Platform deployment that Platform Manager can reach. Axual doesn’t install Ververica Platform; Flink describes its role.
-
The values file the governance release runs with, as
values.yaml.
The commands use the release name governance and the namespace axual, as in Install Axual Governance. Substitute your own. Replace every <VALUE> placeholder with your own value before running a command.
|
Step 1: Switch on the Flink screens in Platform UI
Set platform-ui.config.flinkEnabled to true in values.yaml.
If the file already has a platform-ui.config block, add the key to that block rather than starting a second one.
platform-ui:
config:
flinkEnabled: true (1)
| 1 | Unset by default, which hides every Flink screen in Self-Service. |
For the other Platform UI settings, see Platform UI Chart Values Reference.
Step 2: Tune Flink application deployments (optional)
Platform Manager ships with working defaults for Flink application deployments, so skip this step unless you need to change them.
Both settings go under platform-manager.config in the same values.yaml:
-
Flink SQL Application Deployment Sizes sets the CPU and memory sizes application owners choose from, and the default size.
-
Flink SQL Application Kubernetes Pods Spec sets pod options, such as
affinityandtolerations, for every Flink SQL deployment.
Step 3: Apply the values to the governance release
Upgrade the governance release with the edited values file.
The upgrade is safe to re-run, because helm upgrade --install converges on the values you pass it.
-
Log in to the Axual registry that holds the charts.
helm registry login registry.axual.io --username <YOUR_USERNAME> -
Find the chart version the release runs.
helm list --namespace axual --filter '^governance$'The
CHARTcolumn shows the version, for exampleaxual-governance-1.6.0. Use that version as<GOVERNANCE_CHART_VERSION>in the next command, so the upgrade changes only your values. -
Upgrade the release.
helm upgrade --install governance oci://registry.axual.io/axual-charts/axual-governance \ --version <GOVERNANCE_CHART_VERSION> \ --namespace axual \ -f values.yaml
Helm replaces the Platform UI pod so it loads the new configuration, and the Platform Manager pod too if you changed its values in Step 2.
To undo the change, run helm rollback governance --namespace axual.
Step 4: Confirm Self-Service shows Flink
Confirm the new configuration reached Platform UI, then confirm the Flink screens appear.
-
Check that the replacement Platform UI pod is running.
kubectl get pods --namespace axual -l app.kubernetes.io/name=platform-uiThe pod reads
Running, with anAGEfrom after the upgrade. -
Check the configuration Platform UI serves.
kubectl get configmap --namespace axual -l app.kubernetes.io/name=platform-ui \ -o jsonpath='{.items[0].data.env\.js}' | grep -o '"flinkEnabled":[a-z]*'The expected output is
"flinkEnabled":true. No output means the key isn’t underplatform-ui.config; fix the indentation invalues.yamland repeat Step 3. -
Reload Self-Service in your browser so it loads the new configuration.
-
Open the Applications page and confirm it has a Managed Flink SQL tab.
-
Start a new application and confirm Managed Flink SQL is offered as an application type.
-
As a Tenant Admin, open the edit form of any Instance and confirm it has a Flink section with a Flink Support toggle. Leave the toggle as it is; the next guide switches it on.
Next steps
A Tenant Admin now switches Flink on for each Instance and registers its Flink Cluster: continue with Enabling Flink for an Instance, and give them the Ververica Platform details listed in its Prerequisites.