#google-cloud #google #cli #google-api #runtime-config

app google-runtimeconfig1_beta1-cli

一个完整的库,用于与云RuntimeConfig(协议v1beta1)交互

11个稳定版本 (3个主要版本)

5.0.4+20240227 2024年3月5日
3.1.0+20220228 2022年4月26日
3.0.0+20220228 2022年3月8日
2.0.4+20210329 2021年4月15日
1.0.7+20171030 2018年2月1日

#2418 in Web编程

Download history 15/week @ 2024-03-10 97/week @ 2024-03-31 2/week @ 2024-04-07

207 每月下载量

MIT 许可证

540KB
7K SLoC

runtimeconfig1-beta1 命令行界面(CLI)允许您在终端中舒适地使用Google Cloud RuntimeConfig服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-runtimeconfig1_beta1-cli

GitHub上找到源代码。

用法

本文档是根据修订版 20240227 的Cloud RuntimeConfig API生成的。CLI版本为 5.0.4

runtimeconfig1-beta1 [options]
        projects
                configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-delete <name> [-p <v>]... [-o <out>]
                configs-get <name> [-p <v>]... [-o <out>]
                configs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                configs-list <parent> [-p <v>]... [-o <out>]
                configs-operations-get <name> [-p <v>]... [-o <out>]
                configs-operations-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-variables-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-variables-delete <name> [-p <v>]... [-o <out>]
                configs-variables-get <name> [-p <v>]... [-o <out>]
                configs-variables-list <parent> [-p <v>]... [-o <out>]
                configs-variables-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-variables-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-variables-watch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-waiters-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                configs-waiters-delete <name> [-p <v>]... [-o <out>]
                configs-waiters-get <name> [-p <v>]... [-o <out>]
                configs-waiters-list <parent> [-p <v>]... [-o <out>]
                configs-waiters-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  runtimeconfig1-beta1 --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 目录中存储所有持久数据,目录前缀为 runtimeconfig1-beta1-,以JSON文件形式存储。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

大多数API要求用户对任何请求进行身份验证。如果是这种情况,则 范围 决定了授予的权限集合。这些权限的粒度通常不超过 只读完全访问

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

当第一次使用作用域时,会提示用户授权。根据CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~19–31MB
~581K SLoC