REST Resource: projects.locations.rolloutKinds

Ressource: RolloutKind

Ein Objekt, das verschiedene Einstellungen für die Ausführung des Rollouts beschreibt. Enthält integrierte und anpassbare Richtlinien.

JSON-Darstellung
{
  "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)
  }
}
Felder
name

string

ID. Der Ressourcenname (vollständiger URI der Ressource) gemäß dem Standardbenennungsschema:

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

unitKind

string

Erforderlich. Nicht veränderbar. Die UnitKind, der diese Roll-out-Art entspricht. Roll-outs, die auf dieser Roll-out-Art basieren, werden auf die Einheiten dieser Art ausgerichtet. Mit anderen Worten: Hier wird die Gruppe der Zielgeräte definiert, die durch Roll-outs aktualisiert werden sollen.

rolloutOrchestrationStrategy

string

Optional. Die Strategie, die zum Ausführen eines Roll‑outs verwendet wird. Dies ist ein erforderliches Feld.

Es gibt zwei unterstützte Wertestrategien, mit denen die Steuerung erfolgt: „Google.Cloud.Simple.AllAtOnce“ und „Google.Cloud.Simple.OneLocationAtATime“.

Bei einem Roll-out mit einer dieser einfachen Strategien erfolgt der Roll-out an allen Standorten, die in den SaaS-Standorten der zugehörigen UnitKind definiert sind.

maintenancePolicyEnforcement

enum (MaintenancePolicyEnforcement)

Optional. Wert für „strict“ (Wartungsrichtlinie erzwingen und nur Einheiten mit Wartungsrichtlinie berücksichtigen), „ignore“ (Wartungsrichtlinie ignorieren) und „skip“ (Einheiten mit Wartungsrichtlinie überspringen)

unitFilter

string

Optional. CEL-formatierter Filterstring(https://github.com/google/cel-spec) für die Einheit. Der Filter wird angewendet, um die infrage kommende Einheitenpopulation zu ermitteln. Mit diesem Filter kann der Umfang des Roll-outs nur verringert, nicht aber erweitert werden.

updateUnitKindStrategy

enum (UpdateUnitKindStrategy)

Optional. Die Konfiguration zum Aktualisieren der Art der Einheit. Standardmäßig wird die Art der Einheit beim Start des Roll‑outs aktualisiert.

labels

map (key: string, value: string)

Optional. Die Labels der Ressource, die zur Kategorisierung verwendet werden können, ähnlich wie Kubernetes-Ressourcenlabels.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

annotations

map (key: string, value: string)

Optional. „Annotations“ ist eine unstrukturierte Schlüssel/Wert-Zuordnung, die mit einer Ressource gespeichert wird und von externen Tools festgelegt werden kann, um beliebige Metadaten zu speichern und abzurufen. Sie können nicht abgefragt werden und sollten beim Ändern von Objekten beibehalten werden.

Weitere Informationen: https://kubernetes.io/docs/user-guide/annotations

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

uid

string

Nur Ausgabe. Die eindeutige Kennzeichnung der Ressource. Die UID gilt zeitlich und räumlich im Rahmen des Dienstes nur für diese eine Ressource. Sie wird in der Regel nach dem Erstellen der Ressource vom Server generiert und darf nicht geändert werden. Die UID dient dazu, Ressourcen, deren Namen wiederverwendet werden, eindeutig zu kennzeichnen. Dies sollte eine UUID4 sein.

etag

string

Nur Ausgabe. Ein opaker Wert, der eine Version oder Generation einer Ressource eindeutig kennzeichnet. Damit kann bestätigt werden, dass Client und Server der Reihenfolge einer Ressource, die gerade geschrieben wird, zustimmen.

createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource zuletzt aktualisiert wurde. Wenn Nutzer Änderungen an der Ressource vornehmen, muss dieser Wert aktualisiert werden. Gleiches gilt bei Änderungen an der Ressource durch den Dienst.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

errorBudget

object (ErrorBudget)

Optional. Die Konfiguration für das Fehlerbudget. Wenn die Anzahl der fehlgeschlagenen Einheiten max(allowedCount, allowed_ratio * totalUnits) überschreitet, wird die Einführung pausiert. Wenn nicht festgelegt, wird versucht, alle Einheiten zu aktualisieren, unabhängig von der Anzahl der aufgetretenen Fehler.

MaintenancePolicyEnforcement

Definiert die Durchsetzung der Wartungsrichtlinie.

Enums
MAINTENANCE_POLICY_ENFORCEMENT_UNSPECIFIED
MAINTENANCE_POLICY_ENFORCEMENT_STRICT
MAINTENANCE_POLICY_ENFORCEMENT_IGNORED
MAINTENANCE_POLICY_ENFORCEMENT_SKIPPED

UpdateUnitKindStrategy

Enums
UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED Strategie nicht angegeben.
UPDATE_UNIT_KIND_STRATEGY_ON_START Aktualisieren Sie die Strategie für die Art der Einheit beim Start des Roll-outs.
UPDATE_UNIT_KIND_STRATEGY_NEVER Die Art der Einheit darf nie aktualisiert werden.

ErrorBudget

Die Konfiguration für das Fehlerbudget. Wenn die Anzahl der fehlgeschlagenen Einheiten max(allowedCount, allowed_ratio * totalUnits) überschreitet, wird die Einführung pausiert.

JSON-Darstellung
{
  "allowedCount": integer,
  "allowedPercentage": integer
}
Felder
allowedCount

integer

Optional. Die maximale Anzahl von fehlerhaften Einheiten, die an einem Standort zulässig sind, ohne dass der Roll-out pausiert wird.

allowedPercentage

integer

Optional. Der maximale Prozentsatz der Einheiten, die an einem Standort ausfallen dürfen (0, 100], ohne dass der Roll-out pausiert wird.

Methoden

create

Neue Art des Roll‑outs erstellen

delete

Einzelne Art des Roll‑outs löschen

get

Einzelne Roll-out-Art abrufen.

list

Ruft eine Sammlung von Roll-out-Arten ab.

patch

Einzelnen Rollout-Typ aktualisieren