REST Resource: projects.locations.fleetPackages.rollouts

リソース: Rollout

ロールアウト リソースは、フリート全体での FleetPackage ロールアウト オペレーションのインスタンスを表します。これはシステム生成リソースであり、エンドユーザーは読み取り専用になります。これは主に、サービスが FleetPackage の変更や環境内のその他の変更を処理するために使用されます。

JSON 表現 
{
  "name": string,
  "release": string,
  "rolloutStrategy": {
    object (RolloutStrategy)
  },
  "info": {
    object (RolloutInfo)
  },
  "deletionPropagationPolicy": enum (DeletionPropagationPolicy),
  "createTime": string,
  "updateTime": string
}
フィールド
name

string

ID。Rollout の名前。形式は projects/{project}/locations/{location}/fleetPackages/{fleetPackage}/rollouts/[a-z][a-z0-9\-]{0,62} です。
release

string

ロールアウトされる Release への参照。
rolloutStrategy

object (RolloutStrategy)

クラスタに FleetPackage をロールアウトするためのロールアウト戦略。
info

object (RolloutInfo)

ロールアウトの現在の詳細。
deletionPropagationPolicy

enum (DeletionPropagationPolicy)

ロールアウトの削除伝播ポリシー。
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"。

RolloutInfo

RolloutInfo は、ロールアウトのターゲットとなるすべてのクラスタの FleetPackage の状態を表します。

JSON 表現 
{
  "state": enum (State),
  "startTime": string,
  "endTime": string,
  "message": string,
  "rolloutStrategyInfo": {
    object (RolloutStrategyInfo)
  }
}
フィールド
state

enum (State)

出力専用。State には、ロールアウトの全体的なステータスが含まれます。
startTime

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"。
endTime

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"。
message

string

出力専用。ロールアウトに関連する追加情報を含むメッセージ。
rolloutStrategyInfo

object (RolloutStrategyInfo)

出力専用。ロールアウト戦略情報には、ロールアウト戦略の実行ステータスが表示されます。

状態

ロールアウトの状態

列挙型
STATE_UNSPECIFIED 未指定の状態
COMPLETED ロールアウトが完了しました。
SUSPENDED ロールアウトを一時停止しました。
ABORTED ロールアウトが中止されました。フリート メンバーシップが変更されたか、フリート パッケージが削除されたため、すでに実行中のロールアウトが停止しました。
IN_PROGRESS 現在、提供の準備を進めております。
STALLED ロールアウトが停滞しました。
CANCELLED ロールアウトがキャンセルされました。パッケージ、リリース、バリアントの構成に問題があるため、提案されたロールアウトは最初から無効と見なされたか、実行不可能と見なされました。
ABORTING ロールアウトを中止しています。

RolloutStrategyInfo

RolloutStrategyInfo は、さまざまなタイプのロールアウト戦略の実行ステータスを表します。ロールアウト リソースで指定されたロールアウト戦略に対応するフィールドのみが入力されます。

JSON 表現 
{

  // Union field strategy can be only one of the following:
  "allAtOnceStrategyInfo": {
    object (AllAtOnceStrategyInfo)
  },
  "rollingStrategyInfo": {
    object (RollingStrategyInfo)
  }
  // End of list of possible types for union field strategy.
}
フィールド
共用体フィールド strategy。Strategy は、ロールアウト戦略のいずれかを適用した結果を表します。strategy は次のいずれかになります。
allAtOnceStrategyInfo

object (AllAtOnceStrategyInfo)

AllAtOnceStrategyInfo は、AllAtOnce ロールアウト戦略の実行ステータスを表します。
rollingStrategyInfo

object (RollingStrategyInfo)

RollingStrategyInfo は、ローリング ロールアウト戦略の実行ステータスを表します。

AllAtOnceStrategyInfo

AllAtOnceStrategyInfo は、AllAtOnce ロールアウト戦略の実行ステータスを表します。

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

object (ClusterInfo)

順序なしリスト。すべてのターゲット クラスタのリソース バンドルのデプロイ ステータス。

ClusterInfo

ClusterInfo は、クラスタのリソース バンドル ロールアウトのステータスを表します。

JSON 表現 
{
  "membership": string,
  "desired": {
    object (ResourceBundleDeploymentInfo)
  },
  "initial": {
    object (ResourceBundleDeploymentInfo)
  },
  "current": {
    object (ResourceBundleDeploymentInfo)
  },
  "state": enum (State),
  "messages": [
    string
  ],
  "startTime": string,
  "endTime": string
}
フィールド
membership

string

出力専用。ターゲット クラスタの gkehub メンバーシップ
desired

object (ResourceBundleDeploymentInfo)

出力専用。リソース バンドルの望ましい状態。
initial

object (ResourceBundleDeploymentInfo)

出力専用。デプロイ前のリソース バンドルの初期状態。
current

object (ResourceBundleDeploymentInfo)

出力専用。リソース バンドルの現在の状態。
state

enum (State)

出力専用。クラスタのロールアウトの状態。
messages[]

string

出力専用。順序なしリスト。メッセージには、デプロイに関連する追加情報が伝達されます。
startTime

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"。
endTime

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"。

ResourceBundleDeploymentInfo

ResourceBundleDeploymentInfo は、リソース バンドルのデプロイのステータスを表します。

JSON 表現 
{
  "release": string,
  "version": string,
  "variant": string,
  "syncState": enum (SyncState),
  "messages": [
    string
  ]
}
フィールド
release

string

出力専用。ResourceBundle リリースを参照します。
version

string

出力専用。ResourceBundle リリースのバージョンを指します。
variant

string

出力専用。ResourceBundle リリースのバリアントを指します。
syncState

enum (SyncState)

出力専用。ResourceBundle デプロイの同期状態。
messages[]

string

出力専用。順序なしリスト。メッセージには ResourceBundle デプロイに関連する情報が含まれます。たとえば、エラーが発生した場合は、エラーの理由を示します。デプロイが保留中の場合は、新しいリリースのデプロイが保留中である理由がメッセージに記載されます。

SyncState

リソース バンドル デプロイの同期状態。

列挙型
SYNC_STATE_UNSPECIFIED 未指定の状態
RECONCILING 調整中の状態。
STALLED 停止状態。
SYNCED 同期済みの状態。
PENDING 保留中の状態。
ERROR エラー状態。
DELETION_PENDING 削除保留中の状態。
DELETING 削除中。
DELETED 削除済み状態。

状態

クラスタのロールアウトの状態。

列挙型
STATE_UNSPECIFIED 未指定の状態
WAITING 待機状態。
IN_PROGRESS 進行中の状態。
STALLED 停止状態。
COMPLETED 完了状態。
ABORTED 中止状態。フリート メンバーシップが変更されたか、フリート パッケージが削除されたため、すでに実行中のロールアウトが停止しました。
CANCELLED キャンセルされた状態。パッケージ、リリース、バリアントの構成に問題があるため、提案されたロールアウトは最初から無効と見なされたか、実行不可能と見なされました。
ERROR エラー状態。
UNCHANGED 変更されていない状態。
SKIPPED スキップされた状態。

RollingStrategyInfo

RollingStrategyInfo は、ローリング ロールアウト戦略の実行ステータスを表します。

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

object (ClusterInfo)

順序なしリスト。すべてのターゲット クラスタのリソース バンドルのデプロイ ステータス。

メソッド

abort

 ロールアウトを中止します。

get

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

list

 指定されたプロジェクト、ロケーション、Fleet パッケージの Rollout を一覧表示します。

resume

 ロールアウトを再開します。

suspend

 ロールアウトを一時停止します。