- Manage StreamNative Clusters
- Manage BYOC Infrastructure
Manage Cloud Environments on StreamNative Cloud
Public Preview
This feature is currently in Public Preview. Exercise caution before using it for provisioning production environments. If you encounter issues while creating a Cloud Connection or Cloud Environment, please submit a ticket.
Note
This document assumes that you have already created a Cloud Connection allowing StreamNative to connect to your cloud account. If you have not yet done so, please create a Cloud Connection first, and then return to this page to continue setting up your Cloud Environment.
A Cloud Connection provisions a Pool that enables you to deploy BYOC instances. Within that Pool, you can create Cloud Environments, which provision Pool Members in your designated cloud region. After creating a Cloud Environment, you can create an Instance and then create a cluster within that instance.
Plan a Cloud Environment
Before you start provisioning a cloud environment, you need to plan for the required information. The information you need to provide depends on your cloud provider. Here is a summary of the required information:
Region
Select the region where the Cloud Environment will be created.
VPC
Choose between using a StreamNative-managed VPC or your own VPC (aka Bring Your Own Network
, or BYON
).
StreamNative-managed VPC
If you decide to use a StreamNative-managed VPC, you need to provide the CIDR value for the VPC. Below are the recommended default CIDR values for each cloud provider:
- AWS
- Default VPC CIDR:
10.60.0.0/16
(must between/16
and/28
), but we suggest using/16
to/18
, otherwise there will not be enough IP addresses. - The subnet CIDR will be calculated by VPC CIDR.
- Default VPC CIDR:
- GCP
- Default VPC CIDR:
10.0.0.0/16
- Secondary ranges for pods and services:
- Pods:
192.168.0.0/16
- Services:
192.168.64.0/18
- Pods:
- Default VPC CIDR:
- Azure
- Default VPC CIDR:
10.70.0.0/16
- Default Subnet CIDR:
10.70.0.0/24
- Default VPC CIDR:
Bring You Own Network (BYON)
BYOC Pro Feature
This feature is available in BYOC Pro. Please contact us if you are interested in BYOC Pro.
Note
BYON is currently available only on AWS and GCP. Support for Azure is coming soon.
If you decide to use your own VPC, please make sure that the VPC meets the following requirements:
- The VPC must be tagged with
Vendor=StreamNative
on both VPC and subnets. - For private subnets, tag them with
Type=private
. - For public subnets, tag them with
Type=public
.
If you don't tag the VPC and subnets with the required tags, the Cloud Environment provisioning will fail as we don't have the permission to access the VPC and subnets.
Bring Your Own DNS
BYOC Pro Feature
This feature is available in BYOC Pro. Please contact us if you are interested in BYOC Pro.
Note
BYON is currently available only on AWS and GCP. Support for Azure is coming soon.
By default, all the clusters will have a StreamNative-generated DNS record. If you want to use your own DNS, you need to provide the DNS Zone ID for a public hosted zone.
Default Gateway
Select the endpoint type for the default gateway. A gateway exposes service endpoints externally and can be either public or private. If you select private, you must provide allowed IDs for creating privatelink services. The allowed IDs are the account IDs that you want to grant access to the private endpoints.
Create a Cloud Environment
After you have planned all the required information, you can then provision a cloud environment through Cloud Console, snctl
, or StreamNative's Terraform provider.
Tutorial
You can watch the video of creating a cloud environment using Cloud Console UI:
Step-by-step guide
In the upper-right corner of Cloud Console, click your user profile, and in the dropdown menu, click Cloud Environments.
On the Cloud Environments page, click the + Create button and select Create environment.
On the Cloud Connection page, select the cloud connection you want to use, then click Environment setup.
On the Cloud Environment page, fill out the required information based on what you have planned in the previous step.
Region: Select the region where the Cloud Environment will be created.
Environment tag: Select a tag for the Cloud Environment. This tag will be used for generating the name for the Cloud Environment.
VPC [BYOC Pro Feature]:
StreamNative-managed VPC: Provide the Network CIDR value for the VPC.
Custom Network: Provide the Network Id value of your VPC.
AWS: The Network Id is the VPC ID.
GCP: The Network Id is the Network Name.
Azure: The Network Id is the VNet Name.
Custom DNS [BYOC Pro Feature]:
If you want to use your own DNS, check Custom DNS checkbox and provide the DNS ID and DNS name of your DNS zone.
Select the CloudConnection, then click Environment setup.
Specify the region and other configurations, then click Create.
Monitoring the Provisioning Process
Creating a Cloud Environment through Terraform does not immediately create the Cloud Environment, but rather kicks off a process that creates it. Provisioning a Cloud Environment takes approximately 40 minutes. You will receive an email notification when the Cloud Environment is ready or if there are any issues.
At the same time, if you want to monitor the provisioning process, you can use snctl
.
snctl describe -n orgname cloudenvironment CLOUD_ENVIRONMENT_NAME
- Replace
CLOUD_ENVIRONMENT_NAME
with the name of the cloud environment.
Once snctl describe
returns a status
of True
and a type
of Ready
your Cloud Environment has been provisioned, and you can create a Pulsar Cluster within it.
If this command returns an error state, please reach out to the StreamNative support team.
Update a Cloud Environment
It is generally not recommended to update a Cloud Environment once it has been created. If you need to update a Cloud Environment, please reach out to StreamNative support team to discuss your requirements.
Delete a Cloud Environment
Warning
Deleting a Cloud Environment is an irreversible action. Please exercise caution when performing this operation.
In the upper-right corner of Cloud Console, click your user profile, and in the dropdown menu, click Cloud Environments.
On the Cloud Environments page, find the cloud environment you want to delete, and click the ellipsis (...) on the right side of the row, and then click Delete.
On the Delete cloud environment page, enter the name of the cloud environment, and click Confirm.
Next steps
After setting up one or more Cloud Environments, you can proceed to create StreamNative instances and clusters within those environments.