gkebackup.gke.io/v1
Contém as definições do esquema da API para o grupo de APIs gkebackup.gke.io v1.
BackupAllRestoreAll
Define uma estratégia que faz uma cópia de segurança de tudo o que foi selecionado neste componente e restaura tudo durante o restauro.
Aparece em: - Estratégia
Campo | Descrição |
---|---|
backupPreHooks HookSpec |
Uma lista de hooks que são executados antes de fazer uma cópia de segurança de todos os volumes selecionados deste componente. Normalmente, estes são os passos de suspensão. Os pods de destino de execução são todos os pods neste componente. |
backupPostHooks HookSpec |
Uma lista de hooks que são executados depois de todos os volumes deste componente terem uma cópia de segurança. Normalmente, estes são os passos de anulação da suspensão. Os pods de destino de execução são todos os pods neste componente. |
volumeSelector LabelSelector |
Um seletor de etiquetas que é usado para selecionar volumes persistentes que são copiados e restaurados dentro deste componente. Se não for fornecido, todos os volumes persistentes são selecionados. |
BackupJobList
Contém uma lista de trabalhos de cópia de segurança.
Campo | Descrição |
---|---|
apiVersion string |
gkebackup.gke.io/v1 |
kind string |
BackupJobList |
metadata ListMeta |
Consulte a documentação da API Kubernetes para os campos de metadata . |
items Matriz BackupJob |
BackupJobSpec
Define o estado pretendido da tarefa de cópia de segurança.
Aparece em: - BackupJob
Campo | Descrição |
---|---|
backupName string |
O nome da cópia de segurança do plano de controlo contra o qual a tarefa de cópia de segurança está a ser executada. O nome é imutável. |
BackupJobStatus
Define o estado observado da tarefa de cópia de segurança.
Aparece em: - BackupJob
Campo | Descrição |
---|---|
phase BackupJobPhase |
A fase atual da cópia de segurança. |
message string |
Uma mensagem legível que indica detalhes sobre o motivo pelo qual a cópia de segurança se encontra neste estado. |
reason string |
Uma breve string em camel case que descreve qualquer atualização e é usada para análise por máquina e apresentação organizada. |
BackupOneRestoreAll
Define uma estratégia que apenas faz cópias de segurança de volumes de um Pod
neste componente e estes volumes são restaurados para todos os outros Pods durante
a restauração. Esta estratégia é usada para aplicações implementadas numa configuração de alta disponibilidade de um servidor principal e um ou mais servidores secundários. Esta estratégia é
exclusivamente aplicável a componentes StatefulSet
que usam
um recurso volumeClaimTemplate
definido para aprovisionar volumes.
Se um componente consistir em vários recursos Deployment
,
todas as implementações têm de ter exatamente uma réplica,
todas as réplicas têm de ter o mesmo número de volumes persistentes
e todos os volumes persistentes têm de ser definidos pela mesma ordem.
Estes volumes são definidos no campo .spec.template.spec.volumes
e os volumes não persistentes são ignorados.
Se um componente consistir em vários recursos StatefulSet
, todos os recursos StatefulSet
têm de ter o mesmo número de modelos de reivindicação de volume e todos os modelos de reivindicação de volume têm de seguir a mesma ordem. Estão definidos no campo .spec.volumeClaimTemplates
.
Aparece em: - Estratégia
Campo | Descrição |
---|---|
backupTargetName string |
O nome do recurso Deployment ou StatefulSet preferencial que é usado para a cópia de segurança. Selecionamos o grupo de destino com base na composição deste componente. Para vários Deployment , escolha o único agrupamento criado por este recurso Deployment . Para vários StatefulSet , escolha o primeiro pod criado pelo recurso StatefulSet de destino. Para um único StatefulSet , escolha o segundo Pod criado pelo recurso StatefulSet de destino. |
backupPreHooks HookSpec |
Uma lista de hooks que são executados antes de fazer uma cópia de segurança de todos os volumes selecionados deste componente. Normalmente, estes são os passos de suspensão. Os hooks só são executados no pod de cópia de segurança selecionado. |
backupPostHooks HookSpec |
Uma lista de hooks que são executados depois de todos os volumes deste componente terem uma cópia de segurança. Normalmente, estes são os passos de anulação da suspensão. Os hooks só são executados no pod de cópia de segurança selecionado. |
volumeSelector LabelSelector |
Um seletor de etiquetas que é usado para selecionar todos os volumes persistentes com cópia de segurança no Pod de destino. É possível que o seletor selecione volumes fora do pod de destino, mas apenas os volumes pertencentes ao pod de destino são cópias de segurança. Essas cópias de segurança de volumes são restauradas para todos os outros volumes selecionados pelo seletor durante o restauro. Se não for fornecido, todos os volumes persistentes são selecionados. |
Componente
Define um subconjunto de recursos da aplicação e as respetivas estratégias de cópia de segurança e restauro. Um componente individual é representado por uma lista de recursos StatefulSet
ou Deployment
.
Aparece em: - ProtectedApplicationSpec
Campo | Descrição |
---|---|
name string |
O nome exclusivo deste componente. |
resourceKind ResourceKind |
O tipo de recursos incluídos neste componente. O tipo de recurso só pode ser Deployment , StatefulSet ou Pod . De momento, o tipo de recurso Pod só suporta a estratégia BackupAllRestoreAll . |
resourceNames matriz de strings |
Os nomes dos recursos que pertencem a este componente. Tem de ser uma lista de nomes de recursos Deployment , StatefulSet ou Pod com base no que está definido no campo resourceKind . |
strategy Estratégia |
Os detalhes de como fazer uma cópia de segurança e restaurar este componente. |
DumpAndLoad
Define uma estratégia em que a cópia de segurança e o restauro de um componente são realizados através de ferramentas específicas da aplicação para transferir e carregar dados, como mysqldump
para o MySQL ou pg_dump
para o PostgreSQL. Os ficheiros de despejo são armazenados num volume dedicado. Apenas os volumes dedicados são
selecionados para fazer uma cópia de segurança para esta estratégia. O destino de despejo e o destino de carregamento podem ser diferentes. Esta estratégia é exclusivamente aplicável a componentes que usam um recurso volumeClaimTemplate
definido para aprovisionar volumes.StatefulSet
Aparece em: - Estratégia
Campo | Descrição |
---|---|
dumpTarget string |
O nome de um recurso Deployment ou StatefulSet preferencial que é usado para transferir os dados dos componentes. Selecionamos o pod de destino com base na composição deste componente. Para Deployment , escolha o único Pod criado pelo recurso Deployment de destino. Para o único StatefulSet , escolha o segundo Pod criado pelo recurso StatefulSet de destino se o número de réplicas for superior a dois. Caso contrário, escolha o único Pod. Para vários StatefulSet , escolha o primeiro pod criado pelo recurso StatefulSet de destino. |
loadTarget string |
O nome do recurso Deployment ou StatefulSet preferencial que é usado para carregar os dados do componente. Selecionamos o pod de destino com base na composição deste componente. Para Deployment , escolha o único agrupamento criado pelo recurso de destino Deployment . Para StatefulSet , escolha sempre o primeiro grupo de anúncios criado pelo recurso StatefulSet de destino. |
dumpHooks HookSpec |
Uma lista de hooks que são usados para despejar os dados deste componente num volume dedicado. O pod de destino de execução é um dos pods selecionados no campo DumpTarget . |
backupPostHooks HookSpec |
Uma lista de hooks que são executados após ser feita uma cópia de segurança de um volume de despejo dedicado. Normalmente, estes são passos de limpeza. |
loadHooks HookSpec |
Uma lista de hooks que são usados para carregar os dados deste componente a partir de um volume dedicado. Pode incluir passos de limpeza após a conclusão do carregamento. O pod de destino de execução é um dos pods selecionados no campo LoadTarget . |
volumeSelector LabelSelector |
Um seletor de etiquetas que tem de selecionar volumes dedicados usados para despejar e carregar os dados da aplicação. Só tem de selecionar um volume nos campos DumpTarget e LoadTarget . |
HookFailurePolicy
Tipo subjacente: string
O comportamento desejado a adotar se a execução do gancho encontrar um erro.
Aparece em: - HookSpec
HookSpec
Define como um gancho é executado num contentor selecionado, partindo do princípio de que o pod de destino foi selecionado.
Aparece em: - BackupAllRestoreAll - BackupOneRestoreAll - DumpAndLoad
Campo | Descrição |
---|---|
name string |
O nome deste gancho. Este campo é usado para identificar o estado da execução do gancho e quaisquer erros encontrados. |
container string |
O contentor no qual este gancho é executado. Se não for especificado, é executado no primeiro contentor do pod. |
command matriz de strings |
O comando a executar. O comando de gancho a executar. Por exemplo, ["/sbin/fsfreeze", "--freeze"] . |
timeoutSeconds número inteiro |
O limite de tempo do gancho em segundos. Se não for especificado, o valor predefinido é 30 . |
onError HookFailurePolicy |
O comportamento desejado a seguir quando a execução do gancho encontra um erro. Os valores válidos são Ignore ou Fail . Se não for especificado, o valor é Fail . |
ProtectedApplication
Define o esquema da API Protectedapplication
.
Aparece em: - ProtectedApplicationList
Campo | Descrição |
---|---|
apiVersion string |
gkebackup.gke.io/v1 |
kind string |
ProtectedApplication |
metadata ObjectMeta |
Consulte a documentação da API Kubernetes para os campos de metadata . |
spec ProtectedApplicationSpec |
|
status ProtectedApplicationStatus |
ProtectedApplicationError
Contém informações detalhadas sobre o erro para este recurso ProtectedApplication
.
Aparece em: - ProtectedApplicationStatus
Campo | Descrição |
---|---|
reason string |
Uma string em camel case que descreve qualquer erro e é usada para análise por máquina e apresentação organizada. |
message string |
Uma mensagem legível que indica detalhes sobre o erro. |
ProtectedApplicationList
Contém uma lista de recursos ProtectedApplication
.
Campo | Descrição |
---|---|
apiVersion string |
gkebackup.gke.io/v1 |
kind string |
ProtectedApplicationList |
metadata ListMeta |
Consulte a documentação da API Kubernetes para os campos de metadata . |
items ProtectedApplication array |
ProtectedApplicationSpec
Define os recursos relevantes que pertencem a um ProtectedApplication
,
e como a aplicação especificada tem de ser fazer uma cópia de segurança ou ser restaurada.
Aparece em: - ProtectedApplication
Campo | Descrição |
---|---|
resourceSelection ResourceSelection |
Os recursos que pertencem a este ProtectedApplication . |
components Matriz decomponentes |
Os componentes desta aplicação protegida. |
ProtectedApplicationStatus
Define o estado deste recurso ProtectedApplication
.
Aparece em: - ProtectedApplication
Campo | Descrição |
---|---|
readyToBackup booleano |
Especifica se este recurso ProtectedApplication está pronto para a cópia de segurança. Um recurso ProtectedApplication não está pronto se contiver erros. |
error ProtectedApplicationError array |
Os erros relacionados com esta aplicação protegida. Por exemplo, a configuração de um componente é inválida. |
ResourceKind
Tipo subjacente: string
Define o tipo de recurso.
Aparece em: - Componente
ResourceSelection
Define como identificar os recursos pertencentes a esta aplicação.
Aparece em: - ProtectedApplicationSpec
Campo | Descrição |
---|---|
type ResourceSelectionType |
O tipo de origem da aplicação. O campo Type tem de ser ApplicationName ou Selector . Este é o discriminador de união. |
applicationName string |
O nome de uma aplicação sig-apps no mesmo espaço de nomes. Esta é a aplicação à qual a especificação de proteção de dados se aplica. |
selector LabelSelector |
Os recursos no mesmo espaço de nomes que o recurso ProtectedApplication selecionado. A especificação de proteção de dados é aplicada a estes recursos. |
ResourceSelectionType
Tipo subjacente: string
Os tipos de seleção.
Aparece em: - ResourceSelection
RestoreJob
Define o esquema para a API RestoreJob
Aparece em: - RestoreJobList
Campo | Descrição |
---|---|
apiVersion string |
gkebackup.gke.io/v1 |
kind string |
RestoreJob |
metadata ObjectMeta |
Consulte a documentação da API Kubernetes para os campos de metadata . |
spec RestoreJobSpec |
|
status RestoreJobStatus |
RestoreJobList
Contém uma lista de recursos RestoreJob
.
Campo | Descrição |
---|---|
apiVersion string |
gkebackup.gke.io/v1 |
kind string |
RestoreJobList |
metadata ListMeta |
Consulte a documentação da API Kubernetes para os campos de metadata . |
items RestoreJob |
RestoreJobSpec
Define o estado pretendido de um restauro.
Aparece em: - RestoreJob
Campo | Descrição |
---|---|
restoreName string |
RestoreName é o nome de restauro do plano de controlo em relação ao qual o RestoreJob está a ser executado. O nome é imutável. |
RestoreJobStatus
Define o estado observado de uma tarefa de restauro.
Aparece em: - RestoreJob
Campo | Descrição |
---|---|
phase RestoreJobPhase |
O estado atual de um restauro. |
message string |
Uma mensagem legível que indica detalhes sobre o motivo pelo qual o restauro da cópia de segurança se encontra neste estado. |
reason string |
Uma string em camel case que descreve qualquer atualização e é usada para análise por máquina e apresentação organizada. |
Estratégia
Define como fazer uma cópia de segurança e restaurar um componente específico. Tem de ser um dos seguintes: BackupAllRestoreAll
, BackupOneRestoreAll
ou DumpAndLoad
.
Aparece em: - Componente
Campo | Descrição |
---|---|
type StrategyType |
O tipo de estratégia de cópia de segurança e restauro. O valor só pode ser BackupAllRestoreAll , BackupOneRestoreAll ou DumpAndLoad . Tenha em atenção que o tipo de recurso Pod só suporta a estratégia BackupAllRestoreAll . Este é o discriminador de união. |
backupAllRestoreAll BackupAllRestoreAll |
Uma estratégia que faz uma cópia de segurança de tudo o que foi selecionado neste componente e restaura tudo durante a restauração. |
backupOneRestoreAll BackupOneRestoreAll |
Uma estratégia que apenas faz cópias de segurança de volumes de um Pod neste componente e que são restauradas para todos os outros Pods durante o restauro. Esta estratégia é usada para aplicações implementadas numa configuração de alta disponibilidade de um servidor principal e um ou mais servidores secundários. Esta estratégia é exclusivamente aplicável a componentes StatefulSet que usam um recurso volumeClaimTemplate definido para aprovisionar volumes. |
dumpAndLoad DumpAndLoad |
Uma estratégia em que a cópia de segurança e o restauro de um componente são realizados através de ferramentas específicas da aplicação para transferir e carregar dados, como o mysqldump para o MySQL ou o pg_dump para o PostgreSQL. Os ficheiros de despejo são armazenados num volume dedicado. Apenas o volume dedicado tem de ser selecionado para ter uma cópia de segurança para esta estratégia. O destino de despejo e o destino de carregamento podem ser diferentes. Esta estratégia é exclusivamente aplicável a componentes StatefulSet que usam um recurso volumeClaimTemplate definido para aprovisionar volumes. |
StrategyType
Tipo subjacente: string
define as estratégias de cópia de segurança e restauro de um componente.
Aparece em: - Estratégia