Pular para o conteúdo principal
Versão Next

Configuração dos Parâmetros Globais de Backup

Os seus parâmetros permitem configurar desde aspectos básicos, como diretórios de backup, até opções avançadas, como compressão, criptografia e retenção de backups.

Compreender cada parâmetro é essencial para ajustar o comportamento do pgBackRest conforme as necessidades do ambiente, otimizando desempenho, segurança e confiabilidade nas operações de backup e restauração.

Sintaxe do Comando
Terminal input
    pgsmart backup config [Flags]

Flags​

  • -a, --agent= <agent>. => Alias, hostname ou IP do servidor onde o PgSmart Agent pretendido está instalado.
  • -h, --help . => Ajuda
Configuração Não-Interativa

A execução não interativa está desabilitada para esta operação.

Configuração Interativa
Terminal input
    pgsmart backup config

Consultar um Parâmetro Global de Backup​

  1. Selecione o Agente do PgSmart pretendido ou Registar um novo Agente.

1.1. Selecione Configurações Globais no menu de opções.

  • Os parâmetros globais de backup default e aqueles configurados pelo usuário serão exibidos.

1.2. Para localizar um parâmetro na lista, digite o seu nome completo, parcial ou qualquer conjunto de caracteres relacionados ao valor ou à seção desejada. A pesquisa não diferencia maiúsculas de minúsculas (case insensitive).

1.3. Para visualizar detalhes do parâmetro, clique <ENTER> no parâmetro desejado.

nota

  • Os parâmetros globais são agrupados por seção:

    • global: Aplica-se a todos os sites, repositórios e comandos.
    • site: Parâmetros que definem o ambiente onde o backup está localizado.
    • repo: Parâmetros que definem o Repositório de backups. É onde os backups e os ficheiros WAL serão armazenados.

  • Cada parâmetro é identificado por sua origem de valores, que diz respeito a localização onde se origina o valor:

    • global: parâmetros configurados manualmente pelo usuário.
    • default: parâmetros que permanecem com os valores padrão, sem intervenção do usuário.
    • site: parâmetros configurados especificamente para o site de backup.
    • cmd (comando): parâmetros configurados para um determinado comando.

  • Exemplos:

    • Parâmetro global (aplica-se a todos os sites, repositórios e comandos), quando executado o comando annotate:

          ─── [ global:annotate ] ───
          (cmd)    annotation = rrrr=rrrr

    • Parâmetros global (aplica-se a todos os sites, repositórios e comandos):

          ─── [ global:annotate ] ───
          (global) compress-level = 5
alerta
  • Parâmetros na cor azul são obrigatórios e essenciais para o funcionamento do serviço.
  • Parâmetros em vermelho estão inconsistentes no ficheiro de configuração e devem ser corrigidos.
nota

  • Os parâmetros do pgBackRest são descritos com base nas suas principais características, o que ajuda a entender o seu comportamento e restrições.

  • Cada parâmetro é documentado de forma completa para garantir que o usuário saiba como configurá-lo corretamente com as seguintes informações (desde que aplicáveis):

  • Nome: Nome do parâmetro.
  • Tipo: Define o tipo de dado aceito (ex.: integer, boolean, string, size, list, list_kv).
  • Valor Corrente: Valor atualmente configurado.
  • Origem do Valor: Fonte que definiu o valor (ex.: default, global, site e cmd (comando)).
  • Valor Padrão: Valor assumido se nenhum outro for configurado.
  • Grupo: Categoria funcional do parâmetro (ex.: backup, restauração).
  • Seções: Contextos onde o parâmetro pode ser usado (global, site, repo).
  • Unidade Padrão: Unidade assumida na ausência de especificação explícita.
  • Obrigatório?: Informa se o parâmetro é mandatório.
  • Requer Reinicialização?: Se mudanças exigem reiniciar o serviço.
  • Somente Leitura?: Indica se o valor pode ou não ser alterado depois da configuração inicial.
  • Comandos: Operações em que o parâmetro é usado (ex.: backup, restauração, check).
  • Descrição: Explicação resumida da função do parâmetro.
  • Descrição Complementar: Informações adicionais, exemplos ou observações importantes.

  • Detalhes específicos do tipo Integer e Size:

    • Unidades (B, kB, MB, etc.)
    • Aceita decimal?
    • Aceita negativo?
    • Intervalo de valores.

  • Detalhes específicos do tipo Lista:

    • Indexação obrigatória (pg1-, pg2-).

  • Detalhes específicos do tipo string:

    • Aspas necessárias (casos especiais).
    • Case sensitive.
Figura 1 - Configuração de Parâmetros Globais de Backup - Consulta
Figura 1 - Configuração de Parâmetros Globais de Backup - Consulta
Figura 2 - Configuração de Parâmetros Globais de Backup - Consulta parâmetro por filtro
Figura 2 - Configuração de Parâmetros Globais de Backup - Consulta parâmetro por filtro

Inserir um Parâmetro Global de Backup​

  1. Selecione o Agente do PgSmart pretendido ou Registar um novo Agente.

1.1. Selecione Configurações Globais no menu de opções.

  • Os parâmetros globais de backup default e aqueles configurados pelo usuário serão exibidos.

1.2. Clique na tecla <insert> do seu teclado para inserir uma nova configuração de parâmetro.

1.3. Selecione um parâmetro na lista apresentada.

1.4. Clique <ENTER>.

1.5. Selecione global na seção do ficheiro de configuração.

1.6. Selecione a operação onde o parâmetro pode ser configurado.

1.7. Ajuste a configuração do parâmetro, conforme solicitado (esta operação varia segundo o tipo de cada parâmetro).

1.8. Confirme a operação.

1.9. Confirme a reinicialização, se for solicitado.

nota
  • A configuração dos parâmetros varia conforme o seu tipo.
    • booleano: desabilita/habilita o parâmetro. Ex: archive-async. Valor padrão: disabled. Valores: enabled/disabled.
    • string: valor digitado. Ex: pg1-host-ca-file. Valor: '/etc/pki/tls/certs/ca-bundle.crt'.
    • integer: número dentro de determinado intervalo ou não. Ex: compress-level.
    • lista: lista de valores separados por vírgula. Ex: db-exclude. Valores: (db1, db2, db5)
    • size: valor dentro de um intervalo em B, kB, MB, GB, TB, PB (varia para cada parâmetro). Ex: manifest-save-threshold. Unidade: B, kB, MB, GB, TB, PB. Intervalo de valores: 1B...1TB.
    • time: valor de tempo dentro de um intervalo em ms, s, min, h, d, w. Ex: process-max. Valor padrão: 1. Intervalo de valores: 1...999.
    • enum: valor a ser selecionado numa lista. Ex: buffer-size. Valores possíveis: 16kib, 32kib, 64kib, 128kib, 256kib, 512kib, 1mib, 2mib, 4mib, 8mib, 16mib
    • list_kv: lista de chave-valor (key-value list). Ex: annotation. Valor: sss=sss.
    • path: identifica um caminho. Ex: lock-path. Valor padrão: /tmp/pgbackrest.
alerta
  • Para modificar uma configuração já existente, use a funcionalidade Editar Parâmetro.
Figura 3 - Configuração de Parâmetros de Backup - Inserção de novo Parâmetro
Figura 3 - Configuração de Parâmetros de Backup - Inserção de novo Parâmetro

Editar um Parâmetro Global de Backup​

  1. Selecione o Agente do PgSmart pretendido ou Registar um novo Agente.

1.1. Selecione Configurações Globais no menu de opções.

  • Os parâmetros globais de backup default e aqueles configurados pelo usuário serão exibidos.

1.2. Digite <ENTER> no parâmetro pretendido para visualizar os seus detalhes.

  • Serão apresentados os detalhes do parâmetro selecionado.

1.3. Selecione Editar.

1.4. Indique/Selecione os novos valores.

1.5. Confirme a operação.

1.6. Confirme a reinicialização, se solicitado.

Figura 4 - Configuração de Parâmetros de Backup - Edição
Figura 4 - Configuração de Parâmetros de Backup - Edição

Remover um Parâmetro Global de Backup​

  1. Selecione o Agente do PgSmart pretendido ou Registar um novo Agente.

1.1. Selecione Configurações Globais no menu de opções.

  • Os parâmetros globais de backup default e aqueles configurados pelo usuário serão exibidos.

1.2. Digite <ENTER> no parâmetro pretendido para visualizar os seus detalhes.

  • Serão apresentados os detalhes do parâmetro selecionado.

1.3. Selecione Remover.

1.4. Confirme a operação.

1.5. Confirme a reinicialização, se solicitado.

Figura 5 - Configuração de Parâmetros de Backup - Remoção
Figura 5 - Configuração de Parâmetros de Backup - Remoção
nota

Ao remover a configuração de um parâmetro, este será revertido para o seu valor default.

Notas Finais
nota

  • Conforme o parâmetro alterado, poderá ser necessário efetuar um RELOAD ou um RESTART da instância. O PgSmart informará qual ação é necessária para aplicar a alteração.

  • Caso o Reload ou Restart não seja confirmado, a configuração permanecerá no ficheiro até que a ação necessária seja realizada.