Platform UI Chart Values Reference

This reference lists the Platform UI values the Axual Governance Helm chart exposes: the image and pull secrets, the Platform Manager and authentication endpoints, the Kafka providers, and the toggles for Topic Browse, the signup wizard, Insights, notifications, Flink, and the content security policy.

Type

Reference

Goal

Look up a Platform UI chart value while writing the Axual Governance values file.

Audience

Platform Operator deploying the Self-Service web frontend.

When to use

While configuring Platform UI, alongside the procedure that installs Axual Governance.

Contents

The sections below cover each area in this reference:

About Platform UI

Platform UI is the web frontend that gives access to the management features of Axual Governance. It is written in React and runs on nginx.

Platform UI Configuration

Platform UI needs an authentication server to obtain a JSON Web Token (JWT), and a Platform Manager to view, create, edit, and delete Axual resources. Both endpoints are set through the values below.

For the full list of configuration options, see the Configuration section of the Platform UI page.

Platform UI Repository Configuration

You can override registry, tag, and pullPolicy for the Platform UI pod. By default these values come from the Axual Governance chart. You can also override imagePullSecrets; if you leave it unset, the Platform UI pod uses global.imagePullSecrets.

values.yaml
platform-ui:

  image:
    registry: "registry.axual.io"
    pullPolicy: "Always"
    tag: "9.6.0"

  imagePullSecrets:
    - name: axualdockercred

Platform Manager Configuration

Point Platform UI at the Platform Manager it manages resources through.

values.yaml
platform-ui:

  # PlatformManager Fully Qualified Domain
  platformManager:
    fqdn: "platform-manager"

  config:
    # PlatformManager endpoint used by the UI
    mgmtApiUrl: "https://platform-manager/api"

Authentication Server Configuration

Keycloak handles authentication, and it needs the following values.

values.yaml
platform-ui:

  # -- AuthenticationService Function Qualified Domain
  # Domain where the Keycloak Auth is available
  # this domain will be added to the CSP policy
  auth0:
    fqdn: "platform-manager"

  config:
    # -- BaseUrl where the Self-Service is running
    mgmtUiUrl: "https://platform-manager"
    # -- Url where the Keycloak Auth is available
    oidcEndpoint: "https://platform-manager/auth"
    # -- ClientID identifying the Self-Service client in Keycloak
    clientId: "self-service"
    # -- Scopes used by the Self-Service client
    oidcScopes: "openid profile email"
    # -- ResponseType used by the Self-Service client
    responseTypes: "code"

Kafka Providers Configuration

List the Kafka providers Self-Service offers. At least one must be configured.

values.yaml
platform-ui:

  config:
    # Allowed Kafka Providers
    enabledKafkaProviders:
      - apache_kafka

Topic Browse Configuration

Turn on Browse and Search, and point Platform UI at the stream configuration endpoint Topic Browse uses.

values.yaml
platform-ui:

  config:
    # To enable Browse & Search with Topic Browse
    topicBrowseEnabled: true
    topicBrowseUrl: "https://platform-manager/api/stream_configs"

Wizard Configuration

organizationShortNameEditEnabled makes the Tenant Short Name editable in the signup wizard.

values.yaml
platform-ui:

  config:
    # This allows configuring the Tenant Short Name
    organizationShortNameEditEnabled: true

Insight Configuration

Turn on the Insight feature once Metrics Exposer is available, as described in How to Enable Insights and Metrics.

values.yaml
platform-ui:

  config:
    # To enable Insights with Metrics Exposer
    insightsEnabled: true
    metricsExposerUrl: "https://platform.<domain>/api/metrics"

Notifications Configuration

Turn the Notifications feature on or off.

values.yaml
platform-ui:

  config:
    # To enable Notifications
    notificationsEnabled: true

flinkEnabled shows the Flink screens in Self-Service: the Managed Flink SQL application type and Applications tab, and the Flink Support toggle on the Instance form. It’s unset by default, which hides them, and is available from Axual Governance chart version 1.6.0. See How to Enable Flink in Axual Governance for the procedure.

values.yaml
platform-ui:

  config:
    # To enable Flink SQL applications
    flinkEnabled: true

Content Security Policy Configuration

Extend the content security policy Self-Service sends with your own sources.

values.yaml
platform-ui:

  csp:
    extra:
      # Configure csp values that you may require
      scriptSrc: ""
      mediaSrc: ""
      imageSrc: ""
      styleSrc: ""
      connectSrc: ""