API KRM gkebackup.gke.io/v1

gkebackup.gke.io/v1

Contiene le definizioni dello schema API per il gruppo di API gkebackup.gke.io v1.

BackupAllRestoreAll

Definisce una strategia che esegue il backup di tutto ciò che è selezionato in questo componente e ripristina tutto durante il ripristino.

Visualizzato in: - Strategia

Campo Descrizione
backupPreHooks HookSpec array Un elenco di hook eseguiti prima del backup di tutti i volumi selezionati di questo componente. Questi sono in genere i passaggi di quiescenza. I pod di destinazione dell'esecuzione sono tutti i pod all'interno di questo componente.
backupPostHooks HookSpec array Un elenco di hook eseguiti dopo il backup di tutti i volumi di questo componente. Di solito si tratta dei passaggi di riattivazione. I pod di destinazione dell'esecuzione sono tutti i pod all'interno di questo componente.
volumeSelector LabelSelector Un selettore di etichette utilizzato per selezionare i volumi permanenti di cui viene eseguito il backup e il ripristino all'interno di questo componente. Se non viene fornito, vengono selezionati tutti i volumi permanenti.

BackupJobList

Contiene un elenco di job di backup.

Campo Descrizione
apiVersion stringa gkebackup.gke.io/v1
kind stringa BackupJobList
metadata ListMeta Per i campi di metadata, consulta la documentazione dell'API Kubernetes.
items BackupJob array

BackupJobSpec

Definisce lo stato desiderato del job di backup.

Visualizzato in: - BackupJob

Campo Descrizione
backupName stringa Il nome del backup del control plane rispetto al quale viene eseguito il job di backup. Il nome è immutabile.

BackupJobStatus

Definisce lo stato osservato del job di backup.

Visualizzato in: - BackupJob

Campo Descrizione
phase BackupJobPhase La fase attuale del backup.
message stringa Un messaggio leggibile che indica i dettagli sul motivo per cui il backup si trova in questo stato.
reason stringa Una breve stringa in camel case che descrive qualsiasi aggiornamento e viene utilizzata per l'analisi automatica e la visualizzazione ordinata.

BackupOneRestoreAll

Definisce una strategia che esegue il backup solo dei volumi di un pod all'interno di questo componente e questi volumi vengono ripristinati in tutti gli altri pod durante il ripristino. Questa strategia viene utilizzata per le applicazioni di cui è stato eseguito il deployment in una configurazione ad alta disponibilità di un'istanza primaria e una o più istanze secondarie. Questa strategia è applicabile esclusivamente ai componenti StatefulSet che utilizzano una risorsa volumeClaimTemplate definita per il provisioning dei volumi.

Se un componente è costituito da più risorse Deployment, tutti i deployment devono avere esattamente una replica, tutte le repliche devono avere lo stesso numero di volumi permanenti e tutti i volumi permanenti devono essere definiti nello stesso ordine. Questi volumi sono definiti nel campo .spec.template.spec.volumes e i volumi non permanenti verranno ignorati.

Se un componente è costituito da più risorse StatefulSet, tutte le risorse StatefulSet devono avere lo stesso numero di modelli di richiesta di volume e tutti i modelli di richiesta di volume devono seguire lo stesso ordine. Sono definiti nel campo .spec.volumeClaimTemplates.

Visualizzato in: - Strategia

Campo Descrizione
backupTargetName stringa Il nome della risorsa Deployment o StatefulSet preferita utilizzata per il backup. Selezioniamo il pod di destinazione in base alla composizione di questo componente. Per Deployment multipli, scegli l'unico pod creato da questa risorsa Deployment. Per multi-StatefulSet, scegli il primo pod creato dalla risorsa StatefulSet di destinazione. Per StatefulSet singolo, scegli il secondo pod creato dalla risorsa StatefulSet di destinazione.
backupPreHooks HookSpec array Un elenco di hook eseguiti prima del backup di tutti i volumi selezionati di questo componente. Questi sono in genere i passaggi di quiescenza. Gli hook vengono eseguiti solo sul pod di backup selezionato.
backupPostHooks HookSpec array Un elenco di hook eseguiti dopo il backup di tutti i volumi di questo componente. Di solito si tratta dei passaggi di riattivazione. Gli hook vengono eseguiti solo sul pod di backup selezionato.
volumeSelector LabelSelector Un selettore di etichette utilizzato per selezionare tutti i volumi permanenti di cui viene eseguito il backup all'interno del pod di destinazione. È possibile che il selettore selezioni volumi al di fuori del pod di destinazione, ma vengono sottoposti a backup solo i volumi appartenenti al pod di destinazione. Questi backup del volume vengono ripristinati in tutti gli altri volumi selezionati dal selettore durante il ripristino. Se non viene fornito, vengono selezionati tutti i volumi permanenti.

Componente

Definisce un sottoinsieme di risorse dell'applicazione e le relative strategie di backup e ripristino. Un singolo componente è rappresentato da un elenco di risorse StatefulSet o Deployment.

Appare in: - ProtectedApplicationSpec

Campo Descrizione
name stringa Il nome univoco di questo componente.
resourceKind ResourceKind Il tipo di risorse incluse in questo componente. Il tipo di risorsa può essere solo Deployment, StatefulSet o Pod. Al momento, il tipo di risorsa Pod supporta solo la strategia BackupAllRestoreAll.
resourceNames array di stringhe I nomi delle risorse che appartengono a questo componente. Deve essere un elenco di nomi di risorse Deployment, StatefulSet o Pod in base a quanto definito nel campo resourceKind.
strategy Strategia I dettagli su come eseguire il backup e il ripristino di questo componente.

DumpAndLoad

Definisce una strategia in cui il backup e il ripristino di un componente vengono eseguiti utilizzando strumenti specifici dell'applicazione per il dump e il caricamento dei dati, come mysqldump per MySQL o pg_dump per PostgreSQL. I file di dump vengono archiviati in un volume dedicato. Per questa strategia vengono selezionati solo i volumi dedicati di cui eseguire il backup. La destinazione di dump e la destinazione di caricamento potrebbero essere diverse. Questa strategia è applicabile esclusivamente ai componenti StatefulSet che utilizzano una risorsa volumeClaimTemplate definita per il provisioning dei volumi.

Visualizzato in: - Strategia

Campo Descrizione
dumpTarget stringa Il nome di una risorsa Deployment o StatefulSet preferita utilizzata per scaricare i dati dei componenti. Selezioniamo il pod di destinazione in base alla composizione di questo componente. Per Deployment, scegli l'unico pod creato dalla risorsa Deployment di destinazione. Per StatefulSet singolo, scegli il secondo pod creato dalla risorsa StatefulSet di destinazione se il numero di repliche è maggiore di due. In caso contrario, scegli l'unico pod. Per multi-StatefulSet, scegli il primo pod creato dalla risorsa StatefulSet di destinazione.
loadTarget stringa Il nome della risorsa Deployment o StatefulSet preferita utilizzata per caricare i dati del componente. Selezioniamo il pod di destinazione in base alla composizione di questo componente. Per Deployment, scegli l'unico pod creato dalla risorsa di destinazione Deployment. Per StatefulSet, scegli sempre il primo pod creato dalla risorsa di destinazione StatefulSet.
dumpHooks HookSpec array Un elenco di hook utilizzati per scaricare i dati di questo componente in un volume dedicato. Il pod di destinazione dell'esecuzione è uno dei pod selezionati dal campo DumpTarget.
backupPostHooks HookSpec array Un elenco di hook eseguiti dopo il backup di un volume di dump dedicato. Questi sono in genere passaggi di pulizia.
loadHooks HookSpec array Un elenco di hook utilizzati per caricare i dati di questo componente da un volume dedicato. Potrebbe includere passaggi di pulizia al termine del caricamento. Il pod di destinazione dell'esecuzione è uno dei pod selezionati dal campo LoadTarget.
volumeSelector LabelSelector Un selettore di etichette che deve selezionare i volumi dedicati utilizzati per scaricare e caricare i dati dell'applicazione. Deve essere selezionato un solo volume nei campi DumpTarget e LoadTarget.

HookFailurePolicy

Tipo sottostante:string Il comportamento desiderato da adottare se l'esecuzione dell'hook genera un errore.

Appare in: - HookSpec

HookSpec

Definisce come viene eseguito un hook in un container selezionato, supponendo che il pod di destinazione sia stato selezionato.

Visualizzato in: - BackupAllRestoreAll - BackupOneRestoreAll - DumpAndLoad

Campo Descrizione
name stringa Il nome di questo hook. Questo campo viene utilizzato per identificare lo stato di esecuzione dell'hook e gli eventuali errori riscontrati.
container stringa Il container su cui viene eseguito questo hook. Se non specificato, viene eseguito sul primo container del pod.
command array di stringhe Il comando da eseguire. Il comando hook da eseguire. Ad esempio, ["/sbin/fsfreeze", "--freeze"].
timeoutSeconds integer Il timeout dell'hook in secondi. Se non specificato, il valore predefinito è 30.
onError HookFailurePolicy Il comportamento desiderato da seguire quando l'esecuzione dell'hook genera un errore. I valori validi sono Ignore o Fail. Se non specificato, il valore sarà Fail.

ProtectedApplication

Definisce lo schema per l'API Protectedapplication.

Visualizzato in: - ProtectedApplicationList

Campo Descrizione
apiVersion stringa gkebackup.gke.io/v1
kind stringa ProtectedApplication
metadata ObjectMeta Per i campi di metadata, consulta la documentazione dell'API Kubernetes.
spec ProtectedApplicationSpec
status ProtectedApplicationStatus

ProtectedApplicationError

Contiene informazioni dettagliate sugli errori per questa risorsa ProtectedApplication.

Appare in: - ProtectedApplicationStatus

Campo Descrizione
reason stringa Una stringa in formato camel case che descrive l'errore e viene utilizzata per l'analisi automatica e la visualizzazione ordinata.
message stringa Un messaggio leggibile che indica i dettagli dell'errore.

ProtectedApplicationList

Contiene un elenco di risorse ProtectedApplication.

Campo Descrizione
apiVersion stringa gkebackup.gke.io/v1
kind stringa ProtectedApplicationList
metadata ListMeta Per i campi di metadata, consulta la documentazione dell'API Kubernetes.
items Array ProtectedApplication

ProtectedApplicationSpec

Definisce le risorse pertinenti che appartengono a un ProtectedApplication e come deve essere eseguito il backup o il ripristino della determinata applicazione.

Appare in: - ProtectedApplication

Campo Descrizione
resourceSelection ResourceSelection Le risorse che appartengono a questo ProtectedApplication.
components Component array I componenti di questa applicazione protetta.

ProtectedApplicationStatus

Definisce lo stato di questa risorsa ProtectedApplication.

Appare in: - ProtectedApplication

Campo Descrizione
readyToBackup boolean Specifica se questa risorsa ProtectedApplication è pronta per il backup. Una risorsa ProtectedApplication non è pronta se contiene errori.
error ProtectedApplicationError array Gli errori relativi a questa applicazione protetta. Ad esempio, una configurazione del componente non è valida.

ResourceKind

Tipo sottostante: string Definisce il tipo di risorsa.

Visualizzato in: - Componente

ResourceSelection

Definisce come identificare le risorse appartenenti a questa applicazione.

Appare in: - ProtectedApplicationSpec

Campo Descrizione
type ResourceSelectionType Il tipo di origine dell'applicazione. Il campo Type deve essere ApplicationName o Selector. Questo è il discriminatore di unione.
applicationName stringa Il nome di un'applicazione sig-apps all'interno dello stesso spazio dei nomi. Questa è l'applicazione a cui si applica la specifica di protezione dei dati.
selector LabelSelector Le risorse nello stesso spazio dei nomi della risorsa ProtectedApplication selezionata. La specifica di protezione dei dati viene applicata a queste risorse.

ResourceSelectionType

Tipo sottostante: string I tipi di selezione.

Visualizzato in: - ResourceSelection

RestoreJob

Definisce lo schema per l'API RestoreJob

Visualizzato in: - RestoreJobList

Campo Descrizione
apiVersion stringa gkebackup.gke.io/v1
kind stringa RestoreJob
metadata ObjectMeta Per i campi di metadata, consulta la documentazione dell'API Kubernetes.
spec RestoreJobSpec
status RestoreJobStatus

RestoreJobList

Contiene un elenco di risorse RestoreJob.

Campo Descrizione
apiVersion stringa gkebackup.gke.io/v1
kind stringa RestoreJobList
metadata ListMeta Per i campi di metadata, consulta la documentazione dell'API Kubernetes.
items Array RestoreJob

RestoreJobSpec

Definisce lo stato desiderato di un ripristino.

Visualizzato in: - RestoreJob

Campo Descrizione
restoreName stringa RestoreName è il nome del ripristino del control plane rispetto al quale viene eseguito RestoreJob. Il nome è immutabile.

RestoreJobStatus

Definisce lo stato osservato di un job di ripristino.

Visualizzato in: - RestoreJob

Campo Descrizione
phase RestoreJobPhase Lo stato attuale di un ripristino.
message stringa Un messaggio leggibile che indica i dettagli sul motivo per cui il ripristino del backup si trova in questo stato.
reason stringa Una stringa in formato CamelCase che descrive qualsiasi aggiornamento e viene utilizzata per l'analisi automatica e la visualizzazione ordinata.

Strategia

Definisce come eseguire il backup e il ripristino per un componente specifico. Deve essere uno tra BackupAllRestoreAll, BackupOneRestoreAll o DumpAndLoad.

Visualizzato in: - Componente

Campo Descrizione
type StrategyType Il tipo di strategia di backup e ripristino. Il valore può essere solo BackupAllRestoreAll, BackupOneRestoreAll o DumpAndLoad. Tieni presente che il tipo di risorsa Pod supporta solo la strategia BackupAllRestoreAll. Questo è il discriminatore di unione.
backupAllRestoreAll BackupAllRestoreAll Una strategia che esegue il backup di tutti gli elementi selezionati in questo componente e li ripristina durante il ripristino.
backupOneRestoreAll BackupOneRestoreAll Una strategia che esegue il backup solo dei volumi di un pod all'interno di questo componente e che vengono ripristinati in tutti gli altri pod durante il ripristino. Questa strategia viene utilizzata per le applicazioni di cui è stato eseguito il deployment in una configurazione ad alta disponibilità di un'istanza primaria e una o più istanze secondarie. Questa strategia è applicabile esclusivamente ai componenti StatefulSet che utilizzano una risorsa volumeClaimTemplate definita per il provisioning dei volumi.
dumpAndLoad DumpAndLoad Una strategia in cui il backup e il ripristino di un componente vengono eseguiti utilizzando strumenti specifici dell'applicazione per il dump e il caricamento dei dati, come mysqldump per MySQL o pg_dump per PostgreSQL. I file di dump vengono archiviati in un volume dedicato. Per questa strategia, deve essere selezionato solo il volume dedicato di cui eseguire il backup. La destinazione di dump e la destinazione di caricamento potrebbero essere diverse. Questa strategia è applicabile esclusivamente ai componenti StatefulSet che utilizzano una risorsa volumeClaimTemplate definita per il provisioning dei volumi.

StrategyType

Tipo sottostante: string Definisce le strategie di backup e ripristino di un componente.

Visualizzato in: - Strategia