#google #google-api #cli #deployment-manager #command-line-interface

app google-deploymentmanager2_beta2-cli

一个完整的库,用于与部署管理器(协议 v2beta2)交互

20 个稳定版本 (4 个主要版本)

5.0.4+20160201 2024 年 3 月 5 日
3.1.0+20160201 2022 年 4 月 26 日
3.0.0+20160201 2022 年 3 月 8 日
2.0.4+20160201 2021 年 4 月 15 日
0.3.6+20160201 2016 年 9 月 11 日

#2059 in 网络编程

Download history 172/week @ 2024-04-01 1/week @ 2024-05-20 92/week @ 2024-07-01

每月下载量 92

MIT 许可证

365KB
5K SLoC

deploymentmanager2-beta2 命令行界面(CLI)允许您从终端舒适地使用大多数 Google Deployment Manager 服务的功能。

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

如果请求数据结构,这些将作为格式化的 JSON 返回,以便作为其他工具的输入使用。

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

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-deploymentmanager2_beta2-cli

GitHub 上找到源代码。

用法

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

deploymentmanager2-beta2 [options]
        deployments
                delete <project> <deployment> [-p <v>]... [-o <out>]
                get <project> <deployment> [-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>]
                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-beta2 --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 目录中存储所有持久数据,该目录包含以 deploymentmanager2-beta2- 为前缀的 JSON 文件。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

大多数 API 都需要用户对请求进行身份验证。如果是这种情况,则 作用域 确定了授予的权限集。这些通常不会超过 只读完全访问

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

当第一次使用作用域时,系统会询问用户权限。根据CLI的指示授予权限或拒绝。

如果用户已对作用域进行身份验证,相应信息将以JSON格式存储在配置目录中,例如:~/.google-service-cli/deploymentmanager2-beta2-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授予的认证,请参阅官方文档

应用程序密钥

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

为了使CLI的使用更加方便,无需强迫任何人注册自己的应用程序,CLI自带了一个默认的应用程序密钥,并据此进行配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

尽管CLI会尽力提供可用的错误消息,但有时了解导致特定问题的确切原因可能很有用。这是通过允许所有客户端-服务器通信以原始形式输出到标准错误来实现的。

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

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

依赖项

~19–34MB
~594K SLoC