Skip to content

Commit 681716a

Browse files
committed
docs: Simplify Docker docs
1. Docker standalone is barely used. 2. We should also mount the data as FS instead of a docker volume
1 parent bc574a3 commit 681716a

File tree

4 files changed

+16
-118
lines changed

4 files changed

+16
-118
lines changed

languages/en/installation-guide/docker/docker_compose.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@ Please be aware that you need **double quotes** around your variables in order f
3434

3535
Please check the :ref:`environment variables <docker-environment-variables>` to know what they stand for.
3636

37+
The Volumes
38+
```````````
39+
40+
We're going to mount tuleap as a Filesystem mountpoint instead of a typical Docker volume :
41+
- It eases configuration manipulation
42+
- It allows a better Disk space management
43+
- It allows easier Migration / Disaster Recovery if needed
44+
- It allows easier backups
45+
- There are no significant performance drop on Linux
3746

3847
Tuleap Community
3948
`````````````````
@@ -58,7 +67,7 @@ Then create a ``compose.yaml`` file with following content:
5867
- "443:443"
5968
- "22:22"
6069
volumes:
61-
- tuleap-data:/data
70+
- /srv/tuleap/tuleap-data:/data
6271
depends_on:
6372
- db
6473
environment:
@@ -70,17 +79,14 @@ Then create a ``compose.yaml`` file with following content:
7079
- DB_ADMIN_PASSWORD=${MYSQL_ROOT_PASSWORD}
7180
7281
# This is for test purpose only. It's not advised to run a production database as a docker container
73-
db:
82+
mysql:
7483
image: mysql:8.0
7584
command: ["--character-set-server=utf8mb4", "--collation-server=utf8mb4_unicode_ci", "--sql-mode=NO_ENGINE_SUBSTITUTION"]
7685
environment:
7786
- MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
7887
volumes:
79-
- db-data:/var/lib/mysql
88+
- /srv/tuleap/mysql-data:/var/lib/mysql
8089
81-
volumes:
82-
tuleap-data:
83-
db-data:
8490
8591
Tuleap Enterprise
8692
`````````````````
@@ -117,7 +123,7 @@ Please check the :ref:`environment variables <docker-environment-variables>` to
117123
- "443:443"
118124
- "22:22"
119125
volumes:
120-
- tuleap-data:/data
126+
- /srv/tuleap/tuleap-data:/data
121127
environment:
122128
- TULEAP_FQDN=${TULEAP_FQDN}
123129
- TULEAP_SYS_DBHOST=${DB_FQDN}
@@ -128,8 +134,6 @@ Please check the :ref:`environment variables <docker-environment-variables>` to
128134
- TULEAP_FPM_SESSION_MODE=redis
129135
- TULEAP_REDIS_SERVER=${REDIS_FQDN}
130136
131-
volumes:
132-
tuleap-data:
133137
134138
If you want to secure your server and use certificates, you may spawn a Reverse-Proxy in the stack.
135139

languages/en/installation-guide/docker/docker_standalone.rst

Lines changed: 0 additions & 107 deletions
This file was deleted.

languages/en/installation-guide/docker/intro_docker.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ It allows you to not be bothered by different OS migrations and the like.
1616
Prerequisites
1717
`````````````
1818

19-
You need `docker <https://docs.docker.com/engine/install/>`_ on your host. You might want docker-compose as well.
19+
You need `docker compose <https://docs.docker.com/compose/install/>`_ on your host.
2020

2121
The following sections assume that you are going to run the Tuleap container as the only "visible" container on the server.
2222
That means that Tuleap web container will publish it's ports (``80``, ``443`` and ``22``) on hosts ports.
@@ -34,3 +34,5 @@ Please do note that shared databases must not be used:
3434
- they cannot guarantee the needed Quality of service
3535
- they cannot respect the requirements (SQL modes)
3636
- they make consistent backups almost impossible
37+
38+
In most cases, you'll also want a Reverse-Proxy to get access to your platform and handle the TLS termination.

languages/en/installation-guide/docker/introduction.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,4 @@ Table of contents:
1515
intro_docker
1616
images-configuration
1717
verify_images_authenticity
18-
docker_standalone
1918
docker_compose

0 commit comments

Comments
 (0)