Skip to main content

Gather required materials for grid node recovery

Contributors netapp-perveilerk netapp-lhalbert ssantho3 netapp-madkat
PDFs

Before performing maintenance procedures, you must ensure you have the necessary materials to recover a failed grid node.

Item Notes

StorageGRID installation archive

If you need to recover a grid node, you need to download the StorageGRID installation files for your platform.

Note: You don't need to download files if you are recovering failed storage volumes on a Storage Node.

Service laptop

The service laptop must have the following:

Recovery Package .zip file

Obtain a copy of the most recent Recovery Package .zip file: sgws-recovery-package-id-revision.zip

The contents of the .zip file are updated each time the system is modified. You are directed to store the most recent version of the Recovery Package in a secure location after making such changes. Use the most recent copy to recover from grid failures.

If the primary Admin Node is operating normally, you can download the Recovery Package from the Grid Manager. Select MAINTENANCE > System > Recovery package.

If you can't access the Grid Manager, you can find encrypted copies of the Recovery Package on some Storage Nodes that contain the ADC service. On each Storage Node, examine this location for the Recovery Package: /var/local/install/sgws-recovery-package-grid-id-revision.zip.gpg Use the Recovery Package with the highest revision number.

Passwords.txt file

Contains the passwords required to access grid nodes on the command line. Included in the Recovery Package.

Provisioning passphrase

The passphrase is created and documented when the StorageGRID system is first installed. The provisioning passphrase is not in the Passwords.txt file.

Current documentation for your platform

Go to the platform vendor's website for documentation.

For the current supported versions of your platform, see the NetApp Interoperability Matrix Tool.

Download and extract StorageGRID installation files

Download the software and extract the files, unless you are recovering failed storage volumes on a Storage Node.

You must use the version of StorageGRID that is currently running on the grid.

Steps

  1. Determine which version of the software is currently installed. From the top of the Grid Manager, select the help icon and select About.

  2. Go to the NetApp Downloads page for StorageGRID.

  3. Select the version of StorageGRID that is currently running on the grid.

    StorageGRID software versions have this format: 11.x.y.

  4. Sign in with the username and password for your NetApp account.

  5. Read the End User License Agreement, select the checkbox, and then select Accept & Continue.

  6. In the Install StorageGRID column of the download page, select the .tgz or .zip file for your platform.

    The version shown in the installation archive file must match the version of the software that is currently installed.

    Use the .zip file if you are running Windows.

    Platform Installation archive

    Red Hat Enterprise Linux or CentOS

    StorageGRID-Webscale-version-RPM-uniqueID.zip

    StorageGRID-Webscale-version-RPM-uniqueID.tgz

    Ubuntu or Debian or Appliances

    StorageGRID-Webscale-version-DEB-uniqueID.zip

    StorageGRID-Webscale-version-DEB-uniqueID.tgz

    VMware

    StorageGRID-Webscale-version-VMware-uniqueID.zip

    StorageGRID-Webscale-version-VMware-uniqueID.tgz

  7. Download and extract the archive file.

  8. Follow the appropriate step for your platform to choose the files you need, based on your platform and which grid nodes you need to recover.

    The paths listed in the step for each platform are relative to the top-level directory installed by the archive file.

  9. If you are recovering a Red Hat Enterprise Linux or CentOS system, select the appropriate files.

Path and file name Description

./rpms/README

A text file that describes all of the files contained in the StorageGRID download file.

./rpms/NLF000000.txt

A free license that does not provide any support entitlement for the product.

./rpms/StorageGRID-Webscale-Images-version-SHA.rpm

RPM package for installing the StorageGRID node images on your RHEL or CentOS hosts.

./rpms/StorageGRID-Webscale-Service-version-SHA.rpm

RPM package for installing the StorageGRID host service on your RHEL or CentOS hosts.

Deployment scripting tool

Description

./rpms/configure-storagegrid.py

A Python script used to automate the configuration of a StorageGRID system.

./rpms/configure-sga.py

A Python script used to automate the configuration of StorageGRID appliances.

./rpms/configure-storagegrid.sample.json

An example configuration file for use with the configure-storagegrid.py script.

./rpms/storagegrid-ssoauth.py

An example Python script that you can use to sign in to the Grid Management API when single sign-on is enabled. You can also use this script for Ping Federate.

./rpms/configure-storagegrid.blank.json

A blank configuration file for use with the configure-storagegrid.py script.

./rpms/extras/ansible

Example Ansible role and playbook for configuring RHEL or CentOS hosts for StorageGRID container deployment. You can customize the role or playbook as necessary.

./rpms/storagegrid-ssoauth-azure.py

An example Python script that you can use to sign in to the Grid Management API when single sign-on (SSO) is enabled using Active Directory or Ping Federate.

./rpms/storagegrid-ssoauth-azure.js

A helper script called by the companion storagegrid-ssoauth-azure.py Python script to perform SSO interactions with Azure.

./rpms/extras/api-schemas

API schemas for StorageGRID.

Note: Before you perform an upgrade, you can use these schemas to confirm that any code you have written to use StorageGRID management APIs will be compatible with the new StorageGRID release if you don't have a non-production StorageGRID environment for upgrade compatibility testing.

  1. If you are recovering an Ubuntu or Debian system, select the appropriate files.

Path and file name Description

./debs/README

A text file that describes all of the files contained in the StorageGRID download file.

./debs/NLF000000.txt

A non-production NetApp License File that you can use for testing and proof of concept deployments.

./debs/storagegrid-webscale-images-version-SHA.deb

DEB package for installing the StorageGRID node images on Ubuntu or Debian hosts.

./debs/storagegrid-webscale-images-version-SHA.deb.md5

MD5 checksum for the file /debs/storagegrid-webscale-images-version-SHA.deb.

./debs/storagegrid-webscale-service-version-SHA.deb

DEB package for installing the StorageGRID host service on Ubuntu or Debian hosts.

Deployment scripting tool

Description

./debs/configure-storagegrid.py

A Python script used to automate the configuration of a StorageGRID system.

./debs/configure-sga.py

A Python script used to automate the configuration of StorageGRID appliances.

./debs/storagegrid-ssoauth.py

An example Python script that you can use to sign in to the Grid Management API when single sign-on is enabled. You can also use this script for Ping Federate.

./debs/configure-storagegrid.sample.json

An example configuration file for use with the configure-storagegrid.py script.

./debs/configure-storagegrid.blank.json

A blank configuration file for use with the configure-storagegrid.py script.

./debs/extras/ansible

Example Ansible role and playbook for configuring Ubuntu or Debian hosts for StorageGRID container deployment. You can customize the role or playbook as necessary.

./debs/storagegrid-ssoauth-azure.py

An example Python script that you can use to sign in to the Grid Management API when single sign-on (SSO) is enabled using Active Directory or Ping Federate.

./debs/storagegrid-ssoauth-azure.js

A helper script called by the companion storagegrid-ssoauth-azure.py Python script to perform SSO interactions with Azure.

./debs/extras/api-schemas

API schemas for StorageGRID.

Note: Before you perform an upgrade, you can use these schemas to confirm that any code you have written to use StorageGRID management APIs will be compatible with the new StorageGRID release if you don't have a non-production StorageGRID environment for upgrade compatibility testing.

  1. If you are recovering a VMware system, select the appropriate files.

Path and file name Description

./vsphere/README

A text file that describes all of the files contained in the StorageGRID download file.

./vsphere/NLF000000.txt

A free license that does not provide any support entitlement for the product.

./vsphere/NetApp-SG-version-SHA.vmdk

The virtual machine disk file that is used as a template for creating grid node virtual machines.

./vsphere/vsphere-primary-admin.ovf

./vsphere/vsphere-primary-admin.mf

The Open Virtualization Format template file (.ovf) and manifest file (.mf) for deploying the primary Admin Node.

./vsphere/vsphere-non-primary-admin.ovf

./vsphere/vsphere-non-primary-admin.mf

The template file (.ovf) and manifest file (.mf) for deploying non-primary Admin Nodes.

./vsphere/vsphere-archive.ovf

./vsphere/vsphere-archive.mf

The template file (.ovf) and manifest file (.mf) for deploying Archive Nodes.

./vsphere/vsphere-gateway.ovf

./vsphere/vsphere-gateway.mf

The template file (.ovf) and manifest file (.mf) for deploying Gateway Nodes.

./vsphere/vsphere-storage.ovf

./vsphere/vsphere-storage.mf

The template file (.ovf) and manifest file (.mf) for deploying virtual machine-based Storage Nodes.

Deployment scripting tool

Description

./vsphere/deploy-vsphere-ovftool.sh

A Bash shell script used to automate the deployment of virtual grid nodes.

./vsphere/deploy-vsphere-ovftool-sample.ini

An example configuration file for use with the deploy-vsphere-ovftool.sh script.

./vsphere/configure-storagegrid.py

A Python script used to automate the configuration of a StorageGRID system.

./vsphere/configure-sga.py

A Python script used to automate the configuration of StorageGRID appliances.

./vsphere/storagegrid-ssoauth.py

An example Python script that you can use to sign in to the Grid Management API when single sign-on (SSO) is enabled. You can also use this script for Ping Federate.

./vsphere/configure-storagegrid.sample.json

An example configuration file for use with the configure-storagegrid.py script.

./vsphere/configure-storagegrid.blank.json

A blank configuration file for use with the configure-storagegrid.py script.

./vsphere/storagegrid-ssoauth-azure.py

An example Python script that you can use to sign in to the Grid Management API when single sign-on (SSO) is enabled using Active Directory or Ping Federate.

./vsphere/storagegrid-ssoauth-azure.js

A helper script called by the companion storagegrid-ssoauth-azure.py Python script to perform SSO interactions with Azure.

./vsphere/extras/api-schemas

API schemas for StorageGRID.

Note: Before you perform an upgrade, you can use these schemas to confirm that any code you have written to use StorageGRID management APIs will be compatible with the new StorageGRID release if you don't have a non-production StorageGRID environment for upgrade compatibility testing.

  1. If you are recovering a StorageGRID appliance-based system, select the appropriate files.

Path and file name Description

./debs/storagegrid-webscale-images-version-SHA.deb

DEB package for installing the StorageGRID node images on your appliances.

./debs/storagegrid-webscale-images-version-SHA.deb.md5

MD5 checksum for the file /debs/storagegridwebscale- images-version-SHA.deb.
Note For appliance installation, these files are only required if you need to avoid network traffic. The appliance can download the required files from the primary Admin Node.