docker-compose.yml

version: "2.4"
services:
  ######################################### NGINX #########################################
  nginx:
    container_name: 'osctrl-nginx'
    image: nginx:${NGINX_VERSION}
    restart: unless-stopped
    ports:
      - 8000:80
      - 8443:443
    networks:
      - default
      - osctrl-backend
    volumes:
      - type: bind
        source: ./deploy/docker/conf/nginx/nginx.conf
        target: /etc/nginx/nginx.conf
      - type: bind
        source: ./deploy/docker/conf/nginx/osctrl.conf
        target: /etc/nginx/conf.d/osctrl.conf
      - type: bind
        source: ./deploy/docker/conf/tls/tls.crt
        target: /etc/ssl/certs/osctrl.crt
      - type: bind
        source: ./deploy/docker/conf/tls/tls.key
        target: /etc/ssl/private/osctrl.key
    depends_on:
      - osctrl-tls
      - osctrl-admin
      - osctrl-api
    healthcheck:
      test: ["CMD", "curl", "-f", "-k", "https://localhost"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 40s
    cpus: 2
    mem_limit: 150M

  ######################################### osctrl-tls #########################################
  osctrl-tls:
    image: jmpsec/osctrl-tls:v${OSCTRL_VERSION}
    container_name: 'osctrl-tls'
    restart: unless-stopped
    environment:
      #### TLS settings ####
      - SERVICE_LISTENER=0.0.0.0
      - SERVICE_PORT=9000
      - SERVICE_HOST=0.0.0.0
      - SERVICE_AUTH=none
      - SERVICE_LOGGER=stdout
      #### Database settings ####
      - DB_HOST=postgres
      - DB_NAME=${POSTGRES_DB_NAME}
      - DB_USER=${POSTGRES_DB_USERNAME}
      - DB_PASS=${POSTGRES_DB_PASSWORD}
      #### Redis settings ####
      - REDIS_HOST=redis
    networks:
      - osctrl-backend
    depends_on:
      - postgres
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:9000"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 40s
    cpus: 2
    mem_limit: 150M

  ######################################### osctrl-admin #########################################
  osctrl-admin:
    container_name: 'osctrl-admin'
    restart: unless-stopped
    image: jmpsec/osctrl-admin:v${OSCTRL_VERSION}
    environment:
      #### TLS settings ####
      - SERVICE_LISTENER=0.0.0.0
      - SERVICE_PORT=9001
      - SERVICE_HOST=0.0.0.0
      - SERVICE_AUTH=db
      - JWT_SECRET=${JWT_SECRET}
      - SERVICE_LOGGER=stdout
      #### Database settings ####
      - DB_HOST=postgres
      - DB_NAME=${POSTGRES_DB_NAME}
      - DB_USER=${POSTGRES_DB_USERNAME}
      - DB_PASS=${POSTGRES_DB_PASSWORD}
      #### Redis settings ####
      - REDIS_HOST=redis
    networks:
      - osctrl-backend
    depends_on:
      - postgres
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:9001"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 40s
    cpus: 2
    mem_limit: 150M

  ######################################### osctrl-api #########################################
  osctrl-api:
    container_name: 'osctrl-api'
    restart: unless-stopped
    image: jmpsec/osctrl-api:v${OSCTRL_VERSION}
    environment:
      #### TLS settings ####
      - SERVICE_LISTENER=0.0.0.0
      - SERVICE_PORT=9002
      - SERVICE_HOST=0.0.0.0
      - SERVICE_AUTH=jwt
      - JWT_SECRET=${JWT_SECRET}
      - SERVICE_LOGGER=stdout
      #### Database settings ####
      - DB_HOST=postgres
      - DB_NAME=${POSTGRES_DB_NAME}
      - DB_USER=${POSTGRES_DB_USERNAME}
      - DB_PASS=${POSTGRES_DB_PASSWORD}
      #### Redis settings ####
      - REDIS_HOST=redis
    networks:
      - osctrl-backend
    depends_on:
      - postgres
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:9002"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 40s
    cpus: 2
    mem_limit: 150M

  ######################################### PostgreSQL #########################################
  postgres:
    container_name: 'osctrl-postgres'
    restart: unless-stopped
    image: postgres:${POSTGRES_VERSION}
    environment:
      - POSTGRES_DB=${POSTGRES_DB_NAME}
      - POSTGRES_USER=${POSTGRES_DB_USERNAME}
      - POSTGRES_PASSWORD=${POSTGRES_DB_PASSWORD}
    networks:
      - osctrl-backend
    volumes:
      - postgres-db:/var/lib/postgresql/data
    healthcheck:
      test: ["pg_isready", "-U", "$${POSTGRES_USER}", "-d", "$${POSTGRES_DB}"]
      interval: 10s
      timeout: 5s
      retries: 5
    cpus: 2
    mem_limit: 1G

  ######################################### Redis #########################################
  redis:
    container_name: 'osctrl-redis'
    restart: unless-stopped
    image: redis:${REDIS_VERSION}
    networks:
      - osctrl-backend
    volumes:
      - redis-data:/data
    cpus: 1
    mem_limit: 100M

  ######################################### osctrl-cli #########################################
  # osctrl-cli is the component that creates the osctrl env and admin user
  ##############################################################################################
  osctrl-cli:
    container_name: 'osctrl-cli'
    restart: unless-stopped
    image: jmpsec/osctrl-cli:v${OSCTRL_VERSION}
    tty: true # entrypoint executes `/bin/sh`
    environment:
      #### osctrl env ####
      - ENV_NAME=dev
      - CERT_FILE=/opt/osctrl/config/osctrl.crt
      - HOST=osctrl-nginx
      #### osctrl admin ####
      - OSCTRL_USER=${OSCTRL_USER}
      - OSCTRL_PASS=${OSCTRL_PASS}
      #### Database settings ####
      - DB_HOST=postgres
      - DB_NAME=${POSTGRES_DB_NAME}
      - DB_USER=${POSTGRES_DB_USERNAME}
      - DB_PASS=${POSTGRES_DB_PASSWORD}
    networks:
      - osctrl-backend
    depends_on:
      - postgres
    healthcheck:
      test: ["CMD", "/opt/osctrl/bin/osctrl-cli", "check"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 60s
    cpus: 1
    mem_limit: 100M

  ######################################### osquery #########################################
  ubuntu-osquery:
    restart: unless-stopped
    build:
      context: .
      dockerfile: deploy/docker/Dockerfile-osquery
      args:
        OSQUERY_VERSION: ${OSQUERY_VERSION}
        OSCTRL_VERSION: ${OSCTRL_VERSION}
    environment:
      #### osquery enroll ####
      - ENV_NAME=dev
      - HOST=osctrl-nginx
      #### Database settings ####
      - DB_HOST=postgres
      - DB_NAME=${POSTGRES_DB_NAME}
      - DB_USER=${POSTGRES_DB_USERNAME}
      - DB_PASS=${POSTGRES_DB_PASSWORD}
    networks:
      - osctrl-backend
    volumes:
      - osquery-data:/var/osquery
      - osquery-conf:/etc/osquery
    depends_on:
      - osctrl-tls
      - osctrl-api
      - postgres
    healthcheck:
      test: ["CMD", "test", "-f", "/var/run/osqueryd.pidfile"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 60s
    cpus: 1
    mem_limit: 150M

networks:
  osctrl-backend:

volumes:
  postgres-db:
  redis-data:
  osquery-data:
  osquery-conf: