Add comments to Gitlab CI yaml

.gitlab-ci.yml

@@ -32,6 +32,21 @@ stages:
 #        cobertura: login/coverage.xml
 #    coverage: '/^TOTAL.+?(\d+\%)$/'
 
+#pylint:
+#  stage: build-test-images
+#  variables:
+#    KANIKO_CONTEXT: "test/lint/pylint"
+#    KANIKO_BUILD_IMAGENAME: $CI_JOB_NAME
+#  extends: .kaniko_build
+#  only:
+#    changes:
+#      - test/lint/pylint/Dockerfile
+#      - test/lint/pylint/requirements.txt
+#      - .gitlab-ci.yml
+
+
+
+# Stackspin login panel
 login:
   stage: build
   needs: []
@@ -46,43 +61,20 @@ login:
       - login/**/*
 
 
-# A Fake SSO app to test the behaviour
-sso_testapp:
-  stage: build-test-images
-  variables:
-    KANIKO_CONTEXT: "test/sso_testapp/"
-    KANIKO_BUILD_IMAGENAME: $CI_JOB_NAME
-  extends: .kaniko_build
-  only:
-    changes:
-      - test/sso_testapp/**/*
-#      - .gitlab-ci.yml
-
-# Webbrowser tests
-behave:
-  stage: build-test-images
-  variables:
-    KANIKO_CONTEXT: "test/behave"
-    KANIKO_BUILD_IMAGENAME: $CI_JOB_NAME
-  extends: .kaniko_build
-  only:
-    changes:
-      - test/behave/**/*
-#      - .gitlab-ci.yml
-
-#pylint:
-#  stage: build-test-images
-#  variables:
-#    KANIKO_CONTEXT: "test/lint/pylint"
-#    KANIKO_BUILD_IMAGENAME: $CI_JOB_NAME
-#  extends: .kaniko_build
-#  only:
-#    changes:
-#      - test/lint/pylint/Dockerfile
-#      - test/lint/pylint/requirements.txt
-#      - .gitlab-ci.yml
-
-
+# For full integration testing we need to build the full stack in CI/CD
+#
+# - postgres    : Backend database, the Dockerfile is based on the upstream
+#                 with a small addition to create inital databases
+# - kratos      : Identity manager, based on the upstream. We set the DSN
+#                 in the Dockerimage, as its different from hydra's DSN, 
+#                 however, gitlab-ci will apply the same enviroment for all
+#                 services.
+# - hydra       : See above, the identiy provider
+# - login       : Our login panel
+# - sso_testapp : A test app which implements OIDC for testing
+# - behave      : Image to do behave testing
+
+# Build our own postgres image, which is based on upstream
 postgres:
   stage: build
   needs: []
@@ -95,7 +87,7 @@ postgres:
       - postgres/**/*
 
 
-
+# Build our own kratos image, which is based on upstream
 kratos:
   stage: build
   needs: []
@@ -107,6 +99,7 @@ kratos:
     changes:
       - kratos/**/*
 
+# Build our own hydra image, which is based on upstream
 hydra:
   stage: build
   needs: []
@@ -118,6 +111,28 @@ hydra:
     changes:
       - hydra/**/*
 
+# A Fake SSO app to test the behaviour
+sso_testapp:
+  stage: build-test-images
+  variables:
+    KANIKO_CONTEXT: "test/sso_testapp/"
+    KANIKO_BUILD_IMAGENAME: $CI_JOB_NAME
+  extends: .kaniko_build
+  only:
+    changes:
+      - test/sso_testapp/**/*
+
+# Image to test behaviour (web)
+behave:
+  stage: build-test-images
+  variables:
+    KANIKO_CONTEXT: "test/behave"
+    KANIKO_BUILD_IMAGENAME: $CI_JOB_NAME
+  extends: .kaniko_build
+  only:
+    changes:
+      - test/behave/**/*
+
 
 
 behave-integration: