Log In
Back to Designs page

Table of Contents

Related Research

No research entries have been linked to this design.

Resources

No resources available for this entry.

Additional tags

No tags are assigned to this entry.

Kafka connection panel

Jenn Giardino avatar

Author: Jenn Giardino | Last edit: May 01, 2023 | Design type: Side drawer | Product area: Kafka

Overview

The connection panel displays in a drawer and provides details needed for a client application to access the Kafka instance.

Concepts

The following sections are represented in the Connection panel:

  • Bootstrap server URL - Provides a URL needed to connect to the Kafka instance. 
  • Service accounts - Provides an option to create a new service account, provides a link to the list of service accounts where they are managed, and provides a link to the Kafka instance Access tab where to access user accounts and services accounts is managed.
  • REST APIs - Provides the 2 API URLs needed to manage Kafka instances, along with links to documentation.
  • Authentication method - Explains that SASL/OAUTHBEARER or SASL/PLAIN are the supported authentication methods and how to use them

Examples

Initial display

During Creation

If the Kafka instance is in the creating status, the connection panel is immediately available. However, the bootstrap isn't available immediatedly after the creation process starts. During this time, the bootstrap URL input is replaced with a skeleton to indicate that those contents are still in the process of being generated. 

 

When Suspended

If the Kafka instance is in the suspended status, the user can still access other panels in the drawer, so that they have access to all the properties related to the instance. However, when suspended, details that are normally available on the connection panel are no longer available. When the user selects the Connection tab, instead of seeing the usual connection contents, they will instead see an empty state.

 

REST APIs section

 

 

popover for Kafka Management API

 

popover for Kafka Management API

 

SASL/OAUTHBEARER 

popover