-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
sonarqube-traefik-letsencrypt-docker-compose.yml
243 lines (225 loc) · 11.5 KB
/
sonarqube-traefik-letsencrypt-docker-compose.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# SonarQube with Let's Encrypt Using Docker Compose
# The complete installation guide is available on my website https://www.heyvaldemar.com/install-sonarqube-using-docker-compose/
# Change variables in the `.env` to meet your requirements.
# Note that the `.env` file should be in the same directory as `sonarqube-traefik-letsencrypt-docker-compose.yml`.
# Create networks for your services before deploying the configuration using the commands:
# `docker network create traefik-network`
# `docker network create sonarqube-network`
# Adjust the `vm.max_map_count` using the commands:
# `sudo sysctl -w vm.max_map_count=262144`
# Deploy SonarQube using Docker Compose:
# `docker compose -f sonarqube-traefik-letsencrypt-docker-compose.yml -p sonarqube up -d`
# Backups
# The `backups` container in the configuration is responsible for the following:
# 1. **Database Backup**: Creates compressed backups of the PostgreSQL database using pg_dump.
# Customizable backup path, filename pattern, and schedule through variables like `POSTGRES_BACKUPS_PATH`, `POSTGRES_BACKUP_NAME`, and `BACKUP_INTERVAL`.
# 2. **Application Data Backup**: Compresses and stores backups of the application data on the same schedule. Controlled via variables such as `DATA_BACKUPS_PATH`, `DATA_BACKUP_NAME`, and `BACKUP_INTERVAL`.
# 3. **Backup Pruning**: Periodically removes backups exceeding a specified age to manage storage.
# Customizable pruning schedule and age threshold with `POSTGRES_BACKUP_PRUNE_DAYS` and `DATA_BACKUP_PRUNE_DAYS`.
# By utilizing this container, consistent and automated backups of the essential components of your instance are ensured.
# Moreover, efficient management of backup storage and tailored backup routines can be achieved through easy and flexible configuration using environment variables.
# # sonarqube-restore-database.sh Description
# This script facilitates the restoration of a database backup.
# 1. **Identify Containers**: It first identifies the service and backups containers by name, finding the appropriate container IDs.
# 2. **List Backups**: Displays all available database backups located at the specified backup path.
# 3. **Select Backup**: Prompts the user to copy and paste the desired backup name from the list to restore the database.
# 4. **Stop Service**: Temporarily stops the service to ensure data consistency during restoration.
# 5. **Restore Database**: Executes a sequence of commands to drop the current database, create a new one, and restore it from the selected compressed backup file.
# 6. **Start Service**: Restarts the service after the restoration is completed.
# To make the `sonarqube-restore-database.shh` script executable, run the following command:
# `chmod +x sonarqube-restore-database.sh`
# Usage of this script ensures a controlled and guided process to restore the database from an existing backup.
# # sonarqube-restore-application-data.sh Description
# This script is designed to restore the application data.
# 1. **Identify Containers**: Similarly to the database restore script, it identifies the service and backups containers by name.
# 2. **List Application Data Backups**: Displays all available application data backups at the specified backup path.
# 3. **Select Backup**: Asks the user to copy and paste the desired backup name for application data restoration.
# 4. **Stop Service**: Stops the service to prevent any conflicts during the restore process.
# 5. **Restore Application Data**: Removes the current application data and then extracts the selected backup to the appropriate application data path.
# 6. **Start Service**: Restarts the service after the application data has been successfully restored.
# To make the `sonarqube-restore-application-data.sh` script executable, run the following command:
# `chmod +x sonarqube-restore-application-data.sh`
# By utilizing this script, you can efficiently restore application data from an existing backup while ensuring proper coordination with the running service.
# Author
# I’m Vladimir Mikhalev, the Docker Captain, but my friends can call me Valdemar.
# https://www.docker.com/captains/vladimir-mikhalev/
# My website with detailed IT guides: https://www.heyvaldemar.com/
# Follow me on YouTube: https://www.youtube.com/channel/UCf85kQ0u1sYTTTyKVpxrlyQ?sub_confirmation=1
# Follow me on Twitter: https://twitter.com/heyValdemar
# Follow me on Instagram: https://www.instagram.com/heyvaldemar/
# Follow me on Threads: https://www.threads.net/@heyvaldemar
# Follow me on Mastodon: https://mastodon.social/@heyvaldemar
# Follow me on Bluesky: https://bsky.app/profile/heyvaldemar.bsky.social
# Follow me on Facebook: https://www.facebook.com/heyValdemarFB/
# Follow me on TikTok: https://www.tiktok.com/@heyvaldemar
# Follow me on LinkedIn: https://www.linkedin.com/in/heyvaldemar/
# Follow me on GitHub: https://github.com/heyvaldemar
# Communication
# Chat with IT pros on Discord: https://discord.gg/AJQGCCBcqf
# Reach me at ask@sre.gg
# Give Thanks
# Support on GitHub: https://github.com/sponsors/heyValdemar
# Support on Patreon: https://www.patreon.com/heyValdemar
# Support on BuyMeaCoffee: https://www.buymeacoffee.com/heyValdemar
# Support on Ko-fi: https://ko-fi.com/heyValdemar
# Support on PayPal: https://www.paypal.com/paypalme/heyValdemarCOM
networks:
sonarqube-network:
external: true
traefik-network:
external: true
volumes:
sonarqube-data:
sonarqube-postgres:
sonarqube-postgres-backup:
sonarqube-data-backups:
sonarqube-database-backups:
traefik-certificates:
services:
postgres:
image: ${SONARQUBE_POSTGRES_IMAGE_TAG}
volumes:
- sonarqube-postgres:/var/lib/postgresql/data
environment:
POSTGRES_DB: ${SONARQUBE_DB_NAME}
POSTGRES_USER: ${SONARQUBE_DB_USER}
POSTGRES_PASSWORD: ${SONARQUBE_DB_PASSWORD}
networks:
- sonarqube-network
healthcheck:
test: [ "CMD", "pg_isready", "-q", "-d", "${SONARQUBE_DB_NAME}", "-U", "${SONARQUBE_DB_USER}" ]
interval: 10s
timeout: 5s
retries: 3
start_period: 60s
restart: unless-stopped
sonarqube:
image: ${SONARQUBE_IMAGE_TAG}
volumes:
- sonarqube-data:${DATA_PATH}
environment:
SONARQUBE_DATABASE_HOST: postgres
SONARQUBE_DATABASE_PORT_NUMBER: 5432
SONARQUBE_DATABASE_NAME: ${SONARQUBE_DB_NAME}
SONARQUBE_DATABASE_USER: ${SONARQUBE_DB_USER}
SONARQUBE_DATABASE_PASSWORD: ${SONARQUBE_DB_PASSWORD}
SONARQUBE_USERNAME: ${SONARQUBE_ADMIN_USERNAME}
SONARQUBE_PASSWORD: ${SONARQUBE_ADMIN_PASSWORD}
SONARQUBE_EMAIL: ${SONARQUBE_ADMIN_EMAIL}
SONARQUBE_SMTP_HOST: ${SONARQUBE_SMTP_ADDRESS}
SONARQUBE_SMTP_PORT_NUMBER: ${SONARQUBE_SMTP_PORT}
SONARQUBE_SMTP_USER: ${SONARQUBE_SMTP_USER_NAME}
SONARQUBE_SMTP_PASSWORD: ${SONARQUBE_SMTP_PASSWORD}
healthcheck:
test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/9000' || exit 1
interval: 10s
timeout: 5s
retries: 3
start_period: 90s
networks:
- sonarqube-network
- traefik-network
labels:
- "traefik.enable=true"
- "traefik.http.routers.sonarqube.rule=Host(`${SONARQUBE_HOSTNAME}`)"
- "traefik.http.routers.sonarqube.service=sonarqube"
- "traefik.http.routers.sonarqube.entrypoints=websecure"
- "traefik.http.services.sonarqube.loadbalancer.server.port=9000"
- "traefik.http.routers.sonarqube.tls=true"
- "traefik.http.routers.sonarqube.tls.certresolver=letsencrypt"
- "traefik.http.services.sonarqube.loadbalancer.passhostheader=true"
- "traefik.http.routers.sonarqube.middlewares=compresstraefik"
- "traefik.http.middlewares.compresstraefik.compress=true"
- "traefik.docker.network=traefik-network"
restart: unless-stopped
depends_on:
postgres:
condition: service_healthy
traefik:
condition: service_healthy
traefik:
image: ${TRAEFIK_IMAGE_TAG}
command:
- "--log.level=${TRAEFIK_LOG_LEVEL}"
- "--accesslog=true"
- "--api.dashboard=true"
- "--api.insecure=true"
- "--ping=true"
- "--ping.entrypoint=ping"
- "--entryPoints.ping.address=:8082"
- "--entryPoints.web.address=:80"
- "--entryPoints.websecure.address=:443"
- "--providers.docker=true"
- "--providers.docker.endpoint=unix:///var/run/docker.sock"
- "--providers.docker.exposedByDefault=false"
- "--certificatesresolvers.letsencrypt.acme.tlschallenge=true"
- "--certificatesresolvers.letsencrypt.acme.email=${TRAEFIK_ACME_EMAIL}"
- "--certificatesresolvers.letsencrypt.acme.storage=/etc/traefik/acme/acme.json"
- "--metrics.prometheus=true"
- "--metrics.prometheus.buckets=0.1,0.3,1.2,5.0"
- "--global.checkNewVersion=true"
- "--global.sendAnonymousUsage=false"
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- traefik-certificates:/etc/traefik/acme
networks:
- traefik-network
ports:
- "80:80"
- "443:443"
healthcheck:
test: ["CMD", "wget", "http://localhost:8082/ping","--spider"]
interval: 10s
timeout: 5s
retries: 3
start_period: 5s
labels:
- "traefik.enable=true"
- "traefik.http.routers.dashboard.rule=Host(`${TRAEFIK_HOSTNAME}`)"
- "traefik.http.routers.dashboard.service=api@internal"
- "traefik.http.routers.dashboard.entrypoints=websecure"
- "traefik.http.services.dashboard.loadbalancer.server.port=8080"
- "traefik.http.routers.dashboard.tls=true"
- "traefik.http.routers.dashboard.tls.certresolver=letsencrypt"
- "traefik.http.services.dashboard.loadbalancer.passhostheader=true"
- "traefik.http.routers.dashboard.middlewares=authtraefik"
- "traefik.http.middlewares.authtraefik.basicauth.users=${TRAEFIK_BASIC_AUTH}"
- "traefik.http.routers.http-catchall.rule=HostRegexp(`{host:.+}`)"
- "traefik.http.routers.http-catchall.entrypoints=web"
- "traefik.http.routers.http-catchall.middlewares=redirect-to-https"
- "traefik.http.middlewares.redirect-to-https.redirectscheme.scheme=https"
restart: unless-stopped
backups:
image: ${SONARQUBE_POSTGRES_IMAGE_TAG}
command: >-
sh -c 'sleep $BACKUP_INIT_SLEEP &&
while true; do
pg_dump -h postgres -p 5432 -d $SONARQUBE_DB_NAME -U $SONARQUBE_DB_USER | gzip > $POSTGRES_BACKUPS_PATH/$POSTGRES_BACKUP_NAME-$(date "+%Y-%m-%d_%H-%M").gz &&
tar -zcpf $DATA_BACKUPS_PATH/$DATA_BACKUP_NAME-$(date "+%Y-%m-%d_%H-%M").tar.gz $DATA_PATH &&
find $POSTGRES_BACKUPS_PATH -type f -mtime +$POSTGRES_BACKUP_PRUNE_DAYS | xargs rm -f &&
find $DATA_BACKUPS_PATH -type f -mtime +$DATA_BACKUP_PRUNE_DAYS | xargs rm -f;
sleep $BACKUP_INTERVAL; done'
volumes:
- sonarqube-postgres-backup:/var/lib/postgresql/data
- sonarqube-data:${DATA_PATH}
- sonarqube-data-backups:${DATA_BACKUPS_PATH}
- sonarqube-database-backups:${POSTGRES_BACKUPS_PATH}
environment:
SONARQUBE_DB_NAME: ${SONARQUBE_DB_NAME}
SONARQUBE_DB_USER: ${SONARQUBE_DB_USER}
PGPASSWORD: ${SONARQUBE_DB_PASSWORD}
BACKUP_INIT_SLEEP: ${BACKUP_INIT_SLEEP}
BACKUP_INTERVAL: ${BACKUP_INTERVAL}
POSTGRES_BACKUP_PRUNE_DAYS: ${POSTGRES_BACKUP_PRUNE_DAYS}
DATA_BACKUP_PRUNE_DAYS: ${DATA_BACKUP_PRUNE_DAYS}
POSTGRES_BACKUPS_PATH: ${POSTGRES_BACKUPS_PATH}
DATA_BACKUPS_PATH: ${DATA_BACKUPS_PATH}
DATA_PATH: ${DATA_PATH}
POSTGRES_BACKUP_NAME: ${POSTGRES_BACKUP_NAME}
DATA_BACKUP_NAME: ${DATA_BACKUP_NAME}
networks:
- sonarqube-network
restart: unless-stopped
depends_on:
postgres:
condition: service_healthy