Use storage-only nodes

This document describes how to use storage-only nodes in VMware Engine. Storage-only nodes, also known as storage nodes, can be used to scale the storage capacity of a vSAN cluster without adding cores or memory to the cluster. You can create clusters that contain both standard and storage-only nodes, and then expand or shrink them using the Google Cloud CLI or VMware Engine API.

Google Cloud CLI and API requirements

To use the gcloud command line tool or the API to manage your VMware Engine resources, we recommend configuring the tools as described below.

gcloud

Set your default project ID:
```
gcloud config set project PROJECT_ID
```

Set a default region and zone:

gcloud config set compute/region REGION

gcloud config set compute/zone ZONE

For more information on the gcloud vmware tool, see the Cloud SDK reference docs.

API

API examples in this documentation set use the cURL command-line tool to query the API. A valid access token is required as part of the cURL request. There are many ways to get a valid access token; the following steps use the gcloud tool to generate a access token:

Generate access token and export to TOKEN:

export TOKEN=`gcloud auth print-access-token`

Verify that TOKEN is set properly:
```
echo $TOKEN
```

Now, use the authorization token in your requests to the API. For example:

curl -X GET -H "Authorization: Bearer \"$TOKEN\"" -H "Content-Type: application/json; charset=utf-8" https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations

Python

Python code samples in this documentation use the VMware Engine library to communicate with the API. To be able to use this approach, the library needs to be installed and the Application Default Credentials should be configured.

Download and install the Python library:
```
pip install google-cloud-vmwareengine
```
Configure the ADC information by executing those command in your shell:
```
gcloud auth application-default login
```
Or, use a Service Account key file:
```
export GOOGLE_APPLICATION_CREDENTIALS="FILE_PATH"
```

For more information about the library, visit the reference page or view code samples on GitHub.

Before you begin

Before you create a private cloud with storage-only nodes, confirm that a VMware Engine network exists. If a VMware Engine network doesn't exist, create one using the Google Cloud CLI by entering the gcloud vmware networks create command:

   gcloud vmware networks create NETWORK_NAME \
      --type=STANDARD \
      --project=PROJECT_ID

Replace the following:

NETWORK_NAME: the name for the network.
PROJECT_ID: the project ID for the request.

List available node types

To verify that a storage-only node is available for your project and region, list available node types using the Google Cloud CLI or VMware Engine API.

gcloud

List available node types using the gcloud vmware node-types list command :

  gcloud vmware node-types list \
     --location=ZONE \
     --project=PROJECT_ID

Replace the following:

ZONE: the zone for this request.
PROJECT_ID: the project ID for this request.

API

To list available node types using the VMware Engine API, make a GET request:

GET "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/nodeTypes"

Replace the following:

PROJECT_ID: the project name for this request.
ZONE: the zone for the private cloud.

Create a private cloud with storage-only nodes

You can create a VMware Engine private cloud that contains storage-only nodes in addition to standard nodes using the Google Cloud console, Google Cloud CLI, or VMware Engine API.

Console

To create a private cloud with storage-only nodes using the Google Cloud console, do the following:

In the Google Cloud console, go to the Private clouds page.

Go to Private clouds
Click Select a project and then select the organization, folder, or project where you want to create the private cloud with storage-only nodes.
Click Create.
Enter a name for your private cloud.
Choose Standard for the private cloud type.
Select the location where you want the private cloud deployed.
Enter a name for the primary cluster.
Select the node type for your primary cluster.
Select the number of nodes for the private cloud. For production workloads, create your private cloud with at least 3 nodes. VMware Engine deletes private clouds that contain only 1 node after 60 days.
Optional: Click the Customize Node Cores toggle if you want to reduce the number of available cores for each node in the management cluster. For details, see Custom core counts.
Select the storage node model and node count.
Enter a CIDR range for the VMware management network. Make sure that the CIDR range doesn't overlap with any of your on-premises or cloud subnets.
Select Create new network to create a new VMware Engine network or select from an existing network, if applicable.
Click Create to begin creating the private cloud.

gcloud

To create private cloud with storage-only nodes using the Google Cloud CLI, do the following:

Create a private cloud PC_STORAGE_NODE_NAME with n standard-72 nodes and m storage-only-standard-72 by entering the gcloud private-clouds create command:
```
gcloud vmware private-clouds create PC_STORAGE_NODE_NAME \
 --location=ZONE \
 --project=PROJECT_ID \
 --description=DESCRIPTION \
 --management-range=IP_ADDRESS \
 --cluster=CLUSTER_NAME \
 --node-type-config=type=standard-72,count=n \
 --node-type-config=type=storage-only-standard-72,count=m \
 --vmware-engine-network=NETWORK_NAME
```
Replace the following:
- PC_STORAGE_NODE_NAME: the name for the private cloud with storage-only node.
- ZONE: the zone for this private cloud.
- PROJECT_ID: the project ID for the request.
- DESCRIPTION: the description for this private cloud.
- IP_ADDRESS: the IP address and range for this private cloud, for example 192.168.0.0/22.
- CLUSTER_NAME: the name for the new cluster in this private cloud.
- n: the number of standard nodes in the primary cluster of this private cloud.
- m: the number of storage-only nodes in the primary cluster of this private cloud.
- NETWORK_NAME: the name for the network.
Optional: To confirm creation of the private cloud with storage-only nodes, enter the gcloud vmware private-clouds clusters describe command:
```
gcloud vmware private-clouds clusters describe CLUSTER_NAME \
 --location=ZONE \
 --project=PROJECT_ID \
 --private-cloud=PC_STORAGE_NODE_NAME
```
Replace the following:
- CLUSTER_NAME: the name for the new cluster in this private cloud.
- ZONE: the zone for this private cloud.
- PROJECT_ID: the project ID for the request.
- PC_STORAGE_NODE_NAME: the name for the private cloud with storage-only node.

API

To create private cloud with storage-only nodes using the VMware Engine API, make a GET request:

GET "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/privateClouds?alt=json&privateCloudId=PC_STORAGE_NODE_NAME" -d '{
  "description": "DESCRIPTION",
  "managementCluster": {
     "clusterId": "CLUSTER_NAME",
     "nodeTypeConfigs": {
        "standard-72": {
           "nodeCount": n
        },
        "storage-only-standard-72": {
           "nodeCount": m
        }
     }
     },
     "networkConfig": {
        "managementCidr": "IP_ADDRESS",
        "vmwareEngineNetwork": "projects/PROJECT_ID/locations/ZONE/vmwareEngineNetworks/NETWORK_NAME"
      }
     }'

Replace the following:

PROJECT_ID: the project ID for the request.
ZONE: the zone for this private cloud.
PC_STORAGE_NODE_NAME: the name for the private cloud with storage-only node.
DESCRIPTION: the description for this private cloud.
CLUSTER_NAME: the name for the new cluster in this private cloud.
n: the number of standard nodes in the primary cluster of this private cloud.
m: the number of storage-only nodes in the primary cluster of this private cloud.
IP_ADDRESS: the IP address and range for this private cloud, for example 192.168.0.0/22.
NETWORK_NAME: the name for the network.

As VMware Engine creates your new private cloud, it deploys a number of VMware components and divides the provided IP address range into subnets. Private cloud creation can take 30 minutes to 2 hours. After the provisioning is complete, you receive an email.

Expand a cluster with storage-only nodes

You can expand a standard cluster by adding storage-only nodes using the Google Cloud console, Google Cloud CLI, or VMware Engine API by doing the following:

Console

To expand a cluster with storage-only nodes using the Google Cloud console, do the following:

In the Google Cloud console, go to the Private clouds page.

Go to Private clouds
Click Select a project and then select the organization, folder, or project that contains the private cloud you want to expand.
Click the Cluster tab.
Click the name of the cluster you want to expand.
Click Edit.
Under Node configuration, select a storage node model and increase the node count.
Click Save.

gcloud

To expand a cluster by adding storage-only nodes using the Google Cloud CLI, use the gcloud vmware private-clouds clusters update command:

  gcloud vmware private-clouds clusters update CLUSTER_NAME \
     --private-cloud=PC_STORAGE_NODE_NAME \
     --location=ZONE \
     --project=PROJECT_ID \
     --update-nodes-config=type=storage-only-standard-72,count=m

Replace the following:

CLUSTER_NAME: the name of the cluster in this private cloud.
PC_STORAGE_NODE_NAME: the name of the private cloud.
ZONE: the zone for this private cloud.
PROJECT_ID: the project ID for the request.
m: the new total number of storage-only nodes in the specified cluster of this private cloud.

API

To expand a cluster by adding storage-only nodes using the VMware Engine API, make a PATCH request:

PATCH "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/privateClouds/PC_STORAGE_NODE_NAME/clusters/CLUSTER_NAME/?alt=json&updateMask=node_type_configs.*.node_count" -d '{
  "nodeTypeConfigs": {
     "standard-72": {
        "nodeCount": n
     },
     "storage-only-standard-72": {
        "nodeCount": m
     }
   }
  }'

Replace the following:

PROJECT_ID: the project ID for the request.
ZONE: the zone for this private cloud.
PC_STORAGE_NODE_NAME: the name of the private cloud.
CLUSTER_NAME: the name of the cluster in this private cloud.
n: the number of standard nodes in the specified cluster of this private cloud.
m+1: the new total number of storage-only nodes in the specified cluster of this private cloud.

Shrink a cluster with storage-only nodes

You can shrink a cluster that contains storage-only nodes using the Google Cloud console, Google Cloud CLI, or VMware Engine API by doing the following:

Console

To shrink a cluster with storage-only nodes using the Google Cloud console, do the following:

In the Google Cloud console, go to the Private clouds page.

Go to Private clouds
Click Select a project and then select the organization, folder, or project that contains the private cloud you want to shrink.
Click the Cluster tab.
Click the name of the cluster you want to shrink.
Click Edit.
Under Node configuration, select a lower node count.
Click Save.

gcloud

To shrink a cluster that contains storage-only nodes using the Google Cloud CLI, use the gcloud vmware private-clouds clusters update command:

  gcloud vmware private-clouds clusters update CLUSTER_NAME \
     --private-cloud=PC_STORAGE_NODE_NAME \
     --location=ZONE \
     --project=PROJECT_ID \
     --update-nodes-config=type=storage-only-standard-72,count=m

Replace the following:

CLUSTER_NAME: the name of the cluster in this private cloud.
PC_STORAGE_NODE_NAME: the name of the private cloud.
ZONE: the zone for this private cloud.
PROJECT_ID: the project ID for the request.
m: the new total number of storage-only nodes in the specified cluster of this private cloud.

API

To shrink a cluster that contains storage-only nodes using the VMware Engine API, make a PATCH request:

PATCH "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/privateClouds/PC_STORAGE_NODE_NAME/clusters/CLUSTER_NAME/?alt=json&updateMask=node_type_configs.*.node_count" -d '{
  "nodeTypeConfigs": {
     "standard-72": {
        "nodeCount": n
     },
     "storage-only-standard-72": {
        "nodeCount": m
     }
   }
  }'

Replace the following:

PROJECT_ID: the project ID for the request.
ZONE: the zone for this private cloud.
PC_STORAGE_NODE_NAME: the name of the private cloud.
CLUSTER_NAME: the name of the cluster in this private cloud.
n: the number of standard nodes in the specified cluster of this private cloud.
m: the new total number of storage-only nodes in the specified cluster of this private cloud.

Create a new cluster with storage-only nodes

You can create a new cluster in an existing private cloud that includes storage-only nodes using the Google Cloud console, Google Cloud CLI, or VMware Engine API by doing the following:

Console

To create a new cluster with storage-only nodes using the Google Cloud console, do the following:

In the Google Cloud console, go to the Private clouds page.

Go to Private clouds
Click Select a project and then select the organization, folder, or project that contains the private cloud you want to create a cluster in.
Click the name of the private cloud where you want to create the new cluster.
Click the Clusters tab.
Click Add cluster.
Enter a cluster name.
Select the HCI node model and node count.
Optional: Click the Customize Cores toggle if you want to reduce the number of available cores for each node in the management cluster. For details, see Custom core counts.
Select the storage node model and node count.
Click Create.

gcloud

To create a new cluster with storage-only nodes using the Google Cloud CLI, use the gcloud vmware private-clouds clusters create command:

  gcloud vmware private-clouds clusters create CLUSTER_NAME \
     --private-cloud=PC_STORAGE_NODE_NAME \
     --location=ZONE \
     --project=PROJECT_ID \
     --node-type-config=type=standard-72,count=n \
     --node-type-config=type=storage-only-standard-72,count=m

Replace the following:

CLUSTER_NAME: the name for the new cluster in this private cloud.
PC_STORAGE_NODE_NAME: the name of the private cloud.
ZONE: the zone for this private cloud.
PROJECT_ID: the project ID for the request.
n: the number of standard nodes in the specified cluster of this private cloud.
m: the number of storage-only nodes in the specified cluster of this private cloud.

API

To create a new cluster in a private cloud with storage-only nodes using the VMware Engine API, make a PATCH request:

PATCH "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/privateClouds/PC_STORAGE_NODE_NAME/clusters?alt=json&clusterId=CLUSTER_NAME" -d '{
  "nodeTypeConfigs": {
     "standard-72": {
        "nodeCount": n
     },
     "storage-only-standard-72": {
        "nodeCount": m
     }
   }
  }'

Replace the following:

PROJECT_ID: the project ID for the request.
ZONE: the zone for this private cloud.
PC_STORAGE_NODE_NAME: the name for the private cloud.
CLUSTER_NAME: the name for the new cluster in this private cloud.
n: the number of standard nodes in the specified cluster of this private cloud.
m: the number of storage-only nodes in the specified cluster of this private cloud.

Delete a cluster with storage-only nodes

You can delete a cluster that contains storage-only nodes using the Google Cloud console, Google Cloud CLI, or VMware Engine API by doing the following:

Console

To delete a cluster with storage-only nodes using the Google Cloud console, do the following:

In the Google Cloud console, go to the Private clouds page.

Go to Private clouds
Click Select a project and then select the organization, folder, or project that contains the private cloud you want to delete a cluster in.
Click the Cluster tab.
Click the delete icon in the row of the cluster you want to delete.

gcloud

To delete a cluster that contains storage-only nodes using the Google Cloud CLI, use the gcloud vmware private-clouds clusters delete command:

  gcloud vmware private-clouds clusters delete CLUSTER_NAME \
     --private-cloud=PC_STORAGE_NODE_NAME \
     --location=ZONE \
     --project=PROJECT_ID

Replace the following:

CLUSTER_NAME: the name of the cluster in this private cloud.
PC_STORAGE_NODE_NAME: the name of the private cloud.
ZONE: the zone for this private cloud.
PROJECT_ID: the project ID for the request.

API

To delete a cluster that contains storage-only nodes using the VMware Engine API, make a DELETE request:

DELETE "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/privateClouds/PC_STORAGE_NODE_NAME/clusters/CLUSTER_NAME/?alt=json"

Replace the following:

PROJECT_ID: the project ID for the request.
ZONE: the zone for this private cloud.
PC_STORAGE_NODE_NAME: the name of the private cloud.
CLUSTER_NAME: the name of the cluster in this private cloud.

Create a stretched private cloud with storage-only nodes

You can create a VMware Engine stretched private cloud that contains standard and storage-only nodes using the Google Cloud console, Google Cloud CLI, or VMware Engine API.

Console

To create a stretched private cloud that contains storage-only nodes using the Google Cloud console, do the following:

In the Google Cloud console, go to the Private clouds page.

Go to Private clouds
Click Select a project and then select the organization, folder, or project where you want to create the stretched private cloud with storage-only nodes.
Click Create.
Enter a name for your private cloud.
Choose Stretched for the private cloud type.
Enter your primary hosting location and select your secondary zone.
Select the node type for your primary cluster.
Select the number of nodes per zone for the stretched private cloud. Create your stretched private cloud with a minimum of 3 nodes per zone.
Optional: Click the Customize Cores toggle if you want to reduce the number of available cores for each node in the management cluster. For details, see Custom core counts.
Select the storage node model and node count.
Enter a CIDR range for the VMware management network. Make sure that the CIDR range doesn't overlap with any of your on-premises or cloud subnets.
Click Review and create.
Review the settings. To change any settings, click Back.
Click Create to begin creating the stretched private cloud.
Optional: If you want to list stretched private cloud details and cluster data to confirm the creation of the new stretched private cloud, start on the Private clouds details page. This page contains private cloud details. Clicking the Clusters tab displays cluster data in the table.

gcloud

To create stretched private cloud that contains storage-only nodes using the Google Cloud CLI, do the following:

Create a stretched private cloud by entering the gcloud private-clouds create command:
```
gcloud vmware private-clouds create STRETCHED_PC_STORAGE_NODE_NAME \
 --description=DESCRIPTION \
 --location=REGION \
 --cluster=STRETCHED_CLUSTER_NAME \
 --node-type-config=type=standard-72,count=n \
 --node-type-config=type=storage-only-standard-72,count=m \
 --management-range=IP_ADDRESS \
 --vmware-engine-network=NETWORK_NAME
 --preferred-zone=projects/PROJECT_ID/locations/PREFERRED_ZONE \
 --secondary-zone=projects/PROJECT_ID/locations/SECONDARY_ZONE \
 --type=STRETCHED
```
Replace the following:
- STRETCHED_PC_STORAGE_NODE_NAME: the name for the stretched private cloud with storage-only node.
- DESCRIPTION: the description for this private cloud.
- REGION: the region for this private cloud.
- STRETCHED_CLUSTER_NAME: the name for the new cluster in this private cloud.
- n: the total number of standard nodes, an even number, in the primary cluster of this private cloud.
- m: the total number of storage-only nodes, an even number, in the primary cluster of this private cloud.
- IP_ADDRESS: the IP address and range for this private cloud, for example 192.168.0.0/22.
- NETWORK_NAME: the name for the network.
- PROJECT_ID: the project ID for the request.
- SECONDARY_ZONE: the secondary zone for the request.
- PREFERRED_ZONE: the preferred zone for the request.
Optional: To confirm creation of the stretched private cloud and the number of standard and storage-only nodes, use the gcloud vmware private-clouds describe and gcloud vmware private-clouds clusters describe commands, respectively:
```
gcloud vmware private-clouds describe STRETCHED_PC_STORAGE_NODE_NAME \
 --location=REGION
```
Replace the following:
- STRETCHED_PC_STORAGE_NODE_NAME: the name for the stretched private cloud.
- REGION: the region for this private cloud.
```
gcloud vmware private-clouds clusters describe STRETCHED_CLUSTER_NAME \
 --location=REGION \
 --project=PROJECT_ID \
 --private-cloud=STRETCHED_PC_STORAGE_NODE_NAME
```
Replace the following:
- STRETCHED_CLUSTER_NAME: the name of the stretched cluster in this private cloud.
- REGION: the region for this private cloud.
- PROJECT_ID: the project ID for the request.
- STRETCHED_PC_STORAGE_NODE_NAME: the name for the stretched private cloud.

API

To create stretched private cloud that contains storage-only nodes using the VMware Engine API, make a GET request:

GET "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/ZONE/privateClouds?alt=json&privateCloudId=PC_STORAGE_ONLY_NODE_NAME" -d '{
  "description": "DESCRIPTION",
  "managementCluster": {
     "clusterId": "CLUSTER_NAME",
     "nodeTypeConfigs": {
        "standard-72": {
           "nodeCount": n
        },
        "storage-only-standard-72": {
           "nodeCount": m
        }
     }
     },
     "networkConfig": {
        "managementCidr": "IP_ADDRESS",
        "vmwareEngineNetwork": "projects/PROJECT_ID/locations/ZONE/vmwareEngineNetworks/NETWORK_NAME"
      }
     }'

Replace the following:

PROJECT_ID: the project ID for the request.
ZONE: the zone for this private cloud.
PC_STORAGE_NODE_NAME: the name for the private cloud with storage-only node.
DESCRIPTION: the description for this private cloud.
CLUSTER_NAME: the name for the new cluster in this private cloud.
n: the total number of standard nodes, an even number, in the primary cluster of this private cloud.
m: the total number of storage-only nodes, an even number, in the primary cluster of this private cloud.
IP_ADDRESS: the IP address and range for this private cloud, for example 192.168.0.0/22.
NETWORK_NAME: the name for the network.

Expand or shrink a stretched cluster with storage-only nodes

You can expand or shrink a stretched cluster by adding or removing storage-only nodes using the Google Cloud console, Google Cloud CLI, or VMware Engine API by doing the following:

Console

To expand or shrink a stretched cluster with storage-only nodes using the Google Cloud console, do the following:

In the Google Cloud console, go to the Private clouds page.

Go to Private clouds
Click Select a project and then select the organization, folder, or project that contains the stretched private cloud you want to expand or shrink.
Click the Cluster tab.
Click the name of the stretched cluster you want to expand or shrink.
Click Edit.
Under Node configuration, select a storage node model and increase or decrease the existing node count.
Click Save.

gcloud

To expand or shrink a stretched cluster by adding or removing storage-only nodes using the Google Cloud CLI, use the gcloud vmware private-clouds clusters update command:

  gcloud vmware private-clouds clusters update STRETCHED_CLUSTER_NAME \
     --location=REGION \
     --project=PROJECT_ID \
     --private-cloud=STRETCHED_PC_STORAGE_NODE_NAME \
     --node-type-config=type=standard-72,count=n \
     --node-type-config=type=storage-only-standard-72,count=m

Replace the following:

STRETCHED_CLUSTER_NAME: the name of the stretched cluster in this private cloud.
REGION: the region for this private cloud.
PROJECT_ID: the project ID for the request.
STRETCHED_PC_STORAGE_NODE_NAME: the name of the private cloud.
n: the new total number of standard nodes, an even number, for this specified cluster.
m: the new total number of storage-only nodes, an even number, for this specified cluster.

API

To expand or shrink a stretched cluster by adding or removing storage-only nodes using the VMware Engine API, make a PATCH request:

PATCH "https://vmwareengine.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/privateClouds/STRETCHED_PC_STORAGE_NODE_NAME/clusters/STRETCHED_CLUSTER_NAME" -d '{
  "nodeTypeConfigs": {
     "standard-72": {
        "nodeCount": n
     },
     "storage-only-standard-72": {
        "nodeCount": m
     }
   }
  }'

Replace the following:

PROJECT_ID: the project ID for the request.
REGION: the region for this private cloud.
STRETCHED_PC_STORAGE_NODE_NAME: the name of the stretched private cloud.
STRETCHED_CLUSTER_NAME: the name of the stretched cluster in this private cloud.
n: the new total number of standard nodes, an even number, for this specified cluster.
m: the new total number of storage-only nodes, an even number, for this specified cluster.

What's next

Manage your private cloud resources and activity.