Package google.cloud.gkehub.v1alpha1

索引

GkeHubDomainFeatureService

适用于特征资源的 GKE Hub CRUD API

CreateFeature

rpc CreateFeature(CreateFeatureRequest) returns (Operation)

添加新特征。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

DeleteFeature

rpc DeleteFeature(DeleteFeatureRequest) returns (Operation)

移除特征。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

GetFeature

rpc GetFeature(GetFeatureRequest) returns (Feature)

获取单个特征的详细信息。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

ListFeatures

rpc ListFeatures(ListFeaturesRequest) returns (ListFeaturesResponse)

列出给定项目和位置中的特征。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

UpdateFeature

rpc UpdateFeature(UpdateFeatureRequest) returns (Operation)

更新现有特征。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅身份验证概览

AnthosObservabilityFeatureSpec

Anthos 可观测性规范。必须提供一个规范,因为特征 proto 需要使用该规范。

字段
membership_specs

map<string, AnthosObservabilityMembershipSpec>

基于成员资格的规范,用以定义 Stackdriver CR 中的规范

default_membership_spec

AnthosObservabilityMembershipSpec

未指定该字段时将使用的默认成员资格规范。

AnthosObservabilityFeatureState

此类型没有字段。

Anthos 可观测性状态为空。必须提供一个状态,因为 FeatureStateDetails 需要使用该状态。

AnthosObservabilityMembershipSpec

Anthosobservability:基于成员资格的特征规范。

字段
enable_stackdriver_on_applications

bool

启用从用户应用收集和报告指标和日志的功能。

do_not_optimize_metrics

bool

使用全部指标,而不仅仅是优化指标。请参阅 https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics

version

string

此特征使用的 Stackdriver Operator 版本

AppDevExperienceFeatureSpec

此类型没有字段。

应用开发体验功能的规范。

AppDevExperienceFeatureState

App Dev Exp 特征的状态。

字段
networking_install_succeeded

AppDevExperienceFeatureState.Status

用于检测已配置的 Service Mesh 资源的子组件的状态。

代码

代码指定 AppDevExperienceFeature 子组件的就绪状态。

枚举
CODE_UNSPECIFIED 未设置。
OK AppDevExperienceFeature 的指定子组件已准备就绪。
FAILED AppDevExperienceFeature 的指定子组件就绪状态为 false。这意味着 AppDevExperienceFeature 遇到了会阻碍其全部或部分操作的问题。如需了解详情,请参阅 description
UNKNOWN AppDevExperienceFeature 的指定子组件处于待处理或未知状态。

状态

Status 指定子组件的状态。

字段
code

AppDevExperienceFeatureState.Code

Code 指定 AppDevExperienceFeature 的子组件就绪状态。

description

string

如果代码返回“失败”,则 Description 字段会被填充代码失败的原因。

AuthorizerFeatureSpec

此类型没有字段。

AuthorizerFeatureSpec 包含 Authorizer 特征的选项和规范。

AuthorizerFeatureState

此类型没有字段。

AuthorizerFeatureState 包含 Authorizer 特征的当前详细状态。

结算

已弃用:不再使用 FeatureSpec.billing 字段。Billing 用于标识客户所使用的结算结构。

枚举
BILLING_UNSPECIFIED 未知
PAY_AS_YOU_GO 用户按端点付费。
ANTHOS_LICENSE 用户需要支付 Anthos 整体的费用。

BinauthzConfig

Binauthz 配置

字段
enabled

bool

指定此集群中是否启用了 binauthz。

BinauthzState

Binauthz 的状态

字段
webhook

DeploymentState

binauthz webhook 的状态。

version

BinauthzVersion

已安装的 binauthz 的版本。

BinauthzVersion

binauthz 的版本。

字段
webhook_version

string

binauthz webhook 的版本。

BundleInstallSpec

BundleInstallSpec 是单个托管式软件包的规范配置。

字段
exempted_namespaces[]

string

要从软件包中排除的命名空间集。

CloudAuditLoggingFeatureSpec

Audit Logging 许可名单列入规范。

字段
allowlisted_service_accounts[]

string

应列入许可名单以发送审核日志的服务账号;例如 cloudauditlogging@gcp-project.iam.gserviceaccount.com。这些账号必须已存在,但无需被授予任何权限。在列入许可名单之前,系统会检查客户的使用权(即客户必须是 Anthos 客户)。

CloudAuditLoggingFeatureState

此类型没有字段。

Audit Logging 许可名单列入状态为空。必须提供一个状态,因为 FeatureStateDetails 需要使用该状态。

CloudBuildFeatureSpec

Cloud Build for Anthos 特征规范。必须提供一个规范,因为特征 proto 需要使用该规范。

字段
membership_configs

map<string, CloudBuildMembershipConfig>

从成员资格路径(例如 projects/foo-proj/locations/global/memberships/bar)到为该成员集群选择的 CloudBuildMembershipConfig 的映射。如果为 Hub 启用了 CloudBuild 特征,并且此映射中存在该 Hub 中某个集群的成员资格路径,则表示该特定集群启用了 Cloud Build Hub 特征。

CloudBuildMembershipConfig

每个启用了 Cloud Build 的集群的配置。

字段
version

string

集群上 Cloud Build 软件的版本。

security_policy

CloudBuildMembershipConfig.SecurityPolicy

是否允许在集群上运行特权构建。

SecurityPolicy

可以对集群应用的不同安全政策。

枚举
SECURITY_POLICY_UNSPECIFIED 未指定政策
NON_PRIVILEGED 不允许使用特权构建 pod
PRIVILEGED 允许使用特权构建 pod

ConfigManagementFeatureSpec

Anthos Config Management (ACM) 规范。

字段
membership_configs

map<string, MembershipConfig>

成员资格 ID 与各个配置的映射。

ConfigManagementFeatureState

Anthos Config Management 的状态

字段
cluster_name

string

如果此字段不为空,则设置为成员资格规范的 cluster_name 字段。否则,设置为集群的舰队成员资格名称。

membership_config

MembershipConfig

集群中的成员资格配置。此字段表示集群中的实际状态,而 FeatureSpec 中的 MembershipConfig 表示预期状态

operator_state

OperatorState

ACM Operator 的当前安装状态

config_sync_state

ConfigSyncState

当前同步状态

policy_controller_state

PolicyControllerState

PolicyController 状态

binauthz_state

BinauthzState

Binauthz 状态

hierarchy_controller_state

HierarchyControllerState

Hierarchy Controller 状态

ConfigSync

Config Sync 的配置

字段
git

GitConfig

集群的 Git 代码库配置。

source_format

string

指定 Config Sync 代码库是采用“分层”模式还是“非结构化”模式。

prevent_drift

bool

设置为 true 可启用 Config Sync 准入 webhook 以防止偏移。默认为 false,这会停用 Config Sync 准入 webhook,且不会阻止偏移。

oci

OciConfig

集群的 OCI 代码库配置

allow_vertical_scale
(deprecated)

bool

设置为 true 允许纵向扩缩。默认为 false,不允许纵向扩缩。此字段已弃用。

metrics_gcp_service_account_email

string

启用 Workload Identity 后,用于将 Config Sync 指标导出到 Cloud Monitoring 和 Cloud Monarch 的 Google Cloud 服务账号 (GSA) 的电子邮件地址。GSA 应具有 Monitoring Metric Writer (roles/monitoring.metricWriter) IAM 角色。命名空间 config-management-monitoring 中的 Kubernetes ServiceAccount default 应绑定到 GSA。

enabled

bool

允许安装 ConfigSync。如果设置为 true,则系统会创建 ConfigSync 资源,并应用其他 ConfigSync 字段(如果存在)。如果设置为 false,则所有其他 ConfigSync 字段都会被忽略,并且 ConfigSync 资源会被删除。如果省略,则系统会根据是否存在 git 或 oci 字段来管理 ConfigSync 资源。

ConfigSyncDeploymentState

ConfigSync 在集群上的部署状态

字段
importer

DeploymentState

importer pod 的部署状态

syncer

DeploymentState

syncer pod 的部署状态

git_sync

DeploymentState

git-sync pod 的部署状态

monitor

DeploymentState

monitor pod 的部署状态

reconciler_manager

DeploymentState

reconciler-manager pod 的部署状态

root_reconciler

DeploymentState

root-reconciler 的部署状态

admission_webhook

DeploymentState

admission-webhook 的部署状态

ConfigSyncError

与 Config Sync 安装相关的错误

字段
error_message

string

表示面向用户的错误消息的字符串

ConfigSyncState

ConfigSync 的状态信息

字段
version

ConfigSyncVersion

已部署的 ConfigSync 的版本

deployment_state

ConfigSyncDeploymentState

有关 ConfigSync 部署的信息,包括已部署的各 Pod 的版本

sync_state

SyncState

用于将配置同步到集群的 ConfigSync 进程的状态

errors[]

ConfigSyncError

与 Config Sync 安装相关的错误。

ConfigSyncVersion

与 ConfigSync 的 Pod 相关的特定版本控制信息

字段
importer

string

已部署的 importer pod 的版本

syncer

string

已部署的 syncer pod 的版本

git_sync

string

已部署的 git-sync pod 的版本

monitor

string

已部署的 monitor pod 的版本

reconciler_manager

string

已部署的 reconciler-manager pod 的版本

root_reconciler

string

root-reconciler pod 中已部署的协调器容器的版本

admission_webhook

string

已部署的 admission_webhook pod 的版本

CreateFeatureRequest

GkeHubDomainFeatureService.CreateFeature 方法的请求消息。

字段
parent

string

必需。将在其中创建特征的父级对象(项目和位置),采用 projects/*/locations/global 格式。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • gkehub.features.create
feature_id

string

要创建的特征的 ID。

resource

Feature

要创建的特征资源。

DataplaneV2FeatureSpec

多集群 dataplane-v2 特征的规范。必须提供一个规范,因为特征 proto 需要使用该规范。

字段
enable_encryption

bool

为多个集群启用基于 dataplane-v2 的加密。

DataplaneV2FeatureState

此类型没有字段。

多集群 dataplane-v2 特征的状态为空。必须提供一个状态,因为 FeatureStateDetails 需要使用该状态。

DeleteFeatureRequest

GkeHubDomainFeatureService.DeleteFeature 方法的请求消息。

字段
name

string

必需。特征资源的名称,格式为 projects/*/locations/global/features/*

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • gkehub.features.delete
force

bool

如果设置为 true,删除操作将忽略此特征的所有未完成资源(在这种情况下,FeatureState.has_resources 值为 true);系统不会以任何方式清理或修改这些资源。

DeploymentState

表示 ACM 在集群上的部署状态的枚举

枚举
DEPLOYMENT_STATE_UNSPECIFIED 无法确定部署状态
NOT_INSTALLED 未安装部署
INSTALLED 已安装部署
ERROR 已尝试安装部署,但出现错误
PENDING 正在安装或终止部署

ErrorResource

Git 代码库中存在关联同步错误的配置文件的模型

字段
source_path

string

错误配置在 Git 代码库中的路径

resource_name

string

导致错误的资源的元数据名称

resource_namespace

string

导致错误的资源的命名空间

resource_gvk

GroupVersionKind

导致错误的资源的群组/版本/种类

特征

Feature 可定义任何特征的设置和状态。

字段
name

string

仅限输出。此特征资源的完整唯一名称,格式为 projects/*/locations/global/features/*

labels

map<string, string>

此特征的标签。

description

string

特征的说明,长度不得超过 63 个字符。

feature_state

FeatureState

仅限输出。特征资源本身的状态。

fleet_default_member_config

FleetDefaultMemberConfig

FleetDefaultMemberConfig 描述舰队级默认成员配置。

create_time

Timestamp

仅限输出。特征的创建时间。

update_time

Timestamp

仅限输出。特征的上次更新时间。

delete_time

Timestamp

仅限输出。特征被删除的时间。

联合字段 spec

spec 只能是下列其中一项:

servicemesh_feature_spec

ServiceMeshFeatureSpec

Service Mesh 特征的规范。

authorizer_feature_spec

AuthorizerFeatureSpec

Authorizer 特征的规范。

multiclusteringress_feature_spec

MultiClusterIngressFeatureSpec

Ingress for Anthos 的规范。

metering_feature_spec

MeteringFeatureSpec

计量特征的规范。

multiclusterservicediscovery_feature_spec

MultiClusterServiceDiscoveryFeatureSpec

GKE 多集群服务发现的规范。

configmanagement_feature_spec

ConfigManagementFeatureSpec

Anthos Config Management 的规范。

appdevexperience_feature_spec

AppDevExperienceFeatureSpec

App Dev Experience 的规范。

cloudauditlogging_feature_spec

CloudAuditLoggingFeatureSpec

Anthos Cloud Audit Logging 的规范。

cloudbuild_feature_spec

CloudBuildFeatureSpec

Cloud Build for Anthos 的规范。

servicedirectory_feature_spec

ServiceDirectoryFeatureSpec

Service Directory 的规范。

identityservice_feature_spec

IdentityServiceFeatureSpec

Anthos Identity Service 的规范。

anthosobservability_feature_spec

AnthosObservabilityFeatureSpec

Anthos 可观测性规范。

workloadcertificate_feature_spec

WorkloadCertificateFeatureSpec

Workload Certificate 规范。

policycontroller_feature_spec

PolicyControllerFeatureSpec

Policy Controller 的规范。

dataplanev2_feature_spec

DataplaneV2FeatureSpec

多集群 dataplane-v2 的规范。

fleetobservability_feature_spec

FleetObservabilityFeatureSpec

FleetObservability 特征的规范。

FeatureState

FeatureState 描述特征资源的状态。

字段
lifecycle_state

FeatureState.LifecycleState

特征资源的当前状态。

details

FeatureStateDetails

汇总的特征状态消息。

details_by_membership

map<string, FeatureStateDetails>

每个成员资格的 FeatureState。

键是完全限定成员资格名称,格式为 projects/{NUMBER}/locations/*/memberships/*

has_resources

bool

指定此特征中是否有未完成的资源;如果要停用该特征,需要先清理这些未完成的资源。

LifecycleState

LifecycleState 描述特征的生命周期状态。

枚举
LIFECYCLE_STATE_UNSPECIFIED 状态未知或未设置。
ENABLING 正在启用特征。
ENABLED 特征处于活跃状态。
DISABLING 正在停用特征。
UPDATING 正在更新特征。
SERVICE_UPDATING Hub 服务正在更新特征。

FeatureStateDetails

FeatureStateDetails 是 API 中声明性资源的半结构化状态消息。

字段
code

FeatureStateDetails.Code

code 概要地说明了特征是否正常运行。如果返回的代码不是 OK,则应在 description 中提供相关详细信息来说明需要执行哪些操作(如果可行)才能让特征回到 OK 状态。

description

string

人类可读的问题说明。

update_time

Timestamp

控制器上次更新此状态的时间

联合字段 state。有关特征状态的结构化信息。state 只能是下列其中一项:
servicemesh_feature_state

ServiceMeshFeatureState

Service Mesh 特征的状态。

authorizer_feature_state

AuthorizerFeatureState

Authorizer 特征的状态。

multiclusteringress_feature_state

MultiClusterIngressFeatureState

Ingress for Anthos 特征的状态。

metering_feature_state

MeteringFeatureState

计量特征的状态。

multiclusterservicediscovery_feature_state

MultiClusterServiceDiscoveryFeatureState

多集群服务发现特征的状态。

configmanagement_feature_state

ConfigManagementFeatureState

Config Management 特征的状态。

appdevexperience_feature_state

AppDevExperienceFeatureState

AppDevExperience 特征的状态。

cloudauditlogging_feature_state

CloudAuditLoggingFeatureState

Anthos Cloud Audit Logging 特征的状态。

servicedirectory_feature_state

ServiceDirectoryFeatureState

Service Directory 特征的状态。

identityservice_feature_state

IdentityServiceFeatureState

AIS 特征的状态。

anthosobservability_feature_state

AnthosObservabilityFeatureState

Anthos 可观测性特征的状态

workloadcertificate_feature_state

WorkloadCertificateFeatureState

Workload Certificate 特征的状态

policycontroller_feature_state

PolicyControllerFeatureState

Policy Controller 特征的状态。

dataplanev2_feature_state

DataplaneV2FeatureState

多集群 dataplane-v2 特征的状态。

fleetobservability_feature_state

FleetObservabilityFeatureState

FleetObservability 特征的状态。

代码

Code 描述此特征的错误状态和严重程度。

枚举
CODE_UNSPECIFIED 未设置。
OK 无错误。
FAILED 特征遇到了会阻碍其全部或绝大部分操作的问题。如需了解详情,请参阅 description
WARNING 特征处于影响其正常运行的状态,或出现问题影响其正常运行。此状态问题可能需要用户干预才能解决,也可能不需要;如需了解详情,请参阅 description

FleetDefaultMemberConfig

FleetDefaultMemberConfig 包含舰队成员资格的默认配置信息。

字段

联合字段 spec

spec 只能是下列其中一项:

service_mesh

ServiceMeshMembershipSpec

ServiceMesh 规范。

identity_service

MemberConfig

IdentityService 规范。

FleetObservabilityBaseFeatureState

舰队可观测性特征的基本状态。

字段
code

FleetObservabilityBaseFeatureState.Code

此特征的机器可读概要状态。

errors[]

FleetObservabilityBaseFeatureState.FeatureError

当代码不是“OK”时,在协调监控和日志记录特征后出现的错误。

代码

Code 定义特征的机器可读概要状态。

枚举
CODE_UNSPECIFIED 未知或未设置。
OK 特征正常运行。
ERROR 特征在协调过程中出现错误。特征可能需要干预才能恢复正常运行。有关详情,请参阅相应说明及任何特定于特征的相关详细信息。

FeatureError

舰队可观测性特征的所有错误详细信息。

字段
code

string

错误的代码。

description

string

人类可读的当前状态说明。

FleetObservabilityFeatureSpec

FleetObservability 特征的规范。必须提供一个规范,因为特征 proto 需要使用该规范。

字段
logging_config

LoggingConfig

如果要为整个舰队启用舰队日志记录特征,则指定此字段。如果为 UNSPECIFIED,则整个舰队会停用舰队日志记录特征。

FleetObservabilityFeatureState

FleetObservability 特征的状态为空。必须提供一个状态,因为 FeatureStateDetails 需要使用该状态。

字段
logging

FleetObservabilityLoggingState

舰队日志记录的特征状态。

monitoring

FleetObservabilityMonitoringState

舰队监控的特征状态。

FleetObservabilityLoggingState

日志记录特征的特征状态。

字段
default_log

FleetObservabilityBaseFeatureState

舰队默认日志的基本特征状态。

scope_log

FleetObservabilityBaseFeatureState

舰队范围日志的基本特征状态。

FleetObservabilityMonitoringState

监控特征的特征状态。

字段
state

FleetObservabilityBaseFeatureState

舰队监控特征的基本特征状态。

GatekeeperDeploymentState

Policy Controller 安装的状态。

字段
gatekeeper_controller_manager_state

DeploymentState

gatekeeper-controller-manager pod 的状态。

gatekeeper_audit

DeploymentState

gatekeeper-audit 部署的状态。

gatekeeper_mutation

DeploymentState

传送变更 webhook 的 pod 的状态。

GetFeatureRequest

GkeHubDomainFeatureService.GetFeature 方法的请求消息。

字段
name

string

必需。特征资源的名称,格式为 projects/*/locations/global/features/*

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • gkehub.features.get

GitConfig

单个集群的 Git 代码库配置。

字段
sync_repo

string

用作可靠来源的 Git 代码库的网址。

sync_branch

string

要用作同步来源的代码库分支。默认值:master。

policy_dir

string

Git 代码库中的路径,表示要同步的代码库的顶层目录。默认值:代码库的根目录。

sync_wait_secs

int64

连续的同步操作之间的时长(以秒为单位)。默认值:15。

sync_rev

string

要获取的 Git 修订版本(标记或哈希)。默认值:HEAD。

secret_type

string

为访问 Git 代码库而配置的 Secret 的类型。

https_proxy

string

与 Git 代码库通信时要使用的 HTTPS 代理的网址。

gcp_service_account_email

string

当 secret_type 为 gcpServiceAccount 时用于身份验证的 Google Cloud 服务账号的电子邮件地址。

GroupVersionKind

Kubernetes 对象的 GVK

字段
group

string

Kubernetes 群组

version

string

Kubernetes 版本

kind

string

Kubernetes 种类

HierarchyControllerConfig

层次结构控制器的配置

字段
enabled

bool

此集群中是否启用了 Hierarchy Controller。

enable_pod_tree_labels

bool

指定此集群中是否启用了 Pod 树标签。

enable_hierarchical_resource_quota

bool

指定此集群中是否启用了分层资源配额。

HierarchyControllerDeploymentState

Hierarchy Controller 的部署状态

字段
hnc

DeploymentState

开源 HNC 的部署状态(例如 v0.7.0-hc.0)

extension

DeploymentState

Hierarchy Controller 扩展程序的部署状态(例如 v0.7.0-hc.1)

HierarchyControllerState

Hierarchy Controller 的状态

字段
version

HierarchyControllerVersion

Hierarchy Controller 的版本

state

HierarchyControllerDeploymentState

Hierarchy Controller 的部署状态

HierarchyControllerVersion

Hierarchy Controller 的版本

字段
hnc

string

开源 HNC 的版本

extension

string

Hierarchy Controller 扩展程序的版本

IdentityServiceFeatureSpec

Annthos Identity Service 规范。

字段
member_configs

map<string, MemberConfig>

成员 ID 与其配置之间的映射。该 ID 必须是成员资格的完整路径,例如:/projects/p/locations/l/memberships/m。

IdentityServiceFeatureState

Anthos Identity Service 的状态

字段
installed_version

string

已安装的 AIS 版本。这是此成员上安装的 AIS 版本。如果状态正常,则这些值有意义。

state

IdentityServiceFeatureState.DeploymentState

此成员的部署状态

failure_reason

string

失败的原因。

member_config

MemberConfig

此成员的成员资格配置状态

DeploymentState

部署状态枚举

枚举
DEPLOYMENT_STATE_UNSPECIFIED 未指定状态
OK 部署成功
ERROR 失败,发生错误。

InstallError

与 ACM 安装相关的错误

字段
error_message

string

表示向用户显示的错误消息的字符串

ListFeaturesRequest

GkeHubDomainFeatureService.ListFeatures 方法的请求消息。

字段
parent

string

必需。要列出其中特征的父级对象(项目和位置),采用 projects/*/locations/global 格式。

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权:

  • gkehub.features.list
page_size

int32

在请求返回一“页”资源时,page_size 指定要返回的资源数量。如果未指定或设为 0,则返回所有资源。

page_token

string

上一次 ListFeatures 调用返回的令牌,用于指定列表中要继续列出资源的位置。

filter

string

列出与过滤表达式(需遵循 https://google.aip.dev/160 中列出的语法)匹配的特征。

示例:

  • 项目“foo-proj”中名为“servicemesh”的特征:
  name = "projects/foo-proj/locations/global/features/servicemesh"
  • 启用了 mtls 的 Service Mesh 特征:
 servicemesh_feature_spec.mtls = true
  • 具有名为 foo 的标签的特征:
  labels.foo:*
  • 具有名为 foo 且其值为 bar 的标签的特征:
  labels.foo = bar
order_by

string

用于比较和用于对输出进行排序的一个或多个字段。请参阅 https://google.aip.dev/132#ordering

ListFeaturesResponse

GkeHubDomainFeatureService.ListFeatures 方法的响应消息。

字段
resources[]

Feature

匹配特征的列表

next_page_token

string

用于从 ListFeatures 方法请求下一页资源的令牌。如果是空字符串值,则表示没有更多资源要返回。

LoggingConfig

LoggingConfig 定义不同类型的日志的配置。

字段
default_config

RoutingConfig

如果要将默认路由配置应用于其他配置中未指定的日志,则指定此字段。

fleet_scope_logs_config

RoutingConfig

如果要将路由配置应用于所有舰队范围的所有日志,则指定此字段。

MemberConfig

成员/集群的配置

字段
auth_methods[]

MemberConfig.AuthMethod

一个成员可以支持多种身份验证方法。

AuthMethod

成员/集群的身份验证方法配置。对每个 AuthMethod 只能设置一种身份验证方法(例如 OIDC 和 LDAP)。

字段
name

string

身份验证配置的标识符。

proxy

string

用于身份验证方法的代理服务器地址。

联合字段 auth_config。支持的身份验证配置。auth_config 只能是下列其中一项:
oidc_config

MemberConfig.AuthMethod.OidcConfig

OIDC 特定配置。

azuread_config

MemberConfig.AuthMethod.AzureADConfig

AzureAD 特定配置。

google_config

MemberConfig.AuthMethod.GoogleConfig

GoogleConfig 特定配置

saml_config

MemberConfig.AuthMethod.SamlConfig

可选。SAML 特定配置。

ldap_config

MemberConfig.AuthMethod.LdapConfig

可选。LDAP 特定配置。

AzureADConfig

AzureAD 身份验证流程的配置。

字段
client_id

string

向 Azure AD 身份提供方发出身份验证请求的已注册客户端应用的 ID。

tenant

string

要进行身份验证的 Azure AD 账号的种类。对于属于特定租户的账号,支持的值为

kubectl_redirect_uri

string

kubectl 用于授权的重定向网址。

client_secret

string

仅限输入。未加密的 AzureAD 客户端密钥将传递给 GKE Hub CLH。

encrypted_client_secret

bytes

仅限输出。加密的 AzureAD 客户端密钥。

user_claim

string

可选。AzureAD ID 令牌中包含用户详细信息的声明。

group_format

string

可选。客户端要进行身份验证的 AzureAD 群组的格式。

GoogleConfig

Google 插件身份验证流程的配置。

字段
disable

bool

在支持的平台上停用 Google 插件的自动配置。

LdapConfig

LDAP 身份验证流程的配置。

字段
server

MemberConfig.AuthMethod.LdapConfig.ServerConfig

必需。外部 LDAP 服务器的服务器设置。

user

MemberConfig.AuthMethod.LdapConfig.UserConfig

必需。定义 LDAP 目录中用户的位置。

group

MemberConfig.AuthMethod.LdapConfig.GroupConfig

可选。包含用于在目录中查找群组和对群组进行身份验证的属性。

service_account

MemberConfig.AuthMethod.LdapConfig.ServiceAccountConfig

必需。包含有权在目录中执行 LDAP 搜索的服务账号的凭据。凭据可以由 DN 和密码组合提供,也可以通过客户端证书提供。

GroupConfig

包含用于在目录中查找群组和对群组进行身份验证的属性。

字段
base_dn

string

必需。LDAP 目录中要搜索群组条目的子树位置。

id_attribute

string

可选。用户所属的每个群组的标识名。例如,如果设置为“distinguishedName”,则应将 RBAC 和其他群组预期值写为完整的 DN。默认为“distinguishedName”。

filter

string

可选。搜索用户所属的群组时使用的可选过滤条件。该项可用于明确匹配特定群组,以减少为每个用户返回的群组数量。默认为“(objectClass=Group)”。

ServerConfig

外部 LDAP 服务器的服务器设置。

字段
host

string

必需。定义 LDAP 服务器的主机名或 IP。端口是可选项,如果未指定,则默认为 389。例如,“ldap.server.example”或“10.10.10.10:389”。

connection_type

string

可选。定义与 LDAP 服务器通信的连接类型。如果指定了 starttlsldaps,则 certificate_authority_data 不应为空。

certificate_authority_data

bytes

可选。包含用于 LDAP 服务器的 Base64 编码的 PEM 格式的证书授权机构证书。必须为“ldaps”和“startTLS”连接提供此字段。

ServiceAccountConfig

包含有权在目录中执行 LDAP 搜索的服务账号的凭据。凭据可以由 DN 和密码组合提供,也可以通过客户端证书提供。

字段
联合字段 authentication_mechanism。确保用户一次提供一种身份验证机制。authentication_mechanism 只能是下列其中一项:
simple_bind_credentials

MemberConfig.AuthMethod.LdapConfig.ServiceAccountConfig.SimpleBindCredentials

用于基本身份验证的凭据。

SimpleBindCredentials

该结构包含 LDAP 简单绑定凭据。

字段
dn

string

必需。服务账号对象/用户的标识名 (DN)。

password

string

必需。仅限输入。服务账号对象/用户的密码。

encrypted_password

bytes

仅限输出。服务账号对象/用户的加密密码。

UserConfig

定义 LDAP 目录中用户的位置。

字段
base_dn

string

必需。LDAP 目录中要搜索用户条目的子树位置。

login_attribute

string

可选。与输入用户名匹配的属性的名称。此字段用于在 LDAP 数据库中查找用户,例如“(=)”,并可与可选过滤条件字段结合使用。默认为“userPrincipalName”。

id_attribute

string

可选。确定在用户进行身份验证后要将哪个属性用作其用户身份。这不同于 loginAttribute 字段,后者允许用户使用用户名登录,但其实际标识符是电子邮件地址或完整的标识名 (DN)。例如,如果将 loginAttribute 设置为“sAMAccountName”,并将 identifierAttribute 设置为“userPrincipalName”,则用户将能够以“bsmith”身份登录,但用户的实际 RBAC 政策将写为“bsmith@example.com”。建议使用“userPrincipalName”,因为该项对于每个用户都是唯一的。默认为“userPrincipalName”。

filter

string

可选。搜索用户时要应用的过滤条件。这可用于进一步限制允许登录的用户账号。默认为“(objectClass=User)”。

OidcConfig

OIDC 身份验证流程的配置。

字段
client_id

string

OIDC 客户端应用的 ID。

certificate_authority_data

string

OIDC 提供方的 PEM 编码证书授权机构 (CA)。

issuer_uri

string

OIDC 提供方的 URI。这应指向 .well-known/openid-configuration 以下的级别。

kubectl_redirect_uri

string

已注册的重定向 URI,用于使用 kubectl 插件重定向经历 OAuth 流程的用户。

scopes

string

标识符的逗号分隔列表。

extra_params

string

键值对的逗号分隔列表。

user_claim

string

OIDC ID 令牌中包含用户名的声明。

user_prefix

string

附加到用户名的前缀。

groups_claim

string

OIDC ID 令牌中包含组信息的声明。

group_prefix

string

附加到组名称的前缀。

deploy_cloud_console_proxy

bool

用于表示是否使用反向代理连接到身份验证提供方的标志。当 Google Cloud 控制台无法访问提供方时,此标志应设置为 true。

client_secret

string

仅限输入。未加密的 OIDC 客户端密钥将传递给 GKE Hub CLH。

encrypted_client_secret

bytes

仅限输出。加密的 OIDC 客户端密钥

enable_access_token

bool

启用访问令牌。

SamlConfig

SAML 身份验证流程的配置。

字段
identity_provider_id

string

必需。SAML IdP 的实体 ID。

identity_provider_sso_uri

string

必需。SAML IdP 提供 SSO 服务的 URI。

identity_provider_certificates[]

string

必需。用于验证 SAML 响应的 IdP 证书列表。

user_attribute

string

可选。要从中读取用户名的 SAML 属性。如果未指定,系统会从 SAML 响应中断言的 NameID 元素读取用户名。此值应为字符串,并将按原样传递(可以选择以 user_prefix 作为前缀)。

groups_attribute

string

可选。要从中读取群组的 SAML 属性。此值应为字符串,并将按原样传递(可以选择以 group_prefix 作为前缀)。

user_prefix

string

可选。附加到用户名的前缀。

group_prefix

string

可选。附加到群组名称的前缀。

attribute_mapping

map<string, string>

可选。附加用户属性(例如昵称、生日和地址等)的映射。key 是此附加属性的名称。value 是一个字符串,表示为 CEL(通用表达式语言,go/cel),用于从资源获取值。以昵称为例,在本例中,key 为“attribute.nickname”,value 为“assertion.nickname”。

MembershipConfig

单个集群的配置。旨在与 ConfigManagement CR 并行执行。

字段
config_sync

ConfigSync

集群的 Config Sync 配置。

policy_controller

PolicyController

集群的 Policy Controller 配置。

binauthz
(deprecated)

BinauthzConfig

集群的 Binauthz 配置。已弃用:此字段将被忽略,不应进行设置。

hierarchy_controller

HierarchyControllerConfig

集群的 Hierarchy Controller 配置。

version

string

已安装的 ACM 的版本。

cluster

string

Config Sync cluster-name-selector 注解或 ClusterSelector 使用的用户指定的集群名称,用于将配置仅应用于部分集群。如果 Config Sync cluster-name-selector 注解或 ClusterSelector 使用集群的舰队成员资格名称,请省略此字段。如果 Config Sync cluster-name-selector 注解或 ClusterSelector 使用的名称与集群的舰队成员资格名称不同,请设置此字段。

MeteringFeatureSpec

此类型没有字段。

计量特征的规范为空。必须提供一个规范,因为特征 proto 需要使用该规范。

MeteringFeatureState

计量特征状态。

字段
last_measurement_time

Timestamp

最近一次测量集群中的 vCPU 数量时的时间戳。

precise_last_measured_cluster_vcpu_capacity

float

根据最近的测量结果(1/1000 精度)计算的集群中的 vCPU 容量。

MultiClusterIngressFeatureSpec

MultiClusterIngressFeatureSpec 包含 MultiClusterIngress 特征的输入。

字段
config_membership

string

托管 MultiClusterIngress CRD 的完全限定成员名称。成员名称示例:projects/foo-proj/locations/global/memberships/bar

billing
(deprecated)

Billing

已弃用:此字段将被忽略,不应进行设置。客户的结算结构

MultiClusterIngressFeatureState

此类型没有字段。

MultiClusterIngressFeatureState 包含特定于 MultiClusterIngress 特征的状态字段。这里只是一个占位符,当我们有关于此特征的更多状态信息需要报告时,可以向其添加更多字段。

MultiClusterServiceDiscoveryFeatureSpec

此类型没有字段。

多集群服务发现特征的规范为空。必须提供一个规范,因为特征 proto 需要使用该规范。

MultiClusterServiceDiscoveryFeatureState

此类型没有字段。

多集群服务发现特征的状态为空。必须提供一个状态,因为 FeatureStateDetails 需要使用该状态。

OciConfig

单个集群的 OCI 仓库配置

字段
sync_repo

string

要从中同步的软件包的 OCI 映像代码库网址,例如 LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME

policy_dir

string

包含本地资源的目录的绝对路径。默认值:映像的根目录。

sync_wait_secs

int64

连续两次同步操作之间的间隔时长(以秒为单位)。默认值:15。

secret_type

string

为访问 Git 代码库而配置的 Secret 的类型。

gcp_service_account_email

string

当 secret_type 为 gcpServiceAccount 时用于身份验证的 Google Cloud 服务账号的电子邮件地址。

OnClusterState

OnClusterState 表示 Policy Controller 的子组件的状态。

字段
state

PolicyControllerFeatureState.LifecycleState

此组件的生命周期状态。

details

string

显示潜在的错误或信息日志。

OperationMetadata

表示长时间运行的操作的元数据。

字段
create_time

Timestamp

仅供输出。操作的创建时间。

end_time

Timestamp

仅供输出。操作完成运行的时间。

target

string

仅限输出。由服务器定义的操作目标的资源路径。

verb

string

仅限输出。操作执行的谓词的名称。

status_detail

string

仅限输出。人类可读的操作状态(如果有)。

cancel_requested

bool

仅限输出。标识用户是否已请求取消操作。已成功取消的操作具有 [Operation.error][] 值且 google.rpc.Status.code 为 1,对应于 Code.CANCELLED

api_version

string

仅限输出。用于启动操作的 API 版本。

OperatorState

ACM Operator 的状态信息

字段
version

string

Operator 的语义版本号

deployment_state

DeploymentState

Operator 的部署状态

errors[]

InstallError

安装错误。

PolicyContentSpec

PolicyContentSpec 定义用户在集群上所需的内容配置。

字段
bundles

map<string, BundleInstallSpec>

软件包名称与 BundleInstallSpec 的映射。软件包名称映射到限制条件的 policycontroller.gke.io/constraintData 注解中的 bundleName 键。

template_library

TemplateLibraryConfig

配置模板库的安装。

PolicyContentState

Policy Controller 政策内容的状态

字段
template_library_state

OnClusterState

模板库的状态

bundle_states

map<string, OnClusterState>

所选清单版本中包含的任何软件包的状态

referential_sync_config_state

OnClusterState

参照数据同步配置的状态。这可以表示 syncSet 对象或配置对象的状态,具体取决于用户配置的 PoCo 版本。

PolicyController

政策控制器的配置

字段
enabled

bool

允许安装 Policy Controller。如果为 false,则其余的 PolicyController 字段不会生效。

exemptable_namespaces[]

string

从 Policy Controller 检查中排除的命名空间集。命名空间不需要当前存在于集群中。

referential_rules_enabled

bool

能够使用引用了并非当前正在评估的对象的限制条件模板。

log_denies_enabled

bool

记录所有拒绝及试运行失败。

mutation_enabled

bool

允许用户尝试变更 PolicyController。

monitoring

PolicyControllerMonitoring

Monitoring 指定监控配置。

update_time

Timestamp

仅限输出。此成员资格规范的上次更新时间。

联合字段 template_library_installed_value

template_library_installed_value 只能是下列其中一项:

template_library_installed

bool

安装 Policy Controller 及默认模板库。

联合字段 audit_interval_seconds_value

audit_interval_seconds_value 只能是下列其中一项:

audit_interval_seconds

int64

设置 Policy Controller 审核扫描的间隔时间(以秒为单位)。如果设为 0,则会完全停用审核功能。

PolicyControllerDeploymentConfig

特定于部署的配置。

字段
pod_tolerations[]

PolicyControllerDeploymentConfig.Toleration

Pod 对节点污点的容忍。

pod_affinity

PolicyControllerDeploymentConfig.Affinity

Pod 亲和性配置。

replica_count

int64

Pod 副本数量。

container_resources

ResourceRequirements

容器资源要求。

pod_anti_affinity
(deprecated)

bool

Pod 反亲和性启用。已弃用:请改用 pod_affinity

亲和性

部署使用的 pod 亲和性配置。

枚举
AFFINITY_UNSPECIFIED 未指定亲和性配置。
NO_AFFINITY 亲和性配置将从部署中移除。
ANTI_AFFINITY 反亲和性配置将应用于此部署。准入部署的默认值。

容忍

节点污点的容忍。

字段
key

string

匹配污点键(不一定是唯一的)。

operator

string

匹配污点运算符。

value

string

匹配污点值。

effect

string

匹配污点效果。

PolicyControllerFeatureSpec

Policy Controller 的规范。

字段
membership_specs

map<string, PolicyControllerMembershipSpec>

成员资格 ID 与各个规范的映射。

PolicyControllerFeatureState

PolicyController 的状态

字段
state

PolicyControllerFeatureState.LifecycleState

Hub 特征控制器所观察到的整体 Policy Controller 生命周期状态。

component_states

map<string, OnClusterState>

要跟踪的组件的集群内状态。目前包括(也用作映射键):1. “admission”2. “audit”3. “mutation”

policy_content_state

PolicyContentState

Hub 特征控制器所观察到的整体内容状态。

LifecycleState

Policy Controller 可以具有的状态集。

枚举
LIFECYCLE_STATE_UNSPECIFIED 未指定生命周期状态。
NOT_INSTALLED 给定集群中不存在 Policy Controller (PC),并且其中不应存在与 PC 关联的任何类型的 k8s 资源。集群不拥有 Hub 特征控制器的成员资格。
INSTALLING Hub 特征控制器拥有成员资格,但 Policy Controller 未完全安装在集群上。在此状态下,hub 可以执行操作以在集群上安装 PC。
ACTIVE Policy Controller (PC) 已完全安装在集群上,并处于运行模式。在此状态下,Hub 特征控制器将与 PC 协调状态,PC 将根据该软件执行操作任务。进入 READY 状态要求 hub 确认 PC 已安装,且其 Pod 可与 Hub 特征控制器期望的 PC 版本一起运行。
UPDATING Policy Controller (PC) 已完全安装,但正在更改集群上运行的资源的配置(包括向上或向下更改 PC 的版本,或是修改 PC 的清单)。Hub 特征控制器具有成员资格,知道集群应运行的版本,但尚未自己确认 PC 正在使用该版本运行。
DECOMMISSIONING Policy Controller (PC) 可能具有集群上的资源,但 Hub 特征控制器希望移除成员资格。成员资格仍然存在。
CLUSTER_ERROR Policy Controller (PC) 未运行,Hub 特征控制器无法采取行动使其运行。如果 PCH 确定集群上安装的 PC 无法运行,或者集群不满足为使 Hub 特征控制器可管理集群而设置的要求,但仍收到了执行此操作的指令(例如“安装”),则会自动进入 CLUSTER_ERROR 状态。
HUB_ERROR 在此状态下,PC 可能仍在运行,只有 Hub 特征控制器无法执行操作。Hub 不应发出更改 PC 状态的指令,或以其他方式干扰集群上的资源。如果 Hub 特征控制器确定 Hub 处于健康状况不佳状态,并希望“放手”以避免损坏 PC 或其他数据,则会自动进入 HUB_ERROR 状态。
SUSPENDED Policy Controller (PC) 已安装,但已暂停。这意味着系统不会强制执行政策,但仍会记录违规行为(通过审核)。
DETACHED PoCo Hub 不会执行任何操作来协调集群对象。PoCo Hub 不会覆盖对这些对象进行的更改。

PolicyControllerHubConfig

Policy Controller 的配置。

字段
install_spec

PolicyControllerHubConfig.InstallSpec

install_spec 表示在特征规范中更改了 install_spec 的最新请求所指定的预期状态,而不是以特征状态报告的 Hub 特征控制器所观察到的特征生命周期状态。

exemptable_namespaces[]

string

从 Policy Controller 检查中排除的命名空间集。命名空间不需要当前存在于集群中。

referential_rules_enabled

bool

能够使用引用了并非当前正在评估的对象的限制条件模板。

log_denies_enabled

bool

记录所有拒绝及试运行失败。

mutation_enabled

bool

启用使用 Policy Controller 更改资源的功能。

monitoring

PolicyControllerMonitoringConfig

Monitoring 指定监控配置。

policy_content

PolicyContentSpec

指定集群上所需的政策内容

deployment_configs

map<string, PolicyControllerDeploymentConfig>

部署配置到部署的映射(“admission”“audit”“mutation”)。

audit_interval_seconds

int64

设置 Policy Controller 审核扫描的间隔时间(以秒为单位)。如果设为 0,则会完全停用审核功能。

constraint_violation_limit

int64

要在限制条件中存储的审核违规行为数量上限。如果未设置,系统会使用内部默认值(当前为 20)。

InstallSpec

Hub 特征控制器可以激活的安装规范集。

枚举
INSTALL_SPEC_UNSPECIFIED 规范未知。
INSTALL_SPEC_NOT_INSTALLED 请求卸载 Policy Controller。
INSTALL_SPEC_ENABLED 请求安装并启用 Policy Controller。
INSTALL_SPEC_SUSPENDED 请求暂停 Policy Controller(即其 webhook)。如果未安装 Policy Controller,则系统会安装它,但随后会暂停它。
INSTALL_SPEC_DETACHED 请求停止 PoCo Hub 控制器执行的所有协调操作。这是一种 Breakglass 机制,可防止 PoCo Hub 影响集群资源。

PolicyControllerMembershipSpec

单个集群的配置。旨在与 PolicyController CR 并行执行。

字段
policy_controller_hub_config

PolicyControllerHubConfig

集群的 Policy Controller 配置,由 Policy Controller Hub 特征控制器进行管理。

version

string

Policy Controller 特征的版本。

PolicyControllerMigration

PolicyController 从 ACM 迁移到 PoCo Hub 的迁移操作的状态。

字段
stage

PolicyControllerMigration.Stage

迁移阶段。

copy_time

Timestamp

此成员资格规范上次复制到 PoCo 特征的时间。

阶段

Stage 标记 ACM Hub 所处的迁移阶段。

枚举
STAGE_UNSPECIFIED 迁移状态未知。
ACM_MANAGED ACM Hub/Operator 负责管理 PolicyController。尚未完成迁移。
POCO_MANAGED 所有迁移步骤都已完成;Poco Hub 现在负责管理 PolicyController。

PolicyControllerMonitoring

PolicyControllerMonitoring 指定 Policy Controller 应将指标导出到的后端。例如,如需指定指标应导出到 Cloud Monitoring 和 Prometheus,请指定后端:["cloudmonitoring", "prometheus"]

字段
backends[]

PolicyControllerMonitoring.MonitoringBackend

指定 Policy Controller 将导出到的后端的列表。空列表实际上会停用指标导出。

MonitoringBackend

受支持的监控后端选项

枚举
MONITORING_BACKEND_UNSPECIFIED 无法确定后端
PROMETHEUS Prometheus 后端用于监控
CLOUD_MONITORING Stackdriver/Cloud Monitoring 后端用于监控

PolicyControllerMonitoringConfig

PolicyControllerMonitoringConfig 指定 Policy Controller 应将指标导出到的后端。例如,如需指定指标应导出到 Cloud Monitoring 和 Prometheus,请指定后端:["prometheus", "cloudmonitoring"]

字段
backends[]

PolicyControllerMonitoringConfig.MonitoringBackend

指定 Policy Controller 将导出到的后端的列表。空列表实际上会停用指标导出。

MonitoringBackend

受支持的监控后端选项

枚举
MONITORING_BACKEND_UNSPECIFIED 无法确定后端
PROMETHEUS Prometheus 后端用于监控
CLOUD_MONITORING Stackdriver/Cloud Monitoring 后端用于监控

PolicyControllerState

PolicyControllerState 的状态。

字段
version

PolicyControllerVersion

已部署的 Gatekeeper Policy Controller 的版本。

deployment_state

GatekeeperDeploymentState

有关 Policy Controller 安装的状态。

migration

PolicyControllerMigration

此特征从 ACM 迁移到 PoCo Hub 的迁移记录的状态。

PolicyControllerVersion

Policy Controller 在使用的 Gatekeeper 的 build 版本。

字段
version

string

由 ACM 版本、Git 标记和 build 号组成的 Gatekeeper 映像标记。

ResourceList

ResourceList 包含容器资源要求。

字段
memory

string

以 Kubernetes 资源单元表示的内存要求。

cpu

string

以 Kubernetes 资源单元表示的 CPU 要求。

资源要求

ResourceRequirements 描述计算资源要求。

字段
limits

ResourceList

限制描述正在运行的容器可以使用的计算资源数量上限。

requests

ResourceList

请求描述 kube-scheduler 为容器预留的计算资源数量。

RoutingConfig

RoutingConfig 配置舰队日志记录特征的行为。

字段
mode

RoutingConfig.Mode

mode 配置日志路由模式。

模式

在启用了舰队日志记录特征时指定。

枚举
MODE_UNSPECIFIED 如果为 UNSPECIFIED,则停用舰队日志记录特征。
COPY 日志将复制到目标项目。
MOVE 日志将移至目标项目。

ServiceDirectoryFeatureSpec

此类型没有字段。

Service Directory 特征的规范为空。必须提供一个规范,因为特征 proto 需要使用该规范。

ServiceDirectoryFeatureState

此类型没有字段。

Service Directory 特征的状态为空。必须提供一个状态,因为 FeatureStateDetails 需要使用该状态。

ServiceMeshAnalysisMessage

ServiceMeshAnalysisMessage 是分析器生成的单条消息,用于向最终用户传达其 Service Mesh 配置状态的相关信息。

字段
message_base

ServiceMeshAnalysisMessageBase

所有类型的 Istio 和 ServiceMesh 分析消息的通用详细信息。

description

string

人类可读的错误含义说明,适用于非国际化显示目的。

resource_paths[]

string

这是一组字符串,用于指定导致生成消息的资源的标识符。这里的“path”可以是具体的 MEMBERSHIP_ID(如果是特定的成员集群导致生成消息),也可以是 MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME(如果是集群中的某项资源导致生成消息)。

args

Struct

有一个界面可以通过模板(基于 message_base.type)将这些参数汇总到一起,生成一则国际化消息。

ServiceMeshAnalysisMessageBase

ServiceMeshAnalysisMessageBase 定义所有消息都需要的一些通用信息。

字段
type

ServiceMeshAnalysisMessageBase.Type

指定消息的特定类型。

level

ServiceMeshAnalysisMessageBase.Level

指定消息的严重程度。

documentation_url

string

定向至此特定错误类型的相关 Service Mesh 或 Istio 文档的网址。

级别

在此处选择相应的值后,严重程度更高的消息的排序也会更前,同时在它们之间会留出空间以便之后添加更多的值。请参阅 istio.analysis.v1alpha1.AnalysisMessageBase.Level

枚举
LEVEL_UNSPECIFIED 非法。等同于 istio.analysis.v1alpha1.AnalysisMessageBase.Level.UNKNOWN。
ERROR ERROR 表示必须修复的错误配置。
WARNING WARNING 表示应予以修复的错误配置。
INFO INFO 表示信息性发现结果。

类型

这是用于指定消息类型的唯一标识符。display_name 应是人类可读,code 则是机器可读。display_name 和 code 之间应该存在一对一的映射关系。(即,不应将某个 display_name 或 code 重复用在多个消息类型中。)请参阅 istio.analysis.v1alpha1.AnalysisMessageBase.Type

字段
display_name

string

人类可读的消息类型名称。例如“InternalError”“PodMissingProxy”。该名称在同一类型的所有消息中应保持一致。(该字段对应于开源 Istio 中的 name 字段。)

code

string

符合 ^IST[0-9]{4}$^ASM[0-9]{4}$ 模式的 7 个字符的代码,用于唯一标识消息类型。(例如,“IST0001”对应于“InternalError”消息类型。)

ServiceMeshFeatureSpec

ServiceMeshFeatureSpec 包含 Service Mesh 特征的输入。

字段
membership_specs

map<string, ServiceMeshMembershipSpec>

可选。成员资格的完整路径与其对应配置之间的映射。

ServiceMeshFeatureState

ServiceMeshFeatureState 描述 Service Mesh Hub 特征的状态,由 Service Mesh Hub Controller 分析提供。

字段
analysis_messages[]

ServiceMeshAnalysisMessage

仅限输出。针对成员集群或整个网格运行 Service Mesh 分析器获得的结果。

control_plane_management

ServiceMeshFeatureState.ControlPlaneManagement

仅限输出。控制平面管理状态

data_plane_management

ServiceMeshFeatureState.DataPlaneManagement

仅限输出。数据平面管理状态。

config_api_version

string

用于在此集群中配置服务网格的 API 版本(即 Istio CRD 版本)。此版本由 default_channel 字段决定。

ControlPlaneManagement

控制平面管理状态。仅针对具体成员报告。

字段
details[]

StatusDetails

状态说明。

state

ServiceMeshFeatureState.LifecycleState

控制平面管理状态。

DataPlaneManagement

数据平面管理状态。仅针对具体成员报告。

字段
state

ServiceMeshFeatureState.LifecycleState

数据平面管理的生命周期状态。

details[]

StatusDetails

状态说明。

LifecycleState

服务网格组件的生命周期状态。

枚举
LIFECYCLE_STATE_UNSPECIFIED 未指定
DISABLED DISABLED 表示未启用组件。
FAILED_PRECONDITION FAILED_PRECONDITION 表示由于成员集群的某些因素导致预配无法继续完成。
PROVISIONING PROVISIONING 表示正在进行预配。
ACTIVE ACTIVE 表示组件已准备就绪,可供使用。
STALLED STALLED 表示无法完成预配。
NEEDS_ATTENTION NEEDS_ATTENTION 表示组件已准备就绪,但需要一些用户干预。(例如,需要用户将工作负载迁移到新的控制平面修订版本。)
DEGRADED DEGRADED 表示组件已准备就绪,但在降级状态下运行。

ServiceMeshMembershipSpec

Service Mesh:servicemesh 特征的单个成员资格的规范

字段
control_plane

ServiceMeshMembershipSpec.ControlPlaneManagement

启用控制平面自动管理功能。

management

ServiceMeshMembershipSpec.Management

启用 Service Mesh 的自动管理功能。

ControlPlaneManagement

指定是否自动管理服务网格控制平面。

枚举
CONTROL_PLANE_MANAGEMENT_UNSPECIFIED 未指定
AUTOMATIC Google 应预配控制平面修订版本,并在集群中提供该修订版本。Google 将在发布渠道中注册此修订版本,并使其保持最新。控制平面修订版本可以是托管式服务,也可以是托管式安装。
MANUAL 用户将手动配置控制平面(例如通过 CLI 或通过 ControlPlaneRevision KRM API)

管理

指定是否自动管理服务网格。

枚举
MANAGEMENT_UNSPECIFIED 未指定
MANAGEMENT_AUTOMATIC Google 应负责管理用户的集群的服务网格。
MANAGEMENT_MANUAL 用户将手动配置其服务网格组件。

StatusDetails

人类可读的结构化状态详细信息。

字段
code

string

用于进一步描述状态的机器可读代码。

details

string

人类可读的代码说明。

SyncError

这是 ACM 生成的错误,表示同步配置时出现问题

字段
code

string

ACM 定义的错误代码

error_message

string

错误的说明

error_resources[]

ErrorResource

与错误关联的配置(如果有)的列表

SyncState

指示 ACM 将配置同步到集群的进度的状态

字段
source_token

string

指示代码库状态的令牌。

import_token

string

指示导入器状态的令牌。

sync_token

string

指示同步器状态的令牌。

last_sync

string

ACM 上次成功同步代码库时的时间戳。有关时间格式,请参阅 https://golang.org/pkg/time/#Time.String。此字段已被弃用。请改用 last_sync_time。

last_sync_time

Timestamp

ACM 上次成功同步代码库时的时间戳类型

code

SyncState.SyncCode

同步状态代码

errors[]

SyncError

有问题的配置导致的错误的列表。此列表会在 100 个错误后被截断,但不太可能同时存在这么多错误。

SyncCode

表示 Config Sync 将配置同步到集群的同步操作状态的枚举。

枚举
SYNC_CODE_UNSPECIFIED Config Sync 无法确定同步代码
SYNCED Config Sync 已成功将 Git 代码库与集群同步
PENDING Config Sync 正在同步新更改
ERROR 表示配置 Config Sync 时出错,需要用户操作
NOT_CONFIGURED 已安装 Config Sync,但尚未进行配置
NOT_INSTALLED 尚未安装 Config Sync
UNAUTHORIZED 向集群授权时出错
UNREACHABLE 无法访问集群

TemplateLibraryConfig

用于指定要安装的默认库模板的配置。

字段
installation

TemplateLibraryConfig.Installation

配置在集群上安装模板库的方式。

安装

指定应如何安装模板库

枚举
INSTALLATION_UNSPECIFIED 未指定安装策略。
NOT_INSTALLED 不安装模板库。
ALL 安装整个模板库。

UpdateFeatureRequest

GkeHubDomainFeatureService.UpdateFeature 方法的请求消息。

字段
name

string

必需。特征资源的名称,格式为 projects/*/locations/global/features/*

必须对指定的资源 name 具有以下 IAM 权限才能进行授权:

  • gkehub.features.update
update_mask

FieldMask

要更新的字段掩码。

resource

Feature

只有 update_mask 中指定的字段会被更新。如果您在 update_mask 中指定了字段,但未在此处指定其值,则该字段将被删除。如果要更新映射字段,可将键值设置为 null 或空字符串,以从映射中删除相应键。无法将现有键值更改为空字符串。

WorkloadCertificateFeatureSpec

WorkloadCertificateFeatureSpec 包含 Workload Identity 平台特征的输入。必须提供一个规范,因为特征 proto 需要使用该规范。

字段
provision_google_ca

WorkloadCertificateFeatureSpec.GoogleCAProvisioning

不可变。指定证书授权机构 (CA) 配置。

default_config

WorkloadCertificateMembershipSpec

这是默认成员资格规范。用户可以替换每个成员的 member_configs 中的默认值。

member_configs

map<string, WorkloadCertificateMembershipSpec>

Workload Certificate 的基于成员的配置。

GoogleCAProvisioning

指定是否应预配一个由 Google 管理的默认证书授权机构 (CA)。如果为 UNSPECIFIED,则系统会停用由 Google 管理的证书授权机构 (CA) 特征。如果设置为 UNSPECIFIED/DISABLED,则 WorkloadCertificateConfig 中的“certificate_authority_config”字段必须指定一个证书授权机构 (CA) 端点。

枚举
GOOGLE_CA_PROVISIONING_UNSPECIFIED 停用由 Google 管理的默认证书授权机构 (CA)。
DISABLED 停用由 Google 管理的默认证书授权机构 (CA)。
ENABLED 使用由 Google 管理的默认证书授权机构 (CA)。
ENABLED_WITH_MANAGED_CA 启用了 Workload Certificate 特征,并且整个证书预配过程都由 Google 通过代管式 CAS(比默认 CA 更安全)来进行管理。
ENABLED_WITH_DEFAULT_CA 启用了 Workload Certificate 特征,并且整个证书预配过程都使用免费的默认证书授权机构 (CA) 来完成。

WorkloadCertificateFeatureState

此类型没有字段。

WorkloadCertificateFeatureState 描述 Workload Certificate 特征的状态。必须提供一个状态,因为 FeatureStateDetails 需要使用该状态。

WorkloadCertificateMembershipSpec

WorkloadCertificateMembershipSpec 包含 WorkloadCertificate 特征的成员资格特定输入。

字段
certificate_management

WorkloadCertificateMembershipSpec.CertificateManagement

指定 Workload Certificate Management。

CertificateManagement

指定是否在成员集群上启用了该特征。

枚举
CERTIFICATE_MANAGEMENT_UNSPECIFIED 停用 Workload Certificate 特征。
DISABLED 停用 Workload Certificate 特征。
ENABLED 启用 Workload Certificate 特征。