Managing clusters

Contents

Creating a Cluster

These steps are used to create a Cluster in the Axual Self-Service.

We are writing the steps to add the local cluster started with the Axual Streaming Charts. But these steps can be used as reference for any cluster

  1. Open the clusters menu and press the New Cluster button

    Self-Service Clusters Menu

  2. Provide the Cluster Details

    1. Input local as the Name

    2. Input Local cluster as the Description

    3. Input local as the Location

    4. Select Apache Kafka as the Provider Type

  3. Press the Continue button

    Self-Service Add Cluster Details page

  4. Provide the Kafka Details

    1. Input platform.local:31575 as the Kafka bootstrap URL

    2. Select TLS as the Authentication Method

    3. Upload a super-user certificate

    4. Upload a super-user private-key

    5. Press the Verify button to validate that the above information is valid

    Self-Service Add Kafka Details section

  5. Toggle the Shared cluster to be no

    Shared clusters are visible to all tenants defined in the Axual platform. Only SUPER_ADMIN can manage those clusters.

    Private clusters are visible to only the tenant that has defined it. TENANT_ADMIN can manage those clusters.

  6. Provide the Cluster Patterns

    1. Input {tenant}-{instance}-{environment}-{topic} as the Topic pattern

    2. Input {tenant}-{instance}-{environment}-{app.id} as the Consumer Group pattern

    3. Input {tenant}-{instance}-{environment}-{app.id}-{transactional.id} as the Transactional pattern

      Self-Service Add Cluster Patterns section
    The cluster patterns are used to decide how many instances, environments, and tenants can use this cluster.

  7. Press the Add listener button

    1. Input mTLS as the Protocol

    2. Input platform.local:31757 as the URL

      Self-Service Add Cluster Advertised listeners section
    The Advertised listeners (authentication methods) are used to connect directly to our kafka outside of the cluster. You can add more listeners and there are no validation on our side

  8. Press the Add Cluster button

Editing a Cluster

Tenant Admin can Edit a cluster that they own. To update a cluster:

  1. Visit the Clusters page and click on the cluster you want to edit.

  2. Click on the Edit Cluster button on the bottom right.

    Cluster Edit Page

  3. Fill in or change any information you need and click the Update cluster button.

If you change any of the Kafka bootstrap credential you will need to Verify before you can update.

Deleting a Cluster

Tenant Admin can delete a cluster that they own providing that there are no active instances defined for it.

  1. Navigate to the edit cluster page and then click the Delete Cluster Button

  2. If there are active instance defined for the cluster, the Delete Cluster Button will be disabled with a hover tooltip:

    Cluster Delete Button Disabled

  3. Providing there are no active instance defined for it the following modal will be displayed:

    Cluster Delete Modal

Once you’ve confirmed that you would like to delete the cluster it will be removed and no longer accessible by any instance.