Installation prerequisites

There are several prerequisites for installing IBM Spectrum Scale™.

Required packages for supported Linux distributions

For the list of packages that must be installed on the system before you can install IBM Spectrum Scale, see Software requirements.

Required packages for the spectrumscale installation toolkit

The spectrumscale installation toolkit requires one of the following packages:

python-2.6 or later with argparse
python-2.7

Operating systems supported with the spectrumscale installation toolkit

The spectrumscale installation toolkit is supported on: Red Hat Enterprise Linux 7.x operating system on x86_64 and ppc64 architectures.

spectrumscale installation toolkit can be used only on nodes that have Red Hat Enterprise Linux 7.x installed. The installation toolkit does not work with earlier versions of Red Hat Enterprise Linux or with other vendor operating systems at this time. For information about how the installation toolkit can be used in a cluster that has mixed operating system levels, see Problems due to mixed operating system levels in the cluster.

For latest information about supported operating systems, see IBM Spectrum Scale FAQ in IBM® Knowledge Center.

Required packages for IBM Spectrum Scale NFS

dbus
nfs-utils
python
dbus-python
pygobject2

Requirements for file authentication

Before configuring file authentication, ensure that prerequisites are met to avoid installation failure. For information on prerequisites for configuring file authentication, see Configuring authentication and ID mapping for file access. For Active Directory (AD) authentication considerations, see Integrating with AD server.

Required packages for IBM Spectrum Scale for object storage

IBM Spectrum Scale for object storage requires the following SELinux packages to be installed:

selinux-policy-base at 3.13.1-23 or higher
selinux-policy-targeted at 3.12.1-153 or higher

Attention: If SELinux is disabled during installation of IBM Spectrum Scale for object storage, enabling SELinux after installation is not supported.

Cleanup required if you previously used the Object Redpaper™ configuration process

If you have already configured the system with Openstack software to use GPFS (following instructions from the Object Red paper) be sure to follow the Object cleanup steps in Cleanup procedures required if reinstalling with the spectrumscale installation toolkit before you start any installation activity.

Requirements for the management GUI

PostgreSQL server of the Linux distribution must be installed on the node on which the GUI is to be installed.
IBM Spectrum Scale Java™ Runtime Environment (JRE) must be installed (gpfs.java RPM) on the node on which the GUI is to be installed.
IBM Spectrum Scale performance collector (gpfs.pmcollector RPM) must be installed on the node on which the GUI is to be installed.

GPFS 4.2.0 or later required on protocol and quorum nodes

If you want to run protocols in a mixed-version cluster, the protocol nodes and all of the quorum nodes must run 4.2.0 or later; other nodes can run an older version.

Note: For the Object protocol, the GPFS software is not required on the node that hosts the Keystone identity service if it is deployed on a separate node from the GPFS protocol nodes.

Additional GPFS requirements

If you want to run protocols, Cluster Configuration Repository (CCR) must be available.
mmchconfig release=LATEST must be run.
A GPFS cluster and a file system are required. If this infrastructure does not already exist, you must install the GPFS software, create a GPFS cluster and create a file system. You can use the spectrumscale installation toolkit to do these tasks. For more information, see Using the spectrumscale installation toolkit to perform installation tasks: Explanations and examples.
The GPFS file system must be mounted on all GPFS protocol nodes.
It is strongly recommended to configure the file system to only support NFSv4 ACLs. You can use the spectrumscale installation toolkit to do this task also if you use the installation toolkit to install GPFS. For more information, see Using the spectrumscale installation toolkit to perform installation tasks: Explanations and examples.
Alternatively, you can use the -k nfs4 parameter for mmcrfs. NFSv4 ACLs are a requirement for ACL usage with the SMB and NFS protocols. For more information, see examples in mmcrfs command.
Quotas are not enabled by default in GPFS file systems but are recommended for use with SMB and NFS protocols. For more information about quota management, see Enabling and disabling GPFS quota management.

Creation of a file system or fileset or path for a shared root, and creation of an object fileset

The installation toolkit uses a shared root storage area to install the protocols on each node. This storage is also used by NFS and object protocols to maintain system data associated with the cluster integration we provide. This storage can be a subdirectory in an existing file system or it can be a file system on its own. Once this option is set, changing it will requires a restart of GPFS.

You can use the spectrumscale installation toolkit to set up this shared root storage area if you use the toolkit for GPFS installation and file system creation. For more information, see Using the spectrumscale installation toolkit to perform installation tasks: Explanations and examples.

However, if you want to set up shared root before launching the installation toolkit, the following steps can be used:

Create a file system or fileset for shared root. Size must be at least 4 GB.
Use the following command:
mmchconfig cesSharedRoot=path_to_the_filesystem/fileset_created_in_step_1

For Object, the installation toolkit creates an independent fileset in the GPFS file system that you name.

SSH and network setup

This is a general GPFS prerequisite, not specific to protocols other than protocol-specific ports that need to be open on the firewall.

The node used for initiating installation of SMB, NFS, and/or Object protocols using the installation toolkit must be able to communicate through an internal or external network with all protocol nodes to be installed. All nodes also require SSH keys to be set up so that the installation toolkit can run remote commands without any prompts. Examples of prompts include a prompt asking for a remote node's password or a prompt asking a yes-or-no question. No prompts should exist when using SSH among any cluster nodes to and from each other, and to and from the node designated for installation.

For information on ports required by IBM Spectrum Scale, see Securing the IBM Spectrum Scale system using firewall and GPFS port usage.

The following are examples of how to open firewall ports on Red Hat Enterprise Linux 7.x and SLES 12.

Red Hat Enterprise Linux 7.x

$ firewall-cmd --permanent --add-port=1191/tcp
$ firewall-cmd --permanent --add-port=1191/udp
$ firewall-cmd –add-port=1191/tcp
$ firewall-cmd --add-port=1191/udp
$ firewall-cmd --permanent --add-port=60000-60010/tcp
$ firewall-cmd --permanent --add-port=60000-60010/udp
$ firewall-cmd --add-port=60000-60010/tcp
$ firewall-cmd --add-port=60000-60010/udp

After any firewall changes are done, the firewall service needs to be restarted on each node on which these changes were done. You can do this once after applying all the relevant firewall changes.

$ systemctl restart firewalld.service

The following example command can be used for opening firewall ports on SLES nodes.

$ yast firewall service add

SLES 12.

Open the YaST tool by issuing the following command: yast
Click Security and Users > Firewall.
Select the Allowed Services tab and click Advanced....
Enter the desired port range in the from-port-start:to-port-end format and specify the protocol (TCP or UDP). For example, enter 60000:60010 to open ports 60000 to 60010.
Click OK to close the Advanced dialog box.
Click Next and review the summary of your changes.
Click Finish to apply your changes.

For more information, see SLES Security Guide.

Repository setup

This is a general GPFS prerequisite, not specific to protocols.

Important: Start of change

You must disable all configured EPEL repositories on all nodes added to the spectrumscale installation toolkit before proceeding with installation, deployment, or upgrade. End of change

The spectrumscale installation toolkit contains all necessary code for installation; however, there may be base RHEL 7.x RPMs required as prerequisites. In order to satisfy any prerequisites, it might be necessary for your RHEL 7.x nodes to have access to a DVD repository (or an external repository accessible by network). Repositories containing IBM Spectrum Scale dependencies include the following x86 examples:

rhel-x86_64-server-7 Red Hat Enterprise Linux Server

For more information about Yum repositories, see Configuring Yum and Yum Repositories .

For SLES nodes, you might need to set up repositories. For more information, see Managing Software Repositories and Services.

NTP setup

It is recommended that Network Time Protocol (NTP) be configured on all nodes in your system to ensure that the clocks of all of the nodes are synchronized. Clocks that are not synchronized will cause debugging issues and authentication problems with the protocols.

If you are using the installation toolkit for IBM Spectrum Scale installation, then no prior NTP configuration is required other than that the NTP package is installed and the NTP daemon (ntpd) is not running on all nodes.

Use the config ntp commands listed in Understanding the spectrumscale installation toolkit options, Table 1 to set NTP servers and then NTP will automatically be configured at install time. For example:

/usr/lpp/mmfs/4.2.1.0/installer/spectrumscale config ntp -e on -s 198.51.100.2,198.51.100.4
[ WARN ] The NTP package must already be installed and full bidirectional access to the UDP port 123 must be allowed.
[ WARN ] If NTP is already running on any of your nodes, NTP setup will be skipped. To stop NTP run 'service ntpd stop'.
[ INFO ] Setting NTP to on
[ INFO ] Setting Upstream NTP Servers to 198.51.100.2,198.51.100.4

However, if you are manually installing IBM Spectrum Scale or would prefer to manually configure NTP, see the following example of enabling NTP on a node.

# yum install -y ntp
# ntpdate <NTP_server_IP>
# systemctl enable ntpd
# systemctl start ntpd
# timedatectl list-timezones
# timedatectl set-timezone
# systemctl enable ntpd

Performance Monitoring tool

This is a general GPFS prerequisite, not specific to protocols.

Ensure that the following package is installed on the system before installation of the Performance Monitoring tool:

boost-regex on Red Hat Enterprise Linux
libboost_regex on SLES
libboost-regex-dev on Debian and Ubuntu Linux

Required packages for mmprotocoltrace

Some of the advanced tracing components of the mmprotocoltrace command require specific packages to be installed on all nodes that need to participate in tracing related operations.

To enable network tracing with mmprotocoltrace, you need to install the wireshark package.
To enable the syscalls-tracing for SMB, you need to install the strace package.

Collection of core data

This is a general GPFS prerequisite, not specific to protocols.

See the topic about changing configurations to enable spectrumscale to collect core dump data in Configuration changes required to enable spectrumscale installation toolkit to collect core dump data.