Merge pull request #289 from cloudogu/feature/contentVariables

Allow content variables

Author: schnatterer

docs/configuration.schema.json

@@ -175,7 +175,7 @@
                   "type" : "string",
                   "enum" : [ "INIT", "RESET", "UPGRADE" ]
                 } ],
-                "description" : "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist (SCMM Return value 409).\nRESET - delete alle files after cloning source - new files are deleted\nUPGRADE - clone and copy - existing files will be overwritten, new files are kept"
+                "description" : "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist.\nRESET - delete all files after cloning source - files not in content are deleted\nUPGRADE - clone and copy - existing files will be overwritten, files not in content are kept"
               },
               "password" : {
                 "type" : [ "string", "null" ],
@@ -187,7 +187,7 @@
               },
               "ref" : {
                 "type" : [ "string", "null" ],
-                "description" : "Reference for a specific branch, tag, or commit"
+                "description" : "Reference for a specific branch, tag, or commit. Emtpy defaults to default branch of the repo"
               },
               "target" : {
                 "type" : [ "string", "null" ],
@@ -208,6 +208,10 @@
             },
             "additionalProperties" : false
           }
+        },
+        "variables" : {
+          "$ref" : "#/$defs/Map(String,Object)-nullable",
+          "description" : "Additional variables to use in custom templates."
         }
       },
       "additionalProperties" : false,

pom.xml

@@ -366,6 +366,17 @@
         <configuration>
           <!-- Needed to allow unit tests to do reflection, e.g. for SystemLambda's withEnvironmentVariable -->
           <argLine>--add-opens java.base/java.util=ALL-UNNAMED</argLine>
+          <systemProperties>
+            <property>
+              <name>ROOT_LOG_LEVEL</name>
+              <value>OFF</value>
+            </property>
+            <property>
+              <name>APP_LOG_LEVEL</name>
+              <value>OFF</value>
+            </property>
+          </systemProperties>
+
         </configuration>
       </plugin>
       <plugin>

src/main/groovy/com/cloudogu/gitops/cli/GitopsPlaygroundCliMainScripted.groovy

@@ -92,14 +92,14 @@ class GitopsPlaygroundCliMainScripted {
                         new Jenkins(config, executor, fileSystemUtils, new GlobalPropertyManager(jenkinsApiClient),
                                 new JobManager(jenkinsApiClient), new UserManager(jenkinsApiClient),
                                 new PrometheusConfigurator(jenkinsApiClient), helmStrategy, k8sClient, networkingUtils),
-                        new Content(config, k8sClient, scmmRepoProvider, scmmApiClient),
                         new ArgoCD(config, k8sClient, helmClient, fileSystemUtils, scmmRepoProvider),
                         new IngressNginx(config, fileSystemUtils, deployer, k8sClient, airGappedUtils),
                         new CertManager(config, fileSystemUtils, deployer, k8sClient, airGappedUtils),
                         new Mailhog(config, fileSystemUtils, deployer, k8sClient, airGappedUtils),
                         new PrometheusStack(config, fileSystemUtils, deployer, k8sClient, airGappedUtils, scmmRepoProvider),
                         new ExternalSecretsOperator(config, fileSystemUtils, deployer, k8sClient, airGappedUtils),
-                        new Vault(config, fileSystemUtils, k8sClient, deployer, airGappedUtils)
+                        new Vault(config, fileSystemUtils, k8sClient, deployer, airGappedUtils),
+                        new Content(config, k8sClient, scmmRepoProvider, scmmApiClient),
                 ]))
             }
         }

src/main/groovy/com/cloudogu/gitops/config/ApplicationConfigurator.groovy

@@ -24,7 +24,7 @@ class ApplicationConfigurator {
         addScmmConfig(newConfig)
 
         addRegistryConfig(newConfig)
-        
+
         addJenkinsConfig(newConfig)
 
         addFeatureConfig(newConfig)
@@ -41,23 +41,23 @@ class ApplicationConfigurator {
     private void addFeatureConfig(Config newConfig) {
         if (newConfig.features.secrets.vault.mode)
             newConfig.features.secrets.active = true
-        
+
         if (newConfig.features.mail.smtpAddress || newConfig.features.mail.mailhog)
             newConfig.features.mail.active = true
         if (newConfig.features.mail.smtpAddress && newConfig.features.mail.mailhog) {
             newConfig.features.mail.mailhog = false
             log.warn("Enabled both external Mailserver and MailHog! Implicitly deactivating MailHog")
         }
-        
+
         if (newConfig.features.ingressNginx.active && !newConfig.application.baseUrl) {
             log.warn("Ingress-controller is activated without baseUrl parameter. Services will not be accessible by hostnames. To avoid this use baseUrl with ingress. ")
         }
         if (newConfig.content.examples) {
-            if  (!newConfig.registry.active) {
+            if (!newConfig.registry.active) {
                 throw new RuntimeException("content.examples requires either registry.active or registry.url")
             }
             String prefix = newConfig.application.namePrefix
-            newConfig.content.namespaces += [ prefix+"example-apps-staging", prefix+"example-apps-production"]
+            newConfig.content.namespaces += [prefix + "example-apps-staging", prefix + "example-apps-production"]
         }
     }
 
@@ -161,7 +161,7 @@ class ApplicationConfigurator {
             // "jenkins.localhost" will not work inside the Pods and k3d-container IP + Port (e.g. 172.x.y.z:9090)
             // will not work on Windows and MacOS.
             newConfig.jenkins.urlForScmm = "http://jenkins.${newConfig.application.namePrefix}jenkins.svc.cluster.local"
-            
+
             // More internal fields are set lazily in Jenkins.groovy (after Jenkins is deployed and ports are known)
         } else {
             // Jenkins not active, no need to set the following values
@@ -265,22 +265,29 @@ class ApplicationConfigurator {
                     "LOCAL_HELM_CHART_FOLDER='charts' after running 'scripts/downloadHelmCharts.sh' from the repo")
         }
     }
-    
+
     static void validateContent(Config config) {
         config.content.repos.each { repo ->
             if (!repo.url) {
-                throw new RuntimeException('content.repos requires a url parameter')
+                throw new RuntimeException("content.repos requires a url parameter.")
             }
             if (!repo.folderBased && !repo.target) {
-                throw new RuntimeException('content.repos.folderBased: false requires folder content.repos.target to be set')
+                throw new RuntimeException("content.repos.folderBased: false requires folder content.repos.target to be set. ${repo.url}")
+            }
+            if (repo.target) {
+                if (repo.target.count('/') == 0) {
+                    throw new RuntimeException("content.target needs / to separate namespace/group from repo name. ${repo.url}")
+                }
+
+
             }
         }
     }
 
     private void validateScmmAndJenkinsAreBothSet(Config configToSet) {
-        if (configToSet.jenkins.active && 
+        if (configToSet.jenkins.active &&
                 (configToSet.scmm.url && !configToSet.jenkins.url ||
-                !configToSet.scmm.url && configToSet.jenkins.url)) {
+                        !configToSet.scmm.url && configToSet.jenkins.url)) {
             throw new RuntimeException('When setting jenkins URL, scmm URL must also be set and the other way round')
         }
     }

src/main/groovy/com/cloudogu/gitops/config/Config.groovy

@@ -98,6 +98,9 @@ class Config {
         @JsonPropertyDescription(CONTENT_REPO_DESCRIPTION)
         List<ContentRepositorySchema> repos = []
 
+        @JsonPropertyDescription(CONTENT_VARIABLES_DESCRIPTION)
+        Map<String, Object> variables = [:]
+
         static class ContentRepositorySchema {
             @JsonPropertyDescription(CONTENT_REPO_URL_DESCRIPTION)
             String url = ''
@@ -106,7 +109,7 @@ class Config {
             String path = '.'
 
             @JsonPropertyDescription(CONTENT_REPO_REF_DESCRIPTION)
-            String ref = 'main'
+            String ref = ''
 
             @JsonPropertyDescription(CONTENT_REPO_USERNAME_DESCRIPTION)
             String username = ''
@@ -124,7 +127,7 @@ class Config {
             String target = ''
 
             @JsonPropertyDescription(CONTENT_REPO_TARGET_OVERRIDE_MODE)
-            OverrideMode overrideMode = OverrideMode.INIT // default is init a new repository
+            OverrideMode overrideMode = OverrideMode.INIT // Defensively use init to not override existing files by default
         }
     }
 
@@ -788,6 +791,7 @@ class Config {
 
     /**
      * This defines, how customer repos will be updated.
+     * See {@link ConfigConstants#CONTENT_REPO_TARGET_OVERRIDE_MODE}
      */
     static enum OverrideMode {
         INIT, RESET, UPGRADE

src/main/groovy/com/cloudogu/gitops/config/ConfigConstants.groovy

@@ -33,14 +33,15 @@ interface ConfigConstants {
     String CONTENT_REPO_DESCRIPTION = "Content repos to push into target environment"
     String CONTENT_REPO_URL_DESCRIPTION = "URL of the content repo"
     String CONTENT_REPO_PATH_DESCRIPTION = "Path within the content repo to process"
-    String CONTENT_REPO_REF_DESCRIPTION = "Reference for a specific branch, tag, or commit"
+    String CONTENT_REPO_REF_DESCRIPTION = "Reference for a specific branch, tag, or commit. Emtpy defaults to default branch of the repo"
     String CONTENT_REPO_USERNAME_DESCRIPTION = "Username to authenticate against content repo"
     String CONTENT_REPO_PASSWORD_DESCRIPTION = "Password to authenticate against content repo"
     String CONTENT_REPO_TEMPLATING_DESCRIPTION = "When true, template all files ending in .ftl within the repo"
     String CONTENT_REPO_FOLDER_BASED_REPOS_DESCRIPTION = "When true, interpret the folder structure of each repo as repos. That is, root folder becomes namespace in SCM, sub folders become repository names in SCM"
     String CONTENT_REPO_TARGET_DESCRIPTION = "Target path for the repository"
-    String CONTENT_REPO_TARGET_OVERRIDE_MODE = "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist (SCMM Return value 409).\nRESET - delete alle files after cloning source - new files are deleted\nUPGRADE - clone and copy - existing files will be overwritten, new files are kept"
-    
+    String CONTENT_REPO_TARGET_OVERRIDE_MODE = "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist.\nRESET - delete all files after cloning source - files not in content are deleted\nUPGRADE - clone and copy - existing files will be overwritten, files not in content are kept"
+    String CONTENT_VARIABLES_DESCRIPTION = "Additional variables to use in custom templates."
+
     // group jenkins
     String JENKINS_ENABLE_DESCRIPTION = 'Installs Jenkins as CI server'
     String JENKINS_SKIP_RESTART_DESCRIPTION = 'Skips restarting Jenkins after plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades.'