Foundation

Foundation makes developing and running docker services easier.

The main component of Foundation is traefik proxy. Traefik is used for service discover of docker containers, allowing you to access your services using hostnames you define, i.e. myapp.test.

Foundation also contains instructrions for setting up docker networks in a way that allow communication between different docker-compose applications.

Requirements

• dnsmasq (Tested using NetworkManager and dnsmasq, other local dns resolvers may work)
• docker
• docker-compose
• mkcert

Optional

• jq (used for troubleshooting)

Getting Started

Setup DNS resolution for the "test" tld

The IP Address needs to be the same as the docker bridge network gateway, by default this is 172.17.0.1. You can look it up with this command though docker network inspect bridge | jq '.[0].IPAM.Config[0].Gateway'

This is specific for NetworkManager and dnsmasq on Arch Linux. You may need to adapt it for other distros.

echo address=/test/172.17.0.1 > /etc/NetworkManager/dnsmasq.d/test

Start traefik

docker-compose up -d

The -d runs it in detached mode

The traefik container is configured with restart: always. This will cause it to start automatically at startup. If you want to stop it from running, just run: docker-compose stop in this directory

Enable traefik for a container

By default traefik doesn't expose containers, to expose a container you just need to add a label to it's docker-compose configuration.

labels:
  - "traefik.enable=true"

You can customize lots of things using labels, see https://doc.traefik.io/traefik/providers/docker/ for more details.

Docker Networking

Everything in this repositories docker-compose file operates on the shared network. The shared network is created automatically when you run docker-compose up and is exposed so that other applications can utilize it as well. The idea of this network is to enable a shared network for your different docker-compose applications. You can put shared services on the shared network by adding it in the docker-compose file for you applications. At the bottom of your docker-compose file add:

networks:
  default:
    internal: true
  
  shared:
    external:
      name: shared

And then for your specific service definition that needs access to the shared network add:

networks:
  - default
  - shared

You can also specify aliases for your services to be accessed via by specifying them in the services network definition as follows:

networks:
  default:
  shared:
    aliases:
      - my_custom_name

Accessing the Traefik dashboard

Once traefik is running you can access the dashboard a traefik.test

OpenTelemetry Collector

There is an OpenTelemetry Collector configured with the following:

Receivers

• otlp - http on port 55681, grpc on port 4317

Processors

• batch

Exporters

• jaeger - writing the to included jaeger server
• logging

Jaeger

There is a Jaeger server accessible at http://jaeger.test

The OpenTelemetry Collector exports to it, and currently Traefik exports to it directly, though it should go through the OpenTelemetery Collector as well.