Configuração do Servidor API

O Bencher API Server requer uma configuração JSON no momento da inicialização. A configuração pode ser fornecida de três maneiras:

• Variável de ambiente BENCHER_CONFIG: O valor deve ser definido para a configuração JSON
• Variável de ambiente BENCHER_CONFIG_PATH: O valor deve ser definido para o caminho de um arquivo que contenha a configuração JSON
• Arquivo /etc/bencher/bencher.json: Um arquivo neste local contendo a configuração JSON

Se nenhuma configuração for encontrada, uma configuração padrão será carregada.

Para atualizar a configuração enquanto o servidor está em execução, um administrador pode usar o comando do CLI bencher server config update que acessa o endpoint PUT /v0/server/config. Todas as configurações atualizadas são salvas na variável de ambiente BENCHER_CONFIG e no disco em BENCHER_CONFIG_PATH.

Exemplo de configuração JSON:

{
  "console": {
    "url": "https://bencher.example.com"
  },
  "security": {
    "issuer": "https://api.bencher.example.com",
    "secret_key": "UJu7Cpxb-zFaJYqXD-3mDDSDyj-ZvfxZFZs-X58xjxPy"
  },
  "server": {
    "bind_address": "0.0.0.0:61016",
    "request_body_max_bytes": 1048576,
    "tls": {
      "type": "as_file",
      "cert_file": "/path/to/cert.pem",
      "key_file": "/path/to/key.pem"
    }
  },
  "logging": {
    "name": "Bencher API",
    "log": {
      "stderr_terminal": {
        "level": "info"
      }
    },
  },
  "database": {
    "file": "/var/lib/bencher/data/bencher.db",
    "data_store": {
      "service": "aws_s3"
      "access_key_id": "ABC123DoRemMiABC123",
      "secret_access_key": "AA3Chr-JSF5sUQqKwayx-FvCfZKsMev-5BqPpcFC3m7",
      "access_point": "arn:aws:s3:some-region-1:123456789:accesspoint/my-bucket/path/to/backup/dir"
    }
  },
  "smtp": {
    "hostname": "mailbonobo.com",
    "port": 587,
    "starttls": true,
    "username": "bencher",
    "secret": "WM3F2u9cqSNdBPLfy9sJ5kk9",
    "from_name": "Bencher",
    "from_email": "info@bencher.example.com"
  },
  "plus": {
    "disaster_recovery": {
      "busy_timeout": 5000,
      "replicas": [
        {
          "scheme": "s3",
          "bucket": "my-bucket",
          "path": "path/to/replicate",
          "access_key_id": "ABC123DoRemMiABC123",
          "secret_access_key": "AA3Chr-JSF5sUQqKwayx-FvCfZKsMev-5BqPpcFC3m7"
        }
      ]
    },
    "stats": {
      "offset": 11242,
      "enabled": true
    }
  }
}

console

security

server

Esta seção é baseada na configuração do servidor Dropshot.

logging

Esta seção é baseada na configuração de logging do Dropshot.

database

smtp

Esta seção especifica uma configuração de serviço SMTP. A seção inteira é opcional. Se não especificada, todas as mensagens serão enviadas para logging em vez disso.

plus

Esta seção é para recursos que são cobertos pela Licença Bencher Plus.

plus.github

Esta seção especifica a configuração para um aplicativo GitHub usado para autenticação OAuth2. Você deve ter uma licença Enterprise válida do Bencher Plus para pelo menos uma organização no servidor. A seção inteira é opcional. Se não especificada, a autenticação com o GitHub não será ativada.

plus.disaster_recovery

Esta seção especifica a configuração de recuperação de desastres. O Bencher suporta a replicação contínua de todas as alterações no banco de dados. Para backups sob demanda ou agendados, consulte a seção database.data_store da configuração.

Existem quatro schemes de replicação:

• file: Replicar para um caminho de arquivo local
  • path: Caminho para replicar
• sftp: Replicar via SFTP
  • host: Nome do host do sistema de destino
  • port: Número da porta do sistema de destino
  • user: Nome de usuário no sistema de destino
  • password: (Opcional) Senha no sistema de destino
  • path: (Opcional) Caminho no sistema de destino
  • key_path: (Opcional) Caminho para a chave SSH
• s3: Replicar para qualquer armazenamento de blob compatível com S3
  • bucket: Nome do bucket
  • path: (Opcional) Caminho no bucket
  • endpoint: (AWS: Opcional | Não-AWS: Obrigatório) Endpoint de replicação
  • region: (Opcional) Região do bucket
  • access_key_id: Chave de acesso do S3
  • secret_access_key: Chave de acesso secreta do S3
• abs: Replicar para o Azure Blob Storage
  • account_name: Nome da conta
  • bucket: Nome do bucket
  • path: (Opcional) Caminho no bucket
  • account_key: Chave da conta Azure
• gcs: Replicar para o Google Cloud Storage
  • bucket: Nome do bucket
  • path: (Opcional) Caminho no bucket
  • GOOGLE_APPLICATION_CREDENTIALS: Variável de ambiente configurada para o caminho do arquivo que aponta para as credenciais da conta de serviço

Todos os quatro schemes de replicação têm as seguintes opções adicionais:

• retention: (Opcional) A quantidade de tempo que os arquivos de snapshot e WAL serão mantidos. Após o período de retenção, um novo snapshot será criado e o antigo será removido. Arquivos WAL que existirem antes do snapshot mais antigo também serão removidos. O padrão é 24h.
• retention_check_interval: (Opcional) Especifica com que frequência o Bencher verificará se a retenção precisa ser aplicada. O padrão é 1h.
• snapshot_interval: (Opcional) Especifica com que frequência novos snapshots serão criados. Isso é usado para reduzir o tempo de restauração, já que snapshots mais novos terão menos frames WAL para aplicar. A retenção ainda se aplica a esses snapshots. Se você não definir um intervalo de snapshot, um novo snapshot será criado sempre que a retenção for realizada. A retenção ocorre a cada 24 horas por padrão.
• validation_interval: (Opcional) Quando especificado, o Bencher restaurará automaticamente e validará que os dados na réplica correspondem à cópia local. Desativado por padrão. Habilitar isso pode aumentar significativamente o custo de execução do Bencher, já que a maioria dos serviços em nuvem cobra pelos downloads.
• sync_interval: (Opcional) Frequência com que os frames são enviados para a réplica. O padrão é 1s. Aumentar a frequência pode aumentar significativamente os custos de armazenamento em nuvem.

plus.stats

Esta seção especifica se e quando as estatísticas do servidor são coletadas. A seção inteira é opcional. Se não especificado, os valores padrão listados serão usados. Ou seja, as estatísticas do servidor são opt-out. Defina enabled como false para desabilitar as estatísticas do servidor.