Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mschoeffmann/docker-swarmbase
A minimalistic Docker Swarm base setup featuring ready-to-use Portainer container management, Prometheus/Grafana monitoring and Traefik with Let's Encrypt as ingress proxy on Ubuntu Linux systems.
https://github.com/mschoeffmann/docker-swarmbase
docker docker-swarm grafana prometheus swarm traefik
Last synced: about 2 months ago
JSON representation
A minimalistic Docker Swarm base setup featuring ready-to-use Portainer container management, Prometheus/Grafana monitoring and Traefik with Let's Encrypt as ingress proxy on Ubuntu Linux systems.
- Host: GitHub
- URL: https://github.com/mschoeffmann/docker-swarmbase
- Owner: mschoeffmann
- License: mit
- Created: 2022-06-04T13:05:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T16:08:52.000Z (5 months ago)
- Last Synced: 2024-09-04T20:24:07.754Z (4 months ago)
- Topics: docker, docker-swarm, grafana, prometheus, swarm, traefik
- Language: Shell
- Homepage: https://gitlab.com/mschoeffmann/docker-swarmbase/
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Swarmbase
A minimalistic Docker Swarm base setup featuring ready-to-use [Portainer](https://www.portainer.io) container management, [Prometheus](https://prometheus.io)/[Grafana](https://grafana.com) monitoring and [Traefik](https://traefik.io) with [Let's Encrypt](https://letsencrypt.org) as ingress proxy on [Ubuntu Linux](https://ubuntu.com) systems.
[[_TOC_]]
This boilerplate/template project has been created as a starting-point for my projects.
Feel free to add suggestions, feedback or improvements to the issue tracker.
## Features
- Automated installation and initialization of Docker Swarm
- Basic firewall rules to allow only ports 22, 80, 443 and 8443
- Portainer instance for stack- & container management
- Grafana and Prometheus monitoring inkl. ready-to-use dashboards
- Traefik ingress proxy with included SSL/TLS support and Let's Encrypt certificate management
- Automatic HTTP to HTTPS redirect
## Requirements
- Ubuntu Linux 24.04 LTS host system
- Public IPv4 address
## Installation
Replace `swarmbase.example.com` with your own hostname for the whole installation process.
### Preparing the installation
- Install your Ubuntu base system
- Create DNS entries `swarmbase.example.com` and `*.swarmbase.example.com` (wildcard)
pointing to your server's IP address
- Start up the server and log in as root
*The wildcard DNS provides an easy way of adding Stacks later (like mystack.swarmbase.example.com).
If a wildcard DNS entry is not possible, make sure you create at least `grafana.swarmbase.example.com`, `traefik.swarmbase.example.com` and `portainer.swarmbase.example.com`.*
### Updating the server
```bash
apt update
apt upgrade
reboot
```
### Installing Swarmbase
This automatically installs all required packages and configures the docker swarm stack.
```
git clone https://gitlab.com/mschoeffmann/docker-swarmbase.git
cd docker-swarmbase
./swarmbase install
```
After installing swarmbase, a `reboot` is recommendded.
At least wait about 30-60 seconds after installation for all web-interfaces to be available.
## Configuration
The local configuration file `.config` is only used for the first installation.
- `SWARM_MANAGER`: The internal IP address in case you have an internal network between swarm hosts. Can be empty.
- `LETSENCRYPT_SERVER`: The Let's Encrypt server. Use `acme-v02` for production or `acme-staging-v02` for development.
- `LETSENCRYPT_MAIL`: Your e-mail address for Let's Encrypt.
- `ADMIN_HOSTNAME`: The hostname of your Swarmbase server. Make sure you created the DNS records (including wildcard).
- `ADMIN_PASSWORD`: The admin password. This is set on initial installation.
## Administration
### Web administration
After a successful installation, you have the following web management interfaces available:
- Portainer (management): `https://portainer.swarmbase.example.com:8443`
- Grafana (monitoring): `https://grafana.swarmbase.example.com:8443`
- Traefik (dashboard): `https://traefik.swarmbase.example.com:8443`
*Replace `swarmbase.example.com` with your server's hostname.*
Username: `admin`
Password: *as specified on installation*
### Swarmbase CLI
The `swarmbase` script offers a few cli commands.
```bash
# update installation
./swarmbase update
```
```bash
# update the admin stack
./swarmbase update_admin
# update the proxy stack
./swarmbase update_proxy
# update source files from git
./swarmbase update_source
```
```bash
# (re-)deploy the admin stack
./swarmbase deploy_admin
# (re-)deploy the proxy stack
./swarmbase deploy_proxy
```
```bash
# install docker packages
./swarmbase install_docker
# init the docker swarm
./swarmbase init_swarm
# (re-)create required networks
./swarmbase create_network
# configure (and install) iptables firewall
./swarmbase configure_firewall
```
## Example Stack
You can use add a test service to your Docker Swarmbase server:
1. Open Portainer
2. Open the *primary* environment
3. Go to: Stacks > Add stack
4. Choose a name for the stack: `test-service`
5. Use the example code below as content for the web editor, but make sure you change `swarmbase.example.com` to your server's hostname.
6. After a 30-60 seconds, you find a test-site at `https://test-service.swarmbase.example.com`
```yaml
version: "3.8"
services:
test-service:
image: containous/whoami:latest
volumes:
- /etc/localtime:/etc/localtime:ro
networks:
- proxy
deploy:
mode: replicated
placement:
constraints:
- node.platform.os == linux
replicas: 1
labels:
- "traefik.enable=true"
- "traefik.http.routers.test-service.rule=Host(`test-service.swarmbase.example.com`)"
- "traefik.http.routers.test-service.entrypoints=https"
- "traefik.http.services.test-service.loadbalancer.server.port=80"
networks:
proxy:
external: true
```
For production deployment, every service has to have a unique *router* and *services* id, so make sure you change `test-service` to something unique for each service on your swarm.
More information can be found at [Compose file version 3 reference](https://docs.docker.com/compose/compose-file/compose-file-v3/) and [Traefik & Docker](https://doc.traefik.io/traefik/providers/docker/).