Package google.cloud.gkehub.configmanagement.v1

索引

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 的版本

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

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

GatekeeperDeploymentState

Policy Controller 安装的状态。

字段
gatekeeper_controller_manager_state

DeploymentState

gatekeeper-controller-manager pod 的状态。

gatekeeper_audit

DeploymentState

gatekeeper-audit 部署的状态。

gatekeeper_mutation

DeploymentState

传送变更 webhook 的 pod 的状态。

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 的类型。必须是 ssh、cookiefile、gcenode、token、gcpserviceaccount 或 none 之一。此字段的验证区分大小写。必填。

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 扩展程序的版本

InstallError

与 ACM 安装相关的错误

字段
error_message

string

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

MembershipSpec

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

字段
config_sync

ConfigSync

集群的 Config Sync 配置。

policy_controller

PolicyController

集群的 Policy Controller 配置。

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 使用的名称与集群的舰队成员资格名称不同,请设置此字段。

MembershipState

Anthos Config Management:单个集群的状态。

字段
cluster_name

string

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

membership_spec

MembershipSpec

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

operator_state

OperatorState

ACM Operator 的当前安装状态

config_sync_state

ConfigSyncState

当前同步状态

policy_controller_state

PolicyControllerState

PolicyController 状态

hierarchy_controller_state

HierarchyControllerState

Hierarchy Controller 状态

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 服务账号的电子邮件地址。

OperatorState

ACM Operator 的状态信息

字段
version

string

Operator 的语义版本号

deployment_state

DeploymentState

Operator 的部署状态

errors[]

InstallError

安装错误。

PolicyController

政策控制器的配置

字段
enabled

bool

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

exemptable_namespaces[]

string

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

referential_rules_enabled

bool

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

log_denies_enabled

bool

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

mutation_enabled

bool

在 Policy Controller 中启用或停用变更。如果为 true,则变更 CRD、webhook 和控制器部署将部署到集群。

monitoring

PolicyControllerMonitoring

Monitoring 指定监控配置。

update_time

Timestamp

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

template_library_installed

bool

安装默认模板库以及 Policy Controller。

audit_interval_seconds

int64

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

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 后端用于监控

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 映像标记。

SyncError

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

字段
code

string

ACM 定义的错误代码

error_message

string

错误的说明

error_resources[]

ErrorResource

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

SyncState

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

字段
source_token

string

指示代码库状态的令牌。

import_token

string

指示导入器状态的令牌。

sync_token

string

指示同步器状态的令牌。

last_sync
(deprecated)

string

已弃用:请改用 last_sync_time。ACM 上次成功同步仓库的时间戳。时间格式在 https://golang.org/pkg/time/#Time.String 中指定

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 无法访问集群