REST Resource: projects.locations.features

リソース: Feature

Feature は、Hub Feature の設定とステータスを表します。

JSON 表現
{
  "name": string,
  "labels": {
    string: string,
    ...
  },
  "resourceState": {
    object (FeatureResourceState)
  },
  "spec": {
    object (CommonFeatureSpec)
  },
  "membershipSpecs": {
    string: {
      object (MembershipFeatureSpec)
    },
    ...
  },
  "state": {
    object (CommonFeatureState)
  },
  "membershipStates": {
    string: {
      object (MembershipFeatureState)
    },
    ...
  },
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "fleetDefaultMemberConfig": {
    object (CommonFleetDefaultMemberConfigSpec)
  },
  "scopeSpecs": {
    string: {
      object (ScopeFeatureSpec)
    },
    ...
  },
  "scopeStates": {
    string: {
      object (ScopeFeatureState)
    },
    ...
  }
}
フィールド
name

string

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

labels

map (key: string, value: string)

この Feature のラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

resourceState

object (FeatureResourceState)

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

spec

object (CommonFeatureSpec)

省略可。Hub 全体の Feature の構成。この Feature が Hub 全体の構成をサポートしていない場合、このフィールドは使用されません。

membershipSpecs

map (key: string, value: object (MembershipFeatureSpec))

省略可。この Feature の Membership 固有の構成。この Feature が Membership ごとの構成をサポートしていない場合、このフィールドは使用されません。

キーは、どの Membership の構成かを示します。形式は次のとおりです。

projects/{p}/locations/{l}/memberships/{m}

ここで、{p} はプロジェクト、{l} は有効なロケーション、{m} はそのロケーションのこのプロジェクトで有効なメンバーシップです。{p} は Feature のプロジェクトと一致します。

{p} は常にプロジェクト番号として返されますが、入力時にプロジェクト ID も使用できます。マップ内で同じ Membership が 2 回(プロジェクト ID 形式とプロジェクト番号形式で)指定されている場合、エントリのうち 1 つだけが保存されます。どちらが保存されるかは保証されません。そのため、Feature を変更する際には、すべてのエントリに同じ形式を使用することをおすすめします。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

state

object (CommonFeatureState)

出力専用。Hub 全体の Feature のステータス。

membershipStates

map (key: string, value: object (MembershipFeatureState))

出力専用。メンバーシップ固有の Feature ステータス。この Feature が Membership ごとのステータスを報告する場合、このフィールドは使用されない可能性があります。

キーは、どの Membership の状態であるかを示します。形式は次のとおりです。

projects/{p}/locations/{l}/memberships/{m}

ここで、{p} はプロジェクト番号、{l} は有効なロケーション、{m} はそのロケーションのこのプロジェクトで有効なメンバーシップです。{p} は、Feature のプロジェクト番号と一致しなければなりません。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

createTime

string (Timestamp format)

出力専用。Feature リソースが作成された日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

deleteTime

string (Timestamp format)

出力専用。Feature リソースが削除された日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

fleetDefaultMemberConfig

object (CommonFleetDefaultMemberConfigSpec)

省略可。フリートのすべてのメンバーシップに適用される Feature 構成。

scopeSpecs

map (key: string, value: object (ScopeFeatureSpec))

省略可。この Feature の Scope 固有の構成。この Feature が Scope ごとの構成をサポートしていない場合、このフィールドは使用されません。

キーは、どの Scope の構成かを示します。形式は次のとおりです。

projects/{p}/locations/global/scopes/{s}

{p} はプロジェクト、{s} はこのプロジェクトの有効な Scope です。{p} は Feature のプロジェクトと一致します。

{p} は常にプロジェクト番号として返されますが、入力時にプロジェクト ID も使用できます。マップ内で同じ Scope が 2 回(プロジェクト ID 形式とプロジェクト番号形式で)指定されている場合、エントリのうち 1 つだけが保存されます。どちらが保存されるかは保証されません。そのため、Feature を変更する際には、すべてのエントリに同じ形式を使用することをおすすめします。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

scopeStates

map (key: string, value: object (ScopeFeatureState))

出力専用。Scope 固有の Feature ステータス。この Feature が Scope ごとのステータスを報告する場合、このフィールドは使用されない可能性があります。

キーは、どの Scope の状態かを示します。形式は次のとおりです。

projects/{p}/locations/global/scopes/{s}

{p} はプロジェクト、{s} はこのプロジェクトの有効な Scope です。{p} は Feature のプロジェクトと一致します。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

FeatureResourceState

FeatureResourceState は、GkeHub API の Feature リソースの状態を表します。Hub と Memberships 全体で Feature の「実行状態」を確認するには、FeatureState をご覧ください。

JSON 表現
{
  "state": enum (FeatureResourceState.State)
}
フィールド
state

enum (FeatureResourceState.State)

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

FeatureResourceState.State

State は、Feature のライフサイクル ステータスを表します。

列挙型
STATE_UNSPECIFIED 状態が不明または未設定です。
ENABLING Feature を有効にして Feature リソースを作成しています。完了すると、この Hub で対応する Feature が有効になります。
ACTIVE この Hub で Feature が有効になり、Feature リソースが完全に利用可能になります。
DISABLING この Hub で Feature を無効にして Feature リソースを削除しています。
UPDATING Feature リソースの更新中です。
SERVICE_UPDATING Hub Service が Feature リソースを更新しています。

CommonFeatureSpec

CommonFeatureSpec には、Hub 全体の構成情報が含まれています

JSON 表現
{

  // Union field feature_spec can be only one of the following:
  "multiclusteringress": {
    object (FeatureSpec)
  },
  "cloudauditlogging": {
    object (FeatureSpec)
  },
  "workloadcertificate": {
    object (FeatureSpec)
  },
  "appdevexperience": {
    object (AppDevExperienceFeatureSpec)
  },
  "anthosobservability": {
    object (AnthosObservabilityFeatureSpec)
  },
  "fleetobservability": {
    object (FeatureSpec)
  },
  "namespaceactuation": {
    object (FeatureSpec)
  },
  "clusterupgrade": {
    object (FleetSpec)
  },
  "dataplanev2": {
    object (FeatureSpec)
  }
  // End of list of possible types for union field feature_spec.
}
フィールド

共用体フィールド feature_spec

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

multiclusteringress

object (FeatureSpec)

マルチクラスタ Ingress 固有の仕様。

cloudauditlogging

object (FeatureSpec)

Cloud Audit Logging 固有の仕様。

workloadcertificate

object (FeatureSpec)

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

appdevexperience

object (AppDevExperienceFeatureSpec)

Appdevexperience 固有の仕様。

anthosobservability

object (AnthosObservabilityFeatureSpec)

Anthos Observability の仕様

fleetobservability

object (FeatureSpec)

FleetObservability 機能の使用

namespaceactuation

object (FeatureSpec)

Namespace Actuation 機能の仕様

clusterupgrade

object (FleetSpec)

ClusterUpgrade(フリートベース)機能の仕様。

dataplanev2

object (FeatureSpec)

DataplaneV2 機能の仕様。

FeatureSpec

マルチクラスタ Ingress: MultiClusterIngress 機能の構成。

JSON 表現
{
  "configMembership": string,
  "billing": enum (Billing)
}
フィールド
configMembership

string

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

billing
(deprecated)

enum (Billing)

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

請求

非推奨: FeatureSpec.billing フィールドは使用されなくなりました。Billing は、お客様が使用している課金構造を表します。

列挙型
BILLING_UNSPECIFIED 不明
PAY_AS_YOU_GO ユーザーはエンドポイントごとに料金を支払います。
ANTHOS_LICENSE ユーザーは Anthos 全体に対して支払いを行います。

FeatureSpec

Cloud Audit Logging: 監査ロギング許可リストの仕様。

JSON 表現
{
  "allowlistedServiceAccounts": [
    string
  ]
}
フィールド
allowlistedServiceAccounts[]

string

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

FeatureSpec

ワークロード証明書: WorkloadCertificate 機能に対する Hub 全体の入力。

JSON 表現
{
  "provisionGoogleCa": enum (FeatureSpec.GoogleCAProvisioning),
  "defaultConfig": {
    object (MembershipSpec)
  }
}
フィールド
provisionGoogleCa

enum (FeatureSpec.GoogleCAProvisioning)

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

defaultConfig

object (MembershipSpec)

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

FeatureSpec.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 が使用されます。

MembershipSpec

ワークロード証明書: WorkloadCertificate 機能に対するメンバーシップ固有の入力。

JSON 表現
{
  "certificateManagement": enum (MembershipSpec.CertificateManagement)
}
フィールド
certificateManagement

enum (MembershipSpec.CertificateManagement)

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

MembershipSpec.CertificateManagement

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

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

AnthosObservabilityFeatureSpec

Anthos Observability: 仕様

JSON 表現
{
  "defaultMembershipSpec": {
    object (AnthosObservabilityMembershipSpec)
  }
}
フィールド
defaultMembershipSpec

object (AnthosObservabilityMembershipSpec)

未構成のメンバーシップに対するデフォルトのメンバーシップ仕様

AnthosObservabilityMembershipSpec

Anthosobservability: Membership ごとの Feature 仕様。

JSON 表現
{
  "enableStackdriverOnApplications": boolean,
  "doNotOptimizeMetrics": boolean,
  "version": string
}
フィールド
enableStackdriverOnApplications

boolean

ユーザーアプリからの指標とログの収集とレポートを有効にします。

doNotOptimizeMetrics

boolean

最適化された指標ではなく、すべての指標を使用します。https://cloud.google.com/anthos/clusters/docs/on-prem/1.8/concepts/logging-and-monitoring#optimized_metrics_default_metrics をご覧ください。

version

string

この機能で使用される Stackdriver オペレーターのバージョン

FeatureSpec

フリート オブザーバビリティ: FleetObservability 機能の Hub 全体の入力。

JSON 表現
{
  "loggingConfig": {
    object (LoggingConfig)
  }
}
フィールド
loggingConfig

object (LoggingConfig)

フリート全体でフリート ロギング機能を有効にするかどうかを指定します。UNSPECIFIED の場合、フリート全体でフリート ロギング機能が無効になります。

LoggingConfig

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

JSON 表現
{
  "defaultConfig": {
    object (RoutingConfig)
  },
  "fleetScopeLogsConfig": {
    object (RoutingConfig)
  }
}
フィールド
defaultConfig

object (RoutingConfig)

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

fleetScopeLogsConfig

object (RoutingConfig)

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

RoutingConfig

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

JSON 表現
{
  "mode": enum (RoutingConfig.Mode)
}
フィールド
mode

enum (RoutingConfig.Mode)

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

RoutingConfig.Mode

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

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

FeatureSpec

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

JSON 表現
{
  "actuationMode": enum (FeatureSpec.ActuationMode)
}
フィールド
actuationMode

enum (FeatureSpec.ActuationMode)

actuationMode はコントローラの動作を制御します

FeatureSpec.ActuationMode

ActuationMode はコントローラの動作を制御します

列挙型
ACTUATION_MODE_UNSPECIFIED ACTUATION_MODE_UNSPECIFIED は、デフォルトのコントローラの動作における CREATE_AND_DELETE_IF_CREATED に似ています。
ACTUATION_MODE_CREATE_AND_DELETE_IF_CREATED ACTUATION_MODE_CREATE_AND_DELETE_IF_CREATED では、コントローラはフリートの Namespace ごとにクラスタの Namespace を作成し、ラベルで識別される作成した Namespace のみを削除します。
ACTUATION_MODE_ADD_AND_REMOVE_FLEET_LABELS ACTUATION_MODE_ADD_AND_REMOVE_FLEET_LABELS では、コントローラはフリートの Namespace の有効化を通知するために、クラスタの Namespace にのみラベルを適用します。クラスタの Namespace は作成も削除もされません。

FleetSpec

ClusterUpgrade: フリートレベルの ClusterUpgrade 機能の構成。

JSON 表現
{
  "upstreamFleets": [
    string
  ],
  "postConditions": {
    object (PostConditions)
  },
  "gkeUpgradeOverrides": [
    {
      object (GKEUpgradeOverride)
    }
  ]
}
フィールド
upstreamFleets[]

string

このフリートは、アップストリーム フリートでステータス コードが COMPLETE のアップグレードを使用します。コードの定義については、UpgradeStatus.Code をご覧ください。

フリート名は、フリート プロジェクトの番号または ID にする必要があります。

これは、将来の証明のために繰り返されるものとして定義されています。最初の実装では、最大で 1 つのアップストリーム フリートが適用されます。

postConditions

object (PostConditions)

必須。アップグレードを COMPLETE としてマークするために評価する後処理条件。必須。

gkeUpgradeOverrides[]

object (GKEUpgradeOverride)

ユーザーが GKE アップグレードの一部のプロパティをオーバーライドできるようにします。

PostConditions

アップグレードがすべての対象クラスタに適用された後の後処理条件のチェック。

JSON 表現
{
  "soaking": string
}
フィールド
soaking

string (Duration format)

必須。ロールアウトが完了してから COMPLETE とマークするまでの期間。30 日を超えることはできません。 必須。

s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

GKEUpgradeOverride

ユーザーがオーバーライドできる GKE アップグレードのプロパティ。たとえば、soaking を 0 にオーバーライドすることで、ソーク処理をスキップできます。

JSON 表現
{
  "upgrade": {
    object (GKEUpgrade)
  },
  "postConditions": {
    object (PostConditions)
  }
}
フィールド
upgrade

object (GKEUpgrade)

必須。どのアップグレードをオーバーライドするか。必須。

postConditions

object (PostConditions)

必須。指定されたアップグレード(名前 + バージョン)のオーバーライドの後処理条件。必須。

GKEUpgrade

GKEUpgrade は、GKE が提供するアップグレード(コントロール プレーンのアップグレードなど)を表します。

JSON 表現
{
  "name": string,
  "version": string
}
フィールド
name

string

アップグレードの名前(例: 「k8s_control_plane」)。有効なアップグレードの名前にする必要があります。99 文字以内で指定してください。

version

string

アップグレードのバージョン(例: 「1.22.1-gke.100」)。有効なバージョンである必要があります。99 文字以内で指定してください。

FeatureSpec

Dataplane V2: 仕様

JSON 表現
{
  "enableEncryption": boolean
}
フィールド
enableEncryption

boolean

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

MembershipFeatureSpec

MembershipFeatureSpec には、単一の Membership の構成情報が含まれています。注: 機能名にはスネークケースを使用してください。

JSON 表現
{
  "origin": {
    object (MembershipFeatureSpec.Origin)
  },

  // Union field feature_spec can be only one of the following:
  "configmanagement": {
    object (MembershipSpec)
  },
  "cloudbuild": {
    object (MembershipSpec)
  },
  "identityservice": {
    object (MembershipSpec)
  },
  "workloadcertificate": {
    object (MembershipSpec)
  },
  "mesh": {
    object (MembershipSpec)
  },
  "anthosobservability": {
    object (AnthosObservabilityMembershipSpec)
  },
  "policycontroller": {
    object (MembershipSpec)
  },
  "fleetobservability": {
    object (MembershipSpec)
  },
  "namespaceactuation": {
    object (MembershipSpec)
  }
  // End of list of possible types for union field feature_spec.
}
フィールド
origin

object (MembershipFeatureSpec.Origin)

この Membership ごとの仕様が、フリート単位のデフォルトから継承されたかどうか。このフィールドは、ユーザーが Membership 構成をオーバーライドするか(暗黙的に USER に更新)、明示的に FLEET に設定することで更新できます。

共用体フィールド feature_spec

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

configmanagement

object (MembershipSpec)

Config Management 固有の仕様。

cloudbuild

object (MembershipSpec)

Cloud Build 固有の仕様

identityservice

object (MembershipSpec)

Identity Service 固有の仕様。

workloadcertificate

object (MembershipSpec)

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

mesh

object (MembershipSpec)

Anthos Service Mesh 固有の仕様

anthosobservability

object (AnthosObservabilityMembershipSpec)

Anthos Observability 固有の仕様

policycontroller

object (MembershipSpec)

Policy Controller の仕様。

fleetobservability

object (MembershipSpec)

フリート オブザーバビリティ メンバーシップの仕様

namespaceactuation

object (MembershipSpec)

FNS Actuation メンバーシップの仕様

MembershipSpec

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

JSON 表現
{
  "configSync": {
    object (ConfigSync)
  },
  "policyController": {
    object (PolicyController)
  },
  "binauthz": {
    object (BinauthzConfig)
  },
  "hierarchyController": {
    object (HierarchyControllerConfig)
  },
  "version": string,
  "cluster": string
}
フィールド
configSync

object (ConfigSync)

クラスタの Config Sync 構成。

policyController

object (PolicyController)

クラスタの Policy Controller 構成。

binauthz
(deprecated)

object (BinauthzConfig)

クラスタの Binauthz 構成。非推奨: このフィールドは無視されるため、設定する必要はありません。

hierarchyController

object (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 で、クラスタのフリート メンバーシップ名とは異なる名前が使用されている場合は、このフィールドを設定します。

ConfigSync

Config Sync の構成

JSON 表現
{
  "git": {
    object (GitConfig)
  },
  "sourceFormat": string,
  "preventDrift": boolean,
  "oci": {
    object (OciConfig)
  },
  "allowVerticalScale": boolean,
  "metricsGcpServiceAccountEmail": string,
  "enabled": boolean
}
フィールド
git

object (GitConfig)

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

sourceFormat

string

Config Sync リポジトリが「階層」モードと「非構造化」モードのどちらであるかを指定します。

preventDrift

boolean

Config Sync アドミッション Webhook を有効にしてブレを防止するには、true に設定します。false に設定されている場合、Config Sync アドミッション Webhook を無効にして、ブレを防止しません。

oci

object (OciConfig)

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

allowVerticalScale
(deprecated)

boolean

垂直方向のスケーリングを許可するには、true に設定します。デフォルトの値は false であり、垂直方向のスケーリングは許可されません。このフィールドは非推奨になりました。

metricsGcpServiceAccountEmail

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

boolean

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

GitConfig

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

JSON 表現
{
  "syncRepo": string,
  "syncBranch": string,
  "policyDir": string,
  "syncWaitSecs": string,
  "syncRev": string,
  "secretType": string,
  "httpsProxy": string,
  "gcpServiceAccountEmail": string
}
フィールド
syncRepo

string

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

syncBranch

string

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

policyDir

string

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

syncWaitSecs

string (int64 format)

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

syncRev

string

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

secretType

string

Git リポジトリへのアクセスのために構成された Secret のタイプ。ssh、cookiefile、gcenode、token、gcpserviceaccount、none のいずれかにする必要があります。この検証では大文字と小文字が区別されます。必須。

httpsProxy

string

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

gcpServiceAccountEmail

string

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

OciConfig

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

JSON 表現
{
  "syncRepo": string,
  "policyDir": string,
  "syncWaitSecs": string,
  "secretType": string,
  "gcpServiceAccountEmail": string
}
フィールド
syncRepo

string

同期元のパッケージの OCI イメージ リポジトリの URL(例: LOCATION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME/PACKAGE_NAME)。

policyDir

string

ローカル リソースを格納するディレクトリの絶対パス。デフォルトはイメージのルート ディレクトリです。

syncWaitSecs

string (int64 format)

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

secretType

string

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

gcpServiceAccountEmail

string

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

PolicyController

Policy Controller の構成

JSON 表現
{
  "enabled": boolean,
  "exemptableNamespaces": [
    string
  ],
  "referentialRulesEnabled": boolean,
  "logDeniesEnabled": boolean,
  "mutationEnabled": boolean,
  "monitoring": {
    object (PolicyControllerMonitoring)
  },
  "updateTime": string,
  "templateLibraryInstalled": boolean,
  "auditIntervalSeconds": string
}
フィールド
enabled

boolean

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

exemptableNamespaces[]

string

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

referentialRulesEnabled

boolean

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

logDeniesEnabled

boolean

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

mutationEnabled

boolean

Policy Controller でミューテーションを有効または無効にします。true の場合は、ミューテーション CRD、Webhook、コントローラのデプロイがクラスタにデプロイされます。

monitoring

object (PolicyControllerMonitoring)

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

updateTime

string (Timestamp format)

出力専用。このメンバーシップの仕様が最後に更新された日時。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

templateLibraryInstalled

boolean

Policy Controller とともにデフォルトのテンプレート ライブラリをインストールします。

auditIntervalSeconds

string (int64 format)

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

PolicyControllerMonitoring

PolicyControllerMonitoring は、Policy Controller が指標をエクスポートするバックエンドを指定します。たとえば、Cloud Monitoring と Prometheus にエクスポートする指標を指定するには、["cloudmonitoring", "prometheus"] というバックエンドを指定します。

JSON 表現
{
  "backends": [
    enum (PolicyControllerMonitoring.MonitoringBackend)
  ]
}
フィールド
backends[]

enum (PolicyControllerMonitoring.MonitoringBackend)

Policy Controller がエクスポートするバックエンドのリストを指定します。リストが空の場合、指標のエクスポートは実質的に無効になります。

PolicyControllerMonitoring.MonitoringBackend

モニタリングでサポートされているバックエンド オプション

列挙型
MONITORING_BACKEND_UNSPECIFIED バックエンドを特定できない
PROMETHEUS モニタリング用の Prometheus バックエンド
CLOUD_MONITORING モニタリング用の Stackdriver / Cloud Monitoring バックエンド

BinauthzConfig

Binauthz の構成

JSON 表現
{
  "enabled": boolean
}
フィールド
enabled

boolean

このクラスタで binauthz が有効であるかどうか。

HierarchyControllerConfig

Hierarchy Controller の構成

JSON 表現
{
  "enabled": boolean,
  "enablePodTreeLabels": boolean,
  "enableHierarchicalResourceQuota": boolean
}
フィールド
enabled

boolean

このクラスタで Hierarchy Controller が有効であるかどうか。

enablePodTreeLabels

boolean

このクラスタで Pod ツリーラベルが有効になっているかどうか。

enableHierarchicalResourceQuota

boolean

このクラスタで階層型リソース割り当てが有効かどうか。

MembershipSpec

Cloud Build: Cloud Build 対応クラスタごとの構成。

JSON 表現
{
  "version": string,
  "securityPolicy": enum (MembershipSpec.SecurityPolicy)
}
フィールド
version

string

クラスタ上の Cloud Build ソフトウェアのバージョン。

securityPolicy

enum (MembershipSpec.SecurityPolicy)

クラスタで特権ビルドを実行できるかどうか。

MembershipSpec.SecurityPolicy

クラスタに適用できるさまざまなセキュリティ ポリシー。

列挙型
SECURITY_POLICY_UNSPECIFIED ポリシーは未指定
NON_PRIVILEGED 特権ビルド Pod が許可されていない
PRIVILEGED 特権ビルド Pod が許可されている

MembershipSpec

Anthos Identity Service: 単一のメンバーシップの構成。

JSON 表現
{
  "authMethods": [
    {
      object (MembershipSpec.AuthMethod)
    }
  ]
}
フィールド
authMethods[]

object (MembershipSpec.AuthMethod)

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

MembershipSpec.AuthMethod

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

JSON 表現
{
  "name": string,
  "proxy": string,

  // Union field auth_config can be only one of the following:
  "oidcConfig": {
    object (MembershipSpec.AuthMethod.OidcConfig)
  },
  "azureadConfig": {
    object (MembershipSpec.AuthMethod.AzureADConfig)
  },
  "googleConfig": {
    object (MembershipSpec.AuthMethod.GoogleConfig)
  }
  // End of list of possible types for union field auth_config.
}
フィールド
name

string

認証構成の ID。

proxy

string

認証方法に使用するプロキシ サーバーのアドレス。

共用体フィールド auth_config。サポートされている認証構成。auth_config は次のいずれかになります。
oidcConfig

object (MembershipSpec.AuthMethod.OidcConfig)

OIDC 固有の構成。

azureadConfig

object (MembershipSpec.AuthMethod.AzureADConfig)

AzureAD 固有の構成。

googleConfig

object (MembershipSpec.AuthMethod.GoogleConfig)

GoogleConfig 固有の構成。

MembershipSpec.AuthMethod.OidcConfig

OIDC 認証フローの構成。

JSON 表現
{
  "clientId": string,
  "certificateAuthorityData": string,
  "issuerUri": string,
  "kubectlRedirectUri": string,
  "scopes": string,
  "extraParams": string,
  "userClaim": string,
  "userPrefix": string,
  "groupsClaim": string,
  "groupPrefix": string,
  "deployCloudConsoleProxy": boolean,
  "clientSecret": string,
  "encryptedClientSecret": string,
  "enableAccessToken": boolean
}
フィールド
clientId

string

OIDC クライアント アプリケーションの ID。

certificateAuthorityData

string

OIDC プロバイダの PEM エンコード CA。

issuerUri

string

OIDC プロバイダの URI。これは .well-known/openid-configuration の下位のレベルを指す必要があります。

kubectlRedirectUri

string

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

scopes

string

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

extraParams

string

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

userClaim

string

ユーザー名を保持する OIDC ID トークンのクレーム。

userPrefix

string

ユーザー名の先頭に付加する接頭辞。

groupsClaim

string

グループ情報を保持する OIDC ID トークンのクレーム。

groupPrefix

string

グループ名の先頭に付加する接頭辞。

deployCloudConsoleProxy

boolean

認証プロバイダへの接続にリバース プロキシが使用されるかどうかを示すフラグ。このフラグは、プロバイダに Google Cloud コンソールからアクセスできない場合に true に設定する必要があります。

clientSecret

string

入力のみの暗号化されていない OIDC クライアント シークレットが GKE Hub CLH に渡されます。

encryptedClientSecret

string (bytes format)

出力専用。暗号化された OIDC クライアント シークレット

Base64 でエンコードされた文字列。

enableAccessToken

boolean

アクセス トークンを有効にします。

MembershipSpec.AuthMethod.AzureADConfig

AzureAD 認証フローの構成。

JSON 表現
{
  "clientId": string,
  "tenant": string,
  "kubectlRedirectUri": string,
  "clientSecret": string,
  "encryptedClientSecret": string
}
フィールド
clientId

string

Azure AD ID プロバイダに認証リクエストを行う登録済みクライアント アプリケーションの ID。

tenant

string

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

kubectlRedirectUri

string

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

clientSecret

string

入力のみの暗号化されていない AzureAD クライアント シークレットが GKE Hub CLH に渡されます。

encryptedClientSecret

string (bytes format)

出力専用。暗号化された AzureAD クライアント シークレット。

Base64 でエンコードされた文字列。

MembershipSpec.AuthMethod.GoogleConfig

Google プラグイン認証フローの構成。

JSON 表現
{
  "disable": boolean
}
フィールド
disable

boolean

サポートされているプラットフォームで Google プラグインの自動構成を無効にします。

MembershipSpec

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

JSON 表現
{
  "controlPlane": enum (MembershipSpec.ControlPlaneManagement),
  "defaultChannel": enum (Channel),
  "management": enum (MembershipSpec.Management)
}
フィールド
controlPlane
(deprecated)

enum (MembershipSpec.ControlPlaneManagement)

非推奨: 代わりに management を使用してください。コントロール プレーンの自動管理を有効にします。

defaultChannel

enum (Channel)

デフォルトのインジェクションとサービス メッシュ API に使用するリリース チャンネルを決定します。

management

enum (MembershipSpec.Management)

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

MembershipSpec.ControlPlaneManagement

サービス メッシュ コントロール プレーンを自動的に管理するかどうか。

列挙型
CONTROL_PLANE_MANAGEMENT_UNSPECIFIED 未指定
AUTOMATIC Google が、コントロール プレーン リビジョンをプロビジョニングし、クラスタで使用できるようにします。Google はこのリビジョンをリリース チャンネルに登録し、最新の状態に保ちます。コントロール プレーンのリビジョンは、マネージド サービスまたはマネージド インストールのいずれかです。
MANUAL ユーザーがコントロール プレーンを手動で構成します(CLI または ControlPlaneRevision KRM API を使用)。

チャネル

チャンネルは、リビジョンが登録されているリリース チャンネルを示します。リリース チャンネルはリスクの順に並べられています。

列挙型
CHANNEL_UNSPECIFIED 未指定
RAPID RAPID チャンネルは、新しいリリースのテストを希望されるお客様向けに、早期アクセスベースでリリースを提供するサービスです。
REGULAR REGULAR チャンネルは、新機能を活用したいと考える本番環境のユーザーを対象としています。
STABLE STABLE チャンネルには、本番環境で安定性と信頼性があることが確認されているバージョンが含まれます。

MembershipSpec.Management

サービス メッシュを自動的に管理するかどうか。

列挙型
MANAGEMENT_UNSPECIFIED 未指定
MANAGEMENT_AUTOMATIC クラスタのサービス メッシュを Google が管理します。
MANAGEMENT_MANUAL ユーザーがサービス メッシュ コンポーネントを手動で構成します。

MembershipSpec

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

JSON 表現
{
  "policyControllerHubConfig": {
    object (HubConfig)
  },
  "version": string
}
フィールド
policyControllerHubConfig

object (HubConfig)

クラスタの Policy Controller 構成。

version

string

インストールされている Policy Controller のバージョン。

HubConfig

Policy Controller の構成

JSON 表現
{
  "installSpec": enum (HubConfig.InstallSpec),
  "exemptableNamespaces": [
    string
  ],
  "referentialRulesEnabled": boolean,
  "logDeniesEnabled": boolean,
  "mutationEnabled": boolean,
  "deploymentConfigs": {
    string: {
      object (PolicyControllerDeploymentConfig)
    },
    ...
  },
  "auditIntervalSeconds": string,
  "monitoring": {
    object (MonitoringConfig)
  },
  "policyContent": {
    object (PolicyContentSpec)
  },
  "constraintViolationLimit": string
}
フィールド
installSpec

enum (HubConfig.InstallSpec)

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

exemptableNamespaces[]

string

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

referentialRulesEnabled

boolean

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

logDeniesEnabled

boolean

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

mutationEnabled

boolean

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

deploymentConfigs

map (key: string, value: object (PolicyControllerDeploymentConfig))

デプロイ構成とデプロイ(mutation、audit、mutation)のマッピング。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

auditIntervalSeconds

string (int64 format)

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

monitoring

object (MonitoringConfig)

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

policyContent

object (PolicyContentSpec)

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

constraintViolationLimit

string (int64 format)

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

HubConfig.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 がクラスタ リソースに影響を与えないようにするためのブレークグラス メカニズムです。

MonitoringConfig

MonitoringConfig は、Policy Controller が指標をエクスポートするバックエンドを指定します。たとえば、Cloud Monitoring と Prometheus にエクスポートする指標を指定するには、["cloudmonitoring", "prometheus"] というバックエンドを指定します。

JSON 表現
{
  "backends": [
    enum (MonitoringConfig.MonitoringBackend)
  ]
}
フィールド
backends[]

enum (MonitoringConfig.MonitoringBackend)

Policy Controller がエクスポートするバックエンドのリストを指定します。リストが空の場合、指標のエクスポートは実質的に無効になります。

MonitoringConfig.MonitoringBackend

モニタリングでサポートされているバックエンド オプション

列挙型
MONITORING_BACKEND_UNSPECIFIED バックエンドを特定できない
PROMETHEUS モニタリング用の Prometheus バックエンド
CLOUD_MONITORING モニタリング用の Stackdriver / Cloud Monitoring バックエンド

PolicyContentSpec

PolicyContentSpec は、クラスタ上のユーザーの目的のコンテンツ構成を定義します。

JSON 表現
{
  "bundles": {
    string: {
      object (BundleInstallSpec)
    },
    ...
  },
  "templateLibrary": {
    object (TemplateLibraryConfig)
  }
}
フィールド
bundles

map (key: string, value: object (BundleInstallSpec))

バンドル名から BundleInstallSpec へのマップ。バンドル名は、制約の policycontroller.gke.io/constraintData アノテーションの bundleName キーにマッピングされます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

templateLibrary

object (TemplateLibraryConfig)

テンプレート ライブラリのインストールを構成します。

BundleInstallSpec

BundleInstallSpec は、単一のマネージド バンドルの仕様構成です。

JSON 表現
{
  "exemptedNamespaces": [
    string
  ]
}
フィールド
exemptedNamespaces[]

string

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

TemplateLibraryConfig

インストールするデフォルトのライブラリ テンプレートを指定する構成。

JSON 表現
{
  "installation": enum (TemplateLibraryConfig.Installation)
}
フィールド
installation

enum (TemplateLibraryConfig.Installation)

テンプレート ライブラリをクラスタにインストールする方法を構成します。

TemplateLibraryConfig.Installation

テンプレート ライブラリのインストール方法

列挙型
INSTALLATION_UNSPECIFIED インストール戦略が指定されていません。
NOT_INSTALLED テンプレート ライブラリをインストールしません。
ALL テンプレート ライブラリ全体をインストールします。

PolicyControllerDeploymentConfig

Deployment 固有の構成。

JSON 表現
{
  "podTolerations": [
    {
      object (PolicyControllerDeploymentConfig.Toleration)
    }
  ],
  "podAffinity": enum (PolicyControllerDeploymentConfig.Affinity),
  "replicaCount": string,
  "containerResources": {
    object (ResourceRequirements)
  },
  "podAntiAffinity": boolean
}
フィールド
podTolerations[]

object (PolicyControllerDeploymentConfig.Toleration)

Node Taints の Pod の toleration。

podAffinity

enum (PolicyControllerDeploymentConfig.Affinity)

Pod アフィニティの構成。

replicaCount

string (int64 format)

Pod のレプリカ数。

containerResources

object (ResourceRequirements)

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

podAntiAffinity
(deprecated)

boolean

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

ResourceRequirements

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

JSON 表現
{
  "limits": {
    object (ResourceList)
  },
  "requests": {
    object (ResourceList)
  }
}
フィールド
limits

object (ResourceList)

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

requests

object (ResourceList)

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

ResourceList

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

JSON 表現
{
  "memory": string,
  "cpu": string
}
フィールド
memory

string

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

cpu

string

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

PolicyControllerDeploymentConfig.Toleration

Node Taints の toleration

JSON 表現
{
  "key": string,
  "operator": string,
  "value": string,
  "effect": string
}
フィールド
key

string

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

operator

string

taint 演算子と一致します。

value

string

taint 値と一致します。

effect

string

taint 効果と一致します。

PolicyControllerDeploymentConfig.Affinity

デプロイメントで使用される Pod アフィニティ構成。

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

MembershipSpec

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

FleetObservability: FleetObservability 機能のメンバーシップ固有の入力。

MembershipSpec

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

Namespace Actuation: NamespaceActuation 機能のメンバーシップ固有の入力。

MembershipFeatureSpec.Origin

Origin は、この MembershipFeatureSpec のオリジンを定義します。

JSON 表現
{
  "type": enum (MembershipFeatureSpec.Origin.Type)
}
フィールド
type

enum (MembershipFeatureSpec.Origin.Type)

Type は、どのタイプのオリジンが設定されているかを指定します。

MembershipFeatureSpec.Origin.Type

Type は、構成を永続化したペルソナを指定します。

列挙型
TYPE_UNSPECIFIED タイプが不明または未設定です。
FLEET Membership ごとの仕様がフリートレベルのデフォルトから継承されました。
FLEET_OUT_OF_SYNC Membership ごとの仕様は、フリートレベルのデフォルトから継承されていましたが、現在のデフォルトと同期されなくなりました。
USER Membership ごとの仕様がユーザー仕様から継承されました。

CommonFeatureState

CommonFeatureState には、Hub 全体の Feature のステータス情報が含まれます。

JSON 表現
{
  "state": {
    object (FeatureState)
  },

  // Union field feature_state can be only one of the following:
  "servicemesh": {
    object (FeatureState)
  },
  "appdevexperience": {
    object (AppDevExperienceFeatureState)
  },
  "fleetobservability": {
    object (FeatureState)
  },
  "namespaceactuation": {
    object (FeatureState)
  },
  "clusterupgrade": {
    object (FleetState)
  }
  // End of list of possible types for union field feature_state.
}
フィールド
state

object (FeatureState)

出力専用。この Hub の Feature の「実行状態」。

共用体フィールド feature_state

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

servicemesh

object (FeatureState)

サービス メッシュ固有の状態。

appdevexperience

object (AppDevExperienceFeatureState)

Appdevexperience 固有の状態。

fleetobservability

object (FeatureState)

FleetObservability 機能の状態。

namespaceactuation

object (FeatureState)

Namespace Actuation 機能の状態。

clusterupgrade

object (FleetState)

ClusterUpgrade フリートレベルの状態。

FeatureState

サービス メッシュ: サービス メッシュ Hub Controller によって分析された Hub 全体の状態。

JSON 表現
{
  "analysisMessages": [
    {
      object (AnalysisMessage)
    }
  ]
}
フィールド
analysisMessages[]

object (AnalysisMessage)

出力専用。Service Mesh アナライザの実行結果。

AnalysisMessage

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

JSON 表現
{
  "messageBase": {
    object (AnalysisMessageBase)
  },
  "description": string,
  "resourcePaths": [
    string
  ],
  "args": {
    object
  }
}
フィールド
messageBase

object (AnalysisMessageBase)

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

description

string

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

resourcePaths[]

string

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

args

object (Struct format)

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

AnalysisMessageBase

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

JSON 表現
{
  "type": {
    object (AnalysisMessageBase.Type)
  },
  "level": enum (AnalysisMessageBase.Level),
  "documentationUrl": string
}
フィールド
type

object (AnalysisMessageBase.Type)

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

level

enum (AnalysisMessageBase.Level)

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

documentationUrl

string

この特定のエラータイプのサービス メッシュまたは Istio のドキュメントを指す URL。

AnalysisMessageBase.Type

メッセージの種類に関する固有識別子。display_name は人間が判読できるように、code は機械が判読できるようにすることを意図しています。displayName と code には 1 対 1 のマッピング関係が必要です(つまり、メッセージ タイプ間で display_name や code を再利用しないでください)。istio.analysis.v1alpha1.AnalysisMessageBase.Type を参照

JSON 表現
{
  "displayName": string,
  "code": string
}
フィールド
displayName

string

人が読める形式のメッセージ タイプ名。例: 「InternalError」、「PodMissingProxy」。これは、同じタイプのすべてのメッセージで同じであることが必要です(これは、オープンソースの Istio の name フィールドに対応します)。

code

string

^IST[0-9]{4}$ または ^ASM[0-9]{4}$ に一致する 7 文字のコード。メッセージ タイプを一意に識別するために使用します(例: 「IST0001」は「InternalError」メッセージ タイプにマッピングされます)。

AnalysisMessageBase.Level

ここでの値は、より重大なメッセージが上位に並べ替えられるように選択されています。また、後で追加するためのスペースが間に残されています。istio.analysis.v1alpha1.AnalysisMessageBase.Level を参照してください。

列挙型
LEVEL_UNSPECIFIED 不正。同じ istio.analysis.v1alpha1.AnalysisMessageBase.Level.UNKNOWN。
ERROR ERROR は、修正が必要な構成ミスを表します。
WARNING WARNING は、修正すべき構成ミスを表します。
INFO INFO は情報に関する検出結果を表します。

FeatureState

FleetObservability: FleetObservability 機能の Hub 全体の機能の状態。

JSON 表現
{
  "logging": {
    object (FleetObservabilityLoggingState)
  },
  "monitoring": {
    object (FleetObservabilityMonitoringState)
  }
}
フィールド
logging

object (FleetObservabilityLoggingState)

デフォルトのロギングの機能の状態。

monitoring

object (FleetObservabilityMonitoringState)

フリート モニタリングの機能の状態。

FleetObservabilityLoggingState

ロギング機能の機能の状態。

JSON 表現
{
  "defaultLog": {
    object (FleetObservabilityBaseFeatureState)
  },
  "scopeLog": {
    object (FleetObservabilityBaseFeatureState)
  }
}
フィールド
defaultLog

object (FleetObservabilityBaseFeatureState)

フリートのデフォルトログの機能の基本状態。

scopeLog

object (FleetObservabilityBaseFeatureState)

フリート スコープログの機能の基本状態。

FleetObservabilityBaseFeatureState

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

JSON 表現
{
  "code": enum (FleetObservabilityBaseFeatureState.Code),
  "errors": [
    {
      object (FleetObservabilityBaseFeatureState.FeatureError)
    }
  ]
}
フィールド
code

enum (FleetObservabilityBaseFeatureState.Code)

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

errors[]

object (FleetObservabilityBaseFeatureState.FeatureError)

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

FleetObservabilityBaseFeatureState.Code

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

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

FleetObservabilityBaseFeatureState.FeatureError

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

JSON 表現
{
  "code": string,
  "description": string
}
フィールド
code

string

エラーのコード。

description

string

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

FleetObservabilityMonitoringState

モニタリング機能の機能状態。

JSON 表現
{
  "state": {
    object (FleetObservabilityBaseFeatureState)
  }
}
フィールド
state

object (FleetObservabilityBaseFeatureState)

フリート モニタリング機能の基本状態。

FeatureState

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

NamespaceActuation 機能の状態。

FleetState

ClusterUpgrade: フリートレベルの ClusterUpgrade 機能の状態。

JSON 表現
{
  "downstreamFleets": [
    string
  ],
  "ignored": {
    string: {
      object (IgnoredMembership)
    },
    ...
  },
  "gkeState": {
    object (GKEUpgradeFeatureState)
  }
}
フィールド
downstreamFleets[]

string

upstreamFleets に現在のフリートが含まれているフリート。

フリート名は、フリート プロジェクトの番号または ID にする必要があります。

ignored

map (key: string, value: object (IgnoredMembership))

この機能で無視されるメンバーシップのリスト。たとえば、手動でアップグレードされたクラスタが、リリース チャンネルのデフォルト バージョンより新しい場合、これらのクラスタは無視されます。メンバーシップ リソースの形式は projects/{p}/locations/{l}/membership/{m} です。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

gkeState

object (GKEUpgradeFeatureState)

GKE クラスタの機能の状態。

IgnoredMembership

IgnoredMembership は、機能によって無視されるメンバーシップを表します。メンバーシップは、RC のデフォルトより新しいバージョンに手動でアップグレードされたため、無視できます。

JSON 表現
{
  "reason": string,
  "ignoredTime": string
}
フィールド
reason

string

メンバーシップが無視される理由。

ignoredTime

string (Timestamp format)

メンバーシップが初めて無視に設定された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

GKEUpgradeFeatureState

GKEUpgradeFeatureState には、スコープ内の GKE クラスタの機能の状態が含まれます。

JSON 表現
{
  "upgradeState": [
    {
      object (GKEUpgradeState)
    }
  ],
  "conditions": [
    {
      object (GKEUpgradeFeatureCondition)
    }
  ]
}
フィールド
upgradeState[]

object (GKEUpgradeState)

アップグレードの状態。最終的に state を置き換えます。

conditions[]

object (GKEUpgradeFeatureCondition)

機能の現在の状態。

GKEUpgradeState

GKEUpgradeState は、スコープおよびフリートレベルの GKEUpgrade とその状態です。

JSON 表現
{
  "stats": {
    string: string,
    ...
  },
  "upgrade": {
    object (GKEUpgrade)
  },
  "status": {
    object (UpgradeStatus)
  }
}
フィールド
stats

map (key: string, value: string (int64 format))

各ステータス コードの GKE クラスタ数。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

upgrade

object (GKEUpgrade)

状態を追跡するアップグレード。

status

object (UpgradeStatus)

アップグレードのステータス。

UpgradeStatus

UpgradeStatus は、アップグレードごとのステータス情報を提供します。

JSON 表現
{
  "code": enum (UpgradeStatus.Code),
  "reason": string,
  "updateTime": string
}
フィールド
code

enum (UpgradeStatus.Code)

アップグレードのステータス コード。

reason

string

このステータスの理由。

updateTime

string (Timestamp format)

ステータスが最後に更新された時間のタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

UpgradeStatus.Code

アップグレードのステータス コード。

列挙型
CODE_UNSPECIFIED https://linter.aip.dev/126/unspecified で必須。
INELIGIBLE アップグレードは対象外です。スコープレベルでは、スコープ内のすべてのクラスタでアップグレードが無効であることを意味します。
PENDING アップグレードが保留中です。スコープレベルでは、スコープ内のすべてのクラスタでアップグレードが保留中であることを意味します。
IN_PROGRESS アップグレードが進行中です。スコープレベルでは、スコープ内の少なくとも 1 つのクラスタでアップグレードが進行中であることを意味します。
SOAKING アップグレードが完了し、ソーク時間が経過するまでソーク処理が行われます。スコープレベルでは、少なくとも 1 つのクラスタがソーク処理中の状態にあり、残りのクラスタの状態はソーク処理中または完了していることを意味します。
FORCED_SOAKING 実際のステータスにかかわらず、アップグレードが一定の制限内に完了しない場合、クラスタは強制的にソーク処理に入ります。
COMPLETE アップグレードがすべての後処理条件(ソーク処理条件)を満たしました。スコープレベルでは、対象となるすべてのクラスタが COMPLETE ステータスであることを意味します。

GKEUpgradeFeatureCondition

GKEUpgradeFeatureCondition は、特定の時点での GKE クラスタの機能の状態を表します。

JSON 表現
{
  "type": string,
  "status": string,
  "reason": string,
  "updateTime": string
}
フィールド
type

string

条件のタイプ(「ready」など)。

status

string

条件のステータス(True、False、Unknown のいずれか)。

reason

string

機能がこのステータスになっている理由。

updateTime

string (Timestamp format)

条件が最後に更新された時点のタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

FeatureState

FeatureState は、Feature の状態を概要レベルで表します。コンテキストに応じて、環境レベルまたはメンバーショップごとに Feature の状態を記述するために使用できます。

JSON 表現
{
  "code": enum (FeatureState.Code),
  "description": string,
  "updateTime": string
}
フィールド
code

enum (FeatureState.Code)

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

description

string

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

updateTime

string (Timestamp format)

このステータスとそれに関連する Feature 固有の詳細が更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

FeatureState.Code

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

列挙型
CODE_UNSPECIFIED 不明または未設定。
OK Feature は正常に動作しています。
WARNING Feature で問題が発生し、性能が低下した状態で動作しています。Feature を通常の動作に戻すための介入が必要になる場合があります。詳しくは、説明と関連する Feature 固有の詳細をご覧ください。
ERROR Feature が動作していないか、著しく性能が低下した状態になっています。Feature を通常の動作に戻すための介入が必要になる場合があります。詳しくは、説明と関連する Feature 固有の詳細をご覧ください。

MembershipFeatureState

MembershipFeatureState には、単一の Membership に関する Feature のステータス情報が含まれます。

JSON 表現
{
  "state": {
    object (FeatureState)
  },

  // Union field feature_state can be only one of the following:
  "servicemesh": {
    object (MembershipState)
  },
  "metering": {
    object (MembershipState)
  },
  "configmanagement": {
    object (MembershipState)
  },
  "identityservice": {
    object (MembershipState)
  },
  "appdevexperience": {
    object (AppDevExperienceFeatureState)
  },
  "policycontroller": {
    object (MembershipState)
  },
  "clusterupgrade": {
    object (MembershipState)
  },
  "fleetobservability": {
    object (MembershipState)
  },
  "namespaceactuation": {
    object (MembershipState)
  }
  // End of list of possible types for union field feature_state.
}
フィールド
state

object (FeatureState)

単一メンバーシップに対するこの Feature の概要ステータス。

共用体フィールド feature_state

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

servicemesh

object (MembershipState)

サービス メッシュ固有の状態。

metering

object (MembershipState)

測定固有の状態。

configmanagement

object (MembershipState)

Config Management 固有の状態。

identityservice

object (MembershipState)

Identity Service 固有の状態。

appdevexperience

object (AppDevExperienceFeatureState)

Appdevexperience 固有の状態。

policycontroller

object (MembershipState)

Policycontroller 固有の状態。

clusterupgrade

object (MembershipState)

ClusterUpgrade の状態。

fleetobservability

object (MembershipState)

フリート オブザーバビリティのメンバーシップ ステータス。

namespaceactuation

object (MembershipState)

FNS Actuation のメンバーシップ ステータス

MembershipState

Service Mesh: Service Mesh Hub Controller によって分析された単一のメンバーシップの状態。

JSON 表現
{
  "analysisMessages": [
    {
      object (AnalysisMessage)
    }
  ],
  "controlPlaneManagement": {
    object (MembershipState.ControlPlaneManagement)
  },
  "dataPlaneManagement": {
    object (MembershipState.DataPlaneManagement)
  },
  "configApiVersion": string
}
フィールド
analysisMessages[]

object (AnalysisMessage)

出力専用。Service Mesh アナライザの実行結果。

controlPlaneManagement

object (MembershipState.ControlPlaneManagement)

出力専用。コントロール プレーン管理のステータス

dataPlaneManagement

object (MembershipState.DataPlaneManagement)

出力専用。データプレーン管理のステータス。

configApiVersion

string

このクラスタでサービス メッシュを構成するための API バージョン(Istio CRD バージョン)。このバージョンは defaultChannel フィールドの影響を受けます。

MembershipState.ControlPlaneManagement

コントロール プレーン管理のステータス。

JSON 表現
{
  "details": [
    {
      object (StatusDetails)
    }
  ],
  "state": enum (MembershipState.LifecycleState)
}
フィールド
details[]

object (StatusDetails)

状態の説明。

state

enum (MembershipState.LifecycleState)

コントロール プレーン管理の LifecycleState。

StatusDetails

構造化された、人間が読める形式のステータスの詳細。

JSON 表現
{
  "code": string,
  "details": string
}
フィールド
code

string

広範なステータスをさらに詳しく説明する、機械可読コード。

details

string

人が読める形式のコード説明。

MembershipState.LifecycleState

サービス メッシュ コンポーネントのライフサイクル状態。

列挙型
LIFECYCLE_STATE_UNSPECIFIED 未指定
DISABLED DISABLED はコンポーネントが有効になっていないことを表します。
FAILED_PRECONDITION FAILED_PRECONDITION は、メンバークラスタの特性によりプロビジョニングを続行できないことを表します。
PROVISIONING PROVISIONING は、プロビジョニングが進行中であることを表します。
ACTIVE ACTIVE は、コンポーネントが使用可能であることを表します。
STALLED STALLED は、プロビジョニングが完了しなかったことを表します。
NEEDS_ATTENTION NEEDS_ATTENTION は、コンポーネントは準備ができているものの、ユーザーの介入が必要であることを表します(例: ユーザーがワークロードを新しいコントロール プレーンのリビジョンに移行する必要がある)。
DEGRADED DEGRADED は、コンポーネントは準備ができているものの、性能が低下した状態で動作していることを表します。

MembershipState.DataPlaneManagement

データプレーン管理のステータス。メンバーごとにのみ報告されます。

JSON 表現
{
  "state": enum (MembershipState.LifecycleState),
  "details": [
    {
      object (StatusDetails)
    }
  ]
}
フィールド
state

enum (MembershipState.LifecycleState)

データプレーン管理のライフサイクル ステータス。

details[]

object (StatusDetails)

ステータスの説明。

MembershipState

Metering: Membership ごとの Feature の状態。

JSON 表現
{
  "lastMeasurementTime": string,
  "preciseLastMeasuredClusterVcpuCapacity": number
}
フィールド
lastMeasurementTime

string (Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

preciseLastMeasuredClusterVcpuCapacity

number

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

MembershipState

Anthos Config Management: 単一クラスタの状態。

JSON 表現
{
  "clusterName": string,
  "membershipSpec": {
    object (MembershipSpec)
  },
  "operatorState": {
    object (OperatorState)
  },
  "configSyncState": {
    object (ConfigSyncState)
  },
  "policyControllerState": {
    object (PolicyControllerState)
  },
  "binauthzState": {
    object (BinauthzState)
  },
  "hierarchyControllerState": {
    object (HierarchyControllerState)
  }
}
フィールド
clusterName

string

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

membershipSpec

object (MembershipSpec)

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

operatorState

object (OperatorState)

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

configSyncState

object (ConfigSyncState)

現在の同期ステータス

policyControllerState

object (PolicyControllerState)

PolicyController のステータス

binauthzState

object (BinauthzState)

Binauthz のステータス

hierarchyControllerState

object (HierarchyControllerState)

Hierarchy Controller のステータス

OperatorState

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

JSON 表現
{
  "version": string,
  "deploymentState": enum (DeploymentState),
  "errors": [
    {
      object (InstallError)
    }
  ]
}
フィールド
version

string

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

deploymentState

enum (DeploymentState)

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

errors[]

object (InstallError)

インストール エラー。

DeploymentState

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

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

InstallError

ACM のインストールに関するエラー

JSON 表現
{
  "errorMessage": string
}
フィールド
errorMessage

string

ユーザーに表示されるエラー メッセージを表す文字列

ConfigSyncState

ConfigSync の状態に関する情報

JSON 表現
{
  "version": {
    object (ConfigSyncVersion)
  },
  "deploymentState": {
    object (ConfigSyncDeploymentState)
  },
  "syncState": {
    object (SyncState)
  },
  "errors": [
    {
      object (ConfigSyncError)
    }
  ]
}
フィールド
version

object (ConfigSyncVersion)

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

deploymentState

object (ConfigSyncDeploymentState)

ConfigSync のデプロイに関する情報(デプロイされた各種 Pod のバージョンなど)

syncState

object (SyncState)

構成をクラスタに同期する ConfigSync のプロセスの状態

errors[]

object (ConfigSyncError)

Config Sync のインストールに関連するエラー。

ConfigSyncVersion

ConfigSync の Pod に関連する特定のバージョニング情報

JSON 表現
{
  "importer": string,
  "syncer": string,
  "gitSync": string,
  "monitor": string,
  "reconcilerManager": string,
  "rootReconciler": string,
  "admissionWebhook": string
}
フィールド
importer

string

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

syncer

string

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

gitSync

string

デプロイされた git-sync Pod のバージョン

monitor

string

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

reconcilerManager

string

デプロイされた reconciler-manager Pod のバージョン

rootReconciler

string

root-reconciler Pod にデプロイされた reconciler コンテナのバージョン

admissionWebhook

string

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

ConfigSyncDeploymentState

クラスタでの ConfigSync のデプロイの状態

JSON 表現
{
  "importer": enum (DeploymentState),
  "syncer": enum (DeploymentState),
  "gitSync": enum (DeploymentState),
  "monitor": enum (DeploymentState),
  "reconcilerManager": enum (DeploymentState),
  "rootReconciler": enum (DeploymentState),
  "admissionWebhook": enum (DeploymentState)
}
フィールド
importer

enum (DeploymentState)

importer Pod のデプロイ状態

syncer

enum (DeploymentState)

syncer Pod のデプロイ状態

gitSync

enum (DeploymentState)

git-sync Pod のデプロイ状態

monitor

enum (DeploymentState)

monitor Pod のデプロイ状態

reconcilerManager

enum (DeploymentState)

reconciler-manager Pod のデプロイ状態

rootReconciler

enum (DeploymentState)

root-reconciler のデプロイ状態

admissionWebhook

enum (DeploymentState)

admission-webhook のデプロイ状態

SyncState

ACM がクラスタに構成を同期する処理の進行状況を示す状態

JSON 表現
{
  "sourceToken": string,
  "importToken": string,
  "syncToken": string,
  "lastSync": string,
  "lastSyncTime": string,
  "code": enum (SyncState.SyncCode),
  "errors": [
    {
      object (SyncError)
    }
  ]
}
フィールド
sourceToken

string

リポジトリの状態を示すトークン。

importToken

string

インポータの状態を示すトークン。

syncToken

string

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

lastSync
(deprecated)

string

非推奨: 代わりに lastSyncTime を使用してください。ACM がリポジトリを最後に正常に同期した日時のタイムスタンプ。時刻形式は https://golang.org/pkg/time/#Time.String で指定されています。

lastSyncTime

string (Timestamp format)

ACM がリポジトリを最後に正常に同期した日時のタイムスタンプ タイプ

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

code

enum (SyncState.SyncCode)

同期ステータス コード

errors[]

object (SyncError)

問題のある構成に起因するエラーのリスト。このリストでは 100 個を超えた後のエラーは切り捨てられますが、これほど多くのエラーが同時に存在する可能性は低いと考えられます。

SyncState.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 クラスタに到達できなかった

SyncError

構成の同期に関する問題を表す ACM が作成したエラー

JSON 表現
{
  "code": string,
  "errorMessage": string,
  "errorResources": [
    {
      object (ErrorResource)
    }
  ]
}
フィールド
code

string

ACM が定義したエラーコード

errorMessage

string

エラーの説明

errorResources[]

object (ErrorResource)

エラーに関連付けられている構成のリスト(存在する場合)

ErrorResource

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

JSON 表現
{
  "sourcePath": string,
  "resourceName": string,
  "resourceNamespace": string,
  "resourceGvk": {
    object (GroupVersionKind)
  }
}
フィールド
sourcePath

string

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

resourceName

string

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

resourceNamespace

string

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

resourceGvk

object (GroupVersionKind)

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

GroupVersionKind

Kubernetes オブジェクトの GVK

JSON 表現
{
  "group": string,
  "version": string,
  "kind": string
}
フィールド
group

string

Kubernetes グループ

version

string

Kubernetes のバージョン

kind

string

Kubernetes の種類

ConfigSyncError

Config Sync のインストールに関するエラー

JSON 表現
{
  "errorMessage": string
}
フィールド
errorMessage

string

ユーザーに表示されるエラー メッセージを表す文字列

PolicyControllerState

PolicyControllerState の状態。

JSON 表現
{
  "version": {
    object (PolicyControllerVersion)
  },
  "deploymentState": {
    object (GatekeeperDeploymentState)
  },
  "migration": {
    object (PolicyControllerMigration)
  }
}
フィールド
version

object (PolicyControllerVersion)

デプロイされた Gatekeeper Policy Controller のバージョン。

deploymentState

object (GatekeeperDeploymentState)

Policy Controller のインストールの状態。

migration

object (PolicyControllerMigration)

この機能の ACM から PoCo Hub への移行の状態を記録します。

PolicyControllerVersion

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

JSON 表現
{
  "version": string
}
フィールド
version

string

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

GatekeeperDeploymentState

Policy Controller のインストールの状態。

JSON 表現
{
  "gatekeeperControllerManagerState": enum (DeploymentState),
  "gatekeeperAudit": enum (DeploymentState),
  "gatekeeperMutation": enum (DeploymentState)
}
フィールド
gatekeeperControllerManagerState

enum (DeploymentState)

gatekeeper-controller-manager Pod のステータス。

gatekeeperAudit

enum (DeploymentState)

gatekeeper-audit Deployment のステータス。

gatekeeperMutation

enum (DeploymentState)

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

PolicyControllerMigration

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

JSON 表現
{
  "stage": enum (PolicyControllerMigration.Stage),
  "copyTime": string
}
フィールド
stage

enum (PolicyControllerMigration.Stage)

移行の段階。

copyTime

string (Timestamp format)

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

PolicyControllerMigration.Stage

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

列挙型
STAGE_UNSPECIFIED 移行の状態が不明です。
ACM_MANAGED ACM Hub / Operator は policycontroller を管理します。移行が完了していません。
POCO_MANAGED すべての移行手順が完了し、Poco Hub が policycontroller を管理するようになりました。

BinauthzState

Binauthz の状態

JSON 表現
{
  "webhook": enum (DeploymentState),
  "version": {
    object (BinauthzVersion)
  }
}
フィールド
webhook

enum (DeploymentState)

binauthz Webhook の状態。

version

object (BinauthzVersion)

インストールされている binauthz のバージョン。

BinauthzVersion

binauthz のバージョン。

JSON 表現
{
  "webhookVersion": string
}
フィールド
webhookVersion

string

binauthz Webhook のバージョン。

HierarchyControllerState

Hierarchy Controller の状態

JSON 表現
{
  "version": {
    object (HierarchyControllerVersion)
  },
  "state": {
    object (HierarchyControllerDeploymentState)
  }
}
フィールド
version

object (HierarchyControllerVersion)

Hierarchy Controller のバージョン

state

object (HierarchyControllerDeploymentState)

Hierarchy Controller のデプロイ状態

HierarchyControllerVersion

Hierarchy Controller のバージョン

JSON 表現
{
  "hnc": string,
  "extension": string
}
フィールド
hnc

string

オープンソース HNC のバージョン

extension

string

Hierarchy Controller 拡張機能のバージョン

HierarchyControllerDeploymentState

Hierarchy Controller のデプロイ状態

JSON 表現
{
  "hnc": enum (DeploymentState),
  "extension": enum (DeploymentState)
}
フィールド
hnc

enum (DeploymentState)

オープンソース HNC のデプロイ状態(例: v0.7.0-hc.0)

extension

enum (DeploymentState)

Hierarchy Controller 拡張機能のデプロイ状態(v0.7.0-hc.1 など)

MembershipState

Anthos Identity Service: 単一 Membership の状態。

JSON 表現
{
  "installedVersion": string,
  "state": enum (MembershipState.DeploymentState),
  "failureReason": string,
  "memberConfig": {
    object (MembershipSpec)
  }
}
フィールド
installedVersion

string

インストールされている AIS のバージョン。これは、このメンバーにインストールされている AIS のバージョンです。値は、状態が OK の場合に意味を持ちます。

state

enum (MembershipState.DeploymentState)

このメンバーのデプロイ状態

failureReason

string

失敗の理由。

memberConfig

object (MembershipSpec)

最後に調整されたメンバーシップ構成

MembershipState.DeploymentState

デプロイ状態の列挙型

列挙型
DEPLOYMENT_STATE_UNSPECIFIED 未指定の状態
OK デプロイ成功
ERROR エラーによる失敗。

MembershipState

Policy Controller: 単一クラスタの状態。

JSON 表現
{
  "componentStates": {
    string: {
      object (OnClusterState)
    },
    ...
  },
  "state": enum (MembershipState.LifecycleState),
  "policyContentState": {
    object (PolicyContentState)
  }
}
フィールド
componentStates

map (key: string, value: object (OnClusterState))

現在、以下が含まれます(マップのキーとしても使用されます)。1. admission 2. audit 3. mutation

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

state

enum (MembershipState.LifecycleState)

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

policyContentState

object (PolicyContentState)

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

OnClusterState

OnClusterState は、Policy Controller のサブコンポーネントの状態を表します。

JSON 表現
{
  "state": enum (MembershipState.LifecycleState),
  "details": string
}
フィールド
state

enum (MembershipState.LifecycleState)

このコンポーネントのライフサイクルの状態。

details

string

潜在的なエラーや情報ログを表示します。

MembershipState.LifecycleState

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

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

PolicyContentState

Policy Controller ポリシー コンテンツの状態

JSON 表現
{
  "templateLibraryState": {
    object (OnClusterState)
  },
  "bundleStates": {
    string: {
      object (OnClusterState)
    },
    ...
  },
  "referentialSyncConfigState": {
    object (OnClusterState)
  }
}
フィールド
templateLibraryState

object (OnClusterState)

テンプレート ライブラリの状態

bundleStates

map (key: string, value: object (OnClusterState))

選択したバージョンのマニフェストに含まれるバンドルの状態

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

referentialSyncConfigState

object (OnClusterState)

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

MembershipState

この機能のメンバーシップごとの状態。

JSON 表現
{
  "upgrades": [
    {
      object (MembershipGKEUpgradeState)
    }
  ],
  "scopes": [
    string
  ],
  "ignored": {
    object (IgnoredMembership)
  }
}
フィールド
upgrades[]

object (MembershipGKEUpgradeState)

実際のアップグレード状態と望ましい状態。

scopes[]

string

このクラスタがバインドされている完全修飾スコープ名。ロールアウト シーケンスも有効になっています。

ignored

object (IgnoredMembership)

このメンバーシップが機能で無視されるかどうか。たとえば、手動でアップグレードされたクラスタが、リリース チャンネルのデフォルト バージョンより新しい場合、これらのクラスタは無視されます。

MembershipGKEUpgradeState

ScopeGKEUpgradeState は、GKEUpgrade とその状態(メンバーシップごと)です。

JSON 表現
{
  "upgrade": {
    object (GKEUpgrade)
  },
  "status": {
    object (UpgradeStatus)
  }
}
フィールド
upgrade

object (GKEUpgrade)

状態を追跡するアップグレード。

status

object (UpgradeStatus)

アップグレードのステータス。

MembershipState

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

FleetObservability: fleetobservability の Membership 固有の Feature の状態。

MembershipState

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

Namespace Actuation: メンバーシップ固有の Feature 状態の例として残されている空の状態。

CommonFleetDefaultMemberConfigSpec

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

JSON 表現
{

  // Union field feature_spec can be only one of the following:
  "mesh": {
    object (MembershipSpec)
  },
  "configmanagement": {
    object (MembershipSpec)
  },
  "identityservice": {
    object (MembershipSpec)
  },
  "policycontroller": {
    object (MembershipSpec)
  }
  // End of list of possible types for union field feature_spec.
}
フィールド

共用体フィールド feature_spec

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

mesh

object (MembershipSpec)

Anthos Service Mesh 固有の仕様

configmanagement

object (MembershipSpec)

Config Management 固有の仕様。

identityservice

object (MembershipSpec)

Identity Service 固有の仕様。

policycontroller

object (MembershipSpec)

Policy Controller の仕様。

ScopeFeatureSpec

ScopeFeatureSpec には、フリート スコープの機能仕様が含まれています。

JSON 表現
{

  // Union field feature_spec can be only one of the following:
  "clusterupgrade": {
    object (ScopeSpec)
  }
  // End of list of possible types for union field feature_spec.
}
フィールド

共用体フィールド feature_spec

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

clusterupgrade

object (ScopeSpec)

スコープレベルの ClusterUpgrade 機能の仕様

ScopeSpec

ClusterUpgrade: スコープレベルの ClusterUpgrade 機能の構成。

JSON 表現
{
  "upstreamScopes": [
    string
  ],
  "postConditions": {
    object (PostConditions)
  },
  "gkeUpgradeOverrides": [
    {
      object (GKEUpgradeOverride)
    }
  ]
}
フィールド
upstreamScopes[]

string

このスコープは、アップストリーム スコープでステータス コードが COMPLETE のアップグレードを使用します。コードの定義については、UpgradeStatus.Code をご覧ください。

スコープ名は次の形式にする必要があります。

projects/{p}/locations/global/scopes/{s}

{p} はプロジェクト、{s} はこのプロジェクトの有効な Scope です。{p} は Feature のプロジェクトと一致します。

これは、将来の証明のために繰り返されるものとして定義されています。最初の実装では、最大で 1 つのアップストリーム スコープが適用されます。

postConditions

object (PostConditions)

必須。アップグレードを COMPLETE としてマークするために評価する後処理条件。必須。

gkeUpgradeOverrides[]

object (GKEUpgradeOverride)

ユーザーが GKE アップグレードの一部のプロパティをオーバーライドできるようにします。

ScopeFeatureState

ScopeFeatureState には、Scope 全体の Feature のステータス情報が含まれます。

JSON 表現
{
  "state": {
    object (FeatureState)
  },

  // Union field feature_state can be only one of the following:
  "clusterupgrade": {
    object (ScopeState)
  }
  // End of list of possible types for union field feature_state.
}
フィールド
state

object (FeatureState)

出力専用。この Scope の Feature の「実行状態」。

共用体フィールド feature_state

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

clusterupgrade

object (ScopeState)

スコープレベルでの ClusterUpgrade 機能の状態

ScopeState

ClusterUpgrade: スコープレベルの ClusterUpgrade 機能の状態。

JSON 表現
{
  "downstreamScopes": [
    string
  ],
  "ignored": {
    string: {
      object (IgnoredMembership)
    },
    ...
  },
  "gkeState": {
    object (GKEUpgradeFeatureState)
  }
}
フィールド
downstreamScopes[]

string

upstreamScopes に現在のスコープが含まれるスコープ。

スコープ名は次の形式にする必要があります。

projects/{p}/locations/gloobal/scopes/{s}

{p} はプロジェクト、{s} はこのプロジェクトの有効な Scope です。{p} は Feature のプロジェクトと一致します。

ignored

map (key: string, value: object (IgnoredMembership))

この機能で無視されるメンバーシップのリスト。たとえば、手動でアップグレードされたクラスタが、リリース チャンネルのデフォルト バージョンより新しい場合、これらのクラスタは無視されます。メンバーシップ リソースの形式は projects/{p}/locations/{l}/membership/{m} です。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

gkeState

object (GKEUpgradeFeatureState)

GKE クラスタの機能の状態。

メソッド

create

新しい Feature を追加します。

delete

Feature を削除します。

get

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

getIamPolicy

リソースのアクセス制御ポリシーを取得します。

list

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

patch

既存の Feature を更新します。

setIamPolicy

指定したリソースにアクセス制御ポリシーを設定します。

testIamPermissions

指定されたリソースに対して呼び出し元が持っている権限を返します。