ibm spectrum scale manager #18

Supports: xenial


IBM Spectrum Scale is a flexible software-defined storage that can be deployed as high performance file storage or a cost optimized large-scale content repository. IBM Spectrum Scale, previously known as IBM General Parallel File System (GPFS), is built from the ground up to scale performance and capacity with no bottlenecks. A manager node is any server that has the Spectrum Scale product installed with direct storage access or network access to another node

Software & terms:

Charm for IBM Spectrum Scale (GPFS) Manager V 4.2.2


IBM Spectrum Scale Manager

IBM Spectrum Scale or GPFS provides simplified data management and integrated information lifecycle tools capable of managing petabytes of data and billions of files, in order to arrest the growing cost of managing ever growing amounts of data.

A manager node is any server that has the Spectrum Scale product installed with direct storage access or network access to another node. A manager node will be part of the node pool from which file system managers and token managers can be selected.

For details on Spectrum Scale, as well as information on purchasing, please visit: Product Page and at the Passport Advantage Site

Note that due to the GPFS kernel module, this charm will not work in a LXC/LXD container environment.


This charm makes use of resources, a feature only available in Juju 2.0. During deploy, you will need to specify the installable package(s) required by this charm. Download your licensed IBM Spectrum Scale Standard 4.2.2 version for Ubuntu. To acquire and download IBM Spectrum Scale, follow instructions available at the Product Page.

This charm will deploy only the Standard edition for IBM Spectrum Scale.

For x86_64 Ubuntu, the package and part number is:

    IBM Spectrum Scale Standard 4.2.2 Linux for x86Series English (CNEP7EN)

For Power Ubuntu, the package and part number is:

    IBM Spectrum Scale Standard 4.2.2 Linux PWR8 LE English (CNEP8EN)


To use this charm, you must agree to the Terms of Use. You can view the full license for IBM Spectrum Scale by visiting the Software license agreements search website. Search for "IBM Spectrum Scale, V4.2.2" and choose the license that applies to the version you are using. The charm will automatically create a filesystem when the user makes use of Juju storage feature by specifying the storage parameter, incase the user has specific requirement like making use of Shared disks (SAN), then the charm will just install Spectrum Scale and create a cluster, it will not automatically create a filesystem. The user has to create the filesystem manually later.


Run the following commands to deploy this charm: Based upon user's requirement for creating filesystems, the charm deployment commands will differ. If you want to have the default filesystem created automatically for you, specify the storage requirement while deploying the charm as shown below:

juju deploy ibm-spectrum-scale-manager --resource ibm_spectrum_scale_installer_manager=</path/to/installer.tar.gz>  --storage disks=ebs,1G

Incase you don't want to make use of juju storage feature and want to create the filesystem manually, then just run the below deploy command.

juju deploy ibm-spectrum-scale-manager --resource ibm_spectrum_scale_installer_manager=</path/to/installer.tar.gz>

Note: This charm requires acceptance of Terms of Use. When deploying from the Charm Store, these terms will be presented to you for your consideration. To accept the terms:

juju agree ibm-spectrum-scale/1

Once you have agreed to the Terms, then only the IBM Spectrum Scale Manager charm will be deployed.

Note : Minimum two nodes (Spectrum scale manager units) are required to create a Spectrum Scale cluster.

Each manager unit will be assigned server license and node designation as quorum. Incase you are specifying storage disks at time of deployment or attach disks later, then the charm will create a default File-System called (fs1) with blocksize of (256K) which is mounted at (/gpfs).

Installation Verification

To verify that the client node is added successfully, run the below commands:

1) Go to the machine where Spectrum Scale manager is installed.

2) Go to the Spectrum Scale bin folder path: /usr/lpp/mmfs/bin.

3) We can need root permission to run most of the commands, so do sudo su to run the commands as root user.

4) Run the mmlscluster command to display cluster information or mmgetstate command to see the status of the nodes.

5) You can issue command df -h to see whether gpfs filesystem (fs1) is listed or not if created by the charm, otherwise you can create your own customized filesystem.

Adding more units of Spectrum Scale Manager

To add more units of Spectrum Scale Manager, run the below command:

juju add-unit ibm-spectrum-scale-manager

Each unit added will add a quorum designated node to the existing Spectrum Scale cluster.


Once deployed, users can install fixpacks by upgrading the charm:

juju attach ibm-spectrum-scale-manager ibm_spectrum_scale_manager_fixpack=</path/to/fixpack.tar.gz>

Provide the fixpack having file format as *.tar.gz If the spectrum scale manager units are updated, please do update the spectrum scale units as well. Both Manager and Client nodes should be at same Spectrum Scale version.

Removing unit

To remove a unit of Spectrum Scale manager, run the below step:

juju remove-unit <ibm-spectrum-scale-manager/unit-no>

Please Note : The removal of a manager node from Spectrum Scale cluster depends on the fact whether the node has disks attached/NSD Server. If it does not have a disk attached or is a NSD server for existing filesystem, the node will be deleted from the cluster without any user interference required. But if the node is a NSD Server and has data, the charm will error out. This is done so that the storage admin/user can delete the disks and take appropriate action based upon the filesystem and nsd server requirements. Until user takes appropriate action on this, the charm will remain in error state. Once the node is not a part of filesystem/NSD Server, charm will come out of the error and this node will be deleted from the cluster.

A Spectrum Scale cluster uses a cluster mechanism called quorum to maintain data consistency in the event of a node failure. Quorum operates on the principle of majority rule. If only two units of Spectrum Scale cluster is remaining, and user wants to remove one of the units, then the Spectrum Scale cluster will no longer exist. Atleast two units should be there active for Spectrum Scale cluster to remain functioning.

Removing Relation

An IBM Spectrum Scale Manager charm is related to IBM Spectrum Scale client, to remove relation between them, run the below step:

juju remove-relation ibm-spectrum-scale-client ibm-spectrum-scale-manager

This will remove the client node from the Spectrum Scale cluster. The GPFS file system will be unmounted before deleting the client node.

IBM Spectrum Scale Information

(1) General Information

Information on IBM Spectrum Scale available at the Product Page

(2) Download Information

Information on procuring IBM Platform LSF product is available at the Passport Advantage Site

(3) Spectrum Scale Infocenter

To know more details about how Spectrum Scale works, refer to Spectrum Scale Infocenter IBM Spectrum Scale Knowledge Center

(4) License

License information for IBM Spectrum Scale can be viewed at the Software license agreements search website

(5) Contact Information

For issues with this charm, please contact IBM Juju Support Team

(6) Known Limitations

This charm makes use of Juju features that are only available in version 2.0 or greater.