该deploymentmanager2命令行界面（CLI）允许您从终端舒适地使用Google Deployment Manager服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接重定向到文件，而不考虑您的shell的功能。错误将打印到标准错误，并导致程序的退出代码不为零。

如果请求数据结构，则这些数据结构将以美观打印的JSON格式返回，作为其他工具的输入非常有用。

有关Deployment Manager API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-deploymentmanager2-cli

在github上找到源代码。

用法

此文档是从修订版20240229的Deployment Manager API生成的。CLI版本为5.0.4。

deploymentmanager2 [options]
        deployments
                cancel-preview <project> <deployment> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <deployment> [-p <v>]... [-o <out>]
                get <project> <deployment> [-p <v>]... [-o <out>]
                get-iam-policy <project> <resource> [-p <v>]... [-o <out>]
                insert <project> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> [-p <v>]... [-o <out>]
                patch <project> <deployment> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <project> <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                stop <project> <deployment> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <project> <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project> <deployment> (-r <kv>)... [-p <v>]... [-o <out>]
        manifests
                get <project> <deployment> <manifest> [-p <v>]... [-o <out>]
                list <project> <deployment> [-p <v>]... [-o <out>]
        operations
                get <project> <operation> [-p <v>]... [-o <out>]
                list <project> [-p <v>]... [-o <out>]
        resources
                get <project> <deployment> <resource> [-p <v>]... [-o <out>]
                list <project> <deployment> [-p <v>]... [-o <out>]
        types
                list <project> [-p <v>]... [-o <out>]
  deploymentmanager2 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中，文件名以deploymentmanager2-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数API需要用户对任何请求进行身份验证。如果是这样，则范围确定授予的权限集。这些权限的粒度通常不超过只读或完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如，在调用只读方法时，它将只请求只读范围。您可以使用--scope标志直接指定范围。所有适用的范围都在相应方法的CLI文档中记录。

首次使用范围时，将要求用户授权。遵循CLI给出的指示授权权限或拒绝。

如果某个作用域被用户验证，相应信息将以JSON格式存储在配置目录中，例如~/.google-service-cli/deploymentmanager2-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的验证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，它需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐一启用。大多数API可以免费使用，并且有每日配额。

为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI，CLI附带了一个默认的应用程序密钥，并据此进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您的密钥文件放在此位置来解决这个问题：~/.google-service-cli/deploymentmanager2-secret.json，假设已为它启用了所需的deploymentmanager API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽力提供可用的错误信息，但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原样输出到标准错误来完成的。

使用--debug标志将以Debug表示形式将错误打印到标准错误。

您可以考虑将标准错误重定向到文件，以便于使用，例如deploymentmanager2 --debug <resource> <method> [options] 2>debug.txt。