第 14 章 数据处理服务命令行客户端
sahara 客户端是数据处理服务 API 及其扩展命令行界面(CLI)。本章记录了
0.11.1 版本 sahara。
有关特定 sahara 命令的帮助信息,请输入:
$ sahara help COMMAND
14.1. sahara usage 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara [--version] [--debug] [--os-cache] [--region-name <region-name>] [--service-type <service-type>] [--endpoint-type <endpoint-type>] [--sahara-api-version <sahara-api-ver>] [--bypass-url <bypass-url>] [--os-tenant-name OS_TENANT_NAME] [--os-tenant-id OS_TENANT_ID] [--os-auth-system OS_AUTH_SYSTEM] [--os-auth-token OS_AUTH_TOKEN] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] <subcommand> ...
子命令
- cluster-create
- 创建集群。
- cluster-delete
- 删除集群。
- cluster-list
- 打印可用集群列表。
- cluster-scale
- 扩展集群。
- cluster-show
- 显示集群详情。
- cluster-template-create
- 创建集群模板。
- cluster-template-delete
- 删除集群模板。
- cluster-template-list
- 显示可用集群模板列表。
- cluster-template-show
- 显示集群模板的详情。
- cluster-template-update
- 更新集群模板。
- data-source-create
- 创建提供作业输入或接收作业输出的数据源。
- data-source-delete
- 删除数据源。
- data-source-list
- 打印可用数据源列表。
- data-source-show
- 显示数据源的详细信息。
- data-source-update
- 更新数据源。
- image-add-tag
- 添加标签到镜像。
- image-list
- 打印可用镜像列表。
- image-register
- 从镜像索引注册镜像。
- image-remove-tag
- 从镜像中删除标签。
- image-show
- 显示镜像的详细信息。
- image-unregister
- 取消镜像注册。
- job-binary-create
- 记录作业二进制文件。
- job-binary-data-create
- 将数据存储在内部数据库中。使用 'swift upload' 而不是此命令。仅在 Swift 不可用时使用此命令。
- job-binary-data-delete
- 删除内部存储的作业二进制数据。
- job-binary-data-list
- 打印内部存储作业二进制数据的列表。
- job-binary-delete
- 删除作业二进制文件。
- job-binary-list
- 打印作业二进制文件列表。
- job-binary-show
- 显示作业二进制文件的详细信息。
- job-binary-update
- 更新作业二进制文件。
- job-create
- 创建作业。
- job-delete
- 删除作业。
- job-list
- 打印作业列表。
- job-show
- 显示作业的详细信息。
- job-template-create
- 创建作业模板。
- job-template-delete
- 删除作业模板。
- job-template-list
- 打印作业模板列表。
- job-template-show
- 显示作业模板的详细信息。
- job-type-list
- 显示支持的作业类型。
- node-group-template-create
- 创建节点组模板。
- node-group-template-delete
- 删除节点组模板。
- node-group-template-list
- 显示可用节点组模板列表。
- node-group-template-show
- 显示节点组模板的详细信息。
- node-group-template-update
- 更新节点组模板。
- plugin-list
- 打印可用插件列表。
- plugin-show
- 显示插件的详情。
- bash-completion
- 为 bash 补全打印参数。将所有命令和选项输出到 stdout,以便 sahara.bash_completion 脚本不必硬编码它们。
- 帮助
- 显示有关该程序或其其中一个子命令的帮助。
14.2. sahara 可选参数 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
- --version
- 显示程序的版本号并退出
- --debug
- 打印调试输出。
- --os-cache
- 使用身份验证令牌缓存。如果没有设置
env[OS_CACHE],则默认为 False。 - --region-name <region-name>
- 默认为
env[OS_REGION_NAME]。 - --service-type <service-type>
- 默认为所有操作的数据处理。
- --endpoint-type <endpoint-type>
- 默认为
env[SAHARA_ENDPOINT_TYPE]或env[OS_ENDPOINT_TYPE]或 publicURL。 - --sahara-api-version <sahara-api-ver>
- 接受 "api",默认为
env[SAHARA_API_VERSION]。 - --bypass-url <bypass-url>
- 使用此 API 端点而不是服务目录。
- --os-tenant-name OS_TENANT_NAME
- 默认为
env[OS_TENANT_NAME]。 - --os-tenant-id OS_TENANT_ID
- 默认为
env[OS_TENANT_ID]。 - --os-auth-system OS_AUTH_SYSTEM
- 默认为
env[OS_AUTH_SYSTEM]。 - --os-auth-token OS_AUTH_TOKEN
- 默认为
env[OS_AUTH_TOKEN]。 - --insecure
- 明确允许客户端执行"不安全"TLS (https)请求。服务器的证书不会针对任何证书颁发机构进行验证。这个选项应谨慎使用。
- --os-cacert <ca-certificate>
- 指定用于验证 TLS (https)服务器证书中使用的 CA 捆绑包文件。默认为
env[OS_CACERT]。 - --os-cert <certificate>
- 默认为
env[OS_CERT]。 - --os-key <key>
- 默认为
env[OS_KEY]。 - --timeout <seconds>
- 设置请求超时(以秒为单位)。
- --os-auth-url OS_AUTH_URL
- 身份验证 URL
- --os-domain-id OS_DOMAIN_ID
- 域 ID 范围
- --os-domain-name OS_DOMAIN_NAME
- 域名范围为
- --os-project-id OS_PROJECT_ID
- 项目 ID 到范围
- --os-project-name OS_PROJECT_NAME
- 项目名称到范围
- --os-project-domain-id OS_PROJECT_DOMAIN_ID
- 包含项目的域 ID
- --os-project-domain-name OS_PROJECT_DOMAIN_NAME
- 包含项目的域名
- --os-trust-id OS_TRUST_ID
- 信任 ID
- --os-user-id OS_USER_ID
- 用户 ID
- --os-user-name OS_USERNAME, --os-username OS_USERNAME
- 用户名
- --os-user-domain-id OS_USER_DOMAIN_ID
- 用户的域 ID
- --os-user-domain-name OS_USER_DOMAIN_NAME
- 用户的域名
- --os-password OS_PASSWORD
- 用户密码
14.3. sahara cluster-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-create [--json JSON] [--count COUNT]
创建集群。
可选参数
- --json JSON
- 集群的 JSON 表示。
- --count COUNT
- 要创建的集群数量。
14.4. sahara cluster-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-delete [--name NAME] [--id <cluster_id>]
删除集群。
可选参数
- --name NAME
- 集群的名称。
- --id <cluster_id>
- 要删除的集群的 ID。
14.5. sahara cluster-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-list
打印可用集群列表。
14.6. sahara cluster-scale 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-scale [--name NAME] [--id <cluster_id>] [--json JSON]
扩展集群。
可选参数
- --name NAME
- 集群的名称。
- --id <cluster_id>
- 集群的 ID。
- --json JSON
- 集群扩展的 JSON 表示。
14.7. sahara cluster-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-show [--name NAME] [--id <cluster_id>] [--show-progress SHOW_PROGRESS] [--json]
显示集群详情。
可选参数
- --name NAME
- 集群的名称。
- --id <cluster_id>
- 要显示的集群 ID。
- --show-progress SHOW_PROGRESS
- 显示集群的置备进度事件。
- --json
- 输出集群的 JSON 表示。
14.8. sahara cluster-template-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-template-create [--json JSON]
创建集群模板。
可选参数
- --json JSON
- 集群模板的 JSON 表示。
14.9. sahara cluster-template-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-template-delete [--name NAME] [--id <template_id>]
删除集群模板。
可选参数
- --name NAME
- 集群模板的名称。
- --id <template_id>
- 要删除的集群模板的 ID。
14.10. sahara cluster-template-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-template-list
显示可用集群模板列表。
14.11. sahara cluster-template-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-template-show [--name NAME] [--id <template_id>] [--json]
显示集群模板的详情。
可选参数
- --name NAME
- 集群模板的名称。
- --id <template_id>
- 要显示的集群模板的 ID。
- --json
- 输出集群模板的 JSON 表示。
14.12. sahara cluster-template-update 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara cluster-template-update [--name NAME] [--id <template_id>] [--json JSON]
更新集群模板。
可选参数
- --name NAME
- 要更新的集群模板的名称。
- --id <template_id>
- 要更新的集群模板的 ID。
- --json JSON
- 集群模板更新的 JSON 表示。
14.13. sahara data-source-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara data-source-create --name NAME --type TYPE --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
创建提供作业输入或接收作业输出的数据源。
可选参数
- --name NAME
- 数据源的名称。
- --type TYPE
- 数据源的类型。
- --url URL
- 数据源的 URL。
- --description DESCRIPTION
- 数据源的描述。
- --user USER
- 用于访问数据源 URL 的用户名。
- --password PASSWORD
- 用于访问数据源 URL 的密码。
14.14. sahara data-source-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara data-source-delete [--name NAME] [--id ID]
删除数据源。
可选参数
- --name NAME
- 数据源的名称。
- --id ID
- 要删除的数据源的 ID。
14.15. sahara data-source-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara data-source-list
打印可用数据源列表。
14.16. sahara data-source-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara data-source-show [--name NAME] [--id ID]
显示数据源的详细信息。
可选参数
- --name NAME
- 数据源的名称。
- --id ID
- 数据源的 ID。
14.17. sahara data-source-update 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara data-source-update [--name NAME] [--id ID] [--json JSON]
更新数据源。
可选参数
- --name NAME
- 要更新的数据源的名称。
- --id ID
- 要更新的数据源的 ID。
- --json JSON
- 包含要更新的数据源字段的 JSON。
14.18. sahara image-add-tag 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara image-add-tag [--name NAME] [--id <image_id>] --tag <tag>
添加标签到镜像。
可选参数
- --name NAME
- 镜像的名称。
- --id <image_id>
- 要标记的镜像 ID。
- --tag <tag>
- 要添加的标签。
14.19. sahara image-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara image-list
打印可用镜像列表。
14.20. sahara image-register 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara image-register --id <image_id> [--username <name>] [--description <desc>]
从镜像索引注册镜像。
可选参数
- --id <image_id>
- 镜像 ID,运行 "glance image-list" 来查看所有 ID。
- --username <name>
- 镜像中特权用户的用户名。
- --description <desc>
- 镜像的描述。
14.21. sahara image-remove-tag 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara image-remove-tag [--name NAME] [--id <image_id>] --tag <tag>
从镜像中删除标签。
可选参数
- --name NAME
- 镜像的名称。
- --id <image_id>
- 要标记的镜像。
- --tag <tag>
- 要移除的标签。
14.22. sahara image-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara image-show [--name NAME] [--id <image_id>]
显示镜像的详细信息。
可选参数
- --name NAME
- 镜像的名称。
- --id <image_id>
- 镜像的 ID。
14.23. sahara image-unregister 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara image-unregister [--name NAME] [--id <image_id>]
取消镜像注册。
可选参数
- --name NAME
- 镜像的名称。
- --id <image_id>
- 要取消注册的镜像 ID。
14.24. sahara job-binary-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-create --name NAME --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
记录作业二进制文件。
可选参数
- --name NAME
- 作业二进制文件的名称。
- --url URL
- 作业二进制文件的 URL。
- --description DESCRIPTION
- 作业二进制文件的描述。
- --user USER
- 用于访问作业二进制 URL 的用户名。
- --password PASSWORD
- 用于访问作业二进制 URL 的密码。
14.25. sahara job-binary-data-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-data-create [--file FILE] [--name NAME]
将数据存储在内部数据库中。使用 'swift upload' 而不是此命令。仅在 Swift 不可用时使用此命令。
可选参数
- --file FILE
- 要存储的数据。
- --name NAME
- 作业二进制文件内部的名称。
14.26. sahara job-binary-data-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-data-delete --id ID
删除内部存储的作业二进制数据。
可选参数
- --id ID
- 内部存储作业二进制数据的 ID。
14.27. sahara job-binary-data-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-data-list
打印内部存储作业二进制数据的列表。
14.28. sahara job-binary-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-delete [--name NAME] [--id ID]
删除作业二进制文件。
可选参数
- --name NAME
- 作业二进制文件的名称。
- --id ID
- 要删除的作业二进制文件的 ID。
14.29. sahara job-binary-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-list
打印作业二进制文件列表。
14.30. sahara job-binary-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-show [--name NAME] [--id ID]
显示作业二进制文件的详细信息。
可选参数
- --name NAME
- 作业二进制文件的名称。
- --id ID
- 作业二进制文件的 ID。
14.31. sahara job-binary-update 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-binary-update [--name NAME] [--id <job_binary_id>] [--json JSON]
更新作业二进制文件。
可选参数
- --name NAME
- 要更新的作业二进制文件的名称。
- --id <job_binary_id>
- 要更新的作业二进制文件的 ID。
- --json JSON
- 作业二进制更新的 JSON 表示。
14.32. sahara job-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-create --job-template JOB_TEMPLATE [--cluster CLUSTER] [--input-data INPUT_DATA] [--output-data OUTPUT_DATA] [--param name=value] [--arg ARG] [--config name=value] [--json JSON]
创建作业。
可选参数
- --job-template JOB_TEMPLATE
- 要运行的作业模板的 ID。
- --cluster CLUSTER
- 运行作业的集群 ID。
- --input-data INPUT_DATA
- 输入数据源的 ID。
- --output-data OUTPUT_DATA
- 输出数据源的 ID。
- --param
- 要添加到作业的 name=value 参数,可重复使用。
- --arg ARG
- 要添加到作业的参数,可重复使用。
- --config
- 要添加到作业的 name=value 配置参数,可重复使用。
- --json JSON
- 作业的 JSON 表示。
14.33. sahara job-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-delete --id ID
删除作业。
可选参数
- --id ID
- 作业的 ID。
14.34. sahara job-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-list
打印作业列表。
14.35. sahara job-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-show --id ID
显示作业的详细信息。
可选参数
- --id ID
- 作业的 ID。
14.36. sahara job-template-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-template-create [--name NAME] [--type TYPE] [--main MAIN] [--lib LIB] [--description DESCRIPTION] [--json JSON]
创建作业模板。
可选参数
- --name NAME
- 作业模板的名称。
- --type TYPE
- 作业模板的类型。
- --main MAIN
- 作业主作业主二进制的 ID。
- --lib LIB
- 作业的 lib job-binary 的 ID,可重复使用。
- --description DESCRIPTION
- 作业模板的描述。
- --json JSON
- 作业模板的 JSON 表示。
14.37. sahara job-template-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-template-delete [--name NAME] [--id ID]
删除作业模板。
可选参数
- --name NAME
- 作业模板的名称。
- --id ID
- 作业模板的 ID。
14.38. sahara job-template-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-template-list
打印作业模板列表。
14.39. sahara job-template-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-template-show [--name NAME] [--id ID]
显示作业模板的详细信息。
可选参数
- --name NAME
- 作业模板的名称。
- --id ID
- 作业模板的 ID。
14.40. sahara job-type-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara job-type-list [--type <job_type>] [--plugin <plugin>] [--plugin-version <plugin_version>]
显示支持的作业类型。
可选参数
- --type <job_type>
- 仅报告此作业类型。
- --plugin <plugin>
- 仅报告此插件支持的作业类型。
- --plugin-version <plugin_version>
- 仅报告指定插件此版本所支持的作业类型。仅对 --plugin 有效。
14.41. sahara node-group-template-create 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara node-group-template-create [--json JSON]
创建节点组模板。
可选参数
- --json JSON
- 节点组模板的 JSON 表示。
14.42. sahara node-group-template-delete 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara node-group-template-delete [--name NAME] [--id <template_id>]
删除节点组模板。
可选参数
- --name NAME
- 节点组模板的名称。
- --id <template_id>
- 要删除的节点组模板的 ID。
14.43. sahara node-group-template-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara node-group-template-list
显示可用节点组模板列表。
14.44. sahara node-group-template-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara node-group-template-show [--name NAME] [--id <template_id>] [--json]
显示节点组模板的详细信息。
可选参数
- --name NAME
- 节点组模板的名称。
- --id <template_id>
- 要显示的节点组模板的 ID。
- --json
- 输出节点组模板的 JSON 表示。
14.45. sahara node-group-template-update 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara node-group-template-update [--name NAME] [--id <template_id>] [--json JSON]
更新节点组模板。
可选参数
- --name NAME
- 要更新的节点组模板的名称。
- --id <template_id>
- 要更新的节点组模板的 ID。
- --json JSON
- 节点组模板更新的 JSON 表示。
14.46. sahara plugin-list 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara plugin-list
打印可用插件列表。
14.47. sahara plugin-show 复制链接链接已复制到粘贴板!
复制链接链接已复制到粘贴板!
usage: sahara plugin-show --name <plugin>
显示插件的详情。
可选参数
- --name <plugin>
- 插件的名称。