diff --git a/.dockerignore b/.dockerignore index 8fce603003c1e5857013afec915ace9fc8bcdb8d..ef3c045a7946c23d7b56fac6344665bdf2521f2b 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1 +1,2 @@ data/ +tmp/ diff --git a/DUMP.md b/DUMP.md new file mode 100644 index 0000000000000000000000000000000000000000..503666aa7cc0f184564718dc62e6de3793faaec2 --- /dev/null +++ b/DUMP.md @@ -0,0 +1,38 @@ +Créer/lancer une bdd à partir d'un dump SQL +=========================================== + +- Mettez le fichier de dump SQL dans le répertoire `./tmp/sql` et assurez-vous qu'il a l'extension `.sql`. + +- Trouvez dans le dump le nom du user attendu : + +```bash +grep -Ens "OWNER TO" ./tmp/sql/* | head -n 1 +``` + +- Créez le sous-répertoire `./tmp/sql/admin` et copiez-y le script de création de la bdd : + +```bash +mkdir -p ./tmp/sql/admin +cp ./docker/sql/admin/01_create_db_user.sql ./tmp/sql/admin/ +``` + +- Lancer le container en adaptant `--env SYGAL_USER=ad_sygal` au user trouvé précédemment : + +```bash +docker run \ +--rm \ +--env POSTGRES_USER=postgres \ +--env POSTGRES_PASSWORD=admin \ +--env SYGAL_DB=sygal \ +--env SYGAL_USER=ad_sygal \ +--env SYGAL_PASSWORD=azerty \ +--publish 5432:5432 \ +--volume $PWD/tmp/sql/:/sql \ +--volume $PWD/tmp/db:/var/lib/postgresql/data \ +sygal-db-image +``` + +Au 1er lancement, si aucune bdd n'est déjà persistée dans le répertoire `./tmp/db`, les scripts SQL sont exécutés : +la bdd est créée. +Aux lancements suivants, la bdd existe dans le répertoire donc les scripts ne sont pas exécutés. +Pour que la bdd soit re-créée, il faut supprimer le répertoire `./tmp/db`. diff --git a/README.md b/README.md index 9b521a1b30884fbd879b86184cee453666ab34b6..d9f9131dcd15bd5a3b1f7c8017c09846e027cfdb 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -# SyGAL Database Image +SyGAL Database Image +==================== Ce projet est une image Docker rassemblant le nécessaire pour créer (le cas échéant) et de lancer une base de données pour l'application ESUP-SyGAL. -## Lancement de la base de données +Lancement de la base de données +------------------------------- ### Sans `docker-compose` @@ -23,25 +25,32 @@ sygal-db-image ``` Remarques : -- Le montage `$PWD/data/db:/var/lib/postgresql/data` permet de spécifier un répertoire dans lequel sera persistée - la base de données. - Si aucune base n'est déjà persistée, le script `/initdb.sh` est lancé automatiquement - au démarrage du container pour lancer les scripts SQL situés dans le répertoire `/sql` : - - Pour commencer, ce sont les scripts SQL placés dans le sous-répertoire `admin` qui sont exécutés - **avec le super-user identifié par les variables d'environnement `POSTGRES_USER` et `POSTGRES_PASSWORD`**. - - Ce sont ensuite les autres scripts qui sont exécutés avec le user identifié par les variables d'environnement - `SYGAL_USER` et `SYGAL_PASSWORD`. -- Vous pouvez substituer les scripts SQL par les vôtres en remplaçant le montage dans `/sql` - (exemple : `--volume $PWD/mes/scripts/sql/:/sql`). La présence d'un sous-répertoire `admin` n'est pas obligatoire. + - Les variables d'environnement `POSTGRES_*` spécifient le super-utilisateur à créer + (cf. https://registry.hub.docker.com/_/postgres). + - Les variables d'environnement `SYGAL_*` spécifient la base de données et l'utilisateur SyGAL à créer. + - Le montage `$PWD/data/db:/var/lib/postgresql/data` permet de spécifier un répertoire dans lequel sera persistée + la base de données. + Si aucune base n'est déjà persistée, le script `/initdb.sh` est lancé automatiquement + au démarrage du container pour exécuter les scripts SQL situés dans le répertoire `/sql` : + - Pour commencer, ce sont les scripts SQL placés dans le sous-répertoire `admin` qui sont exécutés + **avec le super-user identifié par les variables d'environnement `POSTGRES_USER` et `POSTGRES_PASSWORD`**. + - Ce sont ensuite les autres scripts qui sont exécutés avec le user identifié par les variables d'environnement + `SYGAL_USER` et `SYGAL_PASSWORD`. + - Vous pouvez substituer les scripts SQL par les vôtres en remplaçant le montage dans `/sql` + (exemple : `--volume $PWD/mes/scripts/sql/:/sql`). La présence d'un sous-répertoire `admin` n'est pas obligatoire. ### Avec `docker-compose` +Si vous utilisez `docker-compose`, les variables d'environnement `POSTGRES_*` et `SYGAL_*` +sont spécifiées "en dur" dans le fichier `docker-compose.yml`. + ```bash docker-compose up ``` -## Utilisation de l'image dans un `docker-compose.yml` +Utilisation de l'image dans un `docker-compose.yml` +--------------------------------------------------- ```yml version: '2.2' @@ -64,7 +73,8 @@ services: ``` -## Build de l'image +Build de l'image +---------------- - Facultatif : vous pouvez éventuellement récupérer les dernières versions des scripts SQL comme ceci : diff --git a/docker/initdb.sh b/docker/initdb.sh index 3ccf930a8bf8f931528f681350a1d2dcce47b10b..263e873af4582ca66c90e0c0445d2b07a5eb890e 100755 --- a/docker/initdb.sh +++ b/docker/initdb.sh @@ -1,6 +1,8 @@ #!/bin/bash set -e +SQL_DIR="/sql" + ## ## Lancement des scripts SQL présents dans le répertoire `/sql`. ## @@ -15,12 +17,13 @@ unset PGHOST PGPORT PGDATABASE PGUSER PGPASSWORD # précaution # Exécution EN TANT QUE SUPER-USER de tous les scripts .sql présents dans le répertoire `/sql/admin`. # NB : il est possible de substituer ces scripts par les vôtres grâce à un volume à monter dans `/sql/admin`. # -if [ -d "/sql/admin" ]; then - cd /sql/admin +if [ -d "${SQL_DIR}/admin" ]; then + cd ${SQL_DIR}/admin export \ - PGDATABASE=$POSTGRES_DB \ - PGUSER=$POSTGRES_USER \ - ON_ERROR_STOP=1 + PGDATABASE=$POSTGRES_DB \ + PGUSER=$POSTGRES_USER \ + PGPASSWORD=$POSTGRES_PASSWORD \ + ON_ERROR_STOP=1 for f in *.sql; do psql \ -v "dbname=${SYGAL_DB}" \ @@ -34,11 +37,12 @@ fi # Exécution de tous les scripts .sql présents dans le répertoire `/sql`. # NB : il est possible de substituer ces scripts par les vôtres grâce à un volume à monter dans `/sql`. # -cd /sql +cd ${SQL_DIR} export \ - PGDATABASE=$SYGAL_DB \ - PGUSER=$SYGAL_USER \ - PGPASSWORD=$SYGAL_PASSWORD +ON_ERROR_STOP=1 \ +PGDATABASE=$SYGAL_DB \ +PGUSER=$SYGAL_USER \ +PGPASSWORD=$SYGAL_PASSWORD for f in *.sql; do psql \ -v "dbuser=${SYGAL_USER}" \