Skip to content

Commit

Permalink
feat(docs): mise à jour de la documentation, suppression de fichiers …
Browse files Browse the repository at this point in the history
…inutiles
  • Loading branch information
pYassine committed Dec 13, 2022
1 parent cb0de71 commit 5ad9490
Show file tree
Hide file tree
Showing 14 changed files with 199 additions and 638 deletions.
9 changes: 0 additions & 9 deletions _docs/dev/00.run-local-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,6 @@ Les bases de données sont initialisées automatiquement lors dla création du c

Voir [./20.databases-dumps.md](./20.databases-dumps.md)

**IMPORTANT**: les tables de test sont de type `unlogged` pour améliorer les performances, donc il est conseillé de les convertir en tables `logged` pour le développement afin d'éviter des erreurs lors de l'application des migrations typeorm futures:

```bash
while ! ${CURRENT_DIR}/convert-postgres-tables-to-logged-docker.sh --db=dev
do # first run can fail due to unlogged table dependency
echo "Try again"
done
```

## Démarrage de l'application

Run backend app:
Expand Down
15 changes: 15 additions & 0 deletions _docs/dev/10.database-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,18 @@ Pour faire un `rollback` + `migrate`:
# /packages/backend
yarn run db:dev:migrate-redo
```

## Mettre à jour la base de données de test suite à une migration

Avant tout, rebaser sa branche sur la dernière version de master et être sûr que personne d'autre ne met à jour le dump sur sa branche:

```bash
git fetch origin && git rebase origin/master
```

Mettre à jour les dumps:

```bash
# auto-update test dump
_scripts/db/update_test_dumps.sh
```
11 changes: 1 addition & 10 deletions _docs/dev/20.databases-dumps.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,4 @@ Pour restaurer les dumps de dev:
_scripts/db/restore-database-docker.sh --db=dev --dump=dev
```

**IMPORTANT**: les tables de test sont de type `unlogged` pour améliorer les performances, donc il est conseillé de les convertir en tables `logged` pour le développement afin d'éviter des erreurs lors de l'application des migrations typeorm futures:

```bash
while ! ${CURRENT_DIR}/convert-postgres-tables-to-logged-docker.sh --db=dev
do # first run can fail due to unlogged table dependency
echo "Try again"
done
```

Pour synchroniser le dump de dev depuis la prod ou pre-prod anonymisée, voir: [21.databases-sync-from-preprod-to-dev.md](./21.databases-sync-from-preprod-to-dev.md)
Pour synchroniser le dump de dev depuis la prod ou pre-prod anonymisée, voir: [21.databases-sync-from-preprod-to-dev.md](./21.databases-sync-db.md)
27 changes: 27 additions & 0 deletions _docs/dev/21.databases-sync-db.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Synchronisation de la préprod k8s depuis un dump de prod anonymisé

Cette synchronisation ne synchronise que la base, pas les fichiers uploadés.

## Récupération du dump azure

Pour pouvoir accéder aux backup et les télécharger, suivre les indications de la documentation SRE : https://socialgouv.github.io/support/docs/faq#acc%C3%A8s-aux-serveurs-pg-de-dev

Télécharger le dernier dump depuis les backups azure, puis le déplacer vers `./_scripts/db/dumps/domifa_prod.postgres.custom.gz`:

**⚠️ Important** : bien respecter le nom du fichier pour le dump, et systèmatiquement vérifier qu'il n'est pas présent dans vos commits.

## Anonymisation du dump

Anonymiser le dump:

```bash
# installer le dump en local sur la base "domifa_dev"
./_scripts/db/restore-database-docker.sh --db=dev --dump=dev
# anonymiser la base de données "domifa_dev"
sudo docker exec domifa-backend bash -c 'yarn db:dev:data-anonymize'
# écraser le dump d'origine avec la version anonymisée
./_scripts/db/make-dump-database-docker.sh --db=dev --dump=dev

# vérifier
ls -lah ./_scripts/db/dumps/domifa_prod.postgres.custom.gz
```
46 changes: 0 additions & 46 deletions _docs/dev/21.databases-sync-from-preprod-to-dev.md

This file was deleted.

80 changes: 0 additions & 80 deletions _docs/dev/22.databases-sync-from-prod-to-preprod.md

This file was deleted.

140 changes: 0 additions & 140 deletions _docs/dev/24.databases-sync-preprod-k8s.md

This file was deleted.

21 changes: 0 additions & 21 deletions _docs/dev/30.tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,27 +94,6 @@ Pour exécuter les tests via une interface graphique:
yarn test:open-ui
```

## Mettre à jour la base de données de test suite à une migration

Avant tout, rebaser sa branche sur la dernière version de master et être sûr que personne d'autre ne met à jour le dump sur sa branche:

```bash
git fetch origin && git rebase origin/master
```

Mettre à jour les dumps:

```bash
# auto-update test dump
_scripts/db/update_test_dumps.sh
```

Relancer les tests pour vérifier.

```bash
yarn test
```

## Mettre à jour les données de test

Installer la dernière version des dumps:
Expand Down
Loading

0 comments on commit 5ad9490

Please sign in to comment.