Self Service

Glossary

Before you start using Self Service to manage your applications and streams, it is important to understand its basic concepts. The following Glossary helps with that.

Stream

a stream represents a flow of information (messages), which is continuously updated

Application

an application represents anything that is responsible for producing and/or consuming data on a stream, whether it is a Java or .NET app or a connector

Cluster

a cluster represents a physical messaging unit consisting of Kafka, Zookeeper and a Schema Registry

Environment

an environment is used to logically and/or physically separate resources on a Kafka cluster. Environments are mapped to a physical Kafka cluster through the instance (see below). Whereas public environments typically map to the application lifecycle, private environments are used to isolate a team’s apps and streams.

Instance

an instance provides an abstraction layer over 1..n clusters, making sure that all data within an instance is synchronized and all streams in different environments mapped to this instance can exist on the same underlying Kafka cluster.

Tenant

a tenant in Self Service is no other than a reference to your company and it’s context in which streams, applications, environments, instances, users and groups exist

Streams and applications are configured in 1..n environment(s)
Environments are defined in an instance

Getting started with Self Service

To access Self Service Portal, use the url provided to you by Axual or your local stream team. Latest versions of Chrome and Firefox are supported.

Internet Explorer is not a supported browser!

Logging In

To access the login screen you will need to visit a preconfigured url which will follow the same format as customers.axual.io/login/tenantName where tenantName is the name of your company or team.

Following this dependant on your organizations security mechanisms you may be presented with a OAUTH provider (Azure, LDAP, Google etc..) or a basic authentication screen will be shown if your company doesn’t support an OAUTH structure.

Login page

Browsing The Self Service Portal

The main menu is shown on the left, with links to the following pages. Use the following overview to quickly determine where to find what.

This is a test

Dashboard

an overview of all stream access requests, sorted by status (Needs action, Pending, Approved, Denied or Revoked)

This is a test

Stream graph

on this page you can see a graphical representation of all applications consuming and producing streams in the selected environment.

This is a test

Streams

an overview of all streams

This is a test

Applications

an overview of all applications

This is a test

Environments

an overview of all public and private (owned) environments

This is a test

Instances

an overview of all instances (only visible for SUPER_TENANT)

This is a test

Settings

here you will find some more tenant (company) specific information, as well as Users and Groups which have been defined in Self Service

Dashboard

As soon as you log in, the dashboard will be shown. Here you have an overview of all stream access requests that need an action, are pending, approved, denied or have been revoked.

If you are a member of the group owning a stream, the action needed list is displayed when you first visit the page. Otherwise, the pending requests list is displayed.

Dashboard

Stream graph

In this page you can see a graphical representation of all applications consuming and producing streams in the selected environment. Use the dropdown in the top to switch to a different environment.

Graph

Streams

The Streams overview displays a list of all streams:

Streams

Stream detail

Clicking on a stream takes you to the stream’s detail page:

Stream detail page

The top section of the page describes the details of the stream, such as the Key and Value schema type and schemas and the retention policy.

If you are a member of the group owning the stream, you will also see an Edit stream button on the top right corner.

The middle section of the page titled Deployments visualises the stream itself and the producer and consumer applications surrounding it. Applications displayed in green have been approved to produce to or consume from the stream, while others in grey are awaiting approval. Use the dropdown on the right to switch to a different environment.

The bottom section of the page shows the pending and approved access requested by the applications. This section is only visible to owners of the stream. For any pending request, in the Pending streams tab, there is an Approve request button, which can be used to approve the request on a particular environment and a Deny button, which can be used to deny the request. In the History tab, all applications that are already approved or denied, on an environment, are shown.

Applications

The Applications page displays a list of all applications:

Applications

Application detail

Clicking on an application takes you to the application’s detail page:

Application detail page

The top section of the page describes the details of the application. If you are a member of the group owning the application, you will also see an Edit application button on the top right corner.

The middle section of the page titled Deployments visualises the application and the streams (topics) it produces and/or consumes from any environment. The dropdown on the right can be used to switch to a different environment.

The bottom section of the page shows the streams where this application has produce or consume access under History tab. If the application has requested access (pending approval) it is also shown under the Unapproved requests tab.
To create a new access, click the + Add request button.

Environments

The Environments page displays a list of all available environments. In the "Environments" overview, only public environments are shown, as well as private environments owned by a group you are member of.

Environments

Environment detail

Clicking on an environment takes you to the Environment detail page:

Environment detail page

Instances

The Instances page displays a list of instances which are defined for your tenant. This menu option is only shown for users with the SUPER_ADMIN role.

Settings

This page describes the details of the Tenant profile (your company). By clicking on Users or Groups on the top right you can see the details of users and groups respectively.

Tenant profile