GKE On-Prem API 是一种由 Google Cloud 托管的 API，可让您使用标准工具（Google Cloud 控制台、Google Cloud CLI 或 Terraform）管理本地集群的生命周期。使用这些工具创建集群时，API 会将集群状态的元数据存储在创建集群时指定的 Google Cloud 区域中。此元数据可让您使用标准工具管理集群的生命周期。如果您想使用这些工具查看集群详情或管理使用 gkectl 创建的集群的生命周期，则必须在 GKE On-Prem API 中注册集群。
术语
通过注册集群，您可以使用控制台、gcloud CLI 或 Terraform 管理集群生命周期。
注册集群是将集群注册到舰队的单独过程。舰队是可以一起管理的 Kubernetes 集群的逻辑分组。所有 GKE on VMware 集群都在集群创建时注册到舰队。使用 gkectl 创建集群时，集群会注册到您在集群配置文件的 gkeConnect.projectID 字段中指定的 Google Cloud 项目。此项目即为舰队宿主项目。如需详细了解舰队，包括应用场景、最佳实践和示例，请参阅舰队管理文档。
查看已注册的集群
所有舰队集群都显示在控制台中的 GKE Enterprise 集群和 GKE 集群页面上。这两种工具都能让您大致了解整个舰队，而且对于 GKE on VMware，您还可以了解哪些集群由 GKE On-Prem API 管理。
如需查看您的舰队集群，请执行以下操作：
-
在控制台中，进入 GKE Enterprise 集群页面。
转到 GKE Enterprise 集群页面 -
选择 Google Cloud 项目。
- 如果类型列中显示 VMware，则该集群由 GKE On-Prem API 管理。
- 如果类型列中显示外部，则该集群不由 GKE On-Prem API 管理。
使用要求
- 用户集群必须为 1.11 或更高版本。
管理员集群必须为 1.13 或更高版本。
如果您不是项目所有者，则必须至少具有项目的 Identity and Access Management 角色
roles/gkeonprem.admin。如需详细了解此角色具备的权限，请参阅 IAM 文档中的 GKE On-Prem 角色。
准备工作
根据需要设置 gcloud CLI。
如果您需要安装 gcloud CLI，请参阅 gcloud CLI 文档。
根据需要更新 gcloud CLI 组件：
gcloud components update
确保已在项目中启用 GKE On-Prem API。如需启用 API，请运行以下命令：
gcloud services enable \ --project PROJECT_ID \ gkeonprem.googleapis.com将
PROJECT_ID替换为您的舰队宿主项目的项目 ID。这是在管理员集群配置文件或用户集群配置文件的gkeconnect部分中配置的项目 ID。如果您收到
PERMISSION_DENIED错误，请仔细检查您输入的项目 ID。如果项目 ID 正确无误，请运行gcloud auth login以使用有权访问项目的账号登录 Google Cloud CLI。如果这是您第一次在项目中启用 GKE On-Prem API，您可能需要初始化该 API。为此，您可以调用 gcloud CLI 命令，该命令可用于显示可用于创建集群的版本：
gcloud container vmware clusters query-version-config \ --project=PROJECT_ID \ --location=REGION将
REGION替换为us-west1或其他受支持的区域。如果您的组织设置了许可名单，以允许来自 Google API 和其他地址的流量通过代理服务器，请将以下条目添加到许可名单：
- gkeonprem.googleapis.com
- gkeonprem.mtls.googleapis.com
这些是 GKE On-Prem API 的服务名称。
注册集群
如需注册集群，您可以使用 gcloud CLI。如果您的集群为 1.15.3 或更高版本，则可以使用 gkectl 命令行工具。
注册用户集群
gcloud CLI
如果需要填写 --admin-cluster-membership 标志的 ADMIN_CLUSTER_NAME 占位符，请务必滚动。
gcloud container vmware clusters enroll USER_CLUSTER_NAME \ --project=PROJECT_ID \ --admin-cluster-membership=projects/PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \ --location=REGION
替换以下内容：
USER_CLUSTER_NAME：您要注册的用户集群的名称。PROJECT_ID：舰队宿主项目的 ID。ADMIN_CLUSTER_NAME：管理用户集群的管理员集群。管理员集群名称是用于唯一标识 Google Cloud 中的集群的完全指定集群名称中的最后一个部分。REGION：GKE On-Prem API 运行并存储集群元数据的 Google Cloud 区域。请指定us-west1或其他受支持的区域。 注册集群后，此区域便无法更改。
gkectl 1.15.3+
在管理员工作站上执行以下步骤。
将以下部分添加到用户集群配置文件：
gkeOnPremAPI: enabled:true location:REGION将
REGION替换为 GKE On-Prem API 在其中运行并存储集群元数据的 Google Cloud 区域。请指定us-west1或其他受支持的区域。 我们建议您使用stackdriver.clusterLocation中配置的同一区域。注册集群后，此区域便无法更改。更新集群：
gkectl update cluster --kubeconfig ADMIN_CLUSTER_KUBECONFIG --config USER_CLUSTER_CONFIG_FILE
替换以下内容：
ADMIN_CLUSTER_KUBECONFIG：管理员集群 kubeconfig 文件的路径USER_CLUSTER_CONFIG_FILE：用户集群配置文件的路径。
注册管理员集群
gcloud CLI
gcloud container vmware admin-clusters enroll ADMIN_CLUSTER_NAME \
--project=PROJECT_ID \
--admin-cluster-membership=projects/PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \
--location=REGION
替换以下内容：
ADMIN_CLUSTER_NAME：您要注册的管理员集群的名称。PROJECT_ID：舰队宿主项目的 ID。ADMIN_CLUSTER_NAME和PROJECT_ID用于为--admin-cluster-membership标志构建完整指定的集群名称。REGION：GKE On-Prem API 运行并存储集群元数据的 Google Cloud 区域。请指定us-west1或其他受支持的区域。 注册集群后，此区域便无法更改。
gkectl 1.15.3+
在管理员工作站上执行以下步骤。
将以下部分添加到管理员集群配置文件：
gkeOnPremAPI: enabled:true location:REGION将
REGION替换为 GKE On-Prem API 在其中运行并存储集群元数据的 Google Cloud 区域。请指定us-west1或其他受支持的区域。 我们建议您使用stackdriver.clusterLocation中配置的同一区域。注册集群后，此区域便无法更改。更新集群：
gkectl update admin --kubeconfig ADMIN_CLUSTER_KUBECONFIG --config ADMIN_CLUSTER_CONFIG_FILE
替换以下内容：
ADMIN_CLUSTER_KUBECONFIG：管理员集群 kubeconfig 文件的路径ADMIN_CLUSTER_CONFIG_FILE：管理员集群配置文件的路径。
获取有关集群的信息
注册集群后，您可以使用以下命令获取有关集群的信息：
用户集群
- 要描述用户集群，请执行以下操作：
gcloud container vmware clusters describe USER_CLUSTER_NAME \ --project=PROJECT_ID \ --location=REGION
- 要列出您的用户集群，请执行以下操作：
gcloud container vmware clusters list \ --project=PROJECT_ID \ --location=-
设置 --location=- 时，意味着列出所有区域中的所有集群。如果您需要缩小列表范围，请将 --location 设置为您在注册集群时指定的区域。
管理员集群
- 要描述管理员集群，请执行以下操作：
gcloud container vmware admin-clusters describe ADMIN_CLUSTER_NAME \ --project=PROJECT_ID \ --location=REGION
- 如需列出管理员集群，请执行以下操作：
gcloud container vmware admin-clusters list \ --project=PROJECT_ID \ --location=-
设置 --location=- 时，意味着列出所有区域中的所有集群。如果您需要缩小列表范围，请将 --location 设置为您在注册集群时指定的区域。
连接到集群
使用 GKE On-Prem API 注册集群后，您需要选择和配置身份验证方法，以便通过 Google Cloud 控制台管理集群。您选择的身份验证方法还可以控制通过命令行对集群的访问。详情请参阅以下内容：