Creating a cluster network

Creating a cluster network in the console

To create a cluster network in the console, follow these steps:

1. From your browser, open the IBM Cloud console and log in to your account.

2. Select the Navigation menu , then click Infrastructure > Network > Cluster networks.

3. On the Cluster networks for VPC page, click Create.

4. In the Location section, edit the following fields, if necessary.

   • Geography: The geographic area for the cluster network.
   • Region: The specific region within the geography.
   • Zone: The availability zone within the selected region.

   You must create the cluster network and the virtual server instances in the same region as the VPC. For more information, see supported regions and zones for cluster networks and instances.

5. In the Details section, complete the following information:

   • Name: Enter a unique name for the virtual network interface, such as my-virtual-network-interface.
   • Resource group: Select a resource group for the virtual network interface.
   • Tags: (Optional) Add tags to help you organize and find your resources. You can add more tags later. For more information, see Working with tags.
   • Virtual private cloud: Choose the VPC to associate the cluster network with.

6. Choose the required profile for your cluster network. Available profile is Hopper 1 (hopper-1).

7. To add cluster subnets to your cluster network, enable the Cluster network subnets section. You can add cluster subnets now, or after you create your cluster network.

   • For Hopper 1, select the total number of cluster subnets that you want to create (8, 16, or 32).
   • Add a subnet prefix to your cluster subnets.

   Certain scenarios might use a larger number of subnets.

8. Review the information in the Summary panel, and click Create cluster network.

Creating a cluster network from the CLI

To create a cluster network from the CLI, follow these steps:

1. Set up your CLI environment.

2. Log in to your account with the CLI. After you enter the password, the system prompts for the account and region that you want to use:

   ibmcloud login --sso
   

3. To create a cluster network, enter the following command:

   ibmcloud is cluster-network-create --vpc VPC --zone ZONE --profile PROFILE [--name NAME] [--subnet-prefixes-cidr SUBNET_PREFIXES_CIDR] [--resource-group-id RESOURCE_GROUP_ID | --resource-group-name RESOURCE_GROUP_NAME] [--output JSON] [-q, --quiet]

Where:

-vpc

The ID or name of the VPC.

--zone

The zone this cluster network resides in. The zone must be listed as supported on the specified cluster network profile. For more information, see Cluster network supported regions and zones.

--profile

Name of the profile to use for this cluster network. Available profiles are hopper-1 for Hopper 1 cluster network.

--name

Name for the cluster network.

--subnet-prefixes-cidr

The IPv4 range of the cluster network's subnet prefix expressed in CIDR format.

--resource-group-id value

ID of the resource group. This ID is mutually exclusive with --resource-group-name.

--resource-group-name value

Name of the resource group. This name is mutually exclusive with --resource-group-id.

--output value

Specify output format, only JSON is supported. One of: JSON.

-q, --quiet

Suppress verbose output.

Creating a cluster network with the API

To create a cluster network with the API, follow these steps:

1. Set up your API environment with the right variables.

2. Store any additional variables to be used in the API commands. For example:

   version (string): The API version, in format YYYY-MM-DD.

3. When all variables are initiated, run the following command to create the cluster network:

   curl -X POST   "$vpc_api_endpoint/v1/cluster_networks?version=$api_version&generation=2" -H "Authorization: Bearer $iam_token" -d '{
      "name": "my-cluster-network",
      "profile": {
          "name": "hopper-1"
      },
      "vpc": {
          "id": "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b"
      },
      "zone": {
          "name": "us-east-3"
      }
    }'
   

   Available cluster network profiles name is hopper-1.

To view the complete set of cluster network APIs, see the VPC API reference.

Creating a cluster network interface with Terraform

The following example provisions a cluster network instance by using Terraform:

resource "ibm_is_cluster_network" "is_cluster_network_instance" {
  name            = var.is_cluster_network_name  // change to update
  profile         = "hopper-1"
  resource_group  = "fee82deba12e4c0fb69c3b09d1f12345"
  subnet_prefixes {
    cidr = "10.0.0.0/24"
  }
  vpc             = "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b"
  zone            = "us-east-3"
}