APIサーバー設定

Bencher APIサーバーは、起動時にJSON構成を必要とします。 構成は以下の3つの方法で提供可能です:

• BENCHER_CONFIG環境変数: 値はJSON構成に設定する必要があります
• BENCHER_CONFIG_PATH環境変数: 値はJSON構成を含むファイルのパスに設定する必要があります
• /etc/bencher/bencher.jsonファイル: この場所にあるJSON構成を含むファイル

構成が見つからない場合、デフォルト構成が読み込まれます。

サーバーが実行中に構成を更新するには、 管理者はCLI bencher server config updateコマンドを使用し、 PUT /v0/server/config エンドポイントを呼び出します。 すべての更新された構成は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"
        }
      ]
    },
    "rate_limiting": {
      "window": 86400,
      "user_limit": 255,
      "unclaimed_limit": 255,
      "claimed_limit": 65536,
    },
    "stats": {
      "offset": 11242,
      "enabled": true
    }
  }
}

console

security

server

このセクションは Dropshotサーバー設定 に基づいています。

logging

このセクションは、Dropshot logging configurationに基づいています。

database

smtp

このセクションでは、SMTPサービスの設定を指定します。セクション全体は任意です。指定しない場合、すべてのメッセージは代わりにloggingに送信されます。

plus

このセクションは、Bencher Plusライセンスでカバーされる機能について説明しています。

plus.github

このセクションでは、OAuth2認証に使用されるGitHubアプリの設定を指定します。 サーバー上の少なくとも1つの組織に対して有効なBencher Plus エンタープライズ ライセンスが必要です。 このセクション全体はオプションです。 指定しない場合、GitHubによる認証は有効になりません。

plus.google

このセクションでは、OAuth2 認証に使用される Google クライアント の設定を指定します。 サーバー上の少なくとも1つの組織に対して有効な Bencher Plus Enterprise ライセンスが必要です。 このセクションは任意です。指定しない場合、Googleによる認証は有効になりません。

plus.disaster_recovery

このセクションは、災害復旧の設定を指定します。 Bencherはデータベースの全ての変更を継続的に複製することをサポートします。 オンデマンドまたは定期バックアップを実行するには、設定の database.data_store セクションをご覧ください。

複製には4つのスキームがあります：

• file: ローカルファイルパスに複製
  • path: 複製先のパス
• sftp: SFTPを使用して複製
  • host: 目標システムのホスト名
  • port: 目標システムのポート番号
  • user: 目標システムのユーザー名
  • password: (任意) 目標システムのパスワード
  • path: (任意) 目標システムのパス
  • key_path: (任意) SSHキーのパス
• s3: S3互換の任意のブロブストレージに複製
  • bucket: バケット名
  • path: (任意) バケット内のパス
  • endpoint: (AWS: 任意 | 非AWS: 必須) 複製エンドポイント
  • region: (任意) バケットのリージョン
  • access_key_id: S3アクセスキー
  • secret_access_key: S3シークレットアクセスキー
• abs: Azure Blobストレージに複製
  • account_name: アカウント名
  • bucket: バケット名
  • path: (任意) バケット内のパス
  • account_key: Azureアカウントキー
• gcs: Google Cloudストレージに複製
  • bucket: バケット名
  • path: (任意) バケット内のパス
  • GOOGLE_APPLICATION_CREDENTIALS: サービスアカウントの資格情報を指すファイルパスに設定される環境変数

4つの複製スキーム全てに共通の追加オプションがあります：

• retention: (任意) スナップショットおよびWALファイルが保持される時間。保持期間の後、新しいスナップショットが作成され、古いものは削除されます。最も古いスナップショットよりも前に存在するWALファイルも削除されます。デフォルトは 24h です。
• retention_check_interval: (任意) Bencherが保持を強制する必要があるかどうかをどの頻度でチェックするかを指定します。デフォルトは 1h です。
• snapshot_interval: (任意) 新しいスナップショットが作成される頻度を指定します。新しいスナップショットは適用されるWALフレームが少ないため、復元時間が短縮されます。保持はこれらのスナップショットにも適用されます。スナップショットの間隔を設定しない場合は、保持が行われるたびに新しいスナップショットが作成されます。保持はデフォルトで24時間ごとに行われます。
• validation_interval: (任意) 指定された場合、Bencherは自動的に復元し、複製データがローカルコピーと一致するかどうかを検証します。デフォルトでは無効になっています。これを有効にすると、ほとんどのクラウドサービスがダウンロードに料金を課すため、Bencherの実行コストが大幅に増加する可能性があります。
• sync_interval: (任意) フレームが複製にプッシュされる頻度。デフォルトは 1s です。頻度を上げるとクラウドストレージコストが大幅に増加する可能性があります。

plus.rate_limiting

このセクションでは、APIサーバーのレート制限を指定します。 このセクション全体はオプションです。 指定しない場合、リストされたデフォルト値が使用されます。

unclaimedプロジェクトの作成を防ぐには、 unclaimed_limitを0に設定します。

plus.stats

このセクションは、サーバー統計がどのくらいの頻度で収集されるのかを指定します。 このセクション全体は任意です。 何も指定されない場合は、リストされたデフォルト値が使用されます。 つまり、サーバー統計はオプトアウトです。 サーバー統計を無効にするには、enabledをfalseに設定します。