REST Resource: projects.locations.rolloutKinds

リソース: RolloutKind

ロールアウト実行のさまざまな設定を記述するオブジェクト。組み込みポリシーとカスタマイズ可能なポリシーが含まれます。

JSON 表現 
{
  "name": string,
  "unitKind": string,
  "rolloutOrchestrationStrategy": string,
  "maintenancePolicyEnforcement": enum (MaintenancePolicyEnforcement),
  "unitFilter": string,
  "updateUnitKindStrategy": enum (UpdateUnitKindStrategy),
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "errorBudget": {
    object (ErrorBudget)
  }
}
フィールド
name

string

ID。標準の命名スキームに沿ったリソース名（リソースの完全な URI）。

"projects/{project}/locations/{location}/rolloutKinds/{rolloutKindId}"
unitKind

string

必須。変更不可。このロールアウトの種類に対応する UnitKind。このロールアウトの種類から派生するロールアウトは、このユニットの種類のユニットをターゲットにします。つまり、ロールアウトによってアップグレードされるターゲット ユニットの母集団を定義します。
rolloutOrchestrationStrategy

string

省略可。ロールアウトの実行に使用される戦略。これは必須項目です。

制御に使用される 2 つのサポートされている値の戦略があります。- "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime"

これらのシンプルな戦略のいずれかを使用したロールアウトは、関連付けられた UnitKind の Saas Locations で定義されているすべてのロケーションにロールアウトされます。
maintenancePolicyEnforcement

enum (MaintenancePolicyEnforcement)

省略可。strict（メンテナンス ポリシーを適用し、メンテナンス ポリシーが設定されたユニットのみを対象とする）、ignore（メンテナンス ポリシーを無視する）、skip（メンテナンス ポリシーが設定されたユニットをスキップする）のいずれかの値
unitFilter

string

省略可。Unit に対する CEL（https://github.com/google/cel-spec）形式のフィルタ文字列。フィルタが適用され、対象となるユニットの人口が決定されます。このフィルタは、ロールアウトの範囲を縮小することのみが可能で、拡大することはできません。
updateUnitKindStrategy

enum (UpdateUnitKindStrategy)

省略可。ユニットの種類を更新するための構成。デフォルトでは、ロールアウトの開始時にユニットの種類が更新されます。
labels

map (key: string, value: string)

省略可。リソースのラベル。分類に使用できます。Kubernetes リソースラベルに似ています。

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

map (key: string, value: string)

省略可。アノテーションは、任意のメタデータを保存して取得するため、外部ツールによって設定される可能性のあるリソースとともに保存される非構造化 Key-Value マップです。クエリは実行可能ではなく、オブジェクトを変更する際に保持する必要があります。

詳細: https://kubernetes.io/docs/user-guide/annotations

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

string

出力専用。リソースの一意の識別子。UID は、サービスのスコープ内で、このリソースの時間と場所において一意性を持ちます。通常は、リソースの作成時にサーバーによって生成され、変更されることはありません。UID は、リソース名が再利用される場合でも一意にリソースを識別するために使用されます。UUID4 であることが必要です。
etag

string

出力専用。リソースのバージョンまたは世代を一意に識別する、不透明な値です。書き込まれるリソースの順序についてクライアントとサーバーの間で確実に同意するために使用できます。
createTime

string (Timestamp format)

出力専用。リソース作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。リソース最終更新時のタイムスタンプ。ユーザーがリソースを変更した場合は、この値を更新する必要があります。サービスがリソースを変更した場合は、この値を更新する必要があります。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
errorBudget

object (ErrorBudget)

省略可。エラー バジェットの構成。失敗したユニットの数が max(allowedCount, allowed_ratio * totalUnits) を超えると、ロールアウトは一時停止されます。設定しない場合、発生したエラーの数に関係なく、すべてのユニットの更新が試行されます。

MaintenancePolicyEnforcement

メンテナンス ポリシーの適用を定義します。

列挙型
MAINTENANCE_POLICY_ENFORCEMENT_UNSPECIFIED
MAINTENANCE_POLICY_ENFORCEMENT_STRICT
MAINTENANCE_POLICY_ENFORCEMENT_IGNORED
MAINTENANCE_POLICY_ENFORCEMENT_SKIPPED

UpdateUnitKindStrategy

列挙型
UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED 戦略が指定されていません。
UPDATE_UNIT_KIND_STRATEGY_ON_START ロールアウトの開始時にユニット種類の戦略を更新します。
UPDATE_UNIT_KIND_STRATEGY_NEVER ユニットの種類は更新しないでください。

ErrorBudget

エラー バジェットの構成。失敗したユニットの数が max(allowedCount, allowed_ratio * totalUnits) を超えると、ロールアウトは一時停止されます。

JSON 表現 
{
  "allowedCount": integer,
  "allowedPercentage": integer
}
フィールド
allowedCount

integer

省略可。ロールアウトを一時停止せずに、ロケーションで許容される失敗したユニットの最大数。
allowedPercentage

integer

省略可。ロールアウトを一時停止せずに、ロケーション内で障害が発生してもよいユニットの最大割合（0、100]）。

メソッド

create

 新しいロールアウトの種類を作成します。

delete

 1 つのロールアウトの種類を削除します。

get

 単一のロールアウトの種類を取得します。

list

 ロールアウトの種類のコレクションを取得します。

patch

 単一のロールアウトの種類を更新します。