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

Sélectionnez une version de la documentation :

Schéma de spécification

BackupPlanSpec définit l'état souhaité de BackupPlan.

backupLocation:
  gcsOptions:
    bucket: string
    key: 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 pour stocker les sauvegardes. Par exemple, les spécifications 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 dépendantes de Cloud Storage.
backupLocation.gcsOptions.bucket
string
Obligatoire
Le bucket est un champ obligatoire (par exemple, "dbs-dump-bucket"). Un utilisateur doit s'assurer d'avoir un accès en écriture approprié au bucket de stockage depuis l'opérateur.
backupLocation.gcsOptions.key
string
Obligatoire
Clé d'objet pour les fichiers de vidage. (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
Le nom est unique dans un espace de noms pour faire référence à une ressource secrète.
backupLocation.gcsOptions.secretRef.namespace
string
Facultatif
L'espace de noms 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 elle est spécifiée, une sauvegarde créée dans ce BackupPlan sera automatiquement supprimée une fois son ancienneté 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 est de 14 jours de conservation.
backupSchedules
object
Facultatif
Définit les plannings pour différents types de sauvegardes. Les types de sauvegarde complète, différentielle et incrémentielle 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 différentielle pgBackRest. 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 backupplan. Ce champ est obligatoire et immuable.
paused
boolean
Facultatif

Valeur par défaut : "false".

Indicateur permettant de savoir 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é de BackupPlan.

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
Les conditions représentent les dernières observations disponibles de l'état actuel de l'entité.
conditions[]
object
CARACTÈRE FACULTATIF
L'état 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 heure n'est pas connue, il est acceptable d'utiliser l'heure à laquelle le champ d'API a changé.
conditions[].message
string
Obligatoire
Message lisible indiquant des détails sur la transition. Il peut s'agir d'une chaîne vide.
conditions[].observedGeneration
integer
Facultatif
Représente la valeur .metadata.generation sur laquelle la condition a été définie. Par exemple, si .metadata.generation est défini sur 12, mais que .status.conditions[x].observedGeneration est défini 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 l'état. 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 condition en 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 spécifique. Les codes d'erreur sont des chaînes DBSE suivies d'un nombre, comme "DBSE1012".
criticalIncidents[].createTime
string
Obligatoire
Horodatage de la création de cet incident à l'origine.
criticalIncidents[].message
string
Facultatif
L'incident ou l'erreur qui s'est produit.
criticalIncidents[].messageTemplateParams
object
Facultatif
Contient les paires clé-valeur nécessaires pour générer une version conviviale et axée sur les données du message dans l'interface utilisateur.
criticalIncidents[].resource
object
Obligatoire
Contient des informations sur le composant du service de base de données qui a signalé l'incident, ainsi que sur la ressource Kubernetes.
criticalIncidents[].resource.component
string
Obligatoire
Identifiant interne du sous-système Database Service 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
Type 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 de la trace de pile.
criticalIncidents[].stackTrace.component
string
Facultatif
Nom d'un composant du service de base de données ayant enregistré le message.
criticalIncidents[].stackTrace.message
string
Facultatif
Message enregistré.
criticalIncidents[].transientUntil
string
Facultatif
Si la valeur "TransientUntil" est présente, cela indique que le problème doit être considéré comme transitoire 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é réconcilié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.