Definizione di risorsa personalizzata BackupPlan 1.4.0

Seleziona una versione della documentazione:

Schema delle specifiche

BackupPlanSpec definisce lo stato desiderato di BackupPlan.

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

Campo

Tipo
Obbligatorio o facoltativo

 

Descrizione
backupLocation
object
Facoltativo
BackupLocation specifica la posizione di archiviazione degli oggetti remoti in cui archiviare i backup. Ad esempio, le specifiche in un bucket Cloud Storage. Questo campo è facoltativo. Per impostazione predefinita, i backup vengono archiviati nel disco di backup.
backupLocation.gcsOptions
object
Facoltativo
gcsOptions è un riferimento alle opzioni dipendenti per Cloud Storage.
backupLocation.gcsOptions.bucket
string
Obbligatorio
Bucket è un campo obbligatorio (ad esempio, dbs-dump-bucket). Un utente deve assicurarsi di avere l'accesso in scrittura corretto al bucket di archiviazione dall'operatore.
backupLocation.gcsOptions.key
string
Obbligatorio
Chiave dell'oggetto per i file di dump. ad esempio: ods-dump/scottschema.dmp.
backupLocation.gcsOptions.secretRef
object
Facoltativo
SecretRef è un riferimento al secret che archivia le informazioni di accesso a GCS.
backupLocation.gcsOptions.secretRef.name
string
Facoltativo
Il nome è univoco all'interno di uno spazio dei nomi per fare riferimento a una risorsa secret.
backupLocation.gcsOptions.secretRef.namespace
string
Facoltativo
Lo spazio dei nomi definisce lo spazio all'interno del quale il nome del secret deve essere univoco.
backupLocation.s3Options
object
Facoltativo
s3Options è un riferimento alle opzioni dipendenti da Cloud Storage.
backupLocation.s3Options.bucket
string
Obbligatorio
Bucket è un campo obbligatorio (ad esempio, dbs-dump-bucket). Un utente deve assicurarsi di avere l'accesso in scrittura corretto al bucket di archiviazione dall'operatore.
backupLocation.s3Options.caBundle
string
Facoltativo
CABundle è un pool di certificati CA con codifica PEM utilizzati per convalidare il certificato server di StorageGrid.
backupLocation.s3Options.endpoint
string
Facoltativo
L'endpoint è un endpoint S3.
backupLocation.s3Options.key
string
Obbligatorio
Una chiave dell'oggetto per i file di dump. ad esempio, ods-dump/scottschema.dmp.
backupLocation.s3Options.secretRef
object
Facoltativo
SecretRef è un riferimento al secret Kubernetes che archivia le credenziali per accedere al bucket Cloud Storage.
backupLocation.s3Options.secretRef.name
string
Facoltativo
Il nome è univoco all'interno di uno spazio dei nomi per fare riferimento a una risorsa secret.
backupLocation.s3Options.secretRef.namespace
string
Facoltativo
Lo spazio dei nomi definisce lo spazio all'interno del quale il nome del secret deve essere univoco.
backupLocation.type
string
Obbligatorio

Valori validi: GCS, S3.

Tipo di repository (S3 per Amazon S3, GCS per Google Cloud Storage), che indica all'agente quale sistema di archiviazione/API utilizzare.
backupRetainDays
integer
Facoltativo

Valore predefinito: 14; minimo: 1, massimo: 90.

Numero di giorni dopo i quali il servizio eliminerà un backup. Se specificato, un backup creato in base a questo BackupPlan verrà eliminato automaticamente dopo che la sua età raggiunge create_time + backup_retain_days. I valori validi vanno da 1 a 90 giorni. Se non specificato, il valore predefinito è 14 giorni di conservazione.
backupSchedules
object
Facoltativo
Definisce le pianificazioni per i diversi tipi di backup. Sono supportati i tipi di backup completo, differenziale e incrementale: https://pgbackrest.org/user-guide.html#concept/backup Questo campo è facoltativo. Per impostazione predefinita, esegui un backup completo ogni giorno a mezzanotte.
backupSchedules.differential
string
Facoltativo
Definisce la pianificazione Cron per un backup differenziale pgBackRest. Segue la sintassi standard di pianificazione cron: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
backupSchedules.full
string
Facoltativo
Definisce la pianificazione Cron per un backup pgBackRest completo. Segue la sintassi standard di pianificazione cron: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
backupSchedules.incremental
string
Facoltativo
Definisce la pianificazione Cron per un backup pgBackRest completo. Segue la sintassi standard di pianificazione cron: https://k8s.io/docs/concepts/workloads/controllers/cron-jobs/#cron-schedule-syntax
dbclusterRef
string
Facoltativo
Il nome del DBCluster configurato da questo piano di backup. Questo campo è obbligatorio e immutabile.
paused
boolean
Facoltativo

Valore predefinito: false.

Un flag che indica se la creazione del backup in questo BackupPlan è in pausa. Se è impostato su true, il servizio sospenderà la pianificazione di nuovi backup in questo BackupPlan. Il valore predefinito è False.

Schema dello stato

BackupPlanStatus definisce lo stato osservato di 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

Campo

Tipo
Obbligatorio o facoltativo

 

Descrizione
conditions
list (object)
OPZIONALITÀ
Le condizioni rappresentano le ultime osservazioni disponibili sullo stato attuale dell'entità.
conditions[]
object
OPZIONALITÀ
La condizione contiene i dettagli di un aspetto della situazione attuale
conditions[].lastTransactionTime
string
Obbligatorio
L'ultima volta che la condizione è passata da uno stato all'altro. Deve essere il momento in cui la condizione sottostante è cambiata. Se non è noto, è accettabile utilizzare l'ora in cui è stato modificato il campo API.
conditions[].message
string
Obbligatorio
Un messaggio leggibile che indica i dettagli della transizione. Potrebbe trattarsi di una stringa vuota.
conditions[].observedGeneration
integer
Facoltativo
Rappresenta .metadata.generation su cui è stata impostata la condizione. Ad esempio, se .metadata.generation è 12, ma .status.conditions[x].observedGeneration è 9, la condizione non è aggiornata rispetto allo stato attuale dell'istanza.
conditions[].reason
string
Obbligatorio
Lunghezza massima: 1024, lunghezza minima: 1 Contiene un identificatore programmatico che indica il motivo dell'ultima transizione della condizione. I produttori di tipi di condizioni specifici possono definire valori e significati previsti per questo campo e se i valori sono considerati un'API garantita. Il valore deve essere una stringa in formato CamelCase. Questo campo non può essere vuoto.
conditions[].status
string
Obbligatorio
Stato della condizione, uno tra True, False, Unknown.
conditions[].type
string
Obbligatorio
Lunghezza massima: 316 Tipo di condizione in formato CamelCase o in foo.example.com/CamelCase.
criticalIncidents
object
Obbligatorio
Un elenco piatto di tutti gli incidenti critici attivi. CriticalIncident contiene tutte le informazioni su un incidente critico in corso.
criticalIncidents[].code
string
Obbligatorio
Il codice di errore di questo errore specifico. I codici di errore sono stringhe numeriche DBSE+, ad esempio "DBSE1012".
criticalIncidents[].createTime
string
Obbligatorio
Il timestamp di creazione di questo incidente all'origine.
criticalIncidents[].message
string
Facoltativo
L'incidente/errore che si è verificato.
criticalIncidents[].messageTemplateParams
object
Facoltativo
Contiene le coppie chiave-valore necessarie per generare una versione basata sui dati e di facile utilizzo del messaggio nell'interfaccia utente.
criticalIncidents[].resource
object
Obbligatorio
Contiene informazioni sul componente del servizio di database che ha segnalato l'incidente, nonché sulla risorsa Kubernetes.
criticalIncidents[].resource.component
string
Obbligatorio
Un identificatore interno del sottosistema del servizio di database che ha segnalato l'incidente.
criticalIncidents[].resource.location
object
Facoltativo
Località
criticalIncidents[].resource.location.cluster
string
Facoltativo
Il nome del cluster della risorsa Kubernetes interessata.
criticalIncidents[].resource.location.group
string
Facoltativo
Il nome del gruppo della risorsa Kubernetes.
criticalIncidents[].resource.location.kind
string
Facoltativo
Il tipo di risorsa Kubernetes.
criticalIncidents[].resource.location.name
string
Facoltativo
Il nome della risorsa Kubernetes interessata.
criticalIncidents[].resource.location.namespace
string
Facoltativo
Lo spazio dei nomi della risorsa Kubernetes interessata.
criticalIncidents[].resource.location.version
string
Facoltativo
La versione della risorsa Kubernetes.
criticalIncidents[].stackTrace
object
Facoltativo
Un elenco non strutturato di messaggi dalla analisi dello stack.
criticalIncidents[].stackTrace.component
string
Facoltativo
Il nome di un componente del servizio di database che ha registrato il messaggio.
criticalIncidents[].stackTrace.message
string
Facoltativo
Messaggio registrato.
criticalIncidents[].transientUntil
string
Facoltativo
Se presente, TransientUntil indica che il problema deve essere considerato temporaneo fino all'ora specificata.
lastBackupTime
string
Facoltativo
Il timestamp dell'ultimo backup eseguito.
nextBackupTime
string
Facoltativo
Il timestamp del prossimo backup programmato.
observedGeneration
integer
Facoltativo
Interno: la generazione osservata dal controller.
phase
string
Facoltativo
La fase di un BackupPlan.
reconciled
boolean
Facoltativo
Interno: indica se la risorsa è stata riconciliata dal controller.
recoveryWindow
object
Facoltativo
La finestra di recupero attualmente disponibile.
recoveryWindow.begin
string
Facoltativo
Ora di inizio.
recoveryWindow.end
string
Facoltativo
Ora di fine.