cloudkit command

The information documented below provides detailed explanations of command-line options for the non-interactive mode of the cloudkit command. It is recommended to run the cloudkit command in the interactive mode to provide enhanced usability. The cloudkit command is a comprehensive command-line tool for cloud resource provisioning, installation, and configuration of IBM Storage Scale.

Synopsis

cloudkit init [--help]
or 
cloudkit configure [--help]
or 
cloudkit create repository [--help]
or 
cloudkit create image [--help]
or
cloudkit create cluster [--help]
or
cloudkit create network [--help]
or
cloudkit create caching-target [--help]
or
cloudkit create jumphost [--help]
or
cloudkit create dns [--help]
or 
cloudkit delete {repository | image | cluster | caching-target | dns | jumphost | network} [--help]
or
cloudkit describe {repository | image | cluster | grant | dns | jumphost | network | caching-target} [--help]
or 
cloudkit describe grant [--help]
or
cloudkit list {all | repository | image | cluster | grant | caching-target | dns | jumphost | network} [--help]
or 
cloudkit grant repository [--help]
or
cloudkit grant filesystem [--help]
or 
cloudkit revoke repository [--help]
or
cloudkit revoke filesystem [--help]
or 
cloudkit validate {quota | permissions} [--help]
or
cloudkit upgrade repository [--help]
or
cloudkit upgrade cluster [--help]
or
cloudkit edit cluster [--help]
or
cloudkit port-forward [--help]
or
cloudkit setup caching [--help]
or
cloudkit status caching [--help]
or
cloudkit version [--help]

Availability

Available with IBM Storage Scale Developer Edition, IBM Storage Scale Data Access Edition, and IBM Storage Scale Data Management Edition.

Description

Use the cloudkit command to deploy IBM Storage Scale within multiple cloud providers (currently limited to AWS, Azure, and GCP), and it offers flexibility in terms of deployment topology.
Note: The cloudkit command can be used as a comprehensive command-line tool with the optional parameters or in an interactive mode that prompts user for all required and optional parameters.
The cloudkit command tool offers following command options:
cloudkit init
Installs prerequisites to use the utility.
cloudkit configure
Configures a local system to use the cloud account.
cloudkit create
Creates a resource based on inputs.
cloudkit delete
Deletes a specific resource.
cloudkit describe
Displays details of a specific resource.
cloudkit edit
Edits cluster resources, which enables to expand cluster resources.
cloudkit grant
Grants access to a specific resource.
cloudkit list
Lists resources from the specified cloud platform.
cloudkit port-forward
Port forward to access the IBM Scale Storage GUI by a jump host.
cloudkit revoke
Revokes mount access of a file system, which is provided to an IBM Storage Scale compute cluster (or) IBM Storage Scale Container Native Storage Access cluster.
cloudkit setup
Sets up features related to IBM Storage Scale, like configuring an AFM relationship from a local IBM Storage Scale cluster to a remote cluster, or configuring cloud object storage.
cloudkit status
Retrieves and displays status of features related to IBM Storage Scale, like an AFM relationship.
cloudkit upgrade
Updates an IBM Storage Scale cluster that is deployed on Cloud.
cloudkit validate
Validates quota and permissions required for an IBM Storage Scale cluster.
cloudkit version
Prints the version number of the command tool.

Parameters

The cloudkit is an interactive, guided command line interface (CLI). The parameters that are made available for the issued command options depend on the particular configuration of the cloud account that is being used. During its execution, the cloudkit queries the cloud account configuration and, based on the settings, generates a command line syntax that includes the parameters available for repeatable deployment.

Examples

To create an IBM Storage Scale cluster on cloud, issue the following interactive command:

#./cloudkit create cluster 
I: Logging at /root/scale-cloudkit/logs/cloudkit-20-2-2024_23-42-37.log 
? Cloud platform name: GCP 
? Cluster name: ibm-storage-scale 
             ………………………………………………… 
I: To create this cluster again in the future, you can run: cloudkit create cluster --airgap=false --region us-east1 --cloud-platform GCP --resource-name ibm-storage-scale --avail-zones "us-east1-b" --vpc-type Existing --deployment-mode Storage-only --network-mode JumpHost --profile-name Throughput-Performance-Persistent-Storage --create-public-subnets=false --view-cost=false --fs-mount-point /gpfs/fs1 --fs-block-size 4M --fs-capacity 1000G --strg-gui-username administrator --vol-type pd-ssd --vpc-ref ibm-storage-scale --public-subnet-refs "ibm-storage-scale-public-subnet-0" --private-subnet-refs "ibm-storage-scale-comp-pvt-subnet-0" --access-scope https://www.googleapis.com/auth/compute.readonly --config-dns=false --create-dns=false --strg-image-ref ibm-storage-scale-1708486763 --strg-ins-type n2-standard-2 --strg-private-key-path /root/.ssh/id_rsa --strg-public-key-path /root/.ssh/id_rsa.pub --strg-node-count 4 --instance-login-user gcpuser 

I: Initiating resource provisioning actions proposed in the scale instances IaC plan. 
             ………………………………………………… 
I: IBM Storage Scale cluster 'ibm-storage-scale ' has been created.

The following video shows an example of how to use the cloudkit command to deploy an IBM Storage Scale cluster on AWS, GCP, and Azure. Using the cloudkit command to deploy an IBM Storage Scale cluster on AWS, GCP, and Azure.Video about how to use the cloudkit command to deploy an IBM Storage Scale cluster on AWS, GCP, and Azure .

Exit status

0
Successful completion.
nonzero
A failure has occurred.

Security

You must have root authority to run the cloudkit command.

Location

/usr/lpp/mmfs/package_code_version/cloudkit