Package google.cloud.gkehub.v1alpha1

索引

GkeHubDomainFeatureService

Feature リソース用の GKE Hub CRUD API

CreateFeature

rpc CreateFeature(CreateFeatureRequest) returns (Operation)

新しい Feature を追加します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

DeleteFeature

rpc DeleteFeature(DeleteFeatureRequest) returns (Operation)

Feature を削除します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

GetFeature

rpc GetFeature(GetFeatureRequest) returns (Feature)

1 つの Feature の詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

ListFeatures

rpc ListFeatures(ListFeaturesRequest) returns (ListFeaturesResponse)

指定されたプロジェクトとロケーションの Feature を一覧表示します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

UpdateFeature

rpc UpdateFeature(UpdateFeatureRequest) returns (Operation)

既存の Feature を更新します。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

AnthosObservabilityFeatureSpec

Anthos Observability の仕様。Feature proto には仕様が必要であるため、これは必須です。

フィールド
membership_specs

map<string, AnthosObservabilityMembershipSpec>

Stackdriver CR の仕様を決定するメンバーシップごとの仕様

default_membership_spec

AnthosObservabilityMembershipSpec

何も指定されていない場合のデフォルトのメンバーシップ仕様。

AnthosObservabilityFeatureState

この型にはフィールドがありません。

Anthos Observability の空の状態。FeatureStateDetails には状態が必要であるため、これは必須です。

AnthosObservabilityMembershipSpec

Anthosobservability: Membership ごとの Feature 仕様。

フィールド
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 オペレーターのバージョン

AppDevExperienceFeatureSpec

この型にはフィールドがありません。

App Dev Experience Feature の仕様。

AppDevExperienceFeatureState

App Dev Exp Feature の状態。

フィールド
networking_install_succeeded

AppDevExperienceFeatureState.Status

構成された Service Mesh リソースを検出するサブコンポーネントのステータス。

Code

AppDevExperienceFeature サブコンポーネントの準備状態を指定します。

列挙型
CODE_UNSPECIFIED 未設定。
OK AppDevExperienceFeature の指定されたサブコンポーネントの準備が完了しました。
FAILED AppDevExperienceFeature の指定されたサブコンポーネントの準備状態が false です。これは、AppDevExperienceFeature が通常の動作のすべてまたは一部をブロックする問題が発生したことを意味します。詳しくは、description をご覧ください。
UNKNOWN AppDevExperienceFeature の指定されたサブコンポーネントが保留中または不明の状態です。

Status

Status は、サブコンポーネントの状態を指定します。

フィールド
code

AppDevExperienceFeatureState.Code

Code は、AppDevExperienceFeature のサブコンポーネントの準備状態を指定します。

description

string

Code が Failed の場合、失敗した理由の説明が設定されます。

AuthorizerFeatureSpec

この型にはフィールドがありません。

AuthorizerFeatureSpec には、Authorizer Feature のオプションと仕様が含まれています。

AuthorizerFeatureState

この型にはフィールドがありません。

AuthorizerFeatureState には、Authorizer Feature の現在の詳細な状態が含まれます。

Billing

非推奨: 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

バンドルから除外する Namespace のセット。

CloudAuditLoggingFeatureSpec

監査ロギングの許可リストの仕様

フィールド
allowlisted_service_accounts[]

string

監査ログを送信するために許可リストに登録するサービス アカウント(例: cloudauditlogging@gcp-project.iam.gserviceaccount.com)。これらのアカウントはすでに存在している必要がありますが、権限を付与する必要はありません。許可リストに登録する前に、お客様の利用資格が確認されます(つまり、お客様は Anthos のお客様である必要があります)。

CloudAuditLoggingFeatureState

この型にはフィールドがありません。

監査ロギング許可リストの空の状態。FeatureStateDetails には状態が必要であるため、これは必須です。

CloudBuildFeatureSpec

Cloud Build for Anthos 機能の仕様。Feature proto には仕様が必要であるため、これは必須です。

フィールド
membership_configs

map<string, CloudBuildMembershipConfig>

メンバーシップ パス(projects/foo-proj/locations/global/memberships/bar など)から、そのメンバー クラスタに選択された CloudBuildMembershipConfig へのマップ。ハブで Cloud Build 機能が有効になっていて、そのハブ内のクラスタのメンバーシップ パスがこのマップに存在する場合、その特定のクラスタで Cloud Build ハブ機能が有効になります。

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

このフィールドは、MembershipSpec の cluster_name フィールドに設定されます(空でない場合)。それ以外の場合は、クラスタのフリート メンバーシップ名に設定されます。

membership_config

MembershipConfig

クラスタのメンバーシップ構成。これはクラスタの実際の状態を表しますが、FeatureSpec の MembershipConfig は意図された状態を表します。

operator_state

OperatorState

ACM のオペレーターの現在のインストール ステータス

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

Config Sync アドミッション Webhook を有効にしてドリフトを防ぐには、true に設定します。デフォルトは 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 には、モニタリング指標の書き込み(roles/monitoring.metricWriter)IAM ロールが付与されている必要があります。Namespace config-management-monitoring の Kubernetes ServiceAccount default は、GSA にバインドされている必要があります。

enabled

bool

ConfigSync のインストールを有効にします。true に設定すると、ConfigSync リソースが作成され、他の ConfigSync フィールドが適用されます(存在する場合)。false に設定すると、他のすべての ConfigSync フィールドが無視され、ConfigSync リソースが削除されます。省略した場合、ConfigSync リソースの管理は、git フィールドまたは oci フィールドの有無によって異なります。

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 にデプロイされた reconciler コンテナのバージョン

admission_webhook

string

デプロイされた admission_webhook Pod のバージョン

CreateFeatureRequest

GkeHubDomainFeatureService.CreateFeature メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。Feature が作成される親(プロジェクトとロケーション)。projects/*/locations/global の形式で指定します。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • gkehub.features.create
feature_id

string

作成する機能の ID。

resource

Feature

作成する Feature リソース。

DataplaneV2FeatureSpec

マルチクラスタ dataplane-v2 機能の仕様。Feature proto には仕様が必要であるため、これは必須です。

フィールド
enable_encryption

bool

複数のクラスタで dataplane-v2 ベースの暗号化を有効にします。

DataplaneV2FeatureState

この型にはフィールドがありません。

マルチクラスタ dataplane-v2 機能の空の状態。FeatureStateDetails には状態が必要であるため、これは必須です。

DeleteFeatureRequest

GkeHubDomainFeatureService.DeleteFeature メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。projects/*/locations/global/features/* 形式の Feature リソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.features.delete
force

bool

true に設定すると、削除時にこの Feature の未処理リソースが無視されます(つまり、FeatureState.has_resources が true に設定されます)。これらのリソースは、クリーンアップも変更もされません。

DeploymentState

クラスタでの ACM のデプロイの状態を表す列挙型

列挙型
DEPLOYMENT_STATE_UNSPECIFIED Deployment の状態を特定できない
NOT_INSTALLED Deployment がインストールされていない
INSTALLED Deployment がインストールされている
ERROR Deployment のインストールを試みたが、エラーが発生した
PENDING Deployment のインストール中または終了中

ErrorResource

関連する Sync エラーがある git リポジトリの構成ファイルのモデル

フィールド
source_path

string

誤った構成の git リポジトリ内のパス

resource_name

string

エラーの原因となっているリソースのメタデータ名

resource_namespace

string

エラーの原因となっているリソースの Namespace

resource_gvk

GroupVersionKind

エラーの原因となっているリソースのグループ / バージョン / 種類

Feature

Feature は、任意の機能の設定とステータスを表します。

フィールド
name

string

出力専用。この Feature リソースの完全で一意の名前(形式: projects/*/locations/global/features/*)。

labels

map<string, string>

この機能のラベル。

description

string

機能の説明(63 文字以内)。

feature_state

FeatureState

出力専用。Feature リソース自体の状態。

fleet_default_member_config

FleetDefaultMemberConfig

FleetDefaultMemberConfig は、フリートレベルのデフォルトのメンバー構成を記述します。

create_time

Timestamp

出力専用。Feature が作成された日時。

update_time

Timestamp

出力専用。Feature が最後に更新された日時。

delete_time

Timestamp

出力専用。Feature が削除された日時。

共用体フィールド spec

spec は次のいずれかになります。

servicemesh_feature_spec

ServiceMeshFeatureSpec

サービス メッシュ機能の仕様。

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 Observability の仕様。

workloadcertificate_feature_spec

WorkloadCertificateFeatureSpec

ワークロード証明書の仕様。

policycontroller_feature_spec

PolicyControllerFeatureSpec

Policy Controller の仕様。

dataplanev2_feature_spec

DataplaneV2FeatureSpec

マルチクラスタ dataplane-v2 の仕様。

fleetobservability_feature_spec

FleetObservabilityFeatureSpec

FleetObservability 機能の仕様。

FeatureState

FeatureState は、Feature リソースの状態を表します。

フィールド
lifecycle_state

FeatureState.LifecycleState

Feature リソースの現在の状態。

details

FeatureStateDetails

機能の集計ステータス メッセージ。

details_by_membership

map<string, FeatureStateDetails>

各 Membership の FeatureState。

キーは、Membership の完全修飾名です(形式: projects/{NUMBER}/locations/*/memberships/*)。

has_resources

bool

この Feature を無効にする前にクリーンアップする必要のある未処理のリソースがあるかどうか。

LifecycleState

LifecycleState は、機能のライフサイクル ステータスを表します。

列挙型
LIFECYCLE_STATE_UNSPECIFIED 状態が不明または未設定です。
ENABLING Feature を有効にしています。
ENABLED Feature はアクティブです。
DISABLING Feature を無効にしています。
UPDATING Feature を更新しています。
SERVICE_UPDATING Hub Service. が Feature を更新しています。

FeatureStateDetails

FeatureStateDetails は、API の宣言型リソースに対する半構造化ステータス メッセージです。

フィールド
code

FeatureStateDetails.Code

Feature が正しく動作しているかどうかを概要レベルで表します。OK 以外のコードには、description に詳細が含まれます。Feature を OK に戻すために必要なアクションがある場合は、それが含まれます。

description

string

問題の説明(人が読める形式)。

update_time

Timestamp

コントローラによるこのステータスの最終更新日時

共用体フィールド state。機能のステータスに関する構造化された情報。state は次のいずれかになります。
servicemesh_feature_state

ServiceMeshFeatureState

サービス メッシュ機能の状態。

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

ワークロード証明書機能の状態

policycontroller_feature_state

PolicyControllerFeatureState

Policy Controller 機能の状態。

dataplanev2_feature_state

DataplaneV2FeatureState

マルチクラスタの dataplane-v2 機能の状態。

fleetobservability_feature_state

FleetObservabilityFeatureState

FleetObservability 機能の状態。

Code

Code は、この機能のエラー状態と重大度を示します。

列挙型
CODE_UNSPECIFIED 未設定。
OK エラーなし。
FAILED Feature に、通常の動作のすべてまたは大部分をブロックする問題が発生しました。詳しくは、description をご覧ください。
WARNING Feature が、通常の動作に影響する状態にあるか、問題が発生しています。この状態を解決するために介入が必要になる場合とそうでない場合があります。詳しくは、description をご覧ください。

FleetDefaultMemberConfig

FleetDefaultMemberConfig には、フリートのメンバーシップに関するデフォルトの構成情報が含まれています。

フィールド

共用体フィールド spec

spec は次のいずれかになります。

service_mesh

ServiceMeshMembershipSpec

ServiceMesh の仕様。

identity_service

MemberConfig

IdentityService の仕様。

FleetObservabilityBaseFeatureState

フリート オブザーバビリティの機能の基本状態。

フィールド
code

FleetObservabilityBaseFeatureState.Code

この Feature のステータス。機械可読性のある概要レベルで表します。

errors[]

FleetObservabilityBaseFeatureState.FeatureError

コードが OK でない場合、モニタリング機能とロギング機能を調整した後のエラー。

Code

Code は、Feature のステータスを機械可読性のある概要レベルで表します。

列挙型
CODE_UNSPECIFIED 不明または未設定。
OK Feature は正常に動作しています。
ERROR Feature の調整中にエラーが発生しています。Feature を通常の動作に戻すための介入が必要になる場合があります。詳しくは、説明と関連する Feature 固有の詳細をご覧ください。

FeatureError

フリート オブザーバビリティ機能のすべてのエラーの詳細。

フィールド
code

string

エラーのコード。

description

string

現在のステータスの説明(人が読める形式)。

FleetObservabilityFeatureSpec

FleetObservability 機能の仕様。Feature 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 Deployment のステータス。

gatekeeper_mutation

DeploymentState

Mutation Webhook を提供する Pod のステータス。

GetFeatureRequest

GkeHubDomainFeatureService.GetFeature メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。projects/*/locations/global/features/* 形式の Feature リソース名

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.features.get

GitConfig

単一クラスタの Git リポジトリ構成。

フィールド
sync_repo

string

真の同期ソースとして使用する Git リポジトリの URL。

sync_branch

string

同期元となるリポジトリのブランチ。デフォルトはマスターです。

policy_dir

string

同期するリポの最上位レベルを表す Git リポジトリ内のパス。デフォルトはリポジトリのルート ディレクトリです。

sync_wait_secs

int64

連続する同期の時間間隔(秒)。デフォルトは 15 です。

sync_rev

string

チェックアウトする Git リビジョン(タグまたはハッシュ)。デフォルトは HEAD です。

secret_type

string

Git リポジトリへのアクセスのために構成された Secret のタイプ。

https_proxy

string

Git リポジトリとの通信時に使用する HTTPS プロキシの URL。

gcp_service_account_email

string

secret_type が gcpServiceAccount の場合に認証に使用される Google Cloud サービス アカウントのメールアドレス。

GroupVersionKind

Kubernetes オブジェクトの GVK

フィールド
group

string

Kubernetes グループ

version

string

Kubernetes のバージョン

kind

string

Kubernetes の種類

HierarchyControllerConfig

Hierarchy Controller の構成

フィールド
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 のバージョンです。値は、状態が OK の場合に意味を持ちます。

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

必須。Feature が一覧表示される親(プロジェクトとロケーション)。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 で説明されている構文に従って、フィルタ式に一致する Feature を一覧表示します。

例:

  • プロジェクト「foo-proj」の「servicemesh」という名前の機能
  name = "projects/foo-proj/locations/global/features/servicemesh"
  • mtls が有効になっているサービス メッシュ機能:
 servicemesh_feature_spec.mtls = true
  • foo というラベルを持つ機能:
  labels.foo:*
  • 値が barfoo というラベルを持つ Feature:
  labels.foo = bar
order_by

string

比較して出力の並べ替えに使用する 1 つ以上のフィールド。https://google.aip.dev/132#ordering をご覧ください。

ListFeaturesResponse

GkeHubDomainFeatureService.ListFeatures メソッドに対するレスポンス メッセージ。

フィールド
resources[]

Feature

一致する Feature のリスト

next_page_token

string

ListFeatures メソッドからリソースの次のページをリクエストするトークン。空の文字列の値は、返すリソースが他にないことを示します。

LoggingConfig

LoggingConfig は、さまざまなタイプのログの構成を定義します。

フィールド
default_config

RoutingConfig

他の構成で指定されていないログにデフォルトのルーティング構成を適用する場合に指定します。

fleet_scope_logs_config

RoutingConfig

すべてのフリート スコープのすべてのログにルーティング構成を適用するかどうかを指定します。

MemberConfig

メンバー / クラスタの構成

フィールド
auth_methods[]

MemberConfig.AuthMethod

メンバーは複数の認証方法をサポートできます。

AuthMethod

メンバー / クラスタの認証方法の構成。認証方法(OIDC と LDAP)を 1 つだけ AuthMethod ごとに設定できます。

フィールド
name

string

認証構成の ID。

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 プロバイダに認証リクエストを行う登録済みクライアント アプリケーションの ID。

tenant

string

認証する Azure AD アカウントの種類。サポートされている値は、特定のテナントに属するアカウントの または です。

kubectl_redirect_uri

string

kubectl が認可に使用するリダイレクト URL。

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 サーバーとの通信に使用する接続タイプを定義します。starttls または ldaps が指定されている場合、certificate_authority_data は空にできません。

certificate_authority_data

bytes

省略可。LDAP サーバー用の Base64 エンコードされた PEM 形式の認証局証明書が含まれます。これは、ldaps 接続と startTLS 接続に対して指定する必要があります。

ServiceAccountConfig

ディレクトリで LDAP 検索を実行する権限を持つサービス アカウントの認証情報。認証情報は、DN とパスワード、またはクライアント証明書の組み合わせで指定できます。

フィールド
共用体フィールド authentication_mechanism。ユーザーが一度に 1 つの認証メカニズムを提供することを保証します。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

省略可。認証後にユーザーの ID として使用する属性を指定します。これは、ユーザーがユーザー名を使用してログインできるようにする loginAttribute フィールドとは別のものですが、実際の ID がメールアドレスか完全な識別名(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

kubectl プラグインを使用して OAuth フローを通過するユーザーをリダイレクトする登録済みのリダイレクト URI。

scopes

string

ID のカンマ区切りのリスト。

extra_params

string

Key-Value ペアのカンマ区切りリスト。

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(Common Expression Language、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

この型にはフィールドがありません。

測定機能の空の仕様。Feature proto には仕様が必要であるため、これは必須です。

MeteringFeatureState

測定機能の状態。

フィールド
last_measurement_time

Timestamp

クラスタ内の vCPU 数に関する最新の測定値のタイムスタンプ。

precise_last_measured_cluster_vcpu_capacity

float

最新の測定値に基づくクラスタ内の vCPU 容量(1/1000 の精度)。

MultiClusterIngressFeatureSpec

MultiClusterIngressFeatureSpec には、MultiClusterIngress 機能の入力が含まれています。

フィールド
config_membership

string

MultiClusterIngress CRD をホストする完全修飾メンバー名。メンバー名の例: projects/foo-proj/locations/global/memberships/bar

billing
(deprecated)

Billing

非推奨: このフィールドは無視されるため、設定する必要はありません。お客様の課金体系

MultiClusterIngressFeatureState

この型にはフィールドがありません。

MultiClusterIngressFeatureState には、MultiClusterIngress 機能に固有のステータス フィールドが含まれています。これはプレースホルダです。この機能について報告する状態情報がさらに増えるとフィールドが追加されます。

MultiClusterServiceDiscoveryFeatureSpec

この型にはフィールドがありません。

マルチクラスタ サービス ディスカバリ機能の空の仕様。Feature proto には仕様が必要であるため、これは必須です。

MultiClusterServiceDiscoveryFeatureState

この型にはフィールドがありません。

マルチクラスタ サービス ディスカバリ機能の空の状態。FeatureStateDetails には状態が必要であるため、これは必須です。

OciConfig

単一クラスタの OCI リポジトリ構成

フィールド
sync_repo

string

同期元のパッケージの OCI イメージ リポジトリの URL(例: 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

出力専用。ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の [Operation.error][] 値を持ちます。これは Code.CANCELLED に相当します。

api_version

string

出力専用。オペレーションを開始するために使用された API のバージョン。

OperatorState

ACM のオペレーターの状態に関する情報

フィールド
version

string

オペレーターのセマンティック バージョン番号

deployment_state

DeploymentState

オペレーターのデプロイの状態

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

参照データ同期構成の状態。これは、ユーザーが構成した PoCo のバージョンに応じて、syncSet オブジェクトまたは config オブジェクトのいずれかの状態を表すことができます。

PolicyController

Policy Controller の構成

フィールド
enabled

bool

Policy Controller のインストールを有効にします。false の場合、PolicyController の他のフィールドは無効になります。

exemptable_namespaces[]

string

Policy Controller のチェックから除外される Namespace のセット。Namespace はクラスタに現在存在している必要はありません。

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

Deployment 固有の構成。

フィールド
pod_tolerations[]

PolicyControllerDeploymentConfig.Toleration

ノード taint の Pod の toleration。

pod_affinity

PolicyControllerDeploymentConfig.Affinity

Pod アフィニティの構成。

replica_count

int64

Pod のレプリカ数。

container_resources

ResourceRequirements

コンテナ リソースの要件。

pod_anti_affinity
(deprecated)

bool

Pod のアンチ アフィニティの有効化。非推奨: 代わりに、pod_affinity を使用してください。

アフィニティ

Deployment で使用される Pod アフィニティ構成。

列挙型
AFFINITY_UNSPECIFIED アフィニティ構成が指定されていません。
NO_AFFINITY アフィニティ構成は Deployment から削除されます。
ANTI_AFFINITY この Deployment にはアンチ アフィニティ構成が適用されます。アドミッションのデプロイのデフォルト。

toleration

ノード taint の toleration

フィールド
key

string

taint キーと一致します(必ずしも一意ではありません)。

operator

string

taint 演算子と一致します。

value

string

taint 値と一致します。

effect

string

taint 効果と一致します。

PolicyControllerFeatureSpec

Policy Controller の仕様。

フィールド
membership_specs

map<string, PolicyControllerMembershipSpec>

メンバーシップ ID と個々の仕様のマッピング。

PolicyControllerFeatureState

PolicyController の状態

フィールド
state

PolicyControllerFeatureState.LifecycleState

ハブ機能コントローラによって検出された Policy Controller のライフサイクル全体の状態。

component_states

map<string, OnClusterState>

トラッキングするコンポーネントのクラスタ内の状態。現在、以下が含まれます(マップのキーとしても使用されます)。1. admission 2. audit 3. mutation

policy_content_state

PolicyContentState

ハブ機能コントローラによって監視されるコンテンツの全体的な状態。

LifecycleState

Policy Controller が存在できる状態のセット。

列挙型
LIFECYCLE_STATE_UNSPECIFIED ライフサイクルの状態が指定されていません。
NOT_INSTALLED Policy Controller(PC)は指定されたクラスタに存在せず、PC に関連付けられた任意のタイプの K8s リソースが存在するべきではありません。クラスタが Hub Feature コントローラのメンバーシップを持っていません。
INSTALLING Hub Feature は Membership を持っていますが、Policy Controller はクラスタに完全にインストールされていません。この状態は、ハブがクラスタに PC をインストールするアクションを実行していることを示します。
ACTIVE Policy Controller(PC)がクラスタに完全にインストールされ、動作モードになっています。この状態では、Hub Feature コントローラが PC と状態を調整し、PC はそのソフトウェアごとにオペレーション タスクを実行します。READY 状態に入るには、PC がインストールされ、その Pod が Hub Feature コントローラが想定する PC のバージョンで動作していることをハブが確認する必要があります。
UPDATING Policy Controller(PC)は完全にインストールされていますが、クラスタで実行されているリソースの構成を変更するプロセス(PC のバージョンをアップダウンする、PC のマニフェストを変更するなど)が進行中です。Hub Feature コントローラは Membership を持っており、クラスタが実行されるべきバージョンを認識していますが、PC がそのバージョンで実行されていることを確認していません。
DECOMMISSIONING Policy Controller(PC)にクラスタのリソースがある場合でも、Hub Feature コントローラは Membership の削除を必要としています。Membership は引き続き存在します。
CLUSTER_ERROR Policy Controller(PC)が動作せず、それを動作させるために Hub Feature コントローラが機能しません。クラスタにインストールされている PC が動作していないか、クラスタを管理するように Hub Feature コントローラに対して設定された要件をクラスタが満たしていないが、それでも関連の動作を行うように(「インストール」など)指示が与えられたと PCH が判断した場合に自動的に CLUSTER_ERROR 状態になります。
HUB_ERROR この状態の場合、PC は引き続き動作可能であり、Hub Feature コントローラのみが動作不能になります。ハブは、PC の状態を変更する命令を発行したり、クラスタ内リソースに干渉することはできません。Hub Feature コントローラがハブが正常な状態ではないと判断し、PC やその他のデータの破損を防ぐために引き継ぐことが望ましいと判断した場合、HUB_ERROR 状態に自動的に移行します。
SUSPENDED Policy Controller(PC)はインストールされていますが、一時停止されています。つまり、ポリシーは適用されませんが、違反は(監査を通じて)引き続き記録されます。
DETACHED PoCo Hub がクラスタ オブジェクトを調整するアクションを実行していません。これらのオブジェクトに対する変更は、PoCo Hub によって上書きされません。

PolicyControllerHubConfig

Policy Controller の構成。

フィールド
install_spec

PolicyControllerHubConfig.InstallSpec

install_spec は、機能の状態に報告される Hub 機能コントローラによって検出された機能のライフサイクル状態ではなく、機能仕様の install_spec を変更した最新のリクエストによって指定された意図された状態を表します。

exemptable_namespaces[]

string

Policy Controller のチェックから除外される Namespace のセット。Namespace はクラスタに現在存在している必要はありません。

referential_rules_enabled

bool

現在評価されているオブジェクト以外のオブジェクトを参照する制約テンプレートを使用できるようにします。

log_denies_enabled

bool

すべての拒否とドライランの失敗がロギングされます。

mutation_enabled

bool

Policy Controller を使用してリソースを変更する機能を有効にします。

monitoring

PolicyControllerMonitoringConfig

Monitoring は、モニタリングの構成を指定します。

policy_content

PolicyContentSpec

クラスタに必要なポリシー コンテンツを指定します

deployment_configs

map<string, PolicyControllerDeploymentConfig>

Deployment 構成と Deployment のマッピング(admission、audit、mutation)。

audit_interval_seconds

int64

Policy Controller 監査スキャンの間隔(秒単位)を設定します。0 に設定すると、監査機能が完全に無効になります。

constraint_violation_limit

int64

制約に保存される監査違反の最大数。設定しなかった場合は、内部のデフォルト(現在は 20)が使用されます。

InstallSpec

Hub Feature コントローラが作動させる可能性がある一連のインストール仕様。

列挙型
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 コントローラによるすべての調整アクションを停止するリクエスト。これは、PoCo Hub がクラスタ リソースに影響を与えないようにするためのブレークグラス メカニズムです。

PolicyControllerMembershipSpec

単一クラスタの構成。PolicyController CR と並行して使用することを目的としています。

フィールド
policy_controller_hub_config

PolicyControllerHubConfig

Policy Controller ハブ機能コントローラによって管理されるクラスタの Policy Controller 構成。

version

string

Policy Controller 機能のバージョン。

PolicyControllerMigration

ACM から PoCo Hub への PolicyController の移行の状態。

フィールド
stage

PolicyControllerMigration.Stage

移行の段階。

copy_time

Timestamp

このメンバーシップ仕様が最後に PoCo 機能にコピーされた日時。

ステージ

ステージは、移行のどの段階に ACM ハブがあるのかを示します。

列挙型
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

Gatekeeper Policy Controller が使用しているビルド バージョン。

フィールド
version

string

ACM バージョン、git タグ、ビルド番号で構成されるゲートキーパー イメージタグ。

ResourceList

ResourceList には、コンテナ リソースの要件が含まれています。

フィールド
memory

string

Kubernetes リソース ユニットで表されるメモリ要件。

cpu

string

Kubernetes リソース ユニットで表される CPU 要件。

ResourceRequirements

ResourceRequirements は、コンピューティング リソースの要件を記述します。

フィールド
limits

ResourceList

上限は、実行中のコンテナで使用できるコンピューティング リソースの最大量を表します。

requests

ResourceList

リクエストは、kube-scheduler によってコンテナ用に予約されたコンピューティング リソースの量を示します。

RoutingConfig

RoutingConfig は、フリート ロギング機能の動作を構成します。

フィールド
mode

RoutingConfig.Mode

mode は、ログ ルーティング モードを構成します。

Mode

フリート ロギング機能が有効かどうかを指定します。

列挙型
MODE_UNSPECIFIED UNSPECIFIED の場合、フリート ロギング機能は無効になります。
COPY ログは宛先プロジェクトにコピーされます。
MOVE ログは宛先プロジェクトに移動されます。

ServiceDirectoryFeatureSpec

この型にはフィールドがありません。

Service Directory 機能の空の仕様。Feature proto には仕様が必要であるため、これは必須です。

ServiceDirectoryFeatureState

この型にはフィールドがありません。

Service Directory 機能の空の状態。FeatureStateDetails には状態が必要であるため、これは必須です。

ServiceMeshAnalysisMessage

ServiceMeshAnalysisMessage は、アナライザによって生成される単一のメッセージであり、Service Mesh 構成の状態をエンドユーザーに通知するために使用されます。

フィールド
message_base

ServiceMeshAnalysisMessageBase

Istio と ServiceMesh の分析メッセージのすべてのタイプに共通する詳細。

description

string

エラーの意味を人が読める形式で記述した説明。多言語化されていない表示目的に適しています。

resource_paths[]

string

メッセージ生成の原因となったリソース ID を指定する文字列のリスト。ここでの「パス」は、次のように指定できます。* 原因が特定のメンバー クラスタである場合: MEMBERSHIP_ID * 原因がクラスタ内のリソースである場合: MEMBERSHIP_ID/(NAMESPACE\/)?RESOURCETYPE/NAME

args

Struct

UI は、これらの引数を(message_base.type に基づいて)テンプレートと組み合わせて、多言語化されたメッセージを生成できます。

ServiceMeshAnalysisMessageBase

ServiceMeshAnalysisMessageBase は、すべてのメッセージに必要な共通情報を記述します。

フィールド
type

ServiceMeshAnalysisMessageBase.Type

特定のメッセージ タイプを表します。

level

ServiceMeshAnalysisMessageBase.Level

メッセージの重大度を表します。

documentation_url

string

この特定のエラータイプの Service Mesh または Istio のドキュメントを指す URL。

レベル

ここでの値は、より重大なメッセージが上位に並べ替えられるように選択されています。また、後で追加するために間にスペースが残されています。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 には 1 対 1 のマッピング関係が必要です(つまり、メッセージ タイプ間で 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 には、サービス メッシュ機能の入力が含まれています。

フィールド
membership_specs

map<string, ServiceMeshMembershipSpec>

省略可。メンバーシップのフルパスから個々の構成にマッピングします。

ServiceMeshFeatureState

ServiceMeshFeatureState は、サービス メッシュ ハブ コントローラによって分析されたサービス メッシュ ハブ機能の状態を表します。

フィールド
analysis_messages[]

ServiceMeshAnalysisMessage

出力専用。メンバー クラスタまたはメッシュ全体に対してサービス メッシュ アナライザを実行した結果。

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

サービス メッシュ: servicemesh 機能の単一メンバーシップの仕様

フィールド
control_plane

ServiceMeshMembershipSpec.ControlPlaneManagement

コントロール プレーンの自動管理を有効にします。

management

ServiceMeshMembershipSpec.Management

サービス メッシュの自動管理を有効にします。

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

syncer の状態を示すトークン。

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/* 形式の Feature リソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • gkehub.features.update
update_mask

FieldMask

更新するフィールドのマスク。

resource

Feature

update_mask で指定されたフィールドのみが更新されます。update_mask でフィールドを指定しても、ここで値を指定しないと、そのフィールドは削除されます。マップ フィールドを更新する場合は、キーの値を null または空の文字列に設定して、マップからキーを削除します。キーの値を空の文字列に更新することはできません。

WorkloadCertificateFeatureSpec

WorkloadCertificateFeatureSpec には、Workload Identity プラットフォーム機能の入力が含まれています。Feature proto には仕様が必要であるため、これは必須です。

フィールド
provision_google_ca

WorkloadCertificateFeatureSpec.GoogleCAProvisioning

変更不可。CA 構成を指定します。

default_config

WorkloadCertificateMembershipSpec

デフォルトのメンバーシップ仕様。ユーザーは、メンバーごとに member_configs でデフォルトをオーバーライドできます。

member_configs

map<string, WorkloadCertificateMembershipSpec>

メンバーごとのワークロード証明書の構成。

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 ワークロード証明書機能が有効になります。証明書のプロビジョニング プロセス全体が、デフォルトの CA よりも安全なマネージド CA を使用して Google によって管理されます。
ENABLED_WITH_DEFAULT_CA ワークロード証明書機能が有効になります。証明書のプロビジョニング プロセス全体で無料のデフォルト CA が使用されます。

WorkloadCertificateFeatureState

この型にはフィールドがありません。

WorkloadCertificateFeatureState は、ワークロード証明書機能の状態を表します。FeatureStateDetails には状態が必要であるため、これは必須です。

WorkloadCertificateMembershipSpec

WorkloadCertificateMembershipSpec には、WorkloadCertificate 機能のメンバーシップ固有の入力が含まれています。

フィールド
certificate_management

WorkloadCertificateMembershipSpec.CertificateManagement

ワークロード証明書の管理を指定します。

CertificateManagement

メンバー クラスタでこの機能を有効にするかどうかを指定します。

列挙型
CERTIFICATE_MANAGEMENT_UNSPECIFIED Workload 証明書機能を無効にします。
DISABLED Workload 証明書機能を無効にします。
ENABLED Workload 証明書機能を有効にします。