Manage Cloud Environments on StreamNative Cloud

• 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.

No special tags are required.

No special tags are required.

Tutorial

You can watch the video of creating a cloud environment using Cloud Console UI:

Step-by-step guide

1. In the upper-right corner of Cloud Console, click your user profile, and in the dropdown menu, click Cloud Environments.

2. On the Cloud Environments page, click the + Create button and select Create environment.

3. On the Cloud Connection page, select the cloud connection you want to use, then click Environment setup.

4. On the Cloud Environment page, fill out the required information based on what you have planned in the previous step.

   1. Region: Select the region where the Cloud Environment will be created.

   2. Environment tag: Select a tag for the Cloud Environment. This tag will be used for generating the name for the Cloud Environment.

   3. 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.

   4. 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.

5. Select the CloudConnection, then click Environment setup.

6. Specify the region and other configurations, then click Create.

Tutorial

You can also watch the video of creating a cloud environment using snctl:

Step-by-step guide

To create a Cloud Environment using snctl, use snctl create cloudenvironment. Usage:

snctl create cloudenvironment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION

Basic Examples

snctl create cloudenvionment --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  -n ORG_NAME

snctl create cloudenvionment --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  -n ORG_NAME

snctl create cloudenvironment --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  -n ORG_NAME

snctl create cloudenvionment --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  -n ORG_NAME

Cloud Environment with a Default Private Gateway Examples

Below are examples of creating a cloud environment with a default private gateway.

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --default-gateway-access private \
  --default-gateway-allowed-ids AWS_ACCOUNT_ID_1,AWS_ACCOUNT_ID_2 \
  -n ORG_NAME

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --default-gateway-access private \
  --default-gateway-allowed-ids AWS_ACCOUNT_ID_1,AWS_ACCOUNT_ID_2 \
  -n ORG_NAME

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --default-gateway-access private \
  --default-gateway-allowed-ids GCP_PROJECT_ID_1,GCP_PROJECT_ID_2 \
  -n ORG_NAME

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --default-gateway-access private \
  --default-gateway-allowed-ids AZURE_SUBSCRIPTION_ID_1,AZURE_SUBSCRIPTION_ID_2 \
  -n ORG_NAME

BYO-Network & BYO-DNS Examples

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --network-id NETWORK_ID \
  --dns-id DNS_ID \
  --dns-name DNS_NAME \
  -n ORG_NAME

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --network-id NETWORK_ID \
  --dns-id DNS_ID \
  --dns-name DNS_NAME \
  -n ORG_NAME

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --network-id NETWORK_ID \
  --dns-id DNS_ID \
  --dns-name DNS_NAME \
  -n ORG_NAME

snctl create cloudenvionment \
  --cloud-connection-name CLOUD_CONNECTION_NAME \
  --region REGION \
  --network-id NETWORK_ID \
  --dns-id DNS_ID \
  --dns-name DNS_NAME \
  -n ORG_NAME

Manifest file

Alternatively, you can prepare a manifest file cloudenvironment.yaml to define a cloud environment, and then use snctl to create the cloud environment:

apiVersion: cloud.streamnative.io/v1alpha1
kind: CloudEnvironment
metadata:
  namespace: ORG_NAME
spec:
  cloudConnectionName: CLOUD_CONNECTION_NAME
  defaultGateway:
    access: public
  dns:
    id: DNS_ID
    name: DNS_NAME
  network:
    id: NETWORK_ID
  region: REGION

• Replace CLOUD_CONNECTION_NAME with the name of the cloud connection.
• Replace REGION with the region where the Cloud Environment will be created.
• Replace ORG_NAME with the name of the organization.
• Replace DNS_ID with the ID of your existing DNS zone (i.e. Z08392741KXNBH5WMR9PQ).
• Replace DNS_NAME with the name of your existing DNS zone (i.e. byod.aws.example.com).
• Replace NETWORK_ID with the ID of your existing VPC (i.e. vpc-0123456789abcdef0).

Then you can create the cloud environment by running snctl create -f cloudenvironment.yaml.

The name of the cloud environment will be generated automatically based on the cloud connection name, region, and environment tag. You can use snctl get cloudenvironment to find the name of the cloud environment you just created.

Then you can use snctl get cloudenvironment <name> to get the details of the cloud environment. If a Cloud Environment is successfully provisioned, all the conditions should be True.

Tutorial

You can also watch the video of creating a cloud environment using Terraform:

Step-by-step guide

To create a Cloud Environment with terraform:

1. Prepare main.tf to define the cloud environment.
2. Run terraform init to initialize the terraform project.
3. Run terraform plan to review the changes.
4. Run terraform apply to create the cloud environment.

For additional details, please refer to our Terraform module documentation on Cloud Environments.

Cloud Environment Schema

Basic Examples

module "sn_managed_cloud" {
  source = "github.com/streamnative/terraform-managed-cloud//modules/aws?ref=v3.13.1"

  external_id = "YOUR_ORG_ID"
}

resource "streamnative_cloud_connection" "shared_aws" {
    depends_on = [ module.sn_managed_cloud ]
    organization = "YOUR_ORG_ID"
    name = "YOUR_CLOUD_CONNECTION_NAME"

    type = "aws"
    aws {
        account_id = "YOUR_AWS_ACCOUNT_ID"
    }
}

resource "streamnative_cloud_environment" "aws_usw1_production" {
    depends_on = [ streamnative_cloud_connection.shared_aws ]
    organization = "YOUR_ORG_ID"
    region = "YOUR_REGION"
    cloud_connection_name = "YOUR_CLOUD_CONNECTION_NAME"

    network {
      cidr = "YOUR_NETWORK_CIDR"
    }
}

module "sn_managed_cloud" {
  source = "github.com/streamnative/terraform-managed-cloud//modules/aws?ref=v3.13.1"

  external_id = "YOUR_ORG_ID"
}

resource "streamnative_cloud_connection" "shared_aws" {
    depends_on = [ module.sn_managed_cloud ]
    organization = "YOUR_ORG_ID"
    name = "YOUR_CLOUD_CONNECTION_NAME"

    type = "aws"
    aws {
        account_id = "YOUR_AWS_ACCOUNT_ID"
    }
}

resource "streamnative_cloud_environment" "aws_usw1_production" {
    depends_on = [ streamnative_cloud_connection.shared_aws ]
    organization = "YOUR_ORG_ID"
    region = "YOUR_REGION"
    cloud_connection_name = "YOUR_CLOUD_CONNECTION_NAME"

    network {
      cidr = "YOUR_NETWORK_CIDR"
    }
}

provider "google" {
  project = "YOUR_GCP_PROJECT_ID"
}

module "sn_managed_cloud" {
  source = "github.com/streamnative/terraform-managed-cloud//modules/gcp/vendor-access?ref=v3.15.0"
  project = "YOUR_GCP_PROJECT_ID"
  streamnative_org_id = "YOUR_ORG_ID"
}

resource "streamnative_cloud_connection" "shared_gcp" {
    depends_on = [ module.sn_managed_cloud ]
    organization = "YOUR_ORG_ID"
    name = "YOUR_CLOUD_CONNECTION_NAME"

    type = "gcp"
    gcp {
        project_id = "YOUR_GCP_PROJECT_ID"
    }
}

resource "streamnative_cloud_environment" "gcp_usw1_production" {
    depends_on = [ streamnative_cloud_connection.shared_gcp ]
    organization = "orgname"
    region = "YOUR_REGION"
    cloud_connection_name = "YOUR_CLOUD_CONNECTION_NAME"

    network {
      cidr = "YOUR_NETWORK_CIDR"
    }
}

resource "streamnative_cloud_environment" "azure_eastus_production" {
    organization = "YOUR_ORG_ID"
    region = "YOUR_REGION"
    cloud_connection_name = "YOUR_CLOUD_CONNECTION_NAME"

    network {
      cidr = "YOUR_NETWORK_CIDR"
      subnet_cidr = "YOUR_SUBNET_CIDR"
    }
}

BYO-Network & BYO-DNS Examples

This example shows how to create a cloud environment using your own network and DNS.

terraform {
  required_providers {
    streamnative = {
      source = "streamnative/streamnative"
      version = "v0.7.0"
    }
  }
}

resource "streamnative_cloud_environment" "example" {
  organization          = "YOUR_ORG_ID"
  region                = "YOUR_REGION"
  cloud_connection_name = "YOUR_CLOUD_CONNECTION_NAME"
  environment_type      = "YOUR_ENVIRONMENT_TYPE"

  network {
    id = "YOUR_NETWORK_ID"
  }

  dns {
    id   = "YOUR_DNS_ID"
    name = "YOUR_DNS_NAME"
  }
}

terraform {
  required_providers {
    streamnative = {
      source = "streamnative/streamnative"
      version = "v0.7.0"
    }
  }
}

resource "streamnative_cloud_environment" "example" {
  organization          = "YOUR_ORG_ID"
  region                = "YOUR_REGION"
  cloud_connection_name = "YOUR_CLOUD_CONNECTION_NAME"
  environment_type      = "YOUR_ENVIRONMENT_TYPE"

  network {
    id = "YOUR_NETWORK_ID"
  }

  dns {
    id   = "YOUR_DNS_ID"
    name = "YOUR_DNS_NAME"
  }
}

1. In the upper-right corner of Cloud Console, click your user profile, and in the dropdown menu, click Cloud Environments.

2. 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.

3. On the Delete cloud environment page, enter the name of the cloud environment, and click Confirm.

You can delete a cloud environment using snctl:

snctl delete cloudenvironment CLOUD_ENVIRONMENT_NAME

• Replace CLOUD_ENVIRONMENT_NAME with the name of the cloud environment.

Alternatively, if you have the manifest file of the cloud environment, you can delete the cloud environment by running:

snctl delete -f cloudenvironment.yaml

You can remove the cloud environment from your terraform code and run terraform apply to delete the cloud environment.