package datakit-ci

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Web Configuration

package datakit-ci

datakit-ci
- Datakit_ci
  - ACL
  - BUILDER
    
    Key
  - Cache
    
    Make
    
    B
    
    Key
    
    Path
  - Config
  - DK
    
    Branch
    
    Commit
    
    Transaction
    
    Tree
  - Docker
    
    Image
  - Git
  - Live_log
  - Monitored_pool
  - Output
  - Private
    
    Client9p
    
    KV_RO
    
    LowLevel
  - Process
  - Target
  - Term
    
    Infix
  - Utils
    
    Infix
  - Web

Legend:
Library
Module
Module type
Parameter
Class
Class type

Web Configuration

type config

The type for web configuration.

val config : 
  ?name:string ->
  ?state_repo:Uri.t ->
  ?metrics_token:[ `SHA256 of string ] ->
  ?listen_addr:[ `HTTP of int | `HTTPS of int ] ->
  can_read:ACL.t ->
  can_build:ACL.t ->
  unit ->
  config

config ~name ~state_repo ~can_read ~can_build () is a web configuration. If name is given, it is used as the main heading, and also as the name of the session cookie (useful if you run multiple CIs on the same host, on different ports). If state_repo is given, it is used to construct links to the state repository on GitHub. If metrics_token is Some (`SHA256 expected) given then doing an HTTP GET on /metrics with an Authorization header containing "Bearer TTT" will return Prometheus-format metrics if sha256(TTT) = expected. There is no rate limiting, so pick a long token.