streamnative.io
Help Center
Login
  1. StreamNative Cloud
  2. Manage StreamNative Clusters
  3. Manage Instances

Manage BYOC Instances on StreamNative Cloud

Prerequisites

Before creating a BYOC instance and clusters, you need to prepare for the BYOC infrastructure. See BYOC Overview for more information.

After you have prepared the BYOC infrastructure, you can create a BYOC instance and clusters.

Create an instance

When creating an instance, you need to make two key choices: the data streaming engine (either Classic Engine or Ursa Engine (Public Preview)) and the cloud provider. Choose the engine based on your workload requirements, and select a cloud provider that aligns with where your applications are running for optimal performance.

Note

Please make sure you have created a cloud environment before creating a BYOC instance.

In the UI, you will create a Dedicated instance and a cluster within the instance.

  1. Navigate to the Organization Dashboard.

  2. Click Instances on the left navigation pane to go to the Instances page.

  3. Click + New Instance button to start the instance creation process.

  4. On the Choose the deployment type for your instance page, click Deploy BYOC to start the instance creation process. If you see the dialog "Cloud Environment required", you need to create a cloud environment first. After creating the cloud environment, return to step 1 to create the instance.

  5. On the Instance Configuration page, enter the Instance Name and select the Cloud Provider.

    ItemDescription
    Instance NameEnter a name for the instance. An instance name starts with a lowercase letter, contains any combination of lowercase letters (a-z), numbers (0-9), and hyphens (-), and must be 4-40 characters.
    Cloud ConnectionSelect the cloud connection you created in the previous step.
    EngineSelect the engine for the instance: Classic Engine or Ursa Engine (Public Preview).

  6. Click Cluster Location to start the cluster creation process.

  7. On the Cluster Location page, enter the Cluster Name, select the Cloud Environment from the dropdown list, then click Cluster Operation.

    ItemDescription
    Cluster NameEnter a name for the cluster. A cluster name starts with a lowercase letter, contains any combination of lowercase letters (a-z), numbers (0-9), and hyphens (-), and must be 4-10 characters.
    Cloud EnvironmentSelect the cloud environment from the dropdown list.

  8. On the Cluster Operation page:

    1. Select the Release Channel: LTS or Rapid. Please note that Rapid channel is required for running Ursa Engine.

    2. (Optional) Enable or disable the Features you want on your cluster. You can enable or disable these features at any time by editing your cluster after it has been created.

      screenshot of the cluster features section

    3. (Optional) If you have a Enterprise or Production support plan, you can customize the maintenance window for the cluster. Otherwise, you can skip this step.

    4. (Optional) Expand the Add optional custom configurations section to specify optional custom configuration parameters.

    5. Click Cluster Size.

  9. On the Cluster Size page:

    • Use the slider to adjust the throughput according to your needs.
    • In the Advanced section, you can manually configure the number of brokers, bookies, and their corresponding resources.
    • Note that bookies configuration is only required for Classic Engine. For Ursa Engine, bookie configuration is not needed.

    The estimated Monthly base cost for your cluster configuration is displayed in the right navigation pane.

  10. Click Finish to start the cluster creation process.

The cluster page appears, showing the cluster creation process. Depending on the chosen cloud provider and other settings, it might take 10-15 minutes to provision a dedicated cluster. Once the cluster is ready, the page will show Cluster Provisioned successfully and you can click Go To The Dashboard to access the Cluster Dashboard page.

Manage instances

To view instances created for an organization, follow these steps.

  1. In the upper-right corner of the StreamNative Cloud Console, click your Profile and select Organizations.

  2. Click the name of the organization you want to check.

  3. Select Instances from the left navigation pane.

  4. On the Instances page, you should able to see the list of instances available for the organization. In each Instance Card, you are able to see Instance Name, Status, Cloud Provider, Number of Clusters, and etc. You can also click the right arrow icon to go the Instance Dashboard page.

    Instances Dashboard

  5. On the Instance Dashboard page, you are able to see the list of clusters available for the instance. In each Cluster Card, you are able to see Cluster Name, Status, Number of Topics, Number of Subscriptions, Number of Producers, Number of Consumers, and etc. You can also click the right arrow icon to go the Cluster Dashboard page.

    Clusters Dashboard

Delete an instance

Note

You cannot delete an instance if there are resources associated with the instance.

  1. Navigate to the Instances page.

  2. Click the ellipsis at the top right corner of the instance card that you want to delete, and then click Delete.

  3. In the Delete instance dialog, enter the instance name and then click Confirm.

Next steps

Previous
Dedicated Instances
Next
Overview