1. StreamNative Console

Log in to StreamNative Console

StreamNative Console is a web-based GUI management and monitoring tool that helps Pulsar users manage tenants, namespaces, topics, subscriptions, and so on.

After deploying StreamNative Platform and a Pulsar cluster, you can log in to StreamNative Console to manage and monitor Pulsar resources.

This document guides you through logging in to StreamNative Console in any of the following situations:

  • Authentication is disabled.
  • Only vault-based authentication is enabled.
  • Only OAuth2 authentication is enabled. StreamNative Platform supports the following OAuth2 authentication providers. You can configure one or more kinds of them.
    • Google OAuth2 authentication
    • Azure AD OAuth2 authentication
    • Okta OAuth2 authentication
  • Only JWT authentication is enabled.

Note

In the following examples, the (release name) refers to the Helm chart release when you use the sn-platform Helm chart.

Login for no authentication

By default, when authentication is disabled, an arbitrary username (admin) and an arbitrary password (apachepulsar) are initialized for StreamNative Console. You can use the initialized username and password to log in to StreamNative Console.

  1. Execute the following command to expose the StreamNative Console service to a localhost address.

    kubectl port-forward <release_name>-pulsar-streamnative-console-0 9527:9527 -n <k8s_namespace>
    
  2. Visit the StreamNative Console at http://localhost:9527.

  3. Enter the username and the password. Then, click Login to log in to StreamNative Console.

    screenshot of StreamNative Console login window

Login for vault-based authentication

When only vault-based authentication is enabled, you can log in to StreamNative Console using a username and a password. By default, an admin user is created for StreamNative Console. You can also configure a specific user and password. For details, see customize usernames and passwords.

Note

For security reasons, it is recommended to execute the following command to automatically generate the password.

kubectl get secret <release_name>-sn-platform-vault-console-admin-passwd -o=jsonpath='{.data.password}' -n <k8s_namespace> | base64 --decode; echo
  1. Execute the following command to expose the StreamNative Console service to a localhost address.

    kubectl port-forward <release_name>-pulsar-streamnative-console-0 9527:9527 -n <k8s_namespace>
    
  2. Visit the StreamNative Console at http://localhost:9527.

  3. Enter the username and the password. Then, click Login to log in to StreamNative Console.

    screenshot of StreamNative Console login window

Login for OAuth2 authentication

This section describes how to log in to StreamNative Console when OAuth2 authentication is enabled.

Login for Google OAuth2 authentication

This section describes how to log in to StreamNative Console using a Google account.

Prerequisites

To log in to StreamNative Console using a Google account, you need to enable Google OAuth2 login and configure related parameters. For details, see configure login methods.

Steps

To log in to StreamNative Console using a Google account, follow these steps.

  1. Execute the following command to expose the StreamNative Console service to a localhost address.

    kubectl port-forward <release_name>-pulsar-streamnative-console-0 9527:9527 -n <k8s_namespace>
    
  2. Visit the StreamNative Console at http://localhost:9527.

  3. Click Sign in with Google.

    screenshot of StreamNative Console login using a Google account

  4. Enter your email and then click Next.

  5. Enter your password and then click Next.

  6. (Optional) If Two-Factor Authentication (2FA) is enabled, enter the verification code and then click Next.

    screenshot of Two-Factor Authentication

Login for Azure AD OAuth2 authentication

This section describes how to log in to StreamNative Console using a Microsoft account.

Prerequisites

To log in to StreamNative Console using a Microsoft account, you need to enable Azure OAuth2 login and configure related parameters. For details, see configure login methods.

Steps

To log in to StreamNative Console using a Microsoft account, follow these s teps.

  1. Execute the following command to expose the StreamNative Console service to a localhost address.

    kubectl port-forward <release_name>-pulsar-streamnative-console-0 9527:9527 -n <k8s_namespace>
    
  2. Visit the StreamNative Console at http://localhost:9527.

  3. Click Sign in with Microsoft.

    screenshot of StreamNative Console login using a Microsoft account

  4. Enter your email and then click Next.

  5. Enter your password and then click Sign in.

Login for Okta OAuth2 authentication

This section describes how to log in to StreamNative Console using Okta.

Prerequisites

To log in to StreamNative Console using Okta, you need to enable Okta login and configure related parameters. For details, see configure login methods.

Steps

To log in to StreamNative Console using Okta,follow these steps.

  1. Execute the following command to expose the StreamNative Console service to a localhost address.

    kubectl port-forward <release_name>-pulsar-streamnative-console-0 9527:9527 -n <k8s_namespace>
    
  2. Visit the StreamNative Console at http://localhost:9527.

  3. Click Sign in with OKTA.

    screenshot of StreamNative Console login using OKTA

  4. Enter your username and password.

  5. Click Sign in.

Login for JWT authentication

This section describes how to log in to StreamNative Console when JWT authentication is enabled.

Prerequisites

Steps

To log in to StreamNative Console using a JWT token, follow these steps.

  1. Execute the following command to expose the StreamNative Console service to a localhost address.

    kubectl port-forward <release_name>-pulsar-streamnative-console-0 9527:9527 -n <k8s_namespace>
    
  2. Visit the StreamNative Console at http://localhost:9527.

  3. Click Sign in with JWT.

    screenshot of StreamNative Console login using a JWT token

  4. Enter your token and then click Login.

After logging into StreamNative Console, you can manage the following resources:

Previous
Configure StreamNative Console