Installation and protocols deployment on Linux nodes

Use these tables to access documentation for IBM Spectrum Scale installation and protocols deployment on Linux nodes.

Note: The list of topics in the following table for installation and protocols deployment on Linux nodes is not exhaustive. The high-level process of installation and protocols deployment is included here with corresponding links to respective documentation topics. For detailed information, see Installing IBM Spectrum Scale on Linux nodes and deploying protocols.

Table 1. Understand product features, planning considerations, and prerequisites
Installation task	Documentation
1 Go through the IBM Spectrum Scale product overview to understand the available features including support for protocols.	Product overview
2 Review the planning considerations for IBM Spectrum Scale including protocols.	Planning for GPFS Planning for protocols
3 Review the hardware requirements, software requirements, and additional installation prerequisites including those for protocols.	Hardware requirements Software requirements Installation prerequisites For the latest prerequisites information including supported Linux distributions and minimum kernel level, see the IBM Spectrum Scale FAQ on IBM® Knowledge Center.

Table 2. Prepare for installation
Installation task	Documentation
1 Review the available installation methods and choose the one that matches your requirements from one of the following: Manual Installation toolkit Installation GUI	Installing IBM Spectrum Scale on Linux nodes and deploying protocols Deciding whether to install IBM Spectrum Scale and deploy protocols manually or with the installation toolkit Overview of the installation toolkit Understanding the installation toolkit options Mixed operating system support with the installation toolkit Limitations of the installation toolkit
2 Perform preparatory tasks.	Preparing the environment on Linux nodes Preparing to install the GPFS software on Linux nodes Extracting the IBM Spectrum Scale software on Linux nodes Preparing to use the installation toolkit

Table 3. Perform manual installation, protocols deployment, and configuration
Installation task	Documentation
1 Install packages.	Manually installing the IBM Spectrum Scale software packages on Linux nodes Manually installing IBM Spectrum Scale and deploying protocols on Linux nodes
2 Build the portability layer.	Building the GPFS portability layer on Linux nodes
3 Verify the installation of base packages.	Verifying the IBM Spectrum Scale installation on SLES and Red Hat Enterprise Linux nodes Verifying the IBM Spectrum Scale installation on Ubuntu Linux nodes
4 Designate nodes in your cluster and create the cluster.	Quorum GPFS cluster creation considerations mmcrcluster command
5 Assign appropriate licenses for the nodes in cluster.	IBM Spectrum Scale license designation mmchlicense command
6 Start GPFS.	mmstartup command
7 Create NSDs and file systems.	Network Shared Disk (NSD) creation considerations File system creation considerations Creating NSDs and file systems as part of installing IBM Spectrum Scale on Linux systems
8 Configure CES and install protocols packages.	Installing Cluster Export Services as part of installing IBM Spectrum Scale on Linux systems Manually installing IBM Spectrum Scale for object storage on Red Hat Enterprise Linux 7.x nodes Manually installing IBM Spectrum Scale for object storage on Ubuntu 16.04 LTS and 18.04 LTS nodes
9 Enable NFS, SMB, and object. Note: IBM Spectrum Scale for object storage is supported only on Red Hat Enterprise Linux 7.x and Ubuntu 16.04 LTS and 18.04 LTS.	Enabling NFS, SMB, and object on Linux systems Manually installing IBM Spectrum Scale for object storage on Red Hat Enterprise Linux 7.x nodes Manually installing IBM Spectrum Scale for object storage on Ubuntu 16.04 LTS and 18.04 LTS nodes
10 Install IBM Spectrum Scale Performance Monitoring tool and IBM Spectrum Scale management GUI.	Manually installing the performance monitoring tool Manually installing IBM Spectrum Scale management GUI
11 Set up authentication and perform further required configuration.	Managing protocol user authentication Configuring the CES and protocol configuration Protocol node IP further configuration Object protocol further configuration
12 Configure and tune your system.	Configuring and tuning your system for GPFS Configuring the GPFS cluster

Table 4. Perform installation, protocols deployment, and configuration using the toolkit
Installation task	Documentation
1 Set up the install node to be used by the installation toolkit.	Setting up the installer node
2 Define configuration options to be used by the installation toolkit for installation, deployment, and configuration.	Defining the cluster topology for the installation toolkit
3 Install GPFS and create a GPFS cluster.	Installing GPFS and creating a GPFS cluster
4 Deploy protocols.	Deploying protocols Protocols Quick Overview
5 Set up authentication.	Setting up authentication
6 Perform further required configuration.	Protocol node IP further configuration Object protocol further configuration
Optional Populate cluster definition file with current cluster state using the installation toolkit.	Populating cluster definition file with current cluster state using the installation toolkit Limitations of config populate option of the installation toolkit
Optional Enable and configure file audit logging using the installation toolkit.	Enabling and configuring file audit logging using the installation toolkit
Optional Enable and configure watch folder using the installation toolkit.	Enabling and configuring watch folder using the installation toolkit
Optional Enable and configure call home using the installation toolkit.	Enabling and configuring call home using the installation toolkit
Optional Use the installation toolkit in a mixed OS environment	Mixed operating system support with the installation toolkit
Optional Use the installation toolkit in a cluster containing ESS	ESS awareness with the installation toolkit
Optional Prepare a cluster containing ESS for deploying protocols with the installation toolkit.	Preparing a cluster that contains ESS for adding protocols
Optional Deploy protocols on an existing cluster with the installation toolkit.	Deploying protocols on an existing cluster Deploying protocols authentication on an existing cluster
Optional Enable another protocol on an existing cluster that has protocols enabled with the installation toolkit.	Enabling another protocol on an existing cluster that has protocols enabled
Optional Add nodes, NSDs, or file systems to an existing installation with the installation toolkit.	Adding nodes, NSDs, or file systems to an existing installation

Table 5. Perform installation using the installation GUI
Installation task	Documentation
1 Use the installation GUI to perform installation tasks. Note: The scope of the installation GUI is to install the IBM Spectrum Scale software on cluster nodes, create an IBM Spectrum Scale cluster, and configure NTP. Other initial tasks like creating file systems, creating NSDs, setting up NFS and SMB protocols, object storage, or authentication of protocol users are out of scope of the installation GUI. Note: The installation GUI is deprecated and it will be removed in a future release.	Installing IBM Spectrum Scale by using the graphical user interface (GUI)