From 3501b8340cde5f7775874ec2d145ea7134ef2a43 Mon Sep 17 00:00:00 2001 From: Patryk Gudalewicz Date: Fri, 28 Oct 2022 10:39:20 +0200 Subject: [PATCH] Adjusting readme --- readme.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/readme.md b/readme.md index 8f8b96e..8a851b1 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,19 @@ Dashboard is generated for specific cluster provided as parameter for the script Dashboard naming convention is: "[PROVIDED CLUSTER NAME] - Kubernetes cluster overview" +# Running with Jenkins + +To run this script with Jenkins go to Jenkins project: +https://jaws.bmwgroup.net/opapm/job/CoCo_Kubernetes_Dashboard_as_code/job/master/ +then use option "Build with parameters". + +Jenkins provides following parameters: + + CLUSTER - value is provided as "-C CLUSTER, --cluster CLUSTER" parameter for script + ENVIRONMENT - value is provided as "-E ENVIRONMENT, --environment ENVIRONMENT" parameter for script + OWNER - value is provided as "-O OWNER, --owner OWNER" parameter for script + REMOVE - value is provided as "--remove" parameter for script + # Prerequisites ## Python packages