From 670b2b5b91418ff32a063cee9ceb03466db1f449 Mon Sep 17 00:00:00 2001 From: mlamalle <mlamalle@cadoles.com> Date: Thu, 20 Feb 2025 13:18:20 +0100 Subject: [PATCH] Add Readme --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..179d5af --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +## Docker Promote + +Script de promotion d'images docker pour MSE. +Ce script permet de promouvoir des tags d'images Docker du projet MSE d'une étape à une autre (ex: 'k8sunstable' vers 'k8stesting'). +Il prend un ou plusieurs tags d'images Docker comme argument et les promeut en fonction de leur étape actuelle. + +### Usage +`promote.sh <source_tag> [<source_tag> ...] [--dry-run] [--target-stage <stage>] [--no-confirmation]` + +Par défaut, la promotion suit la séquence d'étapes : `'k8sunstable' -> 'k8stesting' -> 'k8spreprod' -> 'k8sprod'` +### Arguments : + +`<source_tag>` : Tag source de l'image Docker à promouvoir. + +Format attendu : `<registry>/<repository>:<version>-<stage>.<build>.<commit>` + +Exemple : reg.cadoles.com/cnous-mse/portal:2025.2.6-XXX.1402.ed7732337 + +### Options : + - `--dry-run` : Mode 'dry-run'. Simule la promotion sans exécuter de commandes Docker. + Utile pour vérifier ce qui se passerait sans faire de changements. + + - `--target-stage <stage>` : Spécifie un stage cible particulier pour la promotion. +Par défaut, la promotion suit la séquence d'étapes : `'k8sunstable' -> 'k8stesting' -> 'k8spreprod' -> 'k8sprod'`. Vous pouvez spécifier directement le stage (ex: --target-stage k8spreprod). + + - `--no-confirmation` : Ignore la demande de confirmation avant de pousser le tag Docker. + Utilisé pour automatiser la promotion sans intervention manuelle. + + +### Exemples d'utilisation : + ` promote.sh reg.cadoles.com/cnous-mse/portal:2025.2.6-XXX.1402.ed7732337` + + ` promote.sh reg.cadoles.com/cnous-mse/portal:2025.2.6-XXX.1402.ed7732337 --dry-run` + + ` promote.sh reg.cadoles.com/cnous-mse/portal:2025.2.6-XXX.1402.ed7732337 --target-stage k8spreprod` + + ` promote.sh reg.cadoles.com/cnous-mse/portal:2025.2.6-XXX.1402.ed7732337 --no-confirmation`