streamnative.io
Help Center
Login
  1. StreamNative Cloud
  2. Get Started

StreamNative Cloud Console Basics

The StreamNative Cloud Console enables you to view and manage instances, clusters, tenants, namespaces, topics, view your account billing information, and more. This page describes some common tasks you can complete in the Cloud Console.

Use the Cloud Console

Access the Cloud Console at the following URL:

https://console.streamnative.cloud

To access the console, you will be required to sign in to your StreamNative Cloud account. If you don't have an account, you can sign up for one with $200 in credits.

Console Layout

There are 5 elements in the Cloud Console:

  • Breadcrumb: At the top of the console, there is a Breadcrumb-based Navigation Bar. You can use the Breadcrumb to navigate the structure of StreamNative Cloud.
  • Navigation Pane: On the left side of the console, there is a Navigation Pane that contains the resources available to you at the current level of navigation. The resources at each level are different based on the level of navigation.
  • Main Workspace: To the right of the Navigation Pane is the Main Workspace. This area displays the content and functionality related to the resource you've selected in the Navigation Pane, allowing you to view, manage, and interact with your chosen resources.
  • User Menu: In the top-right corner is the User Menu. This menu contains options for managing your account settings, viewing organization details and resources, accessing documentation, and logging out. It also displays your current user information.
  • Chat Dialog: In the bottom-right corner of the Main Workspace, you can find a Chat Dialog. This dialog allows you to interact directly with the StreamNative support team.

Use the Breadcrumb in the StreamNative Console to navigate the structure of StreamNative Cloud. You can switch between different instances, clusters, tenants, and namespaces by selecting your desired location from the dropdown menu.

breadcrumb

The breadcrumb contains four values that correspond to resources within a StreamNative organization:

Selecting an item in the breadcrumb will take you to the corresponding workspace to work on different levels of resources. The left Navigation Pane will show different resources based on the level of navigation.

Organization Workspace

The Organization Workspace is the landing page when you log into the StreamNative Console. It offers a comprehensive overview of your instances and users, and provides a step-by-step guide to set up and manage your first StreamNative cluster.

To return to the Organization Workspace from any level of navigation, simply click the Organization button located to the right of the StreamNative logo.

In the Organization Workspace, the left Navigation Pane displays the following resources:

  • Organization Dashboard: This central hub presents an overview of your instances and users. It also guides you through the entire process of setting up and managing your first Pulsar cluster.
  • Instances: This section allows you to view and manage all instances associated with your organization.

Organization Dashboard

The Organization Dashboard page provides an overview of the instances and users, and guides you through the complete process of setting up and managing your Pulsar cluster.

For users who don't have a cluster yet, the Organization Dashboard page serves as a prompt for moving forward in the provisioning process. For users who already have a cluster, the Organization Dashboard page encourages them to broaden their usage of StreamNative Cloud.

After logging in to the StreamNative Console, you can go to the Organization Dashboard page by clicking it on the left navigation pane. The Organization Dashboard page consists of three parts:

  • The Instance card

    You can create, view, and manage your instances on this card. For details, see work with instances.

  • The Users card

    You can invite, view, and manage users on this card. For details, see work with users.

  • The Setup guide area

    This section walks you through the basic setup and configuration process, such as adding payment methods, creating service accounts, creating your Pulsar instances and clusters, viewing your tenants and namespaces, creating your topics, setting up your client, and so on. When an operation is completed, the related checkbox is checked.

    gif of dashboard

You can access the Cluster Workspace using either of these methods:

  1. Utilize the Breadcrumb navigation:

    • First, select your desired instance.
    • Then, choose the specific cluster you want to access.

  2. Direct navigation from the Instances page:

    • Navigate to the Instances page.
    • Click on the row of the instance that contains your desired cluster.

Cluster Workspace

The Cluster Workspace is where you view and manage all the cluster-level resources, including Tenants and Secrets, and manage the cluster configuration. It also provides guides on how you can connect to the clusters using various clients, including Kafka, Pulsar, and MQTT. Additionally, it provides instructions on how to use our cloud metrics API to monitor the cluster.

Switch a Cluster

You can use the Breadcrumb to switch to a different cluster within the same instance. If you want to switch to a different instance, you can go back to the Organization Workspace first and select a different instance from the dropdown menu.

Left Navigation Pane

The left Navigation Pane displays the following resources:

  • Cluster Dashboard: This page provides a dashboard of the cluster, including the number of topics, number of messages, number of subscriptions, storage & backlog size and throughput, and more. Additionally, it includes a details tab providing the cluster details and its access points.
  • Resources:
    • Tenants: This page allows you to view and manage all the tenants available in this cluster.
    • Secrets: This page allows you to view and manage all secrets associated with your cluster.
  • Monitor:
    • Metrics API: This page provides instructions on how to use the metrics API to monitor the cluster.
  • Clients:
    • Pulsar Clients: This page provides instructions on how to connect to the cluster using Pulsar clients.
    • Kafka Clients: This page provides instructions on how to connect to the cluster using Kafka clients.
    • MQTT Clients: This page provides instructions on how to connect to the cluster using MQTT clients.
  • Admin:
    • Configuration: This page allows you to view and manage the cluster configuration.

You can access the Tenant Workspace using either of these methods:

  1. Utilize the Breadcrumb navigation:

    • First, select your desired instance.
    • Then, choose the specific cluster that contains your desired tenant.
    • Finally, click on the name of the tenant you want to access.

  2. Direct navigation from the Tenants page:

    • Navigate to the Tenants page.
    • Click on the row of the tenant you want to access.

Tenant Workspace

The Tenant Workspace is where you view and manage all the tenant-level resources, including namespaces, topics, and more. It also provides shortcuts to connect to the clusters using various clients, including Kafka, Pulsar, and MQTT.

Switch a Tenant

You can use the Tenant selector in the Breadcrumb to switch to a different tenant within the same cluster. If you want to switch to a different cluster, you can use the Cluster selector in the Breadcrumb to navigate to a different Cluster's workspace.

Left Navigation Pane

The left Navigation Pane of a Tenant Workspace displays the following resources:

  • Tenant Dashboard: This page provides a dashboard of the tenant, including the number of topics, number of messages, number of subscriptions, storage & backlog size, throughput, and more.
  • Resources:
    • Namespaces: This page allows you to view and manage all the namespaces in this tenant.
  • Clients:
    • Pulsar Clients: This page provides instructions on how to connect to the cluster using Pulsar clients.
    • Kafka Clients: This page provides instructions on how to connect to the cluster using Kafka clients.
    • MQTT Clients: This page provides instructions on how to connect to the cluster using MQTT clients.
  • Admin:
    • Configuration: This page allows you to view and manage the tenant configuration.

You can access the Namespace Workspace using either of these methods:

  1. Utilize the Breadcrumb navigation:

    • First, select your desired instance.
    • Then, choose the specific cluster that contains your desired tenant.
    • Next, click on the name of the tenant you want to access.
    • Finally, click on the name of the namespace you want to access.

  2. Direct navigation from the Namespaces page:

    • Navigate to the Namespaces page.
    • Click on the row of the namespace you want to access.

Namespace Workspace

The Namespace Workspace is where you view and manage all the namespace-level resources, including topics, functions, connectors, and more. It also provides shortcuts to connect to the clusters using various clients, including Kafka, Pulsar, and MQTT.

Switch a Namespace

You can use the Namespace selector in the Breadcrumb to switch to a different namespace within the same tenant. If you want to switch to a different tenant, you can use the Tenant selector in the Breadcrumb to navigate to a different Tenant's workspace.

Left Navigation Pane

The left Navigation Pane of a Namespace Workspace displays the following resources:

  • Namespace Dashboard: This page provides a dashboard of the namespace, including the number of topics, number of messages, number of subscriptions, storage & backlog size, throughput, and more.
  • Resources:
    • Topics: This page allows you to view and manage all the topics in this namespace.
    • Connectors: This page allows you to view and manage all the connectors in this namespace.
    • Functions: This page allows you to view and manage all the functions in this namespace.
    • pfSQL: This page allows you to view and manage all the pfSQL queries in this namespace.
  • Clients:
    • Pulsar Clients: This page provides instructions on how to connect to the cluster using Pulsar clients.
    • Kafka Clients: This page provides instructions on how to connect to the cluster using Kafka clients.
    • MQTT Clients: This page provides instructions on how to connect to the cluster using MQTT clients.
  • Admin:
    • Bundles: This page allows you to view and manage all the bundles in this namespace.
    • Configuration: This page allows you to view and manage the namespace configuration.

User Menu

The User Menu is located in the top-right corner of the StreamNative Console. It contains the following options:

  • Organization: This option allows you to view and manage your organizations. You can use it to switch between organizations.
  • Organization Usage: This page shows the billing usage of your organization, broken down by billing cycles across different billing dimensions.
  • Accounts & Accesses: This page displays the accounts and accesses of your organization. You can access it for any account-related operations.
  • Cloud Environments: This page is for managing the BYOC infrastructure. It is the central place for you to view and manage the Cloud Connections and Cloud Environments of your organization.
  • Billing & Payment: This page shows the billing information of your organization, including your payment methods, invoices, and more.
  • Support: This option allows you to submit a ticket to the StreamNative support portal.
  • Documentation: This option provides access to the StreamNative documentation site.
  • Sign out: This option allows you to log out of your StreamNative Cloud account.
Previous
Kafka APIs
Next
BYOC Quick Start