Ververica DocsVerverica Docs
Docs Home

Using the Apache Fluss™ Console on Ververica Platform 3

3 min read

Enable the Apache Fluss Console on Ververica Platform 3, pin its images, register an Apache Fluss cluster, and browse its databases and tables.

On this page

Applies to: Ververica Platform 3, ververica-platform chart 3.1.4 or later

Overview

The Fluss Console is the Ververica Platform 3 manager of your Fluss clusters: their servers, databases, tables, and metrics. You register each cluster with its bootstrap address and a SASL user, as many as you run, and switch between them in the console. This manual covers turning the console on with its images pinned, updating it, registering a cluster, and browsing its databases and tables. The ververica-platform chart leaves the console off by default.

Prerequisites

  • A Ververica Platform 3 platform on the ververica-platform chart 3.1.4 or later, the first release with the Fluss Console, and Helm access to it: to an installed platform's release and namespace, or to the cluster and namespace a new platform installs into. See Ververica Platform 3 Getting Started.
  • A running Fluss cluster and its bootstrap address. See Deploying Fluss on Kubernetes.
  • A SASL user on that cluster for the console to sign in with. See Securing Fluss.
  • Network access from the platform's namespace to the Fluss bootstrap address.

Enabling the Apache Fluss Console

One chart value, global.flussManager.enabled, turns on both parts of the console: its backend, vvp-fluss-manager, and its frontend, vvp-fluss-ui. Put it in a values file with both image tags, for example fluss-console-values.yaml:

YAML
1global:
2  flussManager:
3    enabled: true
4
5vvp-fluss-manager:
6  image:
7    tag: 0.1.0
8
9vvp-fluss-ui:
10  ui:
11    image:
12      tag: 0.1.0

On a new platform, add the file to the platform install, after your own platform values. The rest of the install is in Ververica Platform 3 Getting Started:

BASH
1helm install <PLATFORM_RELEASE> oci://registry.ververica.cloud/platform-charts/ververica-platform \
2  --version <CHART_VERSION> \
3  --namespace <PLATFORM_NAMESPACE> \
4  --values <PLATFORM_VALUES_FILE> \
5  --values fluss-console-values.yaml

On an installed platform, upgrade its release with the file. --reuse-values keeps the values the release was installed with and applies only the ones the file sets:

BASH
1helm upgrade <PLATFORM_RELEASE> oci://registry.ververica.cloud/platform-charts/ververica-platform \
2  --version <CHART_VERSION> \
3  --namespace <PLATFORM_NAMESPACE> \
4  --reuse-values \
5  --values fluss-console-values.yaml

<CHART_VERSION> is the platform release you run, 3.1.4 or later.

The vvp-fluss-manager and vvp-fluss-ui pods start in <PLATFORM_NAMESPACE>. Check that they run:

BASH
1kubectl get pods -n <PLATFORM_NAMESPACE> | grep vvp-fluss

Then open <VVP_URL>/fluss, where <VVP_URL> is the URL of your Ververica Platform 3 platform: the Fluss Console opens.

Updating the Apache Fluss Console

The backend and the frontend update together, without a new platform release. When this manual lists newer image tags in Enabling the Fluss Console, set both in fluss-console-values.yaml:

YAML
1vvp-fluss-manager:
2  image:
3    tag: <FLUSS_MANAGER_TAG>
4
5vvp-fluss-ui:
6  ui:
7    image:
8      tag: <FLUSS_UI_TAG>

Then run the upgrade command of Enabling the Fluss Console again, with the same <CHART_VERSION>. --reuse-values keeps the rest of the platform as it is. Check that the vvp-fluss-manager and vvp-fluss-ui pods run, then reload <VVP_URL>/fluss:

BASH
1kubectl get pods -n <PLATFORM_NAMESPACE> | grep vvp-fluss

Registering a Cluster

Open the Fluss Console at <VVP_URL>/fluss, a page of its own, not part of the Ververica Platform 3 console's sidebar. A console with no cluster opens on the Register Fluss cluster form; otherwise, open the cluster switcher in the top bar (the button named after the current cluster) and click Register new cluster. Fill in:

  • Cluster name: <CLUSTER_NAME>, the name the console lists the cluster under
  • Bootstrap endpoint: <FLUSS_BOOTSTRAP>, the cluster's bootstrap address
  • External endpoint: leave empty
  • Auth protocol: SASL
  • Username: <FLUSS_USERNAME>
  • Password: <FLUSS_PASSWORD>

For example:

Fluss Console registration form

Confirm with Register. If the console lists several clusters, select <CLUSTER_NAME> in the cluster switcher.

The console opens the cluster's Overview: Server status shows [ HEALTHY ] once the console reaches the cluster with the bootstrap endpoint and the SASL user, and Servers counts the coordinator and the tablet servers. The Servers page lists each of them as HEALTHY. For example:

Fluss Console Overview of a registered cluster with Server status HEALTHY

Browsing Databases and Tables

In the Fluss Console, with <CLUSTER_NAME> selected, open Catalogs in the sidebar. The database switcher (the button named after the current database) lists the cluster's databases: pick <DATABASE>. The Catalogs page lists its tables; open one for its detail:

  • its columns and its properties, such as table.datalake.enabled;
  • its primary key, on a primary-key table.

For example:

Fluss Console: a database with its tables

Troubleshooting

The console page does not open

Check that the vvp-fluss-manager and vvp-fluss-ui pods run in <PLATFORM_NAMESPACE>, and read the logs of one that does not:

BASH
1kubectl get pods -n <PLATFORM_NAMESPACE> | grep vvp-fluss
2kubectl describe pod <POD_NAME> -n <PLATFORM_NAMESPACE>
3kubectl logs <POD_NAME> -n <PLATFORM_NAMESPACE>

If neither pod exists, the release does not have global.flussManager.enabled on: run the upgrade in Enabling the Fluss Console again.

A registered cluster is not healthy

Check, in this order:

  • the Bootstrap endpoint is the cluster's bootstrap address;
  • the platform's namespace reaches that address over the network;
  • the Username and Password are those of a SASL user on the cluster.

Further Reading

Was this helpful?