API KRM gkebackup.gke.io/v1

gkebackup.gke.io/v1

Contient les définitions de schéma d'API pour le groupe d'API gkebackup.gke.io v1.

BackupAllRestoreAll

Définit une stratégie qui sauvegarde tout ce qui est sélectionné dans ce composant et restaure tout lors de la restauration.

Apparaît dans :Strategy

Champ Description
Tableau HookSpec backupPreHooks Liste des hooks exécutés avant la sauvegarde de tous les volumes sélectionnés de ce composant. Il s'agit généralement des étapes de mise au repos. Les pods cibles de l'exécution sont tous les pods de ce composant.
Tableau HookSpec backupPostHooks Liste des hooks exécutés après la sauvegarde de tous les volumes de ce composant. Il s'agit généralement des étapes de réactivation. Les pods cibles de l'exécution sont tous les pods de ce composant.
volumeSelector LabelSelector Sélecteur de libellés utilisé pour sélectionner les volumes persistants sauvegardés et restaurés dans ce composant. Si cette option n'est pas fournie, tous les volumes persistants sont sélectionnés.

BackupJobList

Contient une liste des jobs de sauvegarde.

Champ Description
chaîne apiVersion gkebackup.gke.io/v1
chaîne kind BackupJobList
metadata ListMeta Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata.
items Tableau BackupJob

BackupJobSpec

Définit l'état souhaité de la tâche de sauvegarde.

Apparaît dans :BackupJob

Champ Description
chaîne backupName Nom de la sauvegarde du plan de contrôle par rapport à laquelle le job de sauvegarde est exécuté. Le nom est immuable.

BackupJobStatus

Définit l'état observé de la tâche de sauvegarde.

Apparaît dans :BackupJob

Champ Description
phase BackupJobPhase Phase actuelle de la sauvegarde.
chaîne message Message lisible indiquant pourquoi la sauvegarde est dans cet état.
chaîne reason Brève chaîne en camel case décrivant une mise à jour et utilisée pour l'analyse automatique et l'affichage ordonné.

BackupOneRestoreAll

Définit une stratégie qui ne sauvegarde que les volumes d'un seul pod de ce composant. Ces volumes sont restaurés sur tous les autres pods lors de la restauration. Cette stratégie est utilisée pour les applications déployées dans une configuration à haute disponibilité avec une instance principale et une ou plusieurs instances secondaires. Cette stratégie s'applique exclusivement aux composants StatefulSet qui utilisent une ressource volumeClaimTemplate définie pour provisionner des volumes.

Si un composant se compose de plusieurs ressources Deployment, tous les déploiements doivent comporter exactement une réplique, toutes les répliques doivent comporter le même nombre de volumes persistants et tous les volumes persistants doivent être définis dans le même ordre. Ces volumes sont définis dans le champ .spec.template.spec.volumes et les volumes non persistants sont ignorés.

Si un composant est constitué de plusieurs ressources StatefulSet, toutes les ressources StatefulSet doivent avoir le même nombre de modèles de revendication de volume, et tous les modèles de revendication de volume doivent suivre le même ordre. Elles sont définies dans le champ .spec.volumeClaimTemplates.

Apparaît dans :Strategy

Champ Description
chaîne backupTargetName Nom de la ressource Deployment ou StatefulSet préférée utilisée pour la sauvegarde. Nous sélectionnons le pod cible en fonction de la composition de ce composant. Pour les Deployment multiples, sélectionnez le seul pod créé par cette ressource Deployment. Pour les StatefulSet multiples, sélectionnez le premier pod créé par la ressource StatefulSet cible. Pour un StatefulSet unique, sélectionnez le deuxième pod créé par la ressource StatefulSet cible.
Tableau HookSpec backupPreHooks Liste des hooks exécutés avant la sauvegarde de tous les volumes sélectionnés de ce composant. Il s'agit généralement des étapes de mise au repos. Les hooks ne sont exécutés que sur le pod de sauvegarde sélectionné.
Tableau HookSpec backupPostHooks Liste des hooks exécutés après la sauvegarde de tous les volumes de ce composant. Il s'agit généralement des étapes de réactivation. Les hooks ne sont exécutés que sur le pod de sauvegarde sélectionné.
volumeSelector LabelSelector Sélecteur d'étiquettes utilisé pour sélectionner tous les volumes persistants sauvegardés dans le pod cible. Il est possible que le sélecteur sélectionne des volumes en dehors du pod cible, mais seuls les volumes appartenant au pod cible sont sauvegardés. Ces sauvegardes de volumes sont restaurées dans tous les autres volumes sélectionnés par le sélecteur lors de la restauration. Si cette option n'est pas fournie, tous les volumes persistants sont sélectionnés.

Composant

Définit un sous-ensemble de ressources d'application et leurs stratégies de sauvegarde et de restauration. Un composant individuel est représenté par une liste de ressources StatefulSet ou Deployment.

Apparaît dans :ProtectedApplicationSpec

Champ Description
chaîne name Nom unique de ce composant.
resourceKind ResourceKind Type de ressources incluses dans ce composant. Le type de ressource ne peut être que Deployment, StatefulSet ou Pod. Pour le moment, le type de ressource Pod n'accepte que la stratégie BackupAllRestoreAll.
Tableau de chaînes resourceNames Noms des ressources appartenant à ce composant. Il doit s'agir d'une liste de noms de ressources Deployment, StatefulSet ou Pod en fonction de ce qui est défini dans le champ resourceKind.
strategy Stratégie Informations sur la sauvegarde et la restauration de ce composant.

DumpAndLoad

Définit une stratégie dans laquelle la sauvegarde et la restauration d'un composant sont effectuées à l'aide d'outils spécifiques à l'application pour vider et charger des données, comme mysqldump pour MySQL ou pg_dump pour PostgreSQL. Les fichiers de vidage sont stockés dans un volume dédié. Seuls les volumes dédiés sont sélectionnés pour être sauvegardés avec cette stratégie. La cible de vidage et la cible de chargement peuvent être différentes. Cette stratégie s'applique exclusivement aux composants StatefulSet qui utilisent une ressource volumeClaimTemplate définie pour provisionner des volumes.

Apparaît dans :Strategy

Champ Description
chaîne dumpTarget Nom d'une ressource Deployment ou StatefulSet préférée utilisée pour vider les données du composant. Nous sélectionnons le pod cible en fonction de la composition de ce composant. Pour Deployment, sélectionnez le seul pod créé par la ressource Deployment cible. Pour les StatefulSet uniques, sélectionnez le deuxième pod créé par la ressource StatefulSet cible si le nombre de répliques est supérieur à deux. Sinon, sélectionnez le seul Pod. Pour les StatefulSet multiples, sélectionnez le premier pod créé par la ressource StatefulSet cible.
chaîne loadTarget Nom de la ressource Deployment ou StatefulSet préférée utilisée pour charger les données du composant. Nous sélectionnons le pod cible en fonction de la composition de ce composant. Pour Deployment, sélectionnez le seul pod créé par la ressource cible Deployment. Pour StatefulSet, sélectionnez toujours le premier pod créé par la ressource StatefulSet cible.
Tableau HookSpec dumpHooks Liste des hooks utilisés pour vider les données de ce composant dans un volume dédié. Le pod cible d'exécution est l'un des pods sélectionnés dans le champ DumpTarget.
Tableau HookSpec backupPostHooks Liste des hooks exécutés après la sauvegarde d'un volume de vidage dédié. Il s'agit généralement d'étapes de nettoyage.
Tableau HookSpec loadHooks Liste des hooks utilisés pour charger les données de ce composant à partir d'un volume dédié. Il peut inclure des étapes de nettoyage une fois le chargement terminé. Le pod cible d'exécution est l'un des pods sélectionnés dans le champ LoadTarget.
volumeSelector LabelSelector Sélecteur d'étiquettes qui doit sélectionner les volumes dédiés utilisés pour vider et charger les données de l'application. Vous ne devez sélectionner qu'un seul volume dans les champs DumpTarget et LoadTarget.

HookFailurePolicy

Type sous-jacent : string Comportement souhaité en cas d'erreur d'exécution du hook.

Apparaît dans :HookSpec

HookSpec

Définit la façon dont un hook est exécuté dans un conteneur sélectionné, en supposant que le pod cible a été sélectionné.

Apparaît dans : - BackupAllRestoreAll - BackupOneRestoreAll - DumpAndLoad

Champ Description
chaîne name Nom de ce hook. Ce champ permet d'identifier l'état de l'exécution du crochet et les éventuelles erreurs rencontrées.
chaîne container Conteneur sur lequel ce crochet s'exécute. Si aucune valeur n'est spécifiée, il s'exécute sur le premier conteneur du pod.
Tableau de chaînes command Commande à exécuter. Commande de hook à exécuter. Par exemple, ["/sbin/fsfreeze", "--freeze"].
Entier timeoutSeconds Délai d'expiration du crochet en secondes. Si aucune valeur n'est spécifiée, la valeur par défaut est 30.
onError HookFailurePolicy Comportement souhaité à suivre lorsque l'exécution du hook rencontre une erreur. Les valeurs valides sont Ignore ou Fail. Si aucune valeur n'est spécifiée, la valeur par défaut est Fail.

ProtectedApplication

Définit le schéma de l'API Protectedapplication.

Apparaît dans :ProtectedApplicationList

Champ Description
chaîne apiVersion gkebackup.gke.io/v1
chaîne kind ProtectedApplication
metadata ObjectMeta Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata.
spec ProtectedApplicationSpec
status ProtectedApplicationStatus

ProtectedApplicationError

Contient des informations détaillées sur les erreurs pour cette ressource ProtectedApplication.

Apparaît dans :ProtectedApplicationStatus

Champ Description
chaîne reason Chaîne en camel case décrivant une erreur et utilisée pour l'analyse automatique et l'affichage ordonné.
chaîne message Message lisible indiquant des détails sur l'erreur.

ProtectedApplicationList

Contient une liste de ressources ProtectedApplication.

Champ Description
chaîne apiVersion gkebackup.gke.io/v1
chaîne kind ProtectedApplicationList
metadata ListMeta Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata.
Tableau ProtectedApplication items

ProtectedApplicationSpec

Définit les ressources pertinentes qui appartiennent à un ProtectedApplication et la manière dont l'application donnée doit être sauvegardée ou restaurée.

Apparaît dans :ProtectedApplication

Champ Description
resourceSelection ResourceSelection Ressources appartenant à cette ProtectedApplication.
Tableau Component components Composants de cette application protégée.

ProtectedApplicationStatus

Définit l'état de cette ressource ProtectedApplication.

Apparaît dans :ProtectedApplication

Champ Description
readyToBackup booléen Indique si cette ressource ProtectedApplication est prête à être sauvegardée. Une ressource ProtectedApplication n'est pas prête si elle contient des erreurs.
Tableau ProtectedApplicationError error Erreurs liées à cette application protégée. Par exemple, la configuration d'un composant n'est pas valide.

ResourceKind

Type sous-jacent : string Définit le type de ressource.

Apparaît dans :Component

ResourceSelection

Définit comment identifier les ressources appartenant à cette application.

Apparaît dans :ProtectedApplicationSpec

Champ Description
type ResourceSelectionType Type de source d'application. Le champ Type doit être ApplicationName ou Selector. Il s'agit du discriminateur d'union.
chaîne applicationName Nom d'une application sig-apps dans le même espace de noms. Il s'agit de l'application à laquelle s'applique la spécification de protection des données.
selector LabelSelector Ressources sélectionnées dans le même espace de noms que la ressource ProtectedApplication. La spécification de protection des données est appliquée à ces ressources.

ResourceSelectionType

Type sous-jacent : string Types de sélection.

Apparaît dans :ResourceSelection

RestoreJob

Définit le schéma de l'API RestoreJob.

Apparaît dans :RestoreJobList

Champ Description
chaîne apiVersion gkebackup.gke.io/v1
chaîne kind RestoreJob
metadata ObjectMeta Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata.
spec RestoreJobSpec
status RestoreJobStatus

RestoreJobList

Contient une liste de ressources RestoreJob.

Champ Description
chaîne apiVersion gkebackup.gke.io/v1
chaîne kind RestoreJobList
metadata ListMeta Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata.
items Tableau RestoreJob

RestoreJobSpec

Définit l'état souhaité d'une restauration.

Apparaît dans :RestoreJob

Champ Description
chaîne restoreName RestoreName est le nom de la restauration du plan de contrôle par rapport auquel RestoreJob est exécuté. Le nom est immuable.

RestoreJobStatus

Définit l'état observé d'un job de restauration.

Apparaît dans :RestoreJob

Champ Description
phase RestoreJobPhase État actuel d'une restauration.
chaîne message Message lisible indiquant pourquoi la restauration de la sauvegarde est dans cet état.
chaîne reason Chaîne en camel case décrivant une mise à jour quelconque et utilisée pour l'analyse automatique et l'affichage ordonné.

Stratégie

Définit comment sauvegarder et restaurer un composant spécifique. Il doit être défini sur BackupAllRestoreAll, BackupOneRestoreAll ou DumpAndLoad.

Apparaît dans :Component

Champ Description
type StrategyType Type de stratégie de sauvegarde et de restauration. La valeur ne peut être que BackupAllRestoreAll, BackupOneRestoreAll ou DumpAndLoad. Notez que le type de ressource Pod n'est compatible qu'avec la stratégie BackupAllRestoreAll. Il s'agit du discriminateur d'union.
backupAllRestoreAll BackupAllRestoreAll Stratégie qui sauvegarde tout ce qui est sélectionné dans ce composant et restaure tout lors de la restauration.
backupOneRestoreAll BackupOneRestoreAll Stratégie qui ne sauvegarde que les volumes d'un seul pod de ce composant, et qui sont restaurés sur tous les autres pods lors de la restauration. Cette stratégie est utilisée pour les applications déployées dans une configuration à haute disponibilité avec une instance principale et une ou plusieurs instances secondaires. Cette stratégie s'applique exclusivement aux composants StatefulSet qui utilisent une ressource volumeClaimTemplate définie pour provisionner des volumes.
dumpAndLoad DumpAndLoad Stratégie dans laquelle la sauvegarde et la restauration d'un composant sont effectuées à l'aide d'outils spécifiques à l'application pour vider et charger des données, comme mysqldump pour MySQL ou pg_dump pour PostgreSQL. Les fichiers de vidage sont stockés dans un volume dédié. Pour cette stratégie, seul le volume dédié doit être sélectionné pour la sauvegarde. La cible de vidage et la cible de chargement peuvent être différentes. Cette stratégie s'applique exclusivement aux composants StatefulSet qui utilisent une ressource volumeClaimTemplate définie pour provisionner des volumes.

StrategyType

Type sous-jacent : string Définit les stratégies de sauvegarde et de restauration d'un composant.

Apparaît dans :Strategy