5个稳定版本

3.1.0+20220211 2022年4月26日
3.0.0+20220211 2022年3月8日
2.0.4+20210322 2021年4月15日
2.0.3+20210322 2021年4月14日
2.0.0+20210322 2021年4月3日

40#json-input

Download history 25/week @ 2024-03-28 19/week @ 2024-04-04

61 每月下载量

MIT 许可证

630KB
8K SLoC

gkehub1命令行界面(CLI)允许您在终端中舒适地使用Google GKE Hub服务的大多数功能。

默认情况下,所有输出都打印到标准输出,但可以使用标志将其直接导向文件,而不受您的shell功能限制。错误将打印到标准错误,并导致程序退出码非零。

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-gkehub1-cli

GitHub上找到源代码。

用法

本文档是根据GKE Hub API的修订版20220211生成的。CLI的版本为3.1.0

gkehub1 [options]
        projects
                locations-features-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-features-delete <name> [-p <v>]... [-o <out>]
                locations-features-get <name> [-p <v>]... [-o <out>]
                locations-features-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-features-list <parent> [-p <v>]... [-o <out>]
                locations-features-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-features-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-features-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-memberships-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-memberships-delete <name> [-p <v>]... [-o <out>]
                locations-memberships-generate-connect-manifest <name> [-p <v>]... [-o <out>]
                locations-memberships-get <name> [-p <v>]... [-o <out>]
                locations-memberships-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-memberships-list <parent> [-p <v>]... [-o <out>]
                locations-memberships-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-memberships-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-memberships-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-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>]
  gkehub1 --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文件中,文件名以gkehub1-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息,请参阅以下段落。

身份验证

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

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

第一次使用作用域时,系统会提示用户授权。按照CLI提供的说明授权权限,或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~18–30MB
~566K SLoC