Product documentation in guide format

This page contains IBM Spectrum Scale product documentation in PDF format.

For links to Quick Start Guide and Protocols Quick Overview, see Table 2.
Table 1. IBM Spectrum Scale product guides
Guide name Description Links
Concepts, Planning, and Installation Guide This guide provides the following information:
Product overview
  • Overview of IBM Spectrum Scale
  • GPFS architecture
  • Protocols support overview: Integration of protocol access methods with GPFS
  • Active File Management
  • AFM-based Asynchronous Disaster Recovery (AFM DR)
  • Introduction to AFM to cloud object storage
  • Introduction to system health and troubleshooting
  • Introduction to performance monitoring
  • Data protection and disaster recovery in IBM Spectrum Scale
  • Introduction to IBM Spectrum Scale GUI
  • IBM Spectrum Scale management API
  • Introduction to Cloud services
  • Introduction to file audit logging
  • Introduction to clustered watch folder
  • Understanding call home
  • IBM Spectrum Scale in an OpenStack cloud deployment
  • IBM Spectrum Scale product editions
  • IBM Spectrum Scale license designation
  • Capacity-based licensing
Concepts, Planning, and Installation Guide
Planning
  • Planning for GPFS
  • Planning for protocols
  • Planning for Cloud services
  • Planning for AFM
  • Planning for AFM DR
  • Planning for AFM to cloud object storage
  • Firewall recommendations
 
  • Considerations for GPFS applications
  • Security-Enhanced Linux support
  • Space requirements for call home data upload
  
 
Installing
  • Steps for establishing and starting your IBM Spectrum Scale cluster
  • Installing IBM Spectrum Scale on Linux® nodes and deploying protocols
  • Installing IBM Spectrum Scale on AIX® nodes
  • Installing IBM Spectrum Scale on Windows nodes
  • Installing Cloud services on IBM Spectrum Scale nodes
  • Installing and configuring IBM Spectrum Scale management API
  • Installing GPUDirect Storage for IBM Spectrum Scale
  • Installation of Active File Management (AFM)
  • Installing AFM Disaster Recovery
  • Installing call home
  • Installing file audit logging
  • Installing clustered watch folder
  • Steps to permanently uninstall IBM Spectrum Scale
Upgrading
  • IBM Spectrum Scale supported upgrade paths
  • Online upgrade support for protocols and performance monitoring
  • Upgrading IBM Spectrum Scale nodes
  
 
  • Upgrading IBM Spectrum® Scale non-protocol Linux nodes
  • Upgrading IBM Spectrum Scale protocol nodes
  • Upgrading GPUDirect Storage
  • Upgrading AFM and AFM DR
  • Upgrading object packages
  • Upgrading SMB packages
  • Upgrading NFS packages
  • Upgrading call home
  • Manually upgrading the performance monitoring tool
  • Manually upgrading pmswift
  • Manually upgrading the IBM Spectrum Scale management GUI
  • Upgrading Cloud services
  • Upgrading to IBM® Cloud Object Storage software level 3.7.2 and above
  • Upgrade paths and commands for file audit logging and clustered watch folder
  • Upgrading IBM Spectrum Scale components with the installation toolkit
  • Protocol authentication configuration changes during upgrade
  • Changing the IBM Spectrum Scale product edition
  • Completing the upgrade to a new level of IBM Spectrum Scale
  • Reverting to the previous level of IBM Spectrum Scale
  
 
  • Coexistence considerations
  • Compatibility considerations
  • Considerations for IBM Spectrum Protect for Space Management
  • Applying maintenance to your IBM Spectrum Scale system
  • Guidance for upgrading the operating system on IBM Spectrum Scale nodes
  • Considerations for upgrading from an operating system not supported in IBM Spectrum Scale 5.1.x.x
  • Servicing IBM Spectrum Scale protocol nodes
  • Offline upgrade with complete cluster shutdown
  
Administration Guide This guide provides the following information:
Configuring
  • Configuring the GPFS cluster
  • Configuring GPUDirect Storage for IBM Spectrum Scale
  • Configuring the CES and protocol configuration
  • Configuring and tuning your system for GPFS
  • Parameters for performance tuning and optimization
  • Ensuring high availability of the GUI service
  • Configuring and tuning your system for Cloud services
  • Configuring IBM Power Systems for IBM Spectrum Scale
  • Configuring file audit logging
  • Configuring clustered watch folder
  • Configuring Active File Management
  • Configuring AFM-based DR
  • Configuring AFM to cloud object storage
  • Tuning for Kernel NFS backend on AFM and AFM DR
  • Configuring call home
  • Integrating IBM Spectrum Scale Cinder driver with Red Hat OpenStack Platform 16.1
  • Configuring Multi-Rail over TCP (MROT)
Administration Guide
Administering
  • Performing GPFS administration tasks
  • Performing parallel copy with mmxcp command
  • Protecting file data: IBM Spectrum Scale safeguarded copy
  • Verifying network operation with the mmnetverify command
  • Managing file systems
  • File system format changes between versions of IBM Spectrum Scale
  • Managing disks
 
  • Managing protocol services
  • Managing protocol user authentication
  • Managing protocol data exports
  • Managing object storage
  • Managing GPFS quotas
  • Managing GUI users
  • Managing GPFS access control lists
  • Native NFS and GPFS
  • Accessing a remote GPFS file system
  • Information lifecycle management for IBM Spectrum Scale
  • Creating and maintaining snapshots of file systems
  • Creating and managing file clones
  • Scale Out Backup and Restore (SOBAR)
  • Data Mirroring and Replication
  • Implementing a clustered NFS environment on Linux
  • Implementing Cluster Export Services
  • Identity management on Windows / RFC 2307 Attributes
  • Protocols cluster disaster recovery
  • File Placement Optimizer
  • Encryption
  • Managing certificates to secure communications between GUI web server and web browsers
  • Securing protocol data
  • Cloud services: Transparent cloud tiering and Cloud data sharing
  • Managing file audit logging
  • RDMA tuning
  • Configuring Mellanox Memory Translation Table (MTT) for GPFS RDMA VERBS Operation
  • Administering AFM
  • Administering AFM DR
  
 
  • Administering AFM to cloud object storage
  • Highly available write cache (HAWC)
  • Local read-only cache
  • Miscellaneous advanced administration topics
  • GUI limitations
  
Problem Determination Guide This guide provides the following information:
Monitoring
  • Monitoring system health by using IBM Spectrum Scale GUI
  • Monitoring system health by using the mmhealth command
  • Performance monitoring
  • Monitoring GPUDirect storage
  • Monitoring events through callbacks
  • Monitoring capacity through GUI
  • Monitoring AFM and AFM DR
  • Monitoring AFM to cloud object storage
  • GPFS SNMP support
  • Monitoring the IBM Spectrum Scale system by using call home
  • Monitoring remote cluster through GUI
  • Monitoring file audit logging
  • Monitoring clustered watch folder
  • Monitoring local read-only cache
Troubleshooting
  • Best practices for troubleshooting
  • Understanding the system limitations
  • Collecting details of the issues
  • Managing deadlocks
  • Installation and configuration issues
  • Upgrade issues
  • CCR issues
  • Network issues
  • File system issues
  • Disk issues
  • GPUDirect Storage issues
  • Security issues
  • Protocol issues
  • Disaster recovery issues
  • Performance issues
 
  • GUI and monitoring issues
  • AFM issues
  • AFM DR issues
  • AFM to cloud object storage issues
  • Transparent cloud tiering issues
  • File audit logging issues
  • Troubleshooting mmwatch
  • Maintenance procedures
  • Recovery procedures
  • Support for troubleshooting
  • References
  
Command and Programming Reference This guide provides the following information:
Command reference
  • gpfs.snap command
  • mmaddcallback command
  • mmadddisk command
  • mmaddnode command
  • mmadquery command
  • mmafmconfig command
  • mmafmcosaccess command
  • mmafmcosconfig command
  • mmafmcosctl command
  • mmafmcoskeys command
  • mmafmctl command
  • mmafmlocal command
  • mmapplypolicy command
  • mmaudit command
  • mmauth command
  • mmbackup command
  • mmbackupconfig command
  • mmbuildgpl command
  • mmcachectl command
  • mmcallhome command
  • mmces command
  • mmchattr command
  • mmchcluster command
  • mmchconfig command
  • mmchdisk command
  • mmcheckquota command
  • mmchfileset command
  • mmchfs command
  • mmchlicense command
  • mmchmgr command
  • mmchnode command
  • mmchnodeclass command
  • mmchnsd command
  • mmchpolicy command
  • mmchpool command
  • mmchqos command
  • mmclidecode command
 
  • mmclone command
  • mmcloudgateway command
  • mmcrcluster command
  • mmcrfileset command
  • mmcrfs command
  • mmcrnodeclass command
  • mmcrnsd command
  • mmcrsnapshot command
  • mmdefedquota command
  • mmdefquotaoff command
  • mmdefquotaon command
  • mmdefragfs command
  • mmdelacl command
  • mmdelcallback command
  • mmdeldisk command
  • mmdelfileset command
  • mmdelfs command
  • mmdelnode command
  • mmdelnodeclass command
  • mmdelnsd command
  • mmdelsnapshot command
  • mmdf command
  • mmdiag command
  • mmdsh command
  • mmeditacl command
  • mmedquota command
  • mmexportfs command
  • mmfsck command
  • mmfsckx command
  • mmfsctl command
  • mmgetacl command
  • mmgetstate command
  • mmhadoopctl command
  • mmhdfs command
  • mmhealth command
  • mmimgbackup command
  • mmimgrestore command
  • mmimportfs command
  • mmkeyserv command
 
 
  • mmlinkfileset command
  • mmlsattr command
  • mmlscallback command
  • mmlscluster command
  • mmlsconfig command
  • mmlsdisk command
  • mmlsfileset command
  • mmlsfs command
  • mmlslicense command
  • mmlsmgr command
  • mmlsmount command
  • mmlsnodeclass command
  • mmlsnsd command
  • mmlspolicy command
  • mmlspool command
  • mmlsqos command
  • mmlsquota command
  • mmlssnapshot command
  • mmmigratefs command
  • mmmount command
  • mmnetverify command
  • mmnfs command
  • mmnsddiscover command
  • mmobj command
  • mmperfmon command
  • mmpmon command
  • mmprotocoltrace command
  • mmpsnap command
  • mmputacl command
  • mmqos command
  • mmquotaoff command
  • mmquotaon command
  • mmreclaimspace command
  • mmremotecluster command
  • mmremotefs command
  • mmrepquota command
  • mmrestoreconfig command
  • mmrestorefs command
  • mmrestripefile command
 
 
  • mmrestripefs command
  • mmrpldisk command
  • mmsdrrestore command
  • mmsetquota command
  • mmshutdown command
  • mmsmb command
  • mmsnapdir command
  • mmstartup command
  • mmtracectl command
  • mmumount command
  • mmunlinkfileset command
  • mmuserauth command
  • mmwatch command
  • mmwinservctl command
  • mmxcp command
  • spectrumscale command
Programming reference
  • IBM Spectrum Scale Data Management API for GPFS information
  • GPFS programming interfaces
  • GPFS user exits
  • IBM Spectrum Scale management API endpoints
  • Considerations for GPFS applications
  
Big Data and Analytics Guide This guide provides the following information:

Summary of changes

Big data and analytics support

Hadoop Scale Storage Architecture
  • Elastic Storage Server
  • Erasure Code Edition
  • Share Storage (SAN-based storage)
  • File Placement Optimizer (FPO)
  • Deployment model
  • Additional supported storage features
IBM Spectrum Scale support for Hadoop
  • HDFS transparency overview
  • Supported IBM Spectrum Scale storage modes
  • Hadoop cluster planning
  • CES HDFS
  • Non-CES HDFS
  • Security
  • Advanced features
  • Hadoop distribution support
  • Limitations and differences from native HDFS
  • Problem determination
IBM Spectrum Scale Hadoop performance tuning guide
  • Overview
  • Performance overview
  • Hadoop Performance Planning over IBM Spectrum Scale
  • Performance guide
  Cloudera Data Platform (CDP) Private Cloud Base
  • Overview
  • Planning
  • Installing
  • Configuring
  • Administering
  • Upgrading
  • Limitations
  • Problem determination
  
 
Cloudera HDP 3.X
  • Planning
  • Installation
  • Upgrading and uninstallation
  • Configuration
  • Administration
  • Limitations
  • Problem determination
Open Source Apache Hadoop
  • Open Source Apache Hadoop without CES HDFS
  • Open Source Apache Hadoop with CES HDFS
Cloudera HDP 2.6
  • Planning
  • Installation
  • Upgrading software stack
  • Configuration
  • Administration
  • Troubleshooting
  • Limitations
  • FAQ
  
IBM Spectrum Scale Erasure Code Edition Guide
IBM Spectrum Scale Erasure Code Edition
  • Summary of changes
  • Introduction to IBM Spectrum Scale Erasure Code Edition
  • Planning for IBM Spectrum Scale Erasure Code Edition
  • Installing IBM Spectrum Scale Erasure Code Edition
  • Uninstalling IBM Spectrum Scale Erasure Code Edition
  • Incorporating IBM Spectrum Scale Erasure Code Edition in an Elastic Storage Server (ESS) cluster
  • Creating an IBM Spectrum Scale Erasure Code Edition storage environment
  • Using IBM Spectrum Scale Erasure Code Edition for data mirroring and replication
  • Upgrading IBM Spectrum Scale Erasure Code Edition
  • Administering IBM Spectrum Scale Erasure Code Edition
  • Troubleshooting
  • IBM Spectrum Scale RAID Administration
IBM Spectrum Scale Container Storage Interface Driver Guide This guide provides the following information:
  • Summary of changes
  • Introduction
  • Planning
  • Installation
  • Upgrading
  • Configurations
  • Using IBM Spectrum Scale Container Storage Interface Driver
  • Managing IBM Spectrum Scale when used with IBM Spectrum Scale Container Storage Interface driver
  • Cleanup
  • Limitations
  • Troubleshooting
IBM Spectrum Scale FAQ  
Table 2. IBM Spectrum Scale quick start and protocols overview guides
Guide name Description Links
Quick Start Guide This guide directs you to the instructions for installing IBM Spectrum Scale 5.1.5.
Protocols Quick Overview This guide provides an overview of:
  • Prerequisites needed prior to starting an IBM Spectrum Scale installation and protocols deployment using the installation toolkit.
  • Steps for a basic IBM Spectrum Scale installation using the installation toolkit
  • Steps for protocol deployment (NFS, SMB, Object) using the installation toolkit
  • Basic commands needed to check cluster health, configure NFS/SMB exports, and quickly test the Object protocol