2个稳定版本

5.0.4+20240225 2024年3月5日
3.0.0+20220225 2022年3月8日

#20 in #run

MIT 许可证

1MB
11K SLoC

run2 命令行界面(CLI)允许您从终端舒适地使用Google Cloud Run服务的大多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-run2-cli

GitHub上查找源代码

用法

本文档是从修订版20240225Cloud Run API生成的。CLI版本为5.0.4

run2 [options]
        projects
                locations-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-delete <name> [-p <v>]... [-o <out>]
                locations-jobs-executions-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-executions-delete <name> [-p <v>]... [-o <out>]
                locations-jobs-executions-get <name> [-p <v>]... [-o <out>]
                locations-jobs-executions-list <parent> [-p <v>]... [-o <out>]
                locations-jobs-executions-tasks-get <name> [-p <v>]... [-o <out>]
                locations-jobs-executions-tasks-list <parent> [-p <v>]... [-o <out>]
                locations-jobs-get <name> [-p <v>]... [-o <out>]
                locations-jobs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-jobs-list <parent> [-p <v>]... [-o <out>]
                locations-jobs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-operations-wait <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-services-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-services-delete <name> [-p <v>]... [-o <out>]
                locations-services-get <name> [-p <v>]... [-o <out>]
                locations-services-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-services-list <parent> [-p <v>]... [-o <out>]
                locations-services-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-services-revisions-delete <name> [-p <v>]... [-o <out>]
                locations-services-revisions-get <name> [-p <v>]... [-o <out>]
                locations-services-revisions-list <parent> [-p <v>]... [-o <out>]
                locations-services-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-services-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  run2 --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文件的形式存储所有持久数据,这些文件以run2-为前缀。您可以使用--config-dir标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,用户会被要求授权。遵循CLI提供的说明来授权权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~577K SLoC