Product documentation in guide format

This page contains IBM Spectrum Scale™ product documentation in PDF and EPUB formats.

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)
  • Data protection and disaster recovery in IBM Spectrum Scale
  • Introduction to IBM Spectrum Scale GUI
  • IBM Spectrum Scale management API
  • Introduction to Cloud services
  • Start of changeIntroduction to file audit loggingEnd of change
  • IBM Spectrum Scale in an OpenStack cloud deployment
  • IBM Spectrum Scale product editions
  • IBM Spectrum Scale license designation
  • Capacity based licensing
  • IBM Spectrum Storage™ Suite
Planning
  • Planning for GPFS
  • Planning for protocols
  • Start of changePlanning for Cloud servicesEnd of change
  • Firewall recommendations
  • Considerations for GPFS applications
Concepts, Planning, and Installation Guide
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
  • Start of changeInstalling Cloud services on IBM Spectrum Scale nodes End of change
  • Start of changeSetting up a Cloud services clusterEnd of change
  • Installing and configuring IBM Spectrum Scale management API
  • Installing Active File Management
  • Installing and upgrading AFM-based Disaster Recovery
  • Installing call home
  • Start of changeInstalling file audit loggingEnd of change
  • Steps to permanently uninstall GPFS and/or Protocols
  
Concepts, Planning, and Installation Guide
Start of changeUpgrading
  • IBM Spectrum Scale supported upgrade paths
  • Upgrading to IBM Spectrum Scale 5.0.x from IBM Spectrum Scale 4.2.y
  • Upgrading to IBM Spectrum Scale 4.2.y from IBM Spectrum Scale 4.1.x
  • Upgrading to IBM Spectrum Scale 4.1.1.x from GPFS V4.1.0.x
  • Upgrading from GPFS 3.5
  • Online upgrade support for protocols and performance monitoring
  • Upgrading object packages
  • Upgrading NFS packages
  • Upgrading SMB packages
  • Manually upgrading pmswift
  • Manually upgrading the performance monitoring tool
  • Manually upgrading the IBM Spectrum Scale management GUI
  • Upgrading Cloud services
  • Upgrading to IBM® Cloud Object Storage software level 3.7.2 and above
  • Upgrading IBM Spectrum Scale components with the installation toolkit
  • Migrating from Express Edition to Standard 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
  • GUI user role considerations
  • Applying maintenance to your GPFS system
End of change
  
Administration Guide This guide provides the following information:
Configuring
  • Configuring the GPFS cluster
  • Configuring the CES and protocol configuration
  • Configuring and tuning your system for GPFS
  • Parameters for performance tuning and optimization
  • Start of changeEnsuring high availability of the GUI serviceEnd of change
  • Configuring and tuning your system for Cloud services
  • Start of changeConfiguring file audit loggingEnd of change
  • Configuring Active File Management
  • Configuring AFM-based DR
  • Tuning for Kernel NFS backend on AFM and AFM DR
Administering
  • Performing GPFS administration tasks
  • 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
  • Considerations for GPFS applications
  • Accessing a remote GPFS file system
Administration Guide
  • 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
  • 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
  • Start of changeManaging file audit loggingEnd of change
  • Highly-available write cache (HAWC)
  • Local read-only cache
  • Miscellaneous advanced administration
  • GUI limitations
  
Problem Determination Guide This guide provides the following information:
Monitoring
  • Performance monitoring
  • Monitoring system health through the IBM Spectrum Scale GUI
  • Monitoring system health by using the mmhealth command
  • Monitoring events through callbacks
  • Monitoring capacity through GUI
  • Monitoring AFM and AFM DR
  • GPFS SNMP support
  • Monitoring the IBM Spectrum Scale system by using call home
  • Start of changeMonitoring remote cluster through GUIEnd of change
  • Start of changeMonitoring file audit loggingEnd of change
Troubleshooting
  • Best practices for troubleshooting
  • Understanding the system limitations
  • Collecting details of the issues
  • Managing deadlocks
  • Installation and configuration issues
  • Upgrade issues
  • Network issues
  • File system issues
  • Disk issues
  • Security issues
  • Protocol issues
  • Disaster recovery issues
  • Performance issues
  • GUI issues
  • AFM issues
  • AFM DR issues
  • Transparent cloud tiering issues
  • Start of changeFile audit logging issuesEnd of change
  • Start of changeMaintenance proceduresEnd of change
  • 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
  • mmafmctl command
  • mmafmlocal command
  • mmapplypolicy command
  • Start of changemmaudit commandEnd of change
  • mmauth command
  • mmbackup command
  • mmbackupconfig command
  • mmblock command
  • mmbuildgpl command
  • mmcallhome command
  • mmces command
  • mmcesdr 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
Command and Programming Reference
  • 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
  • mmfsctl command
  • mmgetacl command
  • mmgetstate command
  • mmhadoopctl command
  • mmhealth command
  • mmimgbackup command
  • mmimgrestore command
  • mmimportfs command
  • mmkeyserv command
  • mmlinkfileset command
  • mmlsattr command
  • mmlscallback command
  • mmlscluster command
  • mmlsconfig command
  • mmlsdisk command
 
Command and Programming Reference
  • 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
  • Start of changemmmsgqueue commandEnd of change
  • mmnetverify command
  • mmnfs command
  • mmnsddiscover command
  • mmobj command
  • mmperfmon command
  • mmpmon command
  • mmprotocoltrace command
  • mmpsnap command
  • mmputacl command
  • mmquotaoff command
  • mmquotaon 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
  • mmwinservctl command
  • spectrumscale command
  
Command and Programming Reference
Programming reference
  • IBM Spectrum Scale Data Management API for GPFS information
  • GPFS programming interfaces
  • GPFS user exits
  • IBM Spectrum Scale management API commands
  
Big Data and Analytics Guide This guide provides the following information:
IBM Spectrum Scale support for Hadoop
  • HDFS transparency
  • Supported IBM Spectrum Scale storage modes
  • Hadoop cluster planning
  • Installation and configuration of HDFS transparency
  • Application interaction with HDFS transparency
  • Upgrading the HDFS Transparency cluster
  • Start of changeRolling upgrade for HDFS TransparencyEnd of change
  • Security
  • Advanced features
  • Hadoop distribution support
  • Limitations and differences from native HDFS
  • Problem determination
BigInsights® 4.2.5 and Hortonworks Data Platform 2.6
  • Planning
    • Hardware requirements
    • Preparing the environment
    • Preparing a stanza file
  • Installation
    • Set up
    • Installation of software stack
    • BigInsights value-add services on IBM Spectrum Scale
  • Upgrading software stack
    • Migrating from BI IOP to HDP
    • Upgrading IBM Spectrum Scale service MPack
    • Upgrading HDFS Transparency
    • Upgrading IBM Spectrum Scale file system
    • Upgrading to BI IOP 4.2.5
Big Data and Analytics Guide
  • Configuration
    • Setting up High Availability [HA]
    • IBM Spectrum Scale configuration parameter checklist
    • Dual-network deployment
    • Manually starting services in Ambari
    • Setting up local repository
    • Configuring LogSearch
    • Setting IBM Spectrum Scale configuration for BigSQL
    • Hadoop Kafka/Zookeeper and IBM Spectrum Scale Kafka/Zookeeper
  • Administration
    • IBM Spectrum Scale-FPO deployment
    • Ranger
    • Kerberos
    • Short-circuit read (SSR)
    • Disabling short circuit write
    • IBM Spectrum Scale service management
    • Ambari node management
    • Restricting root access
    • IBM Spectrum Scale management GUI
    • IBM Spectrum Scale versus Native HDFS
  • Troubleshooting
    • Snap data collection
  • Limitations
    • Limitations and information
  • FAQ
    • General
    • Service fails to start
    • Service check failures
  
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.0.0.
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
Parent topic: Library and related publications