gkebackup.gke.io/v1
Contém as definições de esquema da API para o grupo de APIs gkebackup.gke.io v1.
BackupAllRestoreAll
Define uma estratégia que faz backup de tudo selecionado neste componente e restaura tudo durante a restauração.
Aparece em: - Estratégia
Campo | Descrição |
---|---|
backupPreHooks Matriz HookSpec |
Uma lista de hooks executados antes do backup de todos os volumes selecionados deste componente. Essas são geralmente as etapas de inatividade. Os pods de destino de execução são todos os pods dentro desse componente. |
backupPostHooks Matriz HookSpec |
Uma lista de hooks executados depois que todos os volumes deste componente são armazenados em backup. Geralmente, essas são as etapas de remoção da inatividade. Os pods de destino de execução são todos os pods dentro desse componente. |
volumeSelector LabelSelector |
Um seletor de rótulos usado para selecionar volumes permanentes que são armazenados em backup e restaurados nesse componente. Todos os volumes permanentes serão selecionados se isso não for fornecido. |
BackupJobList
Contém uma lista de jobs de backup.
Campo | Descrição |
---|---|
apiVersion string |
gkebackup.gke.io/v1 |
kind string |
BackupJobList |
metadata ListMeta |
Consulte a documentação da API Kubernetes para saber mais sobre os campos de metadata . |
items Matriz de BackupJob |
BackupJobSpec
Define o estado desejado do job de backup.
Aparece em: - BackupJob
Campo | Descrição |
---|---|
backupName string |
O nome do backup do plano de controle em que o job de backup está sendo executado. O nome é imutável. |
BackupJobStatus
Define o estado observado do job de backup.
Aparece em: - BackupJob
Campo | Descrição |
---|---|
phase BackupJobPhase |
A fase atual do backup. |
message string |
Uma mensagem legível por humanos indicando detalhes sobre o motivo de o backup estar nesse estado. |
reason string |
Uma breve string em camel case que descreve qualquer atualização e é usada para análise automática e exibição organizada. |
BackupOneRestoreAll
Define uma estratégia que faz backup apenas dos volumes de um pod
dentro desse componente, e esses volumes são restaurados para todos os outros pods durante
a restauração. Essa estratégia é usada para aplicativos implantados
em uma configuração de alta disponibilidade de um primário e um ou mais secundários. Essa estratégia é aplicável exclusivamente a componentes StatefulSet
que usam um recurso volumeClaimTemplate
definido para provisionar volumes.
Se um componente consistir em vários recursos Deployment
,
todas as implantações precisarão ter exatamente uma réplica,
todas as réplicas precisarão ter o mesmo número de volumes permanentes,
e todos os volumes permanentes precisarão ser definidos na mesma ordem.
Esses volumes são definidos no campo .spec.template.spec.volumes
, e os não permanentes são ignorados.
Se um componente consistir em vários recursos StatefulSet
, todos eles precisarão ter o mesmo número de modelos de solicitação de volume e seguir a mesma ordem.StatefulSet
Elas são definidas no campo .spec.volumeClaimTemplates
.
Aparece em: - Estratégia
Campo | Descrição |
---|---|
backupTargetName string |
O nome do recurso Deployment ou StatefulSet preferido usado para backup. Selecionamos o pod de destino com base na composição desse componente. Para multi-Deployment , escolha o único pod criado por esse recurso Deployment . Para multi-StatefulSet , escolha o primeiro pod criado pelo recurso de destino StatefulSet . Para StatefulSet único, escolha o segundo pod criado pelo recurso StatefulSet de destino. |
backupPreHooks Matriz HookSpec |
Uma lista de hooks executados antes do backup de todos os volumes selecionados deste componente. Essas são geralmente as etapas de inatividade. Os hooks são executados apenas no pod de backup selecionado. |
backupPostHooks Matriz HookSpec |
Uma lista de hooks executados depois que todos os volumes deste componente são armazenados em backup. Geralmente, essas são as etapas de remoção da inatividade. Os hooks são executados apenas no pod de backup selecionado. |
volumeSelector LabelSelector |
Um seletor de rótulo usado para selecionar todos os volumes permanentes com backup no pod de destino. É possível que o seletor escolha volumes fora do pod de destino, mas apenas os volumes pertencentes ao pod de destino são armazenados em backup. Esses backups de volume são restaurados para todos os outros volumes selecionados pelo seletor durante a restauração. Todos os volumes permanentes serão selecionados se isso não for fornecido. |
Componente
Define um subconjunto de recursos do aplicativo e as estratégias de backup e
restauração deles. Um componente individual é representado por uma lista de recursos StatefulSet
ou Deployment
.
Aparece em: - ProtectedApplicationSpec
Campo | Descrição |
---|---|
name string |
O nome exclusivo do componente. |
resourceKind ResourceKind |
O tipo de recursos incluídos neste componente. O tipo de recurso só pode ser Deployment , StatefulSet ou Pod . No momento, o tipo de recurso Pod só é compatível com a estratégia BackupAllRestoreAll . |
resourceNames matriz de string |
Os nomes dos recursos que pertencem a este componente. Precisa 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 backup e restaurar esse componente. |
DumpAndLoad
Define uma estratégia em que o backup e a restauração de um componente são realizados usando ferramentas específicas do aplicativo para despejar e carregar dados, como mysqldump
para MySQL ou pg_dump
para PostgreSQL. Os arquivos de despejo são
armazenados em um volume dedicado. Somente os volumes dedicados são selecionados para backup nessa estratégia. O destino de despejo e o destino de carregamento
podem ser diferentes. Essa estratégia é aplicável exclusivamente a componentes StatefulSet
que usam um recurso volumeClaimTemplate
definido para provisionar volumes.
Aparece em: - Estratégia
Campo | Descrição |
---|---|
dumpTarget string |
O nome de um recurso Deployment ou StatefulSet preferido usado para despejar os dados do componente. Selecionamos o pod de destino com base na composição desse componente. Para Deployment , escolha o único pod criado pelo recurso Deployment de destino. Para StatefulSet único, escolha o segundo pod criado pelo recurso StatefulSet de destino se o número de réplicas for maior que dois. Caso contrário, escolha o único pod. Para multi-StatefulSet , escolha o primeiro pod criado pelo recurso de destino StatefulSet . |
loadTarget string |
O nome do recurso Deployment ou StatefulSet preferido usado para carregar os dados do componente. Selecionamos o pod de destino com base na composição desse componente. Para Deployment , escolha o único pod criado pelo recurso de destino Deployment . Para StatefulSet , sempre escolha o primeiro pod criado pelo recurso de destino StatefulSet . |
dumpHooks Matriz HookSpec |
Uma lista de hooks usados para despejar os dados deste componente em um volume dedicado. O pod de destino da execução é um dos pods selecionados no campo DumpTarget . |
backupPostHooks Matriz HookSpec |
Uma lista de hooks executados depois que um volume de despejo dedicado é armazenado em backup. Geralmente, essas são etapas de limpeza. |
loadHooks Matriz HookSpec |
Uma lista de hooks usados para carregar os dados deste componente de um volume dedicado. Ele pode incluir etapas de limpeza após a conclusão do carregamento. O pod de destino da execução é um dos pods selecionados no campo LoadTarget . |
volumeSelector LabelSelector |
Um seletor de rótulos que precisa selecionar volumes dedicados usados para despejar e carregar os dados do aplicativo. Apenas um volume precisa ser selecionado nos campos DumpTarget e LoadTarget . |
HookFailurePolicy
Tipo subjacente:string
O comportamento desejado a ser adotado se a execução do hook encontrar um erro.
Aparece em: - HookSpec
HookSpec
Define como um hook é executado em um contêiner selecionado, supondo que o pod de destino tenha sido selecionado.
Aparece em: - BackupAllRestoreAll - BackupOneRestoreAll - DumpAndLoad
Campo | Descrição |
---|---|
name string |
O nome deste hook. Esse campo é usado para identificar o status da execução do hook e os erros encontrados. |
container string |
O contêiner em que esse hook é executado. Se não for especificado, ele será executado no primeiro contêiner do pod. |
command matriz de string |
O comando a ser executado. O comando de hook a ser executado. Por exemplo, ["/sbin/fsfreeze", "--freeze"] |
timeoutSeconds número inteiro |
O tempo limite do hook em segundos. Se não for especificado, o valor padrão será 30 . |
onError HookFailurePolicy |
O comportamento desejado a seguir quando a execução do hook encontra um erro. Os valores válidos são Ignore ou Fail . Se não for especificado, o valor será 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 saber mais sobre 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 camel case que descreve qualquer erro e é usada para análise de máquina e exibição organizada. |
message string |
Uma mensagem legível indicando 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 saber mais sobre os campos de metadata . |
items Matriz ProtectedApplication |
ProtectedApplicationSpec
Define os recursos relevantes que pertencem a um ProtectedApplication
e como o aplicativo especificado precisa ser armazenado ou restaurado.
Aparece em: - ProtectedApplication
Campo | Descrição |
---|---|
resourceSelection ResourceSelection |
Os recursos que pertencem a este ProtectedApplication . |
components Matriz de componentes |
Os componentes desse aplicativo protegido. |
ProtectedApplicationStatus
Define o status do recurso ProtectedApplication
.
Aparece em: - ProtectedApplication
Campo | Descrição |
---|---|
readyToBackup booleano |
Especifica se o recurso ProtectedApplication está pronto para backup. Um recurso ProtectedApplication não está pronto se contiver erros. |
error ProtectedApplicationError |
Os erros relacionados a esse aplicativo protegido. Por exemplo, uma configuração de componente é inválida. |
ResourceKind
Tipo subjacente:string
Define o tipo do recurso.
Aparece em: - Component
ResourceSelection
Define como identificar os recursos pertencentes a esse aplicativo.
Aparece em: - ProtectedApplicationSpec
Campo | Descrição |
---|---|
type ResourceSelectionType |
O tipo de origem do aplicativo. O campo Type precisa ser ApplicationName ou Selector . Este é o discriminador de união. |
applicationName string |
O nome de um aplicativo sig-apps no mesmo namespace. É o aplicativo a que a especificação de proteção de dados se aplica. |
selector LabelSelector |
Os recursos no mesmo namespace que o recurso ProtectedApplication selecionado. A especificação de proteção de dados é aplicada a esses recursos. |
ResourceSelectionType
Tipo subjacente:string
Os tipos de seleção.
Aparece em: - ResourceSelection
RestoreJob
Define o esquema da 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 saber mais sobre 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 saber mais sobre os campos de metadata . |
items RestoreJob |
RestoreJobSpec
Define o estado desejado de uma restauração.
Aparece em: - RestoreJob
Campo | Descrição |
---|---|
restoreName string |
"RestoreName" é o nome da restauração do plano de controle que o "RestoreJob" está executando. O nome é imutável. |
RestoreJobStatus
Define o estado observado de um job de restauração.
Aparece em: - RestoreJob
Campo | Descrição |
---|---|
phase RestoreJobPhase |
O status atual de uma restauração. |
message string |
Uma mensagem legível indicando detalhes sobre o motivo de a restauração do backup estar nesse estado. |
reason string |
Uma string em camel case que descreve qualquer atualização e é usada para análise de máquina e exibição organizada. |
Estratégia
Define como fazer backup e restauração de um componente específico. Ele precisa ser BackupAllRestoreAll
, BackupOneRestoreAll
ou DumpAndLoad
.
Aparece em: - Component
Campo | Descrição |
---|---|
type StrategyType |
O tipo de estratégia de backup e restauração. O valor só pode ser BackupAllRestoreAll , BackupOneRestoreAll ou DumpAndLoad . O tipo de recurso Pod só é compatível com a estratégia BackupAllRestoreAll . Este é o discriminador de união. |
backupAllRestoreAll BackupAllRestoreAll |
Uma estratégia que faz backup de tudo o que foi selecionado nesse componente e restaura tudo durante a restauração. |
backupOneRestoreAll BackupOneRestoreAll |
Uma estratégia que faz backup apenas dos volumes de um pod dentro desse componente e que são restaurados para todos os outros pods durante a restauração. Essa estratégia é usada para aplicativos implantados em uma configuração de alta disponibilidade de um primário e um ou mais secundários. Essa estratégia é aplicável exclusivamente a componentes StatefulSet que usam um recurso volumeClaimTemplate definido para provisionar volumes. |
dumpAndLoad DumpAndLoad |
Uma estratégia em que o backup e a restauração de um componente são realizados usando ferramentas específicas do aplicativo para despejar e carregar dados, como mysqldump para MySQL ou pg_dump para PostgreSQL. Os arquivos de despejo são armazenados em um volume dedicado. Apenas o volume dedicado precisa ser selecionado para backup nessa estratégia. O destino do despejo e o destino do carregamento podem ser diferentes. Essa estratégia é aplicável exclusivamente a componentes StatefulSet que usam um recurso volumeClaimTemplate definido para provisionar volumes. |
StrategyType
Tipo subjacente:string
Define as estratégias de backup e restauração de um componente.
Aparece em: - Estratégia