Конфигурация API сервера

Сервер API Bencher требует JSON-конфигурацию при запуске. Конфигурация может быть предоставлена тремя способами:

• Переменная окружения BENCHER_CONFIG: Значение должно быть установлено как JSON-конфигурация
• Переменная окружения BENCHER_CONFIG_PATH: Значение должно быть установлено как путь к файлу, содержащему JSON-конфигурацию
• Файл /etc/bencher/bencher.json: Файл в этом расположении, содержащий JSON-конфигурацию

Если конфигурация не найдена, загружается конфигурация по умолчанию.

Для обновления конфигурации во время работы сервера администратор может использовать команду CLI bencher server config update, которая обращается к PUT /v0/server/config endpoint. Все обновленные конфигурации сохраняются в переменной окружения BENCHER_CONFIG и на диске по пути BENCHER_CONFIG_PATH.

Пример 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

Этот раздел основан на конфигурации сервера Dropshot.

logging

Этот раздел основан на конфигурации журнала Dropshot.

database

smtp

В этом разделе указывается конфигурация сервиса SMTP. Весь раздел является необязательным. Если он не указан, все сообщения будут отправляться в logging.

plus

Этот раздел посвящен функциям, которые покрываются лицензией Bencher Plus.

plus.github

В этом разделе указывается конфигурация приложения GitHub, используемого для аутентификации OAuth2. У вас должна быть действующая лицензия Bencher Plus Enterprise для хотя бы одной организации на сервере. Весь раздел является необязательным. Если он не указан, то аутентификация с помощью GitHub не будет включена.

plus.disaster_recovery

Этот раздел описывает конфигурацию восстановления после аварий. Bencher поддерживает непрерывное реплицирование всех изменений базы данных. Для выполнения резервных копий по запросу или по расписанию, см. раздел конфигурации database.data_store.

Существует четыре схемы репликации:

• file: Реплицирование в локальную файловую систему
  • path: Путь для репликации
• sftp: Реплицирование по SFTP
  • host: Имя хоста целевой системы
  • port: Номер порта целевой системы
  • user: Имя пользователя на целевой системе
  • password: (Опционально) Пароль на целевой системе
  • path: (Опционально) Путь на целевой системе
  • key_path: (Опционально) Путь к SSH ключу
• s3: Реплицирование в любое совместимое S3 хранилище
  • bucket: Имя bucket
  • path: (Опционально) Путь в bucket
  • endpoint: (AWS: Опционально | Не AWS: Обязательно) Конечная точка репликации
  • region: (Опционально) Регион bucket
  • access_key_id: Ключ доступа S3
  • secret_access_key: Секретный ключ доступа S3
• abs: Реплицирование в Azure Blob Storage
  • account_name: Имя учетной записи
  • bucket: Имя bucket
  • path: (Опционально) Путь в bucket
  • account_key: Ключ учетной записи Azure
• gcs: Реплицирование в Google Cloud Storage
  • bucket: Имя bucket
  • path: (Опционально) Путь в bucket
  • GOOGLE_APPLICATION_CREDENTIALS: Переменная окружения, указывающая на путь к файлу с учетными данными сервисного аккаунта

Все четыре схемы репликации имеют следующие дополнительные опции:

• retention: (Опционально) Время, в течение которого будут сохраняться файлы snapshot и WAL. По истечении этого времени будет создан новый snapshot, а старый будет удален. Файлы WAL, которые существуют до самого старого snapshot, также будут удалены. Значение по умолчанию: 24h.
• retention_check_interval: (Опционально) Указывает, как часто Bencher будет проверять необходимость применения политики retention. Значение по умолчанию: 1h.
• snapshot_interval: (Опционально) Указывает, как часто будут создаваться новые snapshots. Это используется для уменьшения времени восстановления, так как новые snapshots будут содержать меньшее количество WAL кадров для применения. Политика retention также применяется к этим snapshots. Если вы не указываете интервал создания snapshot, то новый snapshot будет создан при каждом выполнении retention. По умолчанию retention выполняется каждые 24 часа.
• validation_interval: (Опционально) Если указано, Bencher автоматически восстановит и проверит, что данные на реплике соответствуют локальной копии. По умолчанию отключено. Включение этой функции может значительно увеличить стоимость запуска Bencher, так как большинство облачных сервисов взимают плату за загрузки.
• sync_interval: (Опционально) Частота, с которой кадры передаются на реплику. Значение по умолчанию: 1s. Увеличение частоты может значительно повысить затраты на облачное хранилище.

plus.stats

В этом разделе указывается, собираются ли и когда статистические данные сервера. Весь раздел является необязательным. Если он не указан, будут использованы перечисленные значения по умолчанию. То есть, статистика сервера собирается, если вы на это не отказываетесь. Установите значение enabled в false, чтобы отключить сбор статистики сервера.