mmcloudworkflows utility

The mmcloudworkflows utility manages the IBM Storage Scale cluster lifecycle and workflows on AWS.

Synopsis

mmcloudworkflows cluster expand  [-h]
                                 --node_type {compute,storage}
                                 --num-instance NUM_INSTANCES
                                {--stack_name STACK_NAME }

or

mmcloudworkflows cluster info [-h]
                              --stack_name STACK_NAME

or

mmcloudworkflows cluster destroy [-h][--force]
                                {--stack_name STACK_NAME }

or

mmcloudworkflows gui_service start {--stack_name STACK_NAME }

Availability

Available with IBM Storage Scale on AWS BYOL 1.5.0.

Description

Use the mmcloudworkflows utility to manage the IBM Storage Scale cluster lifecycle and workflow on AWS.

Parameters

cluster expand
Adds the compute or storage nodes to the IBM Storage Scale cluster. The nodes that are added have the same node type and configuration as the nodes that were added during the initial cloud deployment.
--node-type {compute,server}
Specifies the IBM Storage Scale node type.
--num-instances NUM_INSTANCES
Specifies the number of nodes to be added.
--stack-name STACK NAME
Specifies the CloudFormation stack name.
cluster info
Display the nodes in the existing cluster.
--stack-name STACK NAME
Specifies the CloudFormation stack name.
cluster destroy
Deletes the entire cluster.
--force
Skips user intervention.
--stack-name STACK NAME
Specifies the CloudFormation stack name.
gui_service start
Starts the IBM Storage Scale GUI service, and indicates the IP address of the node where the service can be accessed.
--stack-name STACK NAME
Specifies the CloudFormation stack name.

Exit status

0
Successful completion.
nonzero
A failure has occurred.

Security

You must have root authority to run the mmcloudworkflows utility.

Examples

  1. To add compute nodes, run the following command:
    mmcloudworkflows cluster expand --node_type compute --num-instances 1 --stack_name scale-workflow-demo
    The system displays output similar to this:
    
2020-06-17 07:38:00,100 - INFO - Logging in to file:
/var/adm/ras/ibm_cloud_workflow_logs/mm_cloud_workflow_add_nodes.log_2020-Jun-17_07-38-00
2020-06-17 07:38:00,101 - INFO - 1. Performing prerequisite check
2020-06-17 07:38:01,962 - INFO - 2. Preparing cloud-install, install-infra configuration
2020-06-17 07:38:06,457 - INFO - 3. Downloading terraform state file from s3 bucket
2020-06-17 07:38:06,639 - INFO - 4. Downloading aws_scale_instances_inputs.auto.tfvars.json file from s3 bucket
2020-06-17 07:38:06,759 - INFO - 5. Downloading scale_clusterdefinition.json file from s3 bucket
2020-06-17 07:38:06,956 - INFO - 6.1. Existing compute instance ids: ['i-0fdf5fd63cbae4b2c',
'i-0d3f82b396e048a59', 'i-041db38e0cf9e15c2']
2020-06-17 07:38:06,957 - INFO - 6.2. Existing storage instance ids: ['i-0401f3df84f38be2d',
'i-08bc78c2b70b11cb3']
2020-06-17 07:38:06,958 - INFO - 6.3. Existing compute instance ips: ['10.0.1.25', '10.0.1.64', '10.0.1.75']
2020-06-17 07:38:06,958 - INFO - 6.4. Existing storage instance ips: ['10.0.1.49', '10.0.1.193']
2020-06-17 07:39:16,536 - INFO - 6.5. Compute instance ids obtained after expansion of resources: ['i-0fdf5fd63cbae4b2c', 'i-0d3f82b396e048a59', 'i-041db38e0cf9e15c2', 'i-007db34046660a79d']
2020-06-17 07:39:16,537 - INFO - 6.6. Compute instance ips obtained after expansion of resources: ['10.0.1.25', '10.0.1.64', '10.0.1.75', '10.0.1.36']
2020-06-17 07:39:16,537 - INFO - 7.1. Waiting to obtain 'ok' status for instance id(s): ['i-007db34046660a79d']
2020-06-17 07:41:32,172 - INFO - 7.2. Newly spun compute instance ips are: ['10.0.1.36']
2020-06-17 07:41:32,172 - INFO - 8. Proceeding to add newly spun compute instances to cluster (this could take more than a minute)
2020-06-17 07:44:08,047 - INFO - Adding new compute instance(s) (['10.0.1.36']) to cluster completed successfully.
  2. To delete the entire cluster, run the following command:
    mmcloudworkflows cluster destroy --stack_name scale-workflow-demo
    The system displays output similar to this:
    2020-06-17 08:27:48,571 - INFO - Logging in to file:
/var/adm/ras/ibm_cloud_workflow_logs/mm_cloud_workflow_teardown.log_2020-Jun-17_08-27-48

============================================================================
                    |   ! Danger Zone !  |
============================================================================
| This workflow, will result in teardown of IBM Spectrum Scale         |
| cluster and resources. However, it will not destroy VPC, Bastion     |
| Host resources and the s3 bucket.                                    |
|                                                                      |
| Notes:                                                               |
| 1. Ensure to STOP all your applications before proceeding further.   |
| 2. All IBM Scale Scale instances must be in either 'running',        |
|   'pending', 'stopping' or 'stopped' state.                          |
=============================================================================


Do you want to continue teardown [y/N]: y
2020-06-17 08:27:53,109 - INFO - Proceeding for tear down ..
2020-06-17 08:27:53,109 - INFO - 1. Performing prerequisite check
2020-06-17 08:27:54,916 - INFO - 2. Downloading terraform state file from s3 bucket
2020-06-17 08:27:55,150 - INFO - 3. Obtaining IBM SpectrumScale resources
2020-06-17 08:27:56,268 - INFO - 4. Performing IAM role deletion
2020-06-17 08:27:58,856 - INFO - 5. Performing security group deletion
2020-06-17 08:28:03,038 - INFO - 6. Performing instance termination
2020-06-17 08:28:05,034 - INFO - Operation (IBM Spectrum Scale cluster teardown) completed successfully.
2020-06-17 08:28:05,034 - INFO - Make sure VPC, Bastion resources are cleaned via cloudformation. 
Connection to 10.0.1.49 closed by remote host.
  3. To start the GUI node, run the following command:
    mmcloudworkflows gui_service start --stack_name s0
    The system displays output similar to this:
    2020-06-23 10:02:51,800 - INFO - Logging in to file: 
/var/adm/ras/ibm_cloud_workflow_logs/mm_cloud_workflow_gui_start.log_2020-Jun-23_10-02-51
2020-06-23 10:02:51,801 - INFO - 1. Performing prerequisite check
2020-06-23 10:02:53,059 - INFO - 2. Preparing install-infra configuration
2020-06-23 10:02:54,481 - INFO - 3. Downloading scale_clusterdefinition.json file from s3 bucket
2020-06-23 10:02:55,119 - INFO - 4. Identified IBM Spectrum Scale management GUI ip: 10.0.1.118
2020-06-23 10:02:55,119 - INFO - 5. Starting IBM Spectrum Scale management GUI service
2020-06-23 10:03:18,871 - INFO - Successfully started IBM Spectrum Scale management GUI on IP address: 10.0.1.118

Location

/usr/lpp/mmfs/bin