Alternative config schema

[saitho]

While YAML files are easy to process, an alternative config schema may be easier to maintain.

The suggested schema is a block-based config schema. The idea of configuration blocks is easier to grasp, as the documentation would describe the structure of each block and where they can be used.

Similar schemas:

• Jenkins' Jenkinsfile, using Apache Groovy (requires Java -> can't use that)
• Nginx Configuration file (also see https://github.com/nginxinc/crossplane)

Domain declaration

Usecase:
I want to serve the application running inside the service "myservice" on port 8080 on the domain "mydomain.com" on port 80. It should require Basic Authentication with username "user" and password "pass".
The application has a WebSocket endpoint on path /socket.

Old

Taken from documentation

domains:
  - domain: mydomain.com
    expose:
      - internal_port: 8080
        external_port: 80
        service: myservice
        proxy_websocket_locations: ["/socket"]
    security:
        authentication:
            - type: basic
              username: user
              password: pass

New

The security block may be defined globally, inside a domain block or inside a port definition.

domain mydomain.com {
    serve {
        :80 {
            service = myservice
            port = 8080
            proxy_websocket_location {
                path = /socket
            }
            security {
                authentication {
                    type = basic
                    username = user
                    password = pass
                }
            }
        }
    }
    security {
        # ... same as security block inside port definition
    }
}

security {
    # ... same as security block inside port definition
}

Service declaration

Old

Taken from documentation

container:
  services:
    - name: app # service name
      image: nginxdemos/hello:latest # Docker image name
      volumes:
        - type: global # mount the "config" folder inside container at "/var/config". As both services use "global" they will mount the same source and share data.
          src: config
          dest: /var/config
        - type: local # mount the "data" folder inside container at "/var/data". This folder is not shared with other services ("local").
          src: data
          dest: /var/data
        - type: custom # mount the "/docker/data/test" folder inside container at "/var/test".
          src: /docker/data/test
          dest: /var/test
      hooks:
        execute_after_setup: ./setup.sh # this file is executed inside container after the container is created
        execute_before_destroy: ./destroy.sh # this file is executed inside container before the container is destroyed
    - name: db # service name
      image: mariadb:10.5 # Docker image name
      environment: # environment variables for Docker container
        MYSQL_ROOT_PASSWORD: example
      volumes_from: app:ro # mount all volumes from app service as readonly

New

service app {
  image = nginxdemos/hello:latest
  volume {
    type = global # mount the "config" folder inside container at "/var/config". As both services use "global" they will mount the same source and share data.
   src = config
   dest = /var/config
  }
  volume {
    type = local # mount the "data" folder inside container at "/var/data". This folder is not shared with other services ("local").
    src = data
    dest = /var/data
  }
  volume {
    type = custom # mount the "/docker/data/test" folder inside container at "/var/test".
    src = /docker/data/test
    dest = /var/test
  }
  hook after_setup {
    exec = ./setup.sh
  }
  hook before_destroy {
    exec = ./destroy.sh
  }
}
service db {
  image = mariadb:10.5
  volumes_from = app:ro
  environment {
    MYSQL_ROOT_PASSWORD = example
  }
}

Registry declaration

Old

Taken from documentation

container:
  registries:
    # Authenticate with Docker Hub for private images
    - username: mydockerhubuser
      password: mydockerhubpassword
    # Authenticate with custom Docker registry
    - username: myuser
      password: mypassword
      url: https://myregistry.com

New

registry {
  username = mydockerhubuser
  password = mydockerhubpassword
}
registry {
  username = myuser
  password = mypassword
  url = https://myregistry.com
}