Krane config file

[david-castaneda]

Krane's startup configuration is entirely managed through environment variables.

export KRANE_PRIVATE_KEY=""
export DB_PATH=""
export LETSENCRYPT_EMAIL=""

It would be very convenient to have such configurations persisted to a file, like a configuration file that gets picked up by Krane during startup. Environment variables can optionally be used to configure this file and the idea is environment variables would overwrite default values set in the configuration file.

krane.yaml

---
krane:
  private_key: "xxx" # Private key for signing auth requests
  log_level: debug # Log level used by Krane specific logs
  ssh_keys: "/usr/.ssh/authorized_keys" # Path to your ssh keys 
  domain: "krane.example.com" # DNS domain used by Krane to receive requests ($ krane login <domain>)
  https: true # Secure TLS communication (Powered by Lets Encrypt)
  db:
    path: "/data/krane" # Database directory used by Krane to store data
  workers: 1 # Workers for deployment jobs
  queue:
    size: 1 # Deployment jobs queued at any given time
    retry_policy: 1 # Amount of retries for a failed job
proxy:
  enabled: true # If the DNS proxy (Traefik) should be running
  domain: "proxy.example.com" # DNS domain to use for the Traefik dashboard
  https: true  # Secure TLS communication (Powered by Lets Encrypt)
  letsencrypt:
    email: "[email protected]"  # Email used to generate Lets Encrypt certificates for ALL your infrastructure

• Proposed configuration would be in YAML since it's a standard configuration format that allows the use of comments
• The configuration file allows you to configure the Krane and Proxy options