Configure Platform UI

This page outlines the configuration values for the Platform UI deployed via Axual Governance Helm chart.

About Platform UI

Platform UI is the main web-based frontend to access management features of Axual Governance. Platform UI is written in React and runs on nginx

Platform UI Configuration

Platform UI requires configuration to interact with the Authentication Server to retrieve a JWT and with the Platform Manager to view, create, edit, and delete Axual resources.

For a complete list of configurations, please refer to Platform UI Configuration.

Platform UI Repository Configuration

Initially, you can override the registry, tag, and pullPolicy for the Platform UI pod.

By default, these values come from the Axual Governance charts.

You can also override the imagePullSecrets; if not specify the Platform UI pod will use the global.imagePullSecrets

values.yaml

platform-ui:

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

  imagePullSecrets:
    - name: axualdockercred

Platform Manager Configuration

Configure connection to Platform manager .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

Authentication can be done with Keycloak, and requires 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:
    # Keycloak Configuration
    keycloakEnabled: true
    # -- 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

You can configure the Supported Kafka providers. At least one must be configured.

values.yaml

platform-ui:

  config:
    # Allowed Kafka Providers
    enabledKafkaProviders:
      - apache_kafka

Topic Browse Configuration

You can configure the Topic Browse like the following

values.yaml

platform-ui:

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

Wizard Configuration

You can configure the Wizard to let the user decide his Tenant Short Name

values.yaml

platform-ui:

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

Insight Configuration

You can configure the Insight feature once a Metrics Exposer is available

values.yaml

platform-ui:

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

Notifications Configuration

You can configure the Notifications feature like the following

values.yaml

platform-ui:

  config:
    # To enable Notifications
    notificationsEnabled: true

Content Security Policy Configuration

You can configure the content-security policy used by the Self-Service like the following

values.yaml

Authentication can be done with Auth0 or Keycloak Authentication with Auth0 requires these values to be configured

values.yaml

platform-ui:

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

Other Configuration

Check Platform UI Configuration to view all others possible configurations.