ibm spectrum scale manager #2

Supports: trusty

Description

Spectrum Scale 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 Spectrum Scale 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.


Software & terms:

Charm for IBM Spectrum Scale (GPFS) Manager V 4.2

Overview

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. Depending on the type of access, each node can have different roles within the cluster configuration. 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 an LXC container environment.

Prerequisites

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.0 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 packages and their part numbers are:

    IBM Spectrum Scale Standard 4.2.0 Linux for x86Series English (CN78UEN)

For Power Ubuntu, the packages and their part numbers are:

    IBM Spectrum Scale Standard 4.2.0 Linux PWR8 LE English (CN78VEN)

Usage

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.0" and choose the license that applies to the version you are using.

Deploy

Run the following commands to deploy this charm:

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

where --storage parameter specifies the disks required by Spectrum Scale manager charm for creating NSD's and file system. Here the storage type is Block (disks or logical volumes). For example if you are deploying charm on Amazon EC2 provider, then by default we can make use of the default ebs storage pool.

If you want more than one disks attached to your Spectrum Scale manager unit then you can mention the number of disks while deploying as shown below

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

where n can be 2, 3...so on. To know more about Juju Storage, you can go through the documentation at: Juju Storage.

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.

Please Note : Minimum two nodes (Spectrum scale manager units) are required to create a Spectrum Scale cluster. As of now Juju does not support shared storage (i.e. same storage disk attached to multiple units), each manager unit will be having its own attached disks.

Each manager unit will be assigned server license and node designation as quorum. The charm will create a File-System called (fs1) with blocksize of (256K) which is mounted at (/gpfs).

Installation Verification

To verify that the Spectrum Scale cluster is created successfully and File System (fs1) is created, 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 execute the commands as a root user only, so do sudo su to run the commands as root user

4) Run the mmlscluster command can be used 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.

6) You can issue mmdf fs1 command to get the information on the file system created.

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. The storage disks attached to this unit will be used to create additional NSD's and added to the existing gpfs filesystem fs1.

Upgrade

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

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

Note : The Spectrum Scale fixpack is available as an already extracted package. Please run the below command to create a tar.gz package and then place it in the directory which you have used to place the resources for installing Spectrum Scale as shown in the example below:

tar -czvf SPEC_SCALE_STD_4.2.0.2_LINUX_X86SERIE.tar.gz Spectrum_Scale_Standard-4.2.0.2-x86_64-Linux-install

Then you can use juju attach to attach the fixpack as shown below:

juju attach ibm-spectrum-scale-manager ibm_spectrum_scale_fixpack=test/SPEC_SCALE_STD_4.2.0.2_LINUX_X86SERIE.tar.gz

If the spectrum scale manager charm is updated with fixpack, then please do update the spectrum scale client 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>

This will remove the node from the Spectrum Scale cluster, delete the NSD's attached with this unit from the GPFS filesystem, unmount the filesystem before deleting the node.

Note 1 : 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. For the cluster to be up and running (n/2) + 1 quorum nodes need to be up and running, n here denotes the number of designated quorum nodes in the cluster.

For more information on node quorum and how it works, please go through the Spectrum Scale Wiki: Spectrum Scale Wiki

If only two units(two active quorum nodes) of Spectrum Scale cluster is remaining, and user wants to remove one of the unit, then the Spectrum Scale cluster will no longer exist, file system will be unmounted on the remaining two units, the cluster will be shutdown. Atleast two quorum nodes should be there active for Spectrum Scale cluster to remain functioning.

Note 2 : If a manager unit is removed, the attached disks are also deattached.

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 Spectrum Scale 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) Juju Storage Documentation To know more about how charms can declare what storage requirements they have and how allocation happens, refer to the below available documentation Juju Storage

(6) Contact Information

For issues with this charm, please contact IBM Juju Support Team jujusupp@us.ibm.com

(7) Known Limitations

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


Configuration

curl_opts
(string) The options passed to the 'curl' command when fetching files from curl_url. For example: '-u <user:password>'
curl_url
(string) Location of the IBM product installation file(s). This should be a URL that curl can use to download files. Multiple URLs should be separated by a space. NOTE: cryptographic verification is required and must be specified as part of the URL query string with the key a valid hash algorithms md5, sha256, or sha512, and the the checksum value itself (http://<url>?[md5|sha256|sha512]=<checksum>). For example: 'http://example.com/file.tgz?sha256=<sum>' 'sftp://example.com/file1.tgz?md5=<sum> ftp://example.com/file2.tgz?md5=<sum>'
extra_packages
(string) Space separated list of extra deb packages to install.
install_keys
(string) List of signing keys for install_sources package sources, per charmhelpers standard format (a yaml list of strings encoded as a string). The keys should be the full ASCII armoured GPG public keys. While GPG key ids are also supported and looked up on a keyserver, operators should be aware that this mechanism is insecure. null can be used if a standard package signing key is used that will already be installed on the machine, and for PPA sources where the package signing key is securely retrieved from Launchpad.
install_sources
(string) List of extra apt sources, per charm-helpers standard format (a yaml list of strings encoded as a string). Each source may be either a line that can be added directly to sources.list(5), or in the form ppa:<user>/<ppa-name> for adding Personal Package Archives, or a distribution component to enable.
license_accepted
(boolean) Some IBM charms require acceptance of a license before installation can proceed. If required, setting this option to True indicates that you have read and accepted the IBM terms and conditions found in the license file referenced by the charm.
package_status
(string) The status of service-affecting packages will be set to this value in the dpkg database. Valid values are "install" and "hold".
install