操作命令行界面工具

学习目标

  • 概述可用的命令行工具

  • 使用 SAP BTP 命令行界面(btp CLI)

  • 描述 Cloud Foundry 命令行界面(cf CLI)的用法

用于管理的命令行工具

您可以使用各种命令行工具来管理和操作 SAP Business Technology Platform(SAP BTP)。

CLI_ToolsOverview_010_image

SAP BTP 命令行界面(btp CLI)

对于偏好使用命令行工作和/或希望使用脚本自动化操作的用户,SAP BTP 命令行界面(btp CLI)是SAP BTP 主控室的替代方案。

此工具可用于执行与 SAP BTP 上全局账户相关的任务。这包括创建子账户和目录,还允许您获取有关当前全局账户的信息。

Cloud Foundry 命令行界面(cf CLI)

*Cloud Foundry 命令行界面(cf CLI)*用于管理 Cloud Foundry 环境中的子账户,例如创建组织和空间,或管理配额。

可以安装插件以添加更多命令。例如,多目标应用程序插件可简化由多个模块组成的应用程序的管理和部署,并对其执行生命周期操作;基于 B&R 的 Service Fabrik插件可对服务实例执行备份和恢复操作;自定义域自助服务插件可管理自定义域的 TLS 服务器证书和客户端身份验证信任。

Kubernetes 命令行工具(kubectl)

用于与 Kubernetes 集群交互的*Kubernetes 命令行工具(kubectl)*使您能够使用 Kubernetes API 对集群资源执行各种操作。借助 kubectl,您可以部署应用程序,管理集群内的 Pod、服务和其他资源。此外,您还可以检查集群状态、查看日志,并对资源详情执行检查。kubectl 不是直接发出 HTTP 请求,而是通过提供用户友好的界面来简化这一过程。

SAP BTP 命令行界面(btp CLI)

btp CLI 技术基础设施

CLI_btp_Infrastrucure_image

对于偏好使用命令行工作和/或自动化管理任务的用户,SAP BTP 命令行界面(btp CLI)是SAP BTP 主控室的替代方案。

btp CLI 的技术基础设施由客户端和服务器组成。客户端安装在您的计算机上,并通过服务器与 SAP BTP 交互。当您通过 btp CLI 登录全局账户时,就会连接到该 CLI 服务器。

btp CLI 特性与功能

以下列表显示了 btp CLI 使您能够执行的一些任务:

  • 创建子账户和目录。

  • 管理全局账户和子账户的权利。

  • 管理全局账户和子账户中的用户及其权限。

  • 订阅应用程序。

  • 设置权利。

  • 自动化管理任务。

  • 使用 SAP Service Manager 的资源。

btp CLI 命令结构

btp CLI 是用于全局账户、目录和子账户级别所有任务的命令行界面。沿着账户层级向下,使用 btp CLI 的最后一步是创建 Cloud Foundry 环境实例,这实质上就是创建一个 Cloud Foundry 组织。

Note

从组织级别开始,即管理组织和空间中的成员、创建空间以及为组织和空间分配配额,使用的是 cf CLI,稍后将对此进行讨论。

在命令行中输入的基础调用是 btp。

CLI_btp_CommandStructure_image

btp CLI 具有命令结构,使其使用起来非常方便。命令必须以关键字 btp 开头,它将调用可执行文件。

接下来,您必须定义一个操作,它可以是创建、读取、更新和删除(CRUD)操作,例如创建子账户或移除角色集合。然后,您需要指定该操作应应用于哪个组或对象。紧随其后的是对象或组的 ID。

最后,可以选择提供其他参数以执行更具体的配置,例如设置 SAP HANA Cloud 实例的密码。

Note

请注意,根据应执行的任务,并非所有命令占位符都是必需的。

管理和配置全局账户的前提条件:

  • 您已下载并解压 btpCLI (参见相关信息)。

  • 您拥有具有相应权限的全局域的用户和密码。

btp CLI 登录

首先,登录您的全局账户。为此,您需要 btp CLI 服务器的 URL。如果将其留空,客户端通常会建议 https://cpcli.cf.eu10.hana.ondemand.com。

还需要提供您想登录的全局账户的子域。子域显示在切换全局账户对话框中。

要完成登录,您需要提供用户名(通常是您的电子邮件地址)和相应的密码。如果登录成功,客户端会在您的计算机上存储一个令牌,其有效期为 24 小时,并会在每次请求时续期,使您能够不间断地工作。

如果您记不住全局账户子域 ID,可以轻松地从 SAP BTP 主控室复制:

CLI_btp_030_login

这是登录的完整语法:

btp login --url https://cpcli.cf.eu10.hana.ondemand.com –-subdomain <global-account> --user <user> --password <password>

在某个阶段,您可能需要有关全局账户的一些详细信息。您可以使用 btp CLI 获取包含所有相关信息的概览。

btp get accounts/global-account

btp CLI – 帮助与示例

使用 btp CLI 时,您可以获取每个命令的帮助。您可以查阅在线文档,也可以直接使用 btp CLI 的 help 命令。help 命令有多个帮助层级。使用 btp help,您可以获得所有命令的常规帮助概览。

使用 btp help accounts,您可以获得有关账户结构的所有命令的概览。使用 btp help create accounts/subaccount,您可以获得子账户创建命令的完整详细帮助,如下一张幻灯片所示:

CLI_btp_040_create

按下回车后,您会看到简要的用法帮助,随后是您可以使用的参数。此外,您还会看到提示部分、调用此命令所需的权限,以及更多文档链接。

Hint

您甚至可以在(不完整的)命令末尾追加 --help。

当然,您也可以使用在线文档来代替内置帮助命令。信息应当是一致的,并有助于您正确使用 btp CLI。

重要任务

在处理全局账户时,用户及其权限的管理是一项主要任务。全局账户上下文中的一个重要角色是全局账户管理员。创建新子账户或向全局账户添加新成员需要该角色。

通过在 btp CLI 中运行以下命令,将 Global Account Administrator 角色集合分配给用户:

btp assign security/role-collection "Global Account Administrator" --to-user <user>

有时您可能还需要了解全局账户和子账户可使用哪些区域的信息,例如为了创建和管理它们。为此,您可以使用以下命令:

btp list accounts/available-region

该命令还提供有关每个区域的环境和基础设施提供者的信息。

提示与技巧

  • 使用 btp login --sso 在身份提供者处自动打开浏览器进行单点登录。

  • 使用 btp enable autocomplete 为指定的 shell 启用命令自动补全,以在输入命令操作、组-对象组合及其参数时减少按键次数。

Hint

目前,自动补全可在 Bash、PowerShell 和 Zsh 中运行。

  • 使用 btp target 将命令调用指向子账户、目录或全局账户。

Hint

使用 btp get accounts/global-account --show-hierarchy 获取 ID。

  • 使用 --format json 选项将命令的输出格式更改为 JSON,以便利用自动化。

  • 使用 --config 选项指定配置文件的位置。

操作 SAP BTP 命令行界面(btp CLI)

业务示例

您希望操作 SAP BTP 命令行界面(btp CLI)。

任务 1:操作 SAP BTP 命令行界面(btp CLI)

Exercise:Start Exercise(SAP 官方交互式练习)

btp CLI 的相关信息

下载

https://tools.hana.ondemand.com/#cloud

文档

https://help.sap.com/docs/btp/sap-business-technology-platform/account-administration-using-sap-btp-command-line-interface-btp-cli

支持

使用组件

BC-CP-TOOLS-CLI

联系支持。

Cloud Foundry 命令行界面(cf CLI)

cf CLI 命令结构

使用 *Cloud Foundry 命令行界面(cf CLI)*管理 Cloud Foundry 环境中的子账户,例如创建组织和空间,或管理配额。

cf CLI 具有命令结构,使其使用起来非常方便。命令必须以关键字 cf 开头,它将调用可执行文件。

接下来,您可以定义一个全局选项。然后,您必须定义一个命令,例如可以是 start、stop、create-space。根据命令的不同,后面可能跟有参数和命令。

CLI_cf CommandStructure_image CLI_cf CommandStructure_image CLI_cf CommandStructure_image CLI_cf CommandStructure_image

cf CLI 登录

前提条件

  • 您已创建至少一个子账户,并在该子账户中启用了 Cloud Foundry 环境

  • 下载并安装 cf CLI (参见相关信息)。

要登录 cf CLI,您需要设置目标 API 端点(例如 api.cf.ap11.hana.ondemand.com)。要登录 Cloud Foundry 环境,请使用命令 cf login。

我们建议使用选项 --sso。在此登录过程中您需要一个浏览器。否则,请使用与您在默认身份提供者 SAP ID service 中的账户关联的用户和密码登录。如果您忘记了此密码,并且该用户与您的 SAP Universal ID 用户关联,请重置密码。

要使用特定的身份提供者登录,请使用选项 --origin。

下面您可以看到使用 --sso 选项登录的示例。

CLI_cf_030_login

这是登录的完整语法:

cf login \[-a API_URL\] \[-u USERNAME\] \[-p PASSWORD\] \[-o ORG\] \[-s SPACE\] \[--sso | --sso-passcode PASSCODE\] \[--origin ORIGIN\]

登录后,检查您正在使用的组织和空间。使用 cf target -o ORGANISATION -s SPACE 选择您要处理的空间!

cf CLI 帮助与功能

要查看 CLI 的帮助,请执行 cf --help,它会列出最常用的 CLI 命令。

CLI_cf_040_help

命令 cf help -a 会列出所有命令及其简短描述。

要获取特定命令的帮助,请像 btp CLI 工具那样执行 cf --help <command>。

以下关键功能可用:

  • 添加组织成员

  • 创建空间

  • 添加空间成员

  • 创建空间配额计划

  • 将配额计划分配给空间

  • 更改空间配额计划

  • 删除空间

此外,您可以添加插件以扩展功能,例如:

  • 多目标应用程序插件

  • Service Fabric 插件

  • 自定义域插件

cf CLI 的相关信息

下载

https://help.sap.com/docs/btp/sap-business-technology-platform/download-and-install-cloud-foundry-command-line-interface

备选方案:

文档

https://help.sap.com/docs/btp/sap-business-technology-platform/org-administration-using-cloud-foundry-cli

支持

使用组件

BC-CP-CF-DS

联系支持。