storageos/cli

StorageOS CLI

StorageOS命令行客户端，支持Mac、Linux、Windows系统，用于与StorageOS服务器交互。详细命令参考请见命令行参考文档。

概述与主要用途

StorageOS CLI是StorageOS的官方命令行工具，提供与StorageOS服务器交互的接口，允许用户通过命令行管理存储资源，包括配置连接参数、执行存储操作等。适用于需要通过命令行高效管理StorageOS存储系统的场景。

核心功能与特性

• 跨平台支持：兼容Mac、Linux、Windows操作系统
• 灵活配置：支持通过命令行标志或环境变量配置连接参数
• 环境变量管理：提供多种环境变量用于设置默认配置（如服务器地址、认证信息、超时时间等）
• 内置帮助：提供详细的命令使用说明，便于快速上手

使用场景与适用范围

• 系统管理员通过命令行管理StorageOS存储集群
• 开发人员在开发环境中配置和测试StorageOS存储资源
• 需要通过脚本自动化操作StorageOS的场景

安装方法

Linux系统安装

bash
sudo -i
curl -skSL https://github.com/storageos/go-cli/releases/latest/download/storageos_linux_amd64 > /usr/local/bin/storageos
chmod +x /usr/local/bin/storageos
exit

Mac系统安装

bash
sudo -i
curl -skSL https://github.com/storageos/go-cli/releases/latest/download/storageos_darwin_amd64 > /usr/local/bin/storageos
chmod +x /usr/local/bin/storageos
exit

配置说明

CLI客户端需要知道StorageOS服务器地址、用户名和密码。配置可通过命令行标志或环境变量传递。运行storageos env可查看环境变量配置说明：

bash
% storageos env
StorageOS CLI允许用户通过环境变量为某些配置设置提供默认值。

可用设置：
  STORAGEOS_ENDPOINTS      设置CLI连接的默认StorageOS API端点
  STORAGEOS_API_TIMEOUT    指定CLI命令超时前的默认持续时间
  STORAGEOS_USER_NAME      设置CLI用于认证的默认用户名
  STORAGEOS_PASSWORD       设置CLI用于认证的默认密码
  STORAGEOS_USE_IDS        当设置为true时，CLI将使用提供的值作为现有资源的ID而非名称
  STORAGEOS_NAMESPACE      指定CLI操作的默认命名空间
  STORAGEOS_OUTPUT_FORMAT  指定CLI输出的默认格式

使用方法

运行storageos命令获取完整使用信息，包括所有可用命令和参数：

bash
storageos

常用操作示例

• 检查CLI版本：

  bash
  storageos --version
  

• 获取命令帮助：

  bash
  storageos help
  

• 配置环境变量并连接服务器：

  bash
  export STORAGEOS_ENDPOINTS=[***]
  export STORAGEOS_USER_NAME=admin
  export STORAGEOS_PASSWORD=password
  storageos volume list