REST Resource: projects.locations.rollouts

Risorsa: Rollout

Rappresenta una singola esecuzione dell'implementazione e i relativi risultati

Rappresentazione JSON 
{
  "name": string,
  "release": string,
  "startTime": string,
  "endTime": string,
  "state": enum (RolloutState),
  "stateMessage": string,
  "stateTransitionTime": string,
  "rootRollout": string,
  "parentRollout": string,
  "rolloutOrchestrationStrategy": string,
  "unitFilter": string,
  "rolloutKind": string,
  "stats": {
    object (RolloutStats)
  },
  "control": {
    object (RolloutControl)
  },
  "effectiveUnitFilter": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string
}
Campi
name

string

Identificatore. Il nome della risorsa (URI completo della risorsa) che segue lo schema di denominazione standard:

"projects/{project}/locations/{location}/rollout/{rolloutId}"
release

string

Facoltativo. Immutabile. Nome della release implementata nelle unità target. Obbligatorio se non è specificato nessun altro tipo di release.
startTime

string (Timestamp format)

Facoltativo. Solo output. L'ora in cui è iniziata l'esecuzione dell'implementazione. Sarà vuoto se il lancio non è ancora iniziato.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Facoltativo. Solo output. L'ora in cui è terminata l'esecuzione del lancio (indipendentemente dall'esito positivo, negativo o dall'annullamento). Sarà vuoto se l'implementazione non è ancora terminata. Una volta impostato, il lancio è in stato terminale e tutti i risultati sono definitivi.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
state

enum (RolloutState)

Solo output. Stato attuale dell'implementazione.
stateMessage

string

Solo output. Messaggio leggibile che indica i dettagli dell'ultima transizione di stato.
stateTransitionTime

string (Timestamp format)

Facoltativo. Solo output. Il momento in cui l'implementazione è passata allo stato attuale.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
rootRollout

string

Facoltativo. Solo output. L'implementazione principale da cui deriva questa implementazione. Il nome della risorsa (URI completo della risorsa) che segue lo schema di denominazione standard:

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
parentRollout

string

Facoltativo. Solo output. L'implementazione principale diretta da cui deriva questa implementazione. Il nome della risorsa (URI completo della risorsa) che segue lo schema di denominazione standard:

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
rolloutOrchestrationStrategy

string

Facoltativo. La strategia utilizzata per l'esecuzione di questa implementazione. Questa strategia sostituirà qualsiasi strategia specificata in RolloutKind. Se non specificata al momento della creazione, verrà utilizzata la strategia di RolloutKind.

Esistono due strategie di valori supportate utilizzate per il controllo: "Google.Cloud.Simple.AllAtOnce" e "Google.Cloud.Simple.OneLocationAtATime".

Un'implementazione con una di queste semplici strategie verrà eseguita in tutte le località definite nelle località SaaS del tipo di unità di destinazione.
unitFilter

string

Facoltativo. Stringa di filtro formattata CEL(https://github.com/google/cel-spec) rispetto all'unità. Il filtro verrà applicato per determinare la popolazione di unità idonee. Questo filtro può solo ridurre, ma non espandere l'ambito del lancio. Se non viene fornito, verrà utilizzato unitFilter di RolloutKind.
rolloutKind

string

Facoltativo. Immutabile. Nome di RolloutKind da cui deriva questa implementazione e a cui si attiene.
stats

object (RolloutStats)

Facoltativo. Solo output. Dettagli sull'avanzamento dell'implementazione.
control

object (RolloutControl)

Facoltativo. Modifica richiesta all'esecuzione di questo lancio. RolloutControl.action predefinito è ROLLOUT_ACTION_RUN, il che significa che l'implementazione verrà eseguita fino al completamento mentre avanza in tutti gli stati di implementazione naturali (ad esempio RUNNING -> SUCCEEDED o RUNNING -> FAILED). Le richieste possono essere effettuate solo quando l'implementazione non è in uno stato terminale.
effectiveUnitFilter

string

Facoltativo. Solo output. Output solo dello snapshot del filtro unità effettivo all'ora di inizio implementazione. Contiene un'espressione CEL(https://github.com/google/cel-spec) costituita da una congiunzione di Rollout.unit_filter e RolloutKind.unit_filter. Questo campo acquisisce il filtro applicato dal rollout per determinare la popolazione di unità. Se unitFilter di RolloutKind associato viene modificato dopo l'avvio dell'implementazione, non verrà aggiornato qui.
labels

map (key: string, value: string)

Facoltativo. Le etichette sulla risorsa, che possono essere utilizzate per la categorizzazione, simili alle etichette delle risorse Kubernetes.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
annotations

map (key: string, value: string)

Facoltativo. Le annotazioni sono una mappa chiave-valore non strutturata archiviata con una risorsa che può essere impostata da strumenti esterni per archiviare e recuperare metadati arbitrari. Non sono interrogabili e devono essere conservati durante la modifica degli oggetti.

Scopri di più: https://kubernetes.io/docs/user-guide/annotations

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

Solo output. Identificatore unico della risorsa. L'UID è unico nello spazio e nel tempo per questa risorsa nell'ambito del servizio. Viene tipicamente generato dal server durante la creazione di una risorsa e non deve essere modificato. L'UID viene utilizzato per identificare in modo unico le risorse quando i nomi risorsa vengono riutilizzati. Deve essere un UUID4.
etag

string

Solo output. Valore opaco che identifica in modo unico una versione o generazione di una risorsa. Può essere usato per confermare che client e server concordano nell'ordine di una risorsa in fase di scrittura.
createTime

string (Timestamp format)

Solo output. Timestamp di creazione della risorsa.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'ultimo aggiornamento della risorsa. Qualsiasi modifica apportata alla risorsa dagli utenti deve aggiornare questo valore. Le modifiche a una risorsa apportate dal servizio devono aggiornare questo valore.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Solo output. Il timestamp in cui la risorsa è stata contrassegnata per l'eliminazione (l'eliminazione è un'operazione asincrona).

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

RolloutState

Lo stato attuale dell'implementazione.

Enum
ROLLOUT_STATE_UNSPECIFIED Stato non specificato.
ROLLOUT_STATE_RUNNING Il lancio è in corso.
ROLLOUT_STATE_PAUSED L'implementazione è stata messa in pausa.
ROLLOUT_STATE_SUCCEEDED Implementazione completata.
ROLLOUT_STATE_FAILED L'implementazione non è riuscita.
ROLLOUT_STATE_CANCELLED L'implementazione è stata annullata.
ROLLOUT_STATE_WAITING L'implementazione è in attesa che venga soddisfatta una condizione prima di iniziare.
ROLLOUT_STATE_CANCELLING L'implementazione è in fase di annullamento.
ROLLOUT_STATE_RESUMING L'implementazione è in corso di ripresa.
ROLLOUT_STATE_PAUSING L'implementazione è in pausa.

RolloutStats

RolloutStats contiene informazioni sullo stato di avanzamento di un'implementazione.

Rappresentazione JSON 
{
  "operationsByState": [
    {
      object (Aggregate)
    }
  ]
}
Campi
operationsByState[]

object (Aggregate)

Facoltativo. Solo output. Elenco non ordinato. Una suddivisione dell'avanzamento delle operazioni attivate dall'implementazione. Fornisce un conteggio delle operazioni in base al loro stato. Può essere utilizzato per determinare il numero di unità che sono state aggiornate o la cui pianificazione di aggiornamento è prevista.

Ci sarà al massimo una voce per gruppo. I valori possibili per i gruppi di operazioni sono: - "SCHEDULED" - "PENDING" - "RUNNING" - "SUCCEEDED" - "FAILED" - "CANCELLED"

Aggregazione

Rappresenta l'aggregazione di un insieme di popolazione di record simili per un determinato gruppo. Ad esempio, una raccolta di conteggi di unità può essere aggregata e raggruppata in base allo stato.

Rappresentazione JSON 
{
  "group": string,
  "count": integer
}
Campi
group

string

Obbligatorio. Raggruppamento in base al quale eseguire l'aggregazione.
count

integer

Obbligatorio. Numero di record nel gruppo.

RolloutControl

RolloutControl consente di richiedere una modifica all'esecuzione di un rollout mettendolo in pausa o annullandolo.

Rappresentazione JSON 
{
  "action": enum (RolloutAction),

  // Union field action_params can be only one of the following:
  "runParams": {
    object (RunRolloutActionParams)
  }
  // End of list of possible types for union field action_params.
}
Campi
action

enum (RolloutAction)

Obbligatorio. Azione da eseguire sull'implementazione. Il comportamento predefinito prevede l'esecuzione del rollout fino al raggiungimento naturale di uno stato terminale.
Campo unione action_params. Impostazione per l'azione. L'impostazione deve corrispondere all'azione, ad esempio: action=RUN può impostare solo run_params o omettere tutti i parametri. È un errore impostare un'impostazione non applicabile all'azione. action_params può essere solo uno dei seguenti tipi:
runParams

object (RunRolloutActionParams)

Facoltativo. Parametri per l'azione RUN. È un errore specificare questo valore se RolloutAction non è impostato su RUN. Per impostazione predefinita, l'implementazione ripeterà le operazioni non riuscite quando viene ripresa.

RunRolloutActionParams

Parametri per l'azione RUN che controllano il comportamento dell'implementazione quando viene ripresa da uno stato PAUSED.

Rappresentazione JSON 
{
  "retryFailedOperations": boolean
}
Campi
retryFailedOperations

boolean

Obbligatorio. Se è true, l'implementazione ritenterà le operazioni non riuscite quando viene ripresa. Ciò è applicabile solo se lo stato attuale del rollout è PAUSED e l'azione richiesta è RUN.

RolloutAction

RolloutAction indica l'azione da eseguire sull'implementazione.

Enum
ROLLOUT_ACTION_UNSPECIFIED Azione non specificata, verrà trattata come RUN per impostazione predefinita.
ROLLOUT_ACTION_RUN Esegui il rollout finché non raggiunge naturalmente uno stato terminale. Un'implementazione richiesta per l'esecuzione avanzerà in tutti gli stati di implementazione naturali (ad esempio IN ESECUZIONE -> RIUSCITO o IN ESECUZIONE -> NON RIUSCITO). Se durante l'implementazione si verificano errori riprovabili, l'implementazione viene sospesa per impostazione predefinita e può essere ripresa richiedendo nuovamente questa azione RUN.
ROLLOUT_ACTION_PAUSE Metti in pausa il rollout finché non viene ripreso (ovvero viene richiesto RUN).
ROLLOUT_ACTION_CANCEL Annulla definitivamente l'implementazione.

Metodi

create

 Crea una nuova implementazione.

delete

 Elimina una singola implementazione.

get

 Recupera un singolo rollout.

list

 Recupera una raccolta di implementazioni.

patch

 Aggiorna una singola implementazione.