Management API (Platform Manager)

About the Management API

Management API is used to administer the Axual platform. It is used to perform tasks like:

Apply topic configuration
Allow producer/consumer to access a topic
Synchronize Instance

Vault Namespace

In case you are using Hashicorp Vault Enterprise and you are using namespaces to organize your secrets, you need to update the Management API deployment with a reference for namespace.

Configure Management API with Vault Namespace

Using Axual CLI

Add or modify the following configuration in the Management API config file.

platform-config/clusters/{cluster-name}/mgmt-api.sh

# Define which Vault namespace to user
# This is optional
MGMT_VAULT_NAMESPACE="[NAMESPACE]"

Using Axual Helm Charts

Edit the values.yaml file in your working directory with the namespace you want to use.

#Update NAMESPACE for your vault
platform:
    mgmt:
      api:
        axual:
          vault:
            namespace: [NAMESPACE] # Vault Enterprise Namespace

Authentication Methods

The authentication methods provided by the platform can be configured through the configuration of Management API. By default, only SSL is configured as supported authentication methods. Find out below how additional authentication methods (e.g. SASL_SCRAM_256) can be supported for applications connecting to the platform.

Enabling additional authentication methods

From 2022.1, Management API supports SSL connections by default.
SCRAM_SHA_256 and SCRAM_SHA_512 are available only after support for it has been enabled on the broker level.

Using Axual CLI

Add or modify the following configuration in the Management API config file.

platform-config/clusters/{cluster-name}/mgmt-api.sh

# Define which authentication methods available on the Self-Service portal
MGMT_API_AVAILABLE_AUTH_METHODS="'SSL, SCRAM_SHA_256, SCRAM_SHA_512'"

Be sure to wrap your MGMT_API_AVAILABLE_AUTH_METHODS with single quote

Using Axual Helm Charts

Edit the values.yaml for your management stack and add the following configuration

platform:
    mgmt:
      api:
        axual:
          availableAuthMethods: 'SSL, SCRAM_SHA_512, SCRAM_SHA_256'