Deploying the recovery grid node in VMware vSphere

You start the recovery of a grid node by deploying a new virtual machine using the VMware vSphere Web Client.

Before you begin

You have downloaded the VMware installation archive, and have extracted the following files:
Filename Description

vsphere-non-primary-admin.ovf

vsphere-non-primary-admin.mf

The template file and manifest file for deploying non-primary Admin Nodes.

vsphere-archive.ovf

vsphere-archive.mf

The template file and manifest file for deploying Archive Nodes.

vsphere-gateway.ovf

vsphere-gateway.mf

The template file and manifest file for deploying API Gateway Nodes.

vsphere-storage.ovf

vsphere-storage.mf

The template file and manifest file for deploying Storage Nodes.

Place all of these files in the same directory.

CAUTION:
You must deploy the new VM using the same StorageGRID Webscale version as is currently running on the grid.

Steps

  1. Open VMware vSphere Web Client, and sign in.
  2. Navigate to the vApp or resource pool where you want to deploy the StorageGRID Webscale grid, and select Actions > All vCenter Actions > Deploy OVF Template.
  3. Select the vsphere-node.ovf and NetApp-SG-version-SHA.vmdk files.
  4. Specify the name of the virtual machine, which is typically the name of the grid node.
    The best practice is to name the VM during the initial virtual machine deployment instead of changing it later.
  5. In the Network Mapping page, select the networks to use by associating a network port to each network. The Grid Network is required. The Admin and Client Networks are optional. Select the Grid Network to use, and then choose the following as applicable:
    • If you are planning to use the Admin Network, assign the Admin Network adapter to a network in the vSphere environment.
    • If you are planning to use the Client Network, assign the Client Network adapter to a network in the vSphere environment
    • If you do not plan to use an Admin Network or Client Network, assign their network adapters to the same network as the Grid Network.
  6. Provide the required StorageGRID Webscale information in the Properties page, and click Finish.
    1. Enter the Node Name.
    2. Enter the Primary Admin IP.
      If you omit the primary Admin Node IP address, the IP address will be automatically discovered if the primary Admin Node, or at least one other grid node with ADMIN_IP configured, is present on the same subnet. However, it is recommended to set the primary Admin Node IP address here.
    3. Under the Grid Network (eth0) section, enter the following values:
      • Grid network IP
      • Grid network mask
      • Grid network gateway
    4. In the Admin Network (eth1) section, under Admin Network IP configuration, select STATIC, DHCP, or DISABLED.
      • If you select STATIC, enter the Admin Network IP, Admin Network mask, and Admin Network gateway.
      • If you select DHCP, the Admin Network IP, Admin Network mask, and Admin Network gateway are automatically assigned.
      • If you do not want to use the Admin Network (eth1), select DISABLED and enter 0.0.0.0 for the Admin Network IP. You can leave the other fields blank.
    5. Under the Admin Network (eth1) section, enter the Admin network external subnet list.
    6. In the Client Network (eth2) section, under Client Network IP configuration, select STATIC, DHCP, or DISABLED.
      • If you select STATIC, enter the Client Network IP, Client Network mask, and Client Network gateway.
      • If you select DHCP, the Client Network IP, Client Network mask, and Client Network gateway are automatically assigned.
      • If you do not want to use the Client Network (eth2), select DISABLED and enter 0.0.0.0 for the Client Network IP. You can leave the other fields blank.
  7. Click Next and then Finish to start the upload of the virtual machine.
  8. If this is not a full node recovery, perform these steps after deployment is complete:
    1. Right-click the virtual machine, and select the Edit Settings tab.
    2. Select each default virtual hard disk that has been designated for storage, and click the Remove button located at the top of the tab.
    3. Depending on your data recovery circumstances, add new virtual disks according to your storage requirements, or reattach any virtual hard disks preserved from the previously removed failed grid node, or both.
      In general, if you are adding new disks you should use the same type of storage device that was in use prior to node recovery.
      Attention: The Storage Node OVF provided defines several VMDKs for storage. You should remove these and assign appropriate VMDKs or RDMs for storage before powering up the node. VMDKs are more commonly used in VMware environments and are easier to manage, while RDMs may provide better performance for workloads that use larger object sizes (for example, greater than 100 MB).
  9. If you want to remap ports used by a node:
    1. If you specified DISABLED for the Client network IP configuration, you must enter 0.0.0.0. for the Client Network IP under the under the Client Network (eth2) section. Completing this field is required.
    2. Right-click on the VM, and select Edit Settings.
    3. Select vApp Options.
    4. In the Authoring section, expand Properties and scroll down until you see PORT_REMAP_INBOUND and PORT_REMAP.
      You might need to remap a port if your enterprise networking policies restrict access to one or more ports that is used by StorageGRID Webscale. See "Internal grid node communications" or "External client communications" for the list of ports used by StorageGRID Webscale.
    5. To symmetrically map both inbound and outbound communications for a port, select PORT_REMAP and click Edit.
      Enter the port mapping as <network type>/<protocol>/<default port used by grid node>/<new port>, where network type is grid, admin, or client, and protocol is tcp or udp.
      Example
      To remap ssh traffic from port 22 to port 3022, enter the following:
      client/tcp/22/3022

      Click OK.

      Note: If only PORT_REMAP is set, the mapping that you specify applies to both inbound and outbound communications. If PORT_REMAP_INBOUND is also specified, PORT_REMAP applies only to outbound communications.
    6. To specify the port used for inbound communications to the node, select PORT_REMAP_INBOUND and click Edit.
      Enter the port mapping as <network type>/<protocol>/<remapped inbound port>/<default inbound port used by grid node>, where network type is grid, admin, or client, and protocol is tcp or udp.
      Example
      To remap inbound SSH traffic that is sent to port 3022 so that it is received at port 22 by the grid node, enter the following:
      client/tcp/3022/22

      Click OK.

      Note: If you specify PORT_REMAP_INBOUND and do not specify a value for PORT_REMAP, outbound communications for the port are unchanged.
  10. Power on the virtual machine.

After you finish

To complete the recovery, return to the procedure for the failure you are addressing.
Type of recovery Reference
Primary Admin Node Configuring the replacement primary Admin Node
Non-primary Admin Node Selecting Start Recovery to configure a non-primary Admin Node
API Gateway Node Selecting Start Recovery to configure the API Gateway Node
Archive Node Selecting Start Recovery to configure the Archive Node
Storage Node (virtual) Selecting Start Recovery to configure the Storage Node