apigeectl

您当前正在查看 Apigee Hybrid 文档的 1.2 版。 此版本已终止服务。 您应该升级到更高的版本。如需了解详情，请参阅支持的版本。

Version 1.2 (unsupported)

   支持的版本：

• v1.12（最新）                        
• v1.11                         
• v1.10                                        
• 支持的版本列表

   不支持的版本：

• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

apigeectl 是用于在 Kubernetes 集群中安装和管理 Apigee Hybrid 的命令行界面 (CLI)。如需了解如何下载并安装 apigeectl，请参阅下载并安装 apigeectl。

注意：您必须在 Kubernetes 管理机器上安装和设置 kubectl 才能使用 apigeectl 命令。

apigeectl 语法

apigeectl [command] [flags]

其中：

• command：指定您要执行的操作。如需查看命令的完整列表，请参阅 apigeectl 命令。

• flags：指定命令参数。如需查看标志的完整列表，请参阅 apigeectl 标志。

apigeectl 命令

下表列出了 apigeectl 命令：

命令	说明
apply	将 Apigee 混合运行时组件的配置应用到 Kubernetes 集群。使用 -c 标志来指定一个或多个（以逗号分隔）组件。 如果您不指定 -c 标志，则 apply 命令会将所有组件应用到集群。 注意：您必须先调用 apigeectl init，再调用 apigeectl apply。
check‑ready	检查混合组件 Pod 的状态。准备好所有组件 Pod 后，系统就会输出“所有容器都准备就绪”消息。对于自动编写脚本，请注意，当所有容器都准备就绪后，命令将退出并显示状态为 0。当至少有一个 Pod 尚未准备就绪时，命令将退出并显示状态为 1。 如果不指定 -c 标志，则 check-ready 命令应用于集群中的所有组件。
delete	从集群中删除混合组件。使用 --all 标志可移除所有组件。如果省略 --all，则系统只会移除 Apigee 特定组件（使用 apigeectl init 安装的组件不会被删除）。Apigee 特定组件是使用 apply 命令安装的组件。 如果不指定 -c 标志，则 delete 命令应用于在集群中部署的所有组件。
help	输出在线帮助。
init	将必备组件（例如 Istio 和 Apigee Deployment）的配置应用于集群。使用 -c 标志来指定一个或多个（以逗号分隔）组件。
version	输出 CLI 版本信息。

apigeectl 标志

下表列出了 apigeectl 标志：

标志	说明
-c, --components	指定命令应用于的单个组件。 如果不指定此标志，则命令将应用于集群中的所有组件（整个部署）。可能的值包括： cassandra logger mart metrics runtime synchronizer udca 例如 -c cassandra。 或者，要指定多个组件，请添加以逗号分隔的值：-c cassandra, runtime
--dry-run	在不更改集群的情况下执行指定的命令。与 ‑‑print-yaml 结合使用可将呈现的对象规范输出到文件中。
‑f, ‑‑file‑override‑config	指定一个包含混合部署的自定义配置属性的 YAML 文件。默认值为 ./overrides.yaml。apply、check-ready、delete、init 命令需要替换文件。 您必须使用此标志指定完整路径。如需了解详情，请参阅管理运行时层面组件。
-h, --help	显示命令的帮助。
--print-yaml	将配置模板输出输出到 stdout。如需查看使用此标志的示例，请参阅将配置输出到文件。
-s, --settings	指定命令适用的配置。目前，只有 runtime 组件中的 virtualhosts 配置支持此标志。如果仅更改 virtualhosts 属性，请使用此标志。（已添加 v1.2.0） 例如，如果您更改替换文件中的 virtualhosts 配置，请使用以下命令将更改应用于集群： apigeectl apply -f my-overrides.yaml --settings virtualhosts -c runtime

apigeectl 命令在后台使用 kubectl 执行其工作。apigeectl 命令选项（apply 和 delete）以及使用的 YAML 配置文件，与其对应的 kubectl 选项和配置文件类似。如需详细了解如何在 Kubernetes 集群中管理对象，请参阅以下主题：

• 使用配置文件对 Kubernetes 对象进行命令式管理
• kubectl 概览

示例

初始化集群配置

使用 init 将前提条件组件配置应用于您的集群。您必须先运行 init 命令，然后再运行 apply。

apigeectl init -f my_overrides.yaml

应用集群配置

如需将混合配置应用于 Kubernetes 集群，请使用 apply 命令。首次运行 apply 时，系统将在您的集群中创建所有混合运行时组件。如果您更改配置，请重新运行 apply 以仅应用更改，或使用 -c 以仅应用特定组件。

以下示例将混合运行时平面组件的配置应用到您的集群：

apigeectl apply -f my_overrides.yaml

应用单个组件的配置

如需将 apply 命令限定为某个特定组件，请使用 -c 标志，如 apigeectl 标志中所述。

下面的示例仅应用同步器组件的配置：

apigeectl apply -c synchronizer -f my_overrides.yaml

下面的示例仅应用 Cassandra 和运行时组件的配置：

apigeectl apply -c cassandra,runtime -f my_overrides.yaml

将配置输出到文件中

如果要调试安装问题，您可以将整个集群配置输出到文件中以便可以检查配置设置，这种做法非常有用。--print-yaml 标志可将混合配置输出到 stdout，--dry-run 标志允许命令在不更改集群的情况下运行。

apigeectl apply -f my_overrides.yaml --dry-run --print-yaml > apigee-hybrid.yaml

注意：最好在源代码控制系统中保存 YAML 输出的副本，以供日后参考。但请注意，输出文件包含您可能不希望存储的密码和密文。

检查 Pod 状态

以下示例会检查部署到集群的 Pod 的状态：

apigeectl check-ready
All containers ready in namespace 'my-namespace'

从集群中删除混合版本

以下示例只会删除 Kubernetes 集群的混合运行时组件。如需删除所有组件，请使用 --all 标志。

注意：如要成功卸载，您必须安装 kubectl 1.11.x 或更高版本。

apigeectl delete -f my_overrides.yaml