Config Serveur API

Le serveur API Bencher nécessite une configuration JSON au démarrage. La configuration peut être fournie de trois manières :

• Variable d’environnement BENCHER_CONFIG : La valeur doit être définie sur la configuration JSON
• Variable d’environnement BENCHER_CONFIG_PATH : La valeur doit être définie sur le chemin d’un fichier contenant la configuration JSON
• Fichier /etc/bencher/bencher.json : Un fichier à cet emplacement contenant la configuration JSON

Si aucune configuration n’est trouvée, une configuration par défaut est chargée.

Pour mettre à jour la configuration pendant que le serveur est en cours d’exécution, un administrateur peut utiliser la commande CLI bencher server config update qui sollicite le point de terminaison PUT /v0/server/config. Toutes les configurations mises à jour sont enregistrées dans la variable d’environnement BENCHER_CONFIG et sur le disque à BENCHER_CONFIG_PATH.

Exemple de configuration 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

Cette section se base sur la configuration du serveur Dropshot.

logging

Cette section est basée sur la configuration de logging Dropshot.

database

smtp

Cette section spécifie une configuration de service SMTP. La section entière est facultative. Si elle n’est pas spécifiée, tous les messages seront envoyés à logging .

plus

Cette section concerne les fonctionnalités couvertes par la Licence Bencher Plus.

plus.github

Cette section spécifie la configuration pour une application GitHub utilisée pour l’authentification OAuth2. Vous devez avoir une licence Bencher Plus Enterprise valide pour au moins une organisation sur le serveur. La totalité de la section est optionnelle. Si elle n’est pas spécifiée, alors l’authentification avec GitHub ne sera pas activée.

plus.disaster_recovery

Cette section spécifie la configuration de la récupération en cas de sinistre. Bencher prend en charge la réplication continue de tous les changements de base de données. Pour exécuter des sauvegardes à la demande ou programmées, consultez la section database.data_store de la configuration.

Il existe quatre schémas de réplication :

• file: Répliquer vers un chemin de fichier local
  • path: Chemin de réplication
• sftp: Répliquer via SFTP
  • host: Nom d’hôte du système cible
  • port: Numéro de port du système cible
  • user: Nom d’utilisateur sur le système cible
  • password: (Optionnel) Mot de passe sur le système cible
  • path: (Optionnel) Chemin sur le système cible
  • key_path: (Optionnel) Chemin vers la clé SSH
• s3: Répliquer vers un stockage de blob compatible S3
  • bucket: Nom du bucket
  • path: (Optionnel) Chemin dans le bucket
  • endpoint: (AWS: Optionnel | Non-AWS: Requis) Point de terminaison de réplication
  • region: (Optionnel) Région du bucket
  • access_key_id: Clé d’accès S3
  • secret_access_key: Clé d’accès secret S3
• abs: Répliquer vers Azure Blob Storage
  • account_name: Nom du compte
  • bucket: Nom du bucket
  • path: (Optionnel) Chemin dans le bucket
  • account_key: Clé de compte Azure
• gcs: Répliquer vers Google Cloud Storage
  • bucket: Nom du bucket
  • path: (Optionnel) Chemin dans le bucket
  • GOOGLE_APPLICATION_CREDENTIALS: Variable d’environnement définie avec le chemin du fichier pointant vers les informations d’identification du compte de service

Les quatre schémas de réplique ont les options supplémentaires suivantes :

• retention: (Optionnel) La durée pendant laquelle les fichiers snapshot & WAL seront conservés. Après la période de rétention, un nouveau snapshot sera créé et l’ancien sera supprimé. Les fichiers WAL existants avant le snapshot le plus ancien seront également supprimés. La valeur par défaut est 24h.
• retention_check_interval: (Optionnel) Spécifie la fréquence à laquelle Bencher vérifiera si la rétention doit être appliquée. La valeur par défaut est 1h.
• snapshot_interval: (Optionnel) Spécifie la fréquence de création des nouveaux snapshots. Cela permet de réduire le temps de restauration car les snapshots plus récents auront moins de trames WAL à appliquer. La rétention s’applique toujours à ces snapshots. Si vous ne définissez pas d’intervalle de snapshot, un nouveau snapshot sera créé chaque fois que la rétention sera effectuée. La rétention se produit toutes les 24 heures par défaut.
• validation_interval: (Optionnel) Lorsqu’il est spécifié, Bencher restaurera automatiquement et validera que les données sur la réplique correspondent à la copie locale. Désactivé par défaut. Activer cela peut augmenter considérablement le coût d’exécution de Bencher car la plupart des services cloud facturent les téléchargements.
• sync_interval: (Optionnel) Fréquence à laquelle les trames sont poussées vers la réplique. La valeur par défaut est 1s. Augmenter la fréquence peut augmenter considérablement les coûts de stockage cloud.

plus.stats

Cette section spécifie si et quand les statistiques du serveur sont collectées. L’ensemble de la section est facultatif. Si non spécifié, les valeurs par défaut énumérées seront utilisées. C’est-à-dire que les statistiques du serveur sont opt-out. Mettez enabled sur false pour désactiver les statistiques du serveur.