collection.md

Docker-stack

<<Home>>

A collection of docker-compose files

A pre-configured docker-compose files collection helping web developers.

The collection is composed of five categories (web, data, logging, tools, monitoring). To use a service, each .dist files need to be copy as as .yml file.

Application	Description	Category	container name	Image docker	Documentation
Traefik	expose localy your application through a local domain	web	stack.web.reverse	⤴	⤴
Mail Catcher	catch all emails sent	web	stack.web.mailcatcher	⤴	⤴
PostgreSQL	A relational database	data	stack.data.postgres	⤴	⤴
MySQL	A relational database	data	stack.data.mysql	⤴	⤴
Redis	The cache	data	stack.data.redis	⤴	⤴
RabbitMQ	The message broker	data	stack.data.rabbitmq	⤴	⤴
Rsyslog	A log aggregator	logging	stack.logging.rsyslog	⤴	⤴
Loki	A log aggregator	logging	stack.logging.loki	⤴	⤴
Promtail	A log aggregator	logging	stack.logging.promtail	⤴	⤴
Grafana	The dashboard	tools	stack.tools.grafana	⤴	⤴
Portainer CE	The container manager	tools	stack.tools.portainer	⤴	⤴

You can add our own services to the collection and customize the existing ones. Softwares version and few properties are also configurable, this is defined in the environment file on the root of the collection.

If you want to contribute and improve this project, fix a typo, make it better (sorry for my english, please correct me), you're welcome, make me a PR.

Requirements

Docker is required to run the stack. The stack share the same docker network to facilated communication between containers. The network is named "stack_dev" by default.

docker network create stack_dev

Be free to change the name of the network, you can change it by editing the .env file in the root of the collection.

Copy the .env.dist file to .env, and change the value of the DOCKER_NETWORK variable.

1. Web

This is the base of all web projects, composed of the following services:

• A reversed proxy service (Traefik) that forwards requests to your different applications. You don't have to worry about multiple applications port number, the request can be routed to the right application by following a local domain name rule (a host rule in Traefik). So, each application can have is own local domain. For example, the application "myapp" can be accessible at the address myapp.stack.local.
• A mail catcher service (MailCatcher) that captures all emails sent from your applications. This is avoid to send accidentally emails to real users, you can also check the content of the emails sent by your application whitout beeing connected to Internet.

1.1. Reverse proxy

The reverse proxy web interface is available via a local domain. The domain is defined in the environnement file, DOMAIN. To work, the local domain should target the Docker Host IP.

https://dashboard.stack.local (default)

If you want to use a local domain with your application, you must explicitly set the use traefik with docker labels:

services:
  # Your application web server
  nginx:
    container_name: myapp-nginx
    image: nginx:1.20
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.myapp.rule=Host(`myapp.stack.local`)"
      - "traefik.http.routers.myapp.entrypoints=web"
      - "traefik.http.routers.myapp.service=myapp"
      - "traefik.http.services.myapp.loadbalancer.server.port=8080"
    ports:
      - "8080"

Your application can be accessed at http://myapp.stack.local. The entrypoint is web (port 80), Traefik forwards requests to the port 8080 of your application. Note that the application port 8080 is not exposed.

1.2. MailCatcher

The mail catcher web interface is available via a local domain.

http://mailcatcher.stack.local (default)

The SMTP server is exposed on the port 1025, no authentication is required.

2. Data

• A Redis service that provides a cache.
• A RabbitMQ service that provides a message broker.
• A PostgreSQL service that provides a PostrgreSQL database instance.
• A MySQL service that provides a MySQL database instance.

2.1. Redis

Redis service is exposed on port 6379, no authentication is required.

2.2. RabbitMQ

RabbitMQ service is exposed on port 5672, and the managment interface is available via http://rabbitmq.stack.local Credentials are defined in the .env file.

2.3. PostgreSQL

PostgreSQL service is exposed on port 5432, the default port for PostgreSQL. Credentials are defined in the .env file.

2.4. MySQL

MySQL service is exposed on port 3306, the default port for MySQL. Credentials are defined in the .env file.

3. Logging

• A Loki service (Loki) that provides a log aggregator.
• A log service (Rsyslog) that provides a log aggregator.

3.1. Loki

Loki API service is exposed on port 3100, the default port for Loki. Loki is use to collect Docker logs of containers (where you have selected Loki as driver).

To use Loki, you need to install the docker driver before, create the loki configuration using the sample file in logging/docker/loki/loki-local-config.yaml. Then, connect loki API to your Grafana

Loki metrics are accessible at http://loki.stack.local/metrics.

We use Grafana (in the tools stack) to explore loki collected logs.

Signin in Grafana with the default credentials (admin/admin) and add a Loki datasource.

Add a new datasource, and select Loki as type.

Use the Loki container name as URL : http://stack.logging.loki:3100

If you want to see the logs of a container, you must explicitly use Loki as the docker driver and send application log to the standart output.

services:
  php-fpm:
    container_name: myapp-php-fpm
    image: myprod/php:8.1-fpm
    logging:
      driver: loki
      options:
        loki-url: http://loki.stack.local/loki/api/v1/push

3.2. Promtail

Promtail is a service that provides a log collector. It is used to collect logs from the host machine.

Promtail use the Loki API to send logs to Loki. The provided configuration file is logging/docker/promtail/config.yml.dist is given as example. You can see, in the config.yml.dist file, that the logs are collected from the /var/log directory, mounted in the container from docker-compose.

Rename the file config.yml.dist to config.yml and edit it to match your needs.

3.3. Rsyslog

WIP, not yet provided.

4. Monitoring

WIP, not yet provided.

5. Tools

• A container manager, which is a tool to manage containers (Portainer).
• A Grafana service (Grafana) that provides a dashboard to visualize data.

5.1. Portainer

Portainer is a service that provides a web interface to manage containers.

http://portainer.stack.local (default)

5.2. Grafana

As you have seen if you use Loki, Grafana is also used to explore data collected by different types of sources.

You can add a new data source, and select the type of data you want to explore. We use Grafana to visualize tracking and logging data.

http://grafana.stack.local (default)