KRM API gkebackup.gke.io/v1 API

gkebackup.gke.io/v1

Enthält die API-Schemadefinitionen für die API-Gruppe gkebackup.gke.io v1.

BackupAllRestoreAll

Definiert eine Strategie, mit der alles gesichert wird, was in dieser Komponente ausgewählt ist, und alles während der Wiederherstellung wiederhergestellt wird.

Wird angezeigt in: - Strategie

Feld Beschreibung
backupPreHooks HookSpec-Array Eine Liste von Hooks, die ausgeführt werden, bevor alle ausgewählten Volumes dieser Komponente gesichert werden. Das sind in der Regel die Schritte zum Inaktivieren. Die Ziel-Pods für die Ausführung sind alle Pods innerhalb dieser Komponente.
backupPostHooks HookSpec-Array Eine Liste der Hooks, die ausgeführt werden, nachdem alle Volumes dieser Komponente gesichert wurden. Das sind in der Regel die Schritte zum Aufheben des Ruhezustands. Die Ziel-Pods für die Ausführung sind alle Pods innerhalb dieser Komponente.
volumeSelector LabelSelector Ein Label-Selektor, mit dem nichtflüchtige Volumes ausgewählt werden, die in dieser Komponente gesichert und wiederhergestellt werden. Wenn dies nicht angegeben ist, werden alle nichtflüchtigen Volumes ausgewählt.

BackupJobList

Enthält eine Liste der Sicherungsjobs.

Feld Beschreibung
apiVersion String gkebackup.gke.io/v1
kind String BackupJobList
metadata ListMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
items BackupJob-Array

BackupJobSpec

Definiert den gewünschten Status des Sicherungsjobs.

Wird angezeigt in: - BackupJob

Feld Beschreibung
backupName String Der Name der Sicherung der Steuerungsebene, für die der Sicherungsjob ausgeführt wird. Der Name ist unveränderlich.

BackupJobStatus

Definiert den beobachteten Status des Sicherungsjobs.

Wird angezeigt in: - BackupJob

Feld Beschreibung
phase BackupJobPhase Die aktuelle Phase der Sicherung.
message String Eine menschenlesbare Nachricht mit Details dazu, warum sich die Sicherung in diesem Status befindet.
reason String Ein kurzer CamelCase-String, der das Update beschreibt und für die maschinelle Verarbeitung und übersichtliche Darstellung verwendet wird.

BackupOneRestoreAll

Definiert eine Strategie, bei der nur Volumes von einem Pod innerhalb dieser Komponente gesichert werden. Diese Volumes werden bei der Wiederherstellung in allen anderen Pods wiederhergestellt. Diese Strategie wird für Anwendungen verwendet, die in einer Hochverfügbarkeitskonfiguration mit einem primären und einem oder mehreren sekundären Knoten bereitgestellt werden. Diese Strategie gilt ausschließlich für StatefulSet-Komponenten, für die eine volumeClaimTemplate-Ressource zum Bereitstellen von Volumes verwendet wird.

Wenn eine Komponente aus mehreren Deployment-Ressourcen besteht, müssen alle Deployments genau ein Replikat haben, alle Replikate müssen dieselbe Anzahl von nichtflüchtigen Speichern haben und alle nichtflüchtigen Speicher müssen in derselben Reihenfolge definiert werden. Diese Volumes sind im Feld .spec.template.spec.volumes definiert und nichtflüchtige Volumes werden übersprungen.

Wenn eine Komponente aus mehreren StatefulSet-Ressourcen besteht, müssen alle StatefulSet-Ressourcen dieselbe Anzahl von VolumeClaim-Vorlagen haben und alle VolumeClaim-Vorlagen müssen derselben Reihenfolge folgen. Sie werden im Feld .spec.volumeClaimTemplates definiert.

Wird angezeigt in: - Strategie

Feld Beschreibung
backupTargetName String Der Name der bevorzugten Deployment- oder StatefulSet-Ressource, die für die Sicherung verwendet wird. Wir wählen den Ziel-Pod basierend auf der Zusammensetzung dieser Komponente aus. Wählen Sie für mehrere Deployment den einzigen Pod aus, der von dieser Deployment-Ressource erstellt wurde. Wählen Sie für mehrere StatefulSet den ersten Pod aus, der von der Zielressource StatefulSet erstellt wurde. Wählen Sie für einzelne StatefulSet den zweiten Pod aus, der von der Zielressource StatefulSet erstellt wurde.
backupPreHooks HookSpec-Array Eine Liste von Hooks, die ausgeführt werden, bevor alle ausgewählten Volumes dieser Komponente gesichert werden. Das sind in der Regel die Schritte zum Inaktivieren. Hooks werden nur auf dem ausgewählten Sicherungs-Pod ausgeführt.
backupPostHooks HookSpec-Array Eine Liste der Hooks, die ausgeführt werden, nachdem alle Volumes dieser Komponente gesichert wurden. Das sind in der Regel die Schritte zum Aufheben des Ruhezustands. Hooks werden nur auf dem ausgewählten Sicherungs-Pod ausgeführt.
volumeSelector LabelSelector Ein Label-Selektor, mit dem alle persistenten Volumes ausgewählt werden, die im Ziel-Pod gesichert werden. Es ist möglich, dass der Selektor Volumes außerhalb des Ziel-Pods auswählt, aber nur Volumes, die zum Ziel-Pod gehören, werden gesichert. Diese Volume-Sicherungen werden während der Wiederherstellung auf allen anderen vom Selektor ausgewählten Volumes wiederhergestellt. Wenn dies nicht angegeben ist, werden alle nichtflüchtigen Volumes ausgewählt.

Komponente

Definiert eine Teilmenge von Anwendungsressourcen und deren Sicherungs- und Wiederherstellungsstrategien. Eine einzelne Komponente wird entweder durch eine Liste von StatefulSet- oder Deployment-Ressourcen dargestellt.

Wird angezeigt in: - ProtectedApplicationSpec

Feld Beschreibung
name String Der eindeutige Name dieser Komponente.
resourceKind ResourceKind Die Art der Ressourcen, die in dieser Komponente enthalten sind. Der Ressourcentyp kann nur Deployment, StatefulSet oder Pod sein. Für die Ressourcenart Pod wird derzeit nur die Strategie BackupAllRestoreAll unterstützt.
resourceNames String-Array Die Namen der Ressourcen, die zu dieser Komponente gehören. Es muss eine Liste mit Namen von Deployment-, StatefulSet- oder Pod-Ressourcen sein, je nachdem, was im Feld resourceKind definiert ist.
strategy Strategie Details zum Sichern und Wiederherstellen dieser Komponente.

DumpAndLoad

Definiert eine Strategie, bei der das Sichern und Wiederherstellen einer Komponente mit anwendungsspezifischen Tools zum Sichern und Laden von Daten erfolgt, z. B. mysqldump für MySQL oder pg_dump für PostgreSQL. Dump-Dateien werden in einem dedizierten Volume gespeichert. Für diese Strategie werden nur die dafür vorgesehenen Volumes für die Sicherung ausgewählt. Das Dump-Ziel und das Ladeziel können unterschiedlich sein. Diese Strategie gilt ausschließlich für StatefulSet-Komponenten, die eine definierte volumeClaimTemplate-Ressource zum Bereitstellen von Volumes verwenden.

Wird angezeigt in: - Strategie

Feld Beschreibung
dumpTarget String Der Name einer bevorzugten Deployment- oder StatefulSet-Ressource, die zum Exportieren der Komponentendaten verwendet wird. Wir wählen den Ziel-Pod basierend auf der Zusammensetzung dieser Komponente aus. Wählen Sie für Deployment den einzigen Pod aus, der von der Zielressource Deployment erstellt wurde. Wählen Sie für einzelne StatefulSet den zweiten Pod aus, der von der Zielressource StatefulSet erstellt wurde, wenn die Replikatzahl größer als zwei ist. Andernfalls wählen Sie den einzigen Pod aus. Wählen Sie für mehrere StatefulSet den ersten Pod aus, der von der Zielressource StatefulSet erstellt wurde.
loadTarget String Der Name der bevorzugten Deployment- oder StatefulSet-Ressource, die zum Laden der Komponentendaten verwendet wird. Wir wählen den Ziel-Pod basierend auf der Zusammensetzung dieser Komponente aus. Wählen Sie für Deployment den einzigen Pod aus, der von der Zielressource Deployment erstellt wurde. Wählen Sie für StatefulSet immer den ersten Pod aus, der von der Zielressource StatefulSet erstellt wurde.
dumpHooks HookSpec-Array Eine Liste der Hooks, die zum Sichern der Daten dieser Komponente in einem dedizierten Volume verwendet werden. Der Pod für das Ausführungsziel ist einer der Pods, die im Feld DumpTarget ausgewählt wurden.
backupPostHooks HookSpec-Array Eine Liste von Hooks, die ausgeführt werden, nachdem ein dediziertes Dump-Volume gesichert wurde. Dabei handelt es sich in der Regel um Bereinigungsschritte.
loadHooks HookSpec-Array Eine Liste von Hooks, die zum Laden der Daten dieser Komponente aus einem dedizierten Volume verwendet werden. Sie kann Bereinigungsschritte nach dem Laden enthalten. Der Pod für das Ausführungsziel ist einer der Pods, die im Feld LoadTarget ausgewählt wurden.
volumeSelector LabelSelector Eine Label-Auswahl, mit der dedizierte Volumes ausgewählt werden müssen, die zum Sichern und Laden der Anwendungsdaten verwendet werden. Sowohl im Feld DumpTarget als auch im Feld LoadTarget darf nur ein Volume ausgewählt sein.

HookFailurePolicy

Zugrunde liegender Typ:string Das gewünschte Verhalten, wenn bei der Ausführung des Hooks ein Fehler auftritt.

Wird angezeigt in: - HookSpec

HookSpec

Definiert, wie ein Hook in einem ausgewählten Container ausgeführt wird, sofern der Ziel-Pod ausgewählt wurde.

Wird verwendet in: - BackupAllRestoreAll - BackupOneRestoreAll - DumpAndLoad

Feld Beschreibung
name String Der Name dieses Hooks. Mit diesem Feld wird der Status der Hook-Ausführung und alle aufgetretenen Fehler angegeben.
container String Der Container, in dem dieser Hook ausgeführt wird. Wenn nicht angegeben, wird der Befehl für den ersten Container des Pods ausgeführt.
command String-Array Der auszuführende Befehl. Der auszuführende Hook-Befehl. Beispiel: ["/sbin/fsfreeze", "--freeze"].
timeoutSeconds Ganzzahl Das Zeitlimit des Hooks in Sekunden. Wenn nicht angegeben, ist der Standardwert 30.
onError HookFailurePolicy Das gewünschte Verhalten, wenn bei der Ausführung des Hooks ein Fehler auftritt. Gültige Werte sind Ignore und Fail. Wenn nichts angegeben ist, lautet der Wert Fail.

ProtectedApplication

Definiert das Schema für die Protectedapplication API.

Wird angezeigt in: - ProtectedApplicationList

Feld Beschreibung
apiVersion String gkebackup.gke.io/v1
kind String ProtectedApplication
metadata ObjectMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
spec ProtectedApplicationSpec
status ProtectedApplicationStatus

ProtectedApplicationError

Enthält detaillierte Fehlerinformationen für diese ProtectedApplication-Ressource.

Wird angezeigt in: - ProtectedApplicationStatus

Feld Beschreibung
reason String Ein CamelCase-String, der einen Fehler beschreibt und für das maschinelle Parsen und die übersichtliche Darstellung verwendet wird.
message String Eine menschenlesbare Nachricht mit Details zum Fehler.

ProtectedApplicationList

Enthält eine Liste von ProtectedApplication-Ressourcen.

Feld Beschreibung
apiVersion String gkebackup.gke.io/v1
kind String ProtectedApplicationList
metadata ListMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
items ProtectedApplication-Array

ProtectedApplicationSpec

Definiert relevante Ressourcen, die zu einem ProtectedApplication gehören, und wie die angegebene Anwendung gesichert oder wiederhergestellt werden muss.

Wird angezeigt in: - ProtectedApplication

Feld Beschreibung
resourceSelection ResourceSelection Die Ressourcen, die zu diesem ProtectedApplication gehören.
components Component-Array Die Komponenten dieser geschützten Anwendung.

ProtectedApplicationStatus

Definiert den Status dieser ProtectedApplication-Ressource.

Wird angezeigt in: - ProtectedApplication

Feld Beschreibung
readyToBackup boolean Gibt an, ob diese ProtectedApplication-Ressource für die Sicherung bereit ist. Eine ProtectedApplication-Ressource ist nicht bereit, wenn sie Fehler enthält.
error ProtectedApplicationError-Array Die Fehler im Zusammenhang mit dieser geschützten Anwendung. Beispiel: Eine Komponentenkonfiguration ist ungültig.

ResourceKind

Zugrunde liegender Typ:string Definiert die Art der Ressource.

Wird angezeigt in: - Komponente

ResourceSelection

Definiert, wie die zu dieser Anwendung gehörenden Ressourcen identifiziert werden.

Wird angezeigt in: - ProtectedApplicationSpec

Feld Beschreibung
type ResourceSelectionType Der Typ der Anwendungsquelle. Das Feld Type muss ApplicationName oder Selector sein. Dies ist der Diskriminator für die Vereinigung.
applicationName String Der Name einer sig-apps-Anwendung im selben Namespace. Dies ist die Anwendung, für die die Datenschutzspezifikation gilt.
selector LabelSelector Die Ressourcen im selben Namespace wie die ausgewählte ProtectedApplication-Ressource. Die Datenschutzspezifikation wird auf diese Ressourcen angewendet.

ResourceSelectionType

Zugrunde liegender Typ:string Die Auswahltypen.

Wird angezeigt in: - ResourceSelection

RestoreJob

Definiert das Schema für die RestoreJob API.

Wird angezeigt in: - RestoreJobList

Feld Beschreibung
apiVersion String gkebackup.gke.io/v1
kind String RestoreJob
metadata ObjectMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
spec RestoreJobSpec
status RestoreJobStatus

RestoreJobList

Enthält eine Liste von RestoreJob-Ressourcen.

Feld Beschreibung
apiVersion String gkebackup.gke.io/v1
kind String RestoreJobList
metadata ListMeta Informationen zu den Feldern von metadata finden Sie in der Dokumentation zur Kubernetes API.
items RestoreJob-Array

RestoreJobSpec

Definiert den gewünschten Status einer Wiederherstellung.

Wird angezeigt in: - RestoreJob

Feld Beschreibung
restoreName String RestoreName ist der Name des Wiederherstellungsvorgangs auf der Steuerungsebene, für den der RestoreJob ausgeführt wird. Der Name ist unveränderlich.

RestoreJobStatus

Definiert den beobachteten Status eines Wiederherstellungsjobs.

Wird angezeigt in: - RestoreJob

Feld Beschreibung
phase RestoreJobPhase Der aktuelle Status einer Wiederherstellung.
message String Eine menschenlesbare Nachricht mit Details dazu, warum die Sicherungswiederherstellung in diesem Status ist.
reason String Ein String im CamelCase-Format, der eine Aktualisierung beschreibt und für das maschinelle Parsen und die übersichtliche Darstellung verwendet wird.

Strategie

Definiert, wie eine bestimmte Komponente gesichert und wiederhergestellt wird. Sie muss BackupAllRestoreAll, BackupOneRestoreAll oder DumpAndLoad sein.

Wird angezeigt in: - Komponente

Feld Beschreibung
type StrategyType Der Typ der Sicherungs- und Wiederherstellungsstrategie. Der Wert kann nur BackupAllRestoreAll, BackupOneRestoreAll oder DumpAndLoad sein. Der Ressourcentyp Pod unterstützt nur die Strategie BackupAllRestoreAll. Dies ist der Diskriminator für die Vereinigung.
backupAllRestoreAll BackupAllRestoreAll Eine Strategie, mit der alles gesichert wird, was in dieser Komponente ausgewählt ist, und alles während der Wiederherstellung wiederhergestellt wird.
backupOneRestoreAll BackupOneRestoreAll Eine Strategie, bei der nur Volumes von einem Pod innerhalb dieser Komponente gesichert und bei der Wiederherstellung in allen anderen Pods wiederhergestellt werden. Diese Strategie wird für Anwendungen verwendet, die in einer Hochverfügbarkeitskonfiguration mit einem primären und einem oder mehreren sekundären Knoten bereitgestellt werden. Diese Strategie gilt ausschließlich für StatefulSet-Komponenten, die eine definierte volumeClaimTemplate-Ressource zum Bereitstellen von Volumes verwenden.
dumpAndLoad DumpAndLoad Eine Strategie, bei der die Sicherung und Wiederherstellung einer Komponente mit anwendungsspezifischen Tools zum Sichern und Laden von Daten erfolgt, z. B. mysqldump für MySQL oder pg_dump für PostgreSQL. Speicherabbilddateien werden in einem dedizierten Volume gespeichert. Für diese Strategie darf nur das entsprechende Volume für die Sicherung ausgewählt werden. Das Dump-Ziel und das Ladeziel können unterschiedlich sein. Diese Strategie gilt ausschließlich für StatefulSet-Komponenten, die eine definierte volumeClaimTemplate-Ressource zum Bereitstellen von Volumes verwenden.

StrategyType

Zugrunde liegender Typ:string Definiert die Sicherungs- und Wiederherstellungsstrategien einer Komponente.

Wird angezeigt in: - Strategie