Create Self-Service Resources

Once you have started all the governance components and successfully configured them, it’s time to access the Self-Service to create the Axual Resources.

Sign up and register Organization

These steps are used to create the Tenant and User in the Axual Self-Service.

This user will get TENANT_ADMIN role, so they will be able to create all the mandatory resources of the organization.

  1. Access the Local login page and press the Register button

    The URL is <self-service.host>/login/local
    Local realm sign up page

  2. Fill the user details and press the Register button

    Local realm register form

  3. Provide the Organization details and press the Continue button

    Check this page to configure the wizard to expect the Organization Short Name
    Wizard Step 1 form

You have now reached the Self-Service dashboard.

Self-Service Dashboard

Create the 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. Put local as the Name

    2. Put Local cluster as the Description

    3. Put local as the Location

    4. Select Apache Kafka as the Provider Type

    Self-Service Add Cluster Details page

  3. Provide the Kafka Details

    1. Put platform.local:31767 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

  4. Toggle the Shared cluster to be no

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

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

  5. Select the Full Chain Certificate as the SSL Authentication Mode

The Full Chain Certificate option is recommended for multi-tenant environments.

  1. Provide the Cluster Patterns

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

    2. Put {tenant}-{instance}-{environment}-{group} as the Consumer Group pattern

    3. Put {tenant}-{instance}-{environment}-{transactional.id} as the Transactional ID pattern

  2. Press the Add Cluster button

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

Now that you have created a Cluster in the Self-Service, you can proceed to create an Instance.

Create the Instance

These steps are used to create an Instance in the Axual Self-Service.

We are writing the steps to create a dta instance using the local cluster created in the previous step.

  1. Open the instances menu and press the Add instance button

    Self-Service Instances Menu

  2. Provide the Instance Details and press the Continue button

    1. Put Dev Test Acceptance as the Name

    2. Put dta as the ShortName

    3. Put DTA Instance as the Description

    Do not fill the Instance Manager URL field, this field is for older installation. It will be removed in future releases.

  3. Press the Select cluster button

    Self-Service Add Instance Details page

  4. Select the local cluster created in the previous step and press the Apply button

    Self-Service Select Cluster page

  5. Enable the Authentication Method for this Instance

    1. Toggle the SSL (MUTUAL TLS)

    2. Upload the Signing CA used to sign your application certificate

  6. Press the Add Instance button

    Self-Service Add Instance Security

Now you have successfully created an Instance in the Self-Service

Self-Service Instance Create

Schema Registry Configuration

  1. Open the instances menu and select freshly created Dev Test Acceptance instance

    Self-Service Add Confluent Schema Registry Details page

  2. Under the field Clusters press Configure Cluster for cluster local. A modal for configuring the Schema Registry will open

    Self-Service Add Confluent Schema Registry Details page

    1. Put https://apicurio.axual.dta.local/apis/registry/v2 as the Schema Registry URL

    2. Select Apicurio as the Schema Registry Type

    3. Select Basic Authentication as the Authentication Method

      1. Put the username used by Platform Manager to authenticate against Apicurio Registry

      2. Put the password used by Platform Manager to authenticate against Apicurio Registry

  3. Verify the Schema Registry details and connectivity by pressing the Verify button

    Self-Service Add Apicurio Schema Registry Details page

  4. You can now press the Save button to update the Instance-Cluster

Create the Environment

These steps are used to create an Environment in the Axual Self-Service.

We are writing the steps to create a dev environment using the dta instance created in the previous step.

  1. Open the environments menu and press the New Environment button

    Self-Service Environments Menu

  2. Provide the Environment Details

    1. Put Development as the Name

    2. Put dev as the ShortName

    3. Put Dev Environment as the Description

    4. Select a Color

    5. Select Dev Test Acceptance as the Instance

    6. Select Public as the Visibility

    7. Select Auto as the Authorization Issuer

    8. Select Admins as the Owner

  3. Press the Add Environment button

    Self-Service Add Environment Details page

Now that you have created an Environment in the Self-Service, you can proceed to create a Topic.

Self-Service Environment Created page

Create the Topic

String/String Topic

These steps are used to create a string/string Topic in the Axual Self-Service and deploy to the Kafka Cluster.

We are writing the steps to create a string-string topic in the dev environment created in the previous step.

  1. Open the topics menu and press the New Topic button

    Self-Service Topics Menu

  2. Provide the Topics Details

    1. Put string-string as the Name

    2. Put String/String topic as the Description

    3. Select Admins as the Owner

    4. Select String as the Key Type

    5. Select String as the Value Type

    6. Select Delete as the Retention Policy

  3. Press the Add Topic button

    Self-Service Add Topic Details page

Now that you have created a Topic in the Self-Service, you can proceed to configure it in the previously created Environment

  1. Open the topic configuration modal

    Self-Service Configure Topic modal

  2. Provide the topic configuration and press Save

    1. Put 3 as the Retention time

    2. Put 4 as the Number of partitions

  3. Press the Save button

    Self-Service Configure Topic modal configured

Now the string-string topic is available in the kafka cluster.

Self-Service Topic Configured

Create the Application

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

We are writing the steps to create a java-producer application that will produce to the string-string topic created in the previous step.

  1. Open the applications menu and press the New Application button

    Self-Service Applications Menu

  2. Provide the Application Details

    1. Put io.axual.producer as the ID

    2. Put Java Producer as the Name

    3. Put java_prd as the Short Name

    4. Select Admins as the Owner

    5. Select Custom as the Application Type

    6. Select Java as the Type

    7. Select Public as the Visibility

    8. Put Java producer application as the Description

  3. Press the Add Application button

    Self-Service Add Application Details page

  4. Once the application has been created, be sure to have dev environment selected in the Environment Dropdown

    Self-Service Application created

  5. Open the application-authentication

    Self-Service Application Authentication button

  6. Upload your application certificate

    Self-Service Application Authentication secret

  7. Once the Platform Manager validates the application certificate, it’s possible to press the Apply button

    Self-Service Application Authentication uploaded

  8. Press the + Add request button

    Self-Service Application Add Request button

  9. Select the type of request to make

    1. Choose Producer as the Application Type

    2. Select string-string as the Topic

  10. Press the Request Approval button

    Self-Service Application Access requested

    Based on the Environment Authorization Issuer it’s possible that Stream Owner will require approving the pending access request

Since the dev Environment created as AUTO Authorization Issuer, the access request is approved.

Self-Service Application Access granted

The Topic ACL has been updated, the Application is able to produce to the string-string topic.