tobilg/postgrest-dcos repository overview

⁠postgrest-dcos

A Docker image for running https://github.com/begriffs/postgrest⁠ on DC/OS

⁠Configuration

The postgrest instance can be configured using environment variables:

• POSTGRES_URL: The hostname or ip address of the Postgres instance, concatenated by a : and the port on which the instance is running. Default is postgresql.marathon.l4lb.thisdcos.directory:5432. (mandatory)
• POSTGRES_DATABASE: The name of the database to use. (mandatory)
• POSTGRES_SCHEMA: The name of the schema to use. (mandatory)
• POSTGRES_USER: The name of the Postgres user. (mandatory)
• POSTGRES_PASSWORD: The Postgres user's password. (mandatory)
• POSTGRES_TIMEOUT_SECONDS: The timeout for which dockerize checks the availability of the Postgres service at the POSTGRES_URL. Default is `120 seconds.
• POSTGREST_JWT_SECRET: The JWT secret used to connect to postgrest. By default, a random 32 character string will be generated if nothing is provided.
• POSTGREST_DB_MAX_ROWS: The number of rows that a query can return at maximum. Default is 1000.
• POSTGREST_DB_POOL_SIZE: The number of connections which are used for connection pooling. Default is 5.
• POSTGREST_ANON_ROLE: The default anon database role. Default is app_user.

⁠Running

You can run postgrest by using the following Marathon app definition:

{
  "id": "postgrest",
  "cpus": 0.5,
  "mem": 1024.0,
  "instances": 1,
  "container": {
    "type": "DOCKER",
    "docker": {
      "image": "tobilg/postgrest-dcos:latest",
      "network": "HOST",
      "forcePullImage": true
    }
  },
  "env": {
    "POSTGRES_USER": "marathon",
    "POSTGRES_PASSWORD": "test123",
    "POSTGRES_DATABASE": "marathon-build",
    "POSTGRES_SCHEMA": "postgrest-test",
    "POSTGREST_ANON_ROLE": "marathon"
  },
  "labels": {
    "HAPROXY_GROUP": "external",
    "HAPROXY_0_VHOST": "YOUR_EXTERNAL_LB_HOSTNAME",
    "HAPROXY_0_PATH": "/postgrest",
    "HAPROXY_0_HTTP_BACKEND_PROXYPASS_PATH": "/postgrest"
  },
  "portDefinitions": [
    {
      "port": 0,
      "protocol": "tcp",
      "name": "http",
      "labels": {
        "VIP_0": "postgrest:80"
      }
    }
  ],
  "requirePorts": false,
  "healthChecks": [
    {
      "protocol": "HTTP",
      "portIndex": 0,
      "path": "/postgrest",
      "gracePeriodSeconds": 5,
      "intervalSeconds": 20,
      "maxConsecutiveFailures": 3
    }
  ]
}

The postgrest service will then be available at postgrest.marathon.l4lb.thisdcos.directory:80 inside the DC/OS cluster. The above example will expose the service via marathon-lb, make sure to change the HAPROXY_0_VHOST to your external loadbalancer.

⁠Authentication

Make sure you configure your Postgres database as described in the postgrest docs⁠. Also make sure to configure the correct POSTGREST_ANON_ROLE role. Otherwise the public will have read/write access!