Définition de ressource personnalisée BackupPlan v1.6.0

Sélectionnez une version de la documentation :

Schéma de spécification

"BackupPlanSpec" définit l'état souhaité pour le plan de sauvegarde.

backupLocation:
  gcsOptions:
    bucket: string
    key: string
    secretRef:
      name: string
      namespace: string
  s3Options:
    bucket: string
    caBundle: []string
    endpoint: string
    key: string
    region: string
    secretRef:
      name: string
      namespace: string
  type: string
backupRetainDays: integer
backupSchedules:
  differential: string
  full: string
  incremental: string
dbclusterRef: string
paused: boolean

Champ

Type
Obligatoire ou facultatif

 

Description
backupLocation
object
(facultatif) 		"BackupLocation" spécifie l'emplacement de stockage d'objets distant destiné à stocker les sauvegardes. Il peut s'agir, par exemple, d'un bucket Cloud Storage. Ce champ est facultatif. Par défaut, les sauvegardes sont stockées sur le disque de sauvegarde.
backupLocation.gcsOptions
object
(facultatif) 		"gcsOptions" fait référence aux options concernant Cloud Storage.
backupLocation.gcsOptions.bucket
string
Obligatoire 		"Bucket" est un champ obligatoire (par exemple, dbs-dump-bucket). L'utilisateur doit s'assurer de disposer d'un accès en écriture approprié sur le bucket de stockage depuis l'opérateur.
backupLocation.gcsOptions.key
string
Obligatoire 		Clé d'objet pour les fichiers de dump (par exemple, ods-dump/scottschema.dmp).
backupLocation.gcsOptions.secretRef
object
(facultatif) 		"SecretRef" est une référence au secret qui stocke les informations d'accès à GCS.
backupLocation.gcsOptions.secretRef.name
string
(facultatif) 		"name" est un nom unique (dans un espace de noms) servant à référencer une ressource de secret.
backupLocation.gcsOptions.secretRef.namespace
string
(facultatif) 		"namespace" définit l'espace dans lequel le nom du secret doit être unique.
backupLocation.s3Options
object
(facultatif) 		s3Options fait référence aux options dépendant de Cloud Storage.
backupLocation.s3Options.bucket
string
Obligatoire 		"Bucket" est un champ obligatoire (par exemple, dbs-dump-bucket). L'utilisateur doit s'assurer de disposer d'un accès en écriture approprié sur le bucket de stockage depuis l'opérateur.
backupLocation.s3Options.caBundle
string
(facultatif) 		CABundle est un pool de certificats CA encodés au format PEM qui sont utilisés pour valider le certificat de serveur StorageGrid.
backupLocation.s3Options.endpoint
string
(facultatif) 		Le point de terminaison est un point de terminaison S3.
backupLocation.s3Options.key
string
Obligatoire 		Clé d'objet pour les fichiers de dump. Par exemple, ods-dump/scottschema.dmp.
backupLocation.s3Options.secretRef
object
(facultatif) 		SecretRef est une référence au secret Kubernetes qui stocke les identifiants permettant d'accéder au bucket Cloud Storage.
backupLocation.s3Options.secretRef.name
string
(facultatif) 		"name" est un nom unique (dans un espace de noms) servant à référencer une ressource de secret.
backupLocation.s3Options.secretRef.namespace
string
(facultatif) 		"namespace" définit l'espace dans lequel le nom du secret doit être unique.
backupLocation.type
string
Obligatoire

Valeurs valides : GCS, S3.

Type de dépôt (S3 pour Amazon S3, GCS pour Google Cloud Storage), qui indique à l'agent le système de stockage/l'API à utiliser.
backupRetainDays
integer
(facultatif)

La valeur par défaut est 14, la valeur minimale est 1 et la valeur maximale est 90.

Nombre de jours après lequel le service supprime une sauvegarde. Si cette valeur est spécifiée, une sauvegarde créée selon ce BackupPlan sera automatiquement supprimée une fois l'ancienneté requise atteinte (create_time + backup_retain_days). Les valeurs valides sont comprises entre 1 et 90 jours. Si aucune valeur n'est spécifiée, la valeur par défaut de 14 jours de conservation s'applique.
backupSchedules
object
(facultatif) 		Définit les plannings pour différents types de sauvegardes. Les types de sauvegarde complète, différentielle et incrémentale sont acceptés : https://pgbackrest.org/user-guide.html#concept/backup. Ce champ est facultatif. Par défaut, effectuez une sauvegarde complète chaque jour à minuit.
backupSchedules.differential
string
(facultatif) 		Définit la planification Cron pour une sauvegarde pgBackRest différentielle. Suit la syntaxe de planification Cron standard : https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
backupSchedules.full
string
(facultatif) 		Définit la planification Cron pour une sauvegarde pgBackRest complète. Suit la syntaxe de planification Cron standard : https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
backupSchedules.incremental
string
(facultatif) 		Définit la planification Cron pour une sauvegarde pgBackRest complète. Suit la syntaxe de planification Cron standard : https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
dbclusterRef
string
(facultatif) 		Nom du DBCluster configuré par ce plan de sauvegarde. Ce champ est obligatoire et immuable.
paused
boolean
(facultatif)

Valeur par défaut : "false".

Indique si la création de sauvegardes dans ce BackupPlan est suspendue. Si la valeur est définie sur true, le service suspend la planification de nouvelles sauvegardes dans ce BackupPlan. La valeur par défaut est false.

Schéma d'état

"BackupPlanStatus" définit l'état observé pour le plan de sauvegarde.

conditions:
- lastTransactionTime: string
  message: string
  observedGeneration: integer
  reason: string
  status: string
  type: string
criticalIncidents:
- code: string
  createTime: string
  message: string
  messageTemplateParams: object
  resource:
    component: string
    location:
      cluster: string
      group: string
      kind: string
      name: string
      namespace: string
      version: string
  stackTrace:
  - component: string
    message: string
  transientUntil: string
lastBackupTime: string
nextBackupTime: string
observedGeneration: integer
phase: string
reconciled: boolean
recoveryWindow:
  begin: string
  end: string

Champ

Type
Obligatoire ou facultatif

 

Description
conditions
list (object)
CARACTÈRE FACULTATIF 		"Conditions" représente les dernières observations disponibles pour l'état actuel de l'entité.
conditions[]
object
OPTIONALITÉ 		"Condition" contient des informations sur un aspect de l'état actuel.
conditions[].lastTransactionTime
string
Obligatoire 		Dernière transition de la condition d'un état à un autre. Il doit s'agir du moment où la condition sous-jacente a changé. Si cette valeur n'est pas connue, vous pouvez utiliser l'heure à laquelle le champ d'API a changé.
conditions[].message
string
Obligatoire 		Message lisible par l'humain indiquant des détails sur la transition. Il peut s'agir d'une chaîne vide.
conditions[].observedGeneration
integer
(facultatif) 		Représente le .metadata.generation sur lequel la condition a été définie. Par exemple, si la valeur .metadata.generation est définie sur 12, mais que la valeur .status.conditions[x].observedGeneration est définie sur 9, la condition est obsolète par rapport à l'état actuel de l'instance.
conditions[].reason
string
Obligatoire 		Longueur maximale : 1 024, longueur minimale : 1. Contient un identifiant programmatique indiquant la raison de la dernière transition de la condition. Les producteurs de types de conditions spécifiques peuvent définir des valeurs et des significations attendues pour ce champ, et indiquer si les valeurs sont considérées comme une API garantie. La valeur doit être une chaîne CamelCase. Ce champ ne peut pas être vide.
conditions[].status
string
Obligatoire 		État de la condition. Sa valeur peut être "True", "False" ou "Unknown".
conditions[].type
string
Obligatoire 		Longueur maximale : 316. Type de la condition au format CamelCase ou au format foo.example.com/CamelCase.
criticalIncidents
object
Obligatoire 		Liste à plat de tous les incidents critiques actifs. "CriticalIncident" contient toutes les informations sur un incident critique en cours.
criticalIncidents[].code
string
Obligatoire 		Code d'erreur de cette erreur spécifique. Les codes d'erreur sont des chaînes DBSE suivies d'un nombre, comme "DBSE1012".
criticalIncidents[].createTime
string
Obligatoire 		Code temporel d'origine de la création de cet incident.
criticalIncidents[].message
string
(facultatif) 		L'incident survenu ou l'erreur qui s'est produite.
criticalIncidents[].messageTemplateParams
object
(facultatif) 		Contient des paires clé-valeur nécessaires pour générer une version conviviale et axée sur les données de Message dans l'interface utilisateur.
criticalIncidents[].resource
object
Obligatoire 		Contient des informations sur le composant Database Service qui a signalé l'incident, ainsi que des informations sur la ressource Kubernetes.
criticalIncidents[].resource.component
string
Obligatoire 		Identifiant interne du sous-système du service de base de données qui a signalé l'incident.
criticalIncidents[].resource.location
object
(facultatif) 		Emplacement
criticalIncidents[].resource.location.cluster
string
(facultatif) 		Nom du cluster de la ressource Kubernetes concernée.
criticalIncidents[].resource.location.group
string
(facultatif) 		Nom du groupe de la ressource Kubernetes.
criticalIncidents[].resource.location.kind
string
(facultatif) 		Genre de la ressource Kubernetes.
criticalIncidents[].resource.location.name
string
(facultatif) 		Nom de la ressource Kubernetes concernée.
criticalIncidents[].resource.location.namespace
string
(facultatif) 		Espace de noms de la ressource Kubernetes concernée.
criticalIncidents[].resource.location.version
string
(facultatif) 		Version de la ressource Kubernetes.
criticalIncidents[].stackTrace
object
(facultatif) 		Liste non structurée des messages provenant de la trace de la pile.
criticalIncidents[].stackTrace.component
string
(facultatif) 		Nom d'un composant Database Service ayant enregistré le message.
criticalIncidents[].stackTrace.message
string
(facultatif) 		Message consigné.
criticalIncidents[].transientUntil
string
(facultatif) 		Si la valeur "TransientUntil" est présente, cela indique que le problème doit être considéré comme temporaire jusqu'à l'heure spécifiée.
lastBackupTime
string
(facultatif) 		Code temporel de la sauvegarde la plus récente.
nextBackupTime
string
(facultatif) 		Code temporel de la prochaine sauvegarde planifiée.
observedGeneration
integer
(facultatif) 		Interne : génération observée par le contrôleur.
phase
string
(facultatif) 		Phase d'un BackupPlan.
reconciled
boolean
(facultatif) 		Interne : indique si la ressource a été rapprochée par le contrôleur.
recoveryWindow
object
(facultatif) 		Période de récupération actuellement disponible.
recoveryWindow.begin
string
(facultatif) 		Heure de début
recoveryWindow.end
string
(facultatif) 		Heure de fin