Interface Declaration
Program Name |
Function |
Remarks |
|---|---|---|
cert_cli.sh |
Generates certificates. |
For software internal use. You are not advised to manually invoke it. |
common_var.sh |
Sets environment variables. |
For software internal use. You are not advised to manually invoke it. |
ssh_and_run_cmd.sh |
Implements remote execution. |
For software internal use. You are not advised to manually invoke it. |
ssh_and_scp.sh |
Distributes certificates. |
For software internal use. You are not advised to manually invoke it. |
kmc_tool |
Encrypts data and updates keys. |
For software internal use. You are not advised to manually invoke it. |
ccm_main |
Manages the cluster. |
For software internal use. You are not advised to manually invoke it. |
GlobalCache |
Accelerates I/Os. |
For software internal use. You are not advised to manually invoke it. |
statustool |
Queries the status of Ceph, ZooKeeper, and the CCM. |
For software internal use. You are not advised to manually invoke it. |
checkStatus.sh |
Checks whether the Global Cache process is in D state. |
For software internal use. You are not advised to manually invoke it. |
gcache_startup |
Starts the process (such as configuring environment variables). |
For software internal use. You are not advised to manually invoke it. |
gc_upgrade |
Upgrades the Global Cache service. |
For software internal use. You are not advised to manually invoke it. |
update_tool |
Verifies the signature and checks the cluster status. |
For software internal use. You are not advised to manually invoke it. |
cert_cli.sh
- Function
Generates a TLS certificate.
- Syntax
cert_cli agent [req/fetch] [CA_ip] [CA_user] [agent_ip]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
agent
Node type
N/A
[req/fetch]
req: applying for a certificate; fetch: distributing a certificate
N/A
[CA_ip]
IP address of the CA node
N/A
[CA_user]
User name of the CA node
N/A
[agent_ip]
IP address of the agent
N/A
common_var.sh
- Function
Sets environment variables related to certificate generation.
- Syntax
sh common_var.sh
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
N/A
N/A
N/A
ssh_and_run_cmd.sh
- Function
Runs commands remotely.
- Syntax
sh ssh_and_run_cmd.sh [target_ip] [target_username]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
[target_ip]
IP address of the target node
N/A
[target_username]
User name of the target node
N/A
ssh_and_scp.sh
- Function
Implements remote copy.
- Syntax
sh ssh_and_scp.sh [source_path] [dest_path]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
[source_path]
Copies the source path.
N/A
[dest_path]
Copies the target path.
N/A
kmc_tool
- Function
Encrypts passwords and updates KMC keys.
- Syntax
kmc_tool [domain_id] [--encrypt/--updateMK]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
[domain_id]
Domain ID
[0–65536]
[--encrypt/--updateMK]
--encrypt: encryption; --updateMK: key update
N/A
ccm_main
- Function
Manages the cluster.
- Syntax
ccm_main
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
N/A
N/A
N/A
GlobalCache
- Function
Accelerates I/Os.
- Syntax
GlobalCache
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
N/A
N/A
N/A
statustool
- Function
Queries the status of Ceph, ZooKeeper, and the CCM.
- Syntax
statustool [process_name]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
process_name
Process name
- ccm: To check whether Ceph and ZooKeeper support CCM running.
- globalcache: To check whether Ceph, ZooKeeper, and the CCM support the running of Global Cache.
checkStatus.sh
- Function
Checks whether the Global Cache process is in D state.
- Syntax
sh checkStatus.sh
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
N/A
N/A
N/A
gcache_startup
- Function
Starts the process (such as configuring environment variables).
- Syntax
gcache_startup [cmd_str]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
cmd_str
Command string, which is used to start the Global Cache process.
/opt/gcache/bin/GlobalCache
gc_upgrade
- Function
Upgrades Global Cache.
- Syntax
gc_upgrade [upgrade/upgrade_M/recover] [rpm_path]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
[upgrade/upgrade_M/recover]
- upgrade: single-node upgrade
- upgrade_M: batch upgrade
- recover: restoration
N/A
[rpm_path]
RPM path.
N/A
update_tool
- Function
Facilitates the upgrade regarding signature verification and cluster status check.
- Syntax
update_tool [file_verify/prepare/backup_data/update_data/set_ccmnofault/unset_ccmnofault] [rpm_path] [cms_path] [update]
- Remarks
For software internal use. You are not advised to manually invoke it.
- Parameters
Parameter
Description
Value
file_verify
Verifies the validity of the file signature.
N/A
prepare
Prepares for the upgrade.
N/A
backup_data
Backs up data before the upgrade.
N/A
update_data
Updates data after the upgrade.
N/A
set_ccmnofault
Sets the cluster not to generate alarms.
N/A
unset_ccmnofault
Enables the cluster alarm function.
N/A
rpm_path
RPM path, which is used with file_verify.
N/A
cms_path
Signature file path, which is used with file_verify.
N/A
update
Upgrade flag, which is used with file_verify.
N/A