Understanding the installation toolkit options

Use the following information to understand how to work with the installation toolkit, and the options that are available with it.

Installation
When you use the installation toolkit to install IBM Storage Scale, the procedure comprises two stages:
  1. Using a series of spectrumscale commands to add node and NSD specifications and configuration properties to the cluster definition file.
  2. Using the spectrumscale install command to install IBM Storage Scale on the nodes specified in the cluster definition file and to apply the configuration options to the cluster.
Deployment
When you use the installation toolkit to deploy protocols, the procedure comprises two similar stages:
  1. Using a series of spectrumscale commands to specify environment details, to identify which protocols are to be enabled, and to define protocol-specific properties in the cluster definition file.
  2. Using the spectrumscale deploy command to deploy protocols as specified in the cluster definition file.

If you already have an existing IBM Storage Scale cluster, with IBM Storage Scale started and at least one file system for the CES shared file system, you can just define protocol nodes in the cluster definition and then deploy protocols.

Upgrade
When you use the installation toolkit to upgrade, the procedure comprises two similar stages:
  1. Using a series of spectrumscale commands to specify environment details, or using ./spectrumscale config populate to populate cluster wide properties in the cluster definition file in preparation for upgrade.
  2. Using the spectrumscale upgrade command to upgrade all nodes and features as specified in the cluster definition file.
See Using the installation toolkit to perform installation tasks: Explanations and examples for information on how to use the command options listed in Table 1 to perform the installation and deployment. After you review the examples, you can tailor them according to your needs and then proceed to implement them.
Table 1. spectrumscale command options for installing IBM Storage Scale and deploying protocols
spectrumscale command option Purpose
node add Adds node specifications to the cluster definition file
node delete Removes node specifications from the cluster definition file
nsd add Adds NSD specifications to the cluster definition file
nsd clear Clears all NSDs
nsd delete Removes a single NSD
nsd list Lists all NSDs currently in the configuration
nsd modify Modifies an NSD
filesystem list Lists all file systems that currently have NSDs assigned to them
filesystem modify Changes the block size and mount point of a file system
config gpfs Adds IBM Storage Scale specific properties to the cluster definition file
install Installs IBM Storage Scale on the configured nodes, creates a cluster, and creates NSDs.
config protocols Provides details about the IBM Storage Scale environment to be used during protocol deployment
config perfmon Configures performance monitoring settings
config populate Populates cluster definition file with current cluster configuration
deploy Creates file systems and deploys protocols on your configured nodes
callhome Configures call home settings
fileauditlogging Configures file audit logging settings
upgrade Upgrades the various components of the installation.

The list of spectrumscale command options listed is not exhaustive. For all command options available with the spectrumscale command and for more information about these command options, see spectrumscale command.