ibm spectrum scale client #20

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 client node is any server that has the Spectrum Scale product installed but do not support direct attached disks. A client node will not be part of the node pool from where file system managers and token managers are selected.

Software & terms:

Charm for IBM Spectrum Scale (GPFS) Client V 4.2.2


IBM Spectrum Scale Client

IBM Spectrum Scale (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 client node is any server that has the Spectrum Scale product installed but do not support direct attached disks. Also a client node will not 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.


Run the following commands to deploy this charm:

As the Spectrum scale client is a subordinate charm, you need to deploy the principle charm first, where you want your client nodes to be present. For simple deployment, you can deploy on top of Ubuntu charm as shown below:

juju deploy cs:ubuntu-10
juju deploy ibm-spectrum-scale-client --resource     
juju add-relation ubuntu ibm-spectrum-scale-client
juju add-relation ibm-spectrum-scale-client ibm-spectrum-scale-manager

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 Client charm will be deployed. Once IBM Spectrum Scale client is deployed successfully, a node will be added to the Spectrum Scale cluster with designated license as client and node designation as non-quorum

Installation Verification

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

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

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

3) The commands can be executed as a root user only, so do sudo su to run the commands as root user

4) Run the mmlscluster command which will display cluster information or mmgetstate command to see the status of the client node

5) If you have created the filesystem on manager nodes, you can issue command df -h to see whether gpfs filesystem is mounted or not on the client nodes.


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

juju attach ibm-spectrum-scale-client ibm_spectrum_scale_client_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 client as well. Both Manager and Client nodes should be at same Spectrum Scale version.

Removing Relation

An IBM Spectrum Scale client charm is related to IBM Spectrum Scale Manager, 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.

Relation with IBM Cinder/Glance SpectrumScale charm

In Openstack, you can have Spectrum Scale as one of the storage backend for Cinder or Glance. The Spectrum Scale client charm can be deployed on nova compute nodes and related to IBM Cinder/Glance SpectrumScale charm (which is the gpfs driver). This allows a single Spectrum Scale storage cluster to be associated with Cinder or glance or both, potentially alongside other storage backends from other vendors. For more details on this, please refer to IBM Cinder SpectrumScale charm: IBM Cinder SpectrumScale Charm IBM Glance SpectrumScale Charm

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.