Merge pull request #82 from dwasinge/config

Read Config.yml from ConfigMap

Author: pabrahamsson

deployment/README.md

@@ -31,7 +31,6 @@ helm template . \
   --values values-dev.yaml \
   --set git.uri=https://github.com/rht-labs/open-management-portal-git-api.git \
   --set git.ref=master \
-  --set configFile=<your-config-file> \
   --set configRepositoryId=<your-config-repository-id> \
   --set deployKey=<your-gitlab-deploy-key-id> \
   --set gitLabApiUrl=<your-gitlab-base-url> \
@@ -46,11 +45,16 @@ It accepts the following variables
 |---|---|
 | `git.uri`  | The HTTPS reference to the repo (your fork!) to build  |
 | `git.ref`  | The branch name to build  |
-| `configFile` | The path including name of the config file |
 | `configRepositoryId`  | The GitLab ID of the config repository  |
 | `deployKey`  | The ID of the GitLab deploy key to enable on newly-created repositories  |
 | `gitLabApiUrl`  | The base URL of the GitLab instance to use  |
 | `gitLabPersonalAccessToken`  | The access token to use to auth against GitLab  |
 | `engagementsRepositoryId`  | The ID of the GitLab group under which to create new projects  |
 
 This will spin up all of the usual resources that this service needs in production, plus a `BuildConfig` configured to build it from source from the Git repository specified. To trigger this build, use `oc start-build omp-git-api`.
+
+## Config Map Configurations
+
+Please note that there is a configuration for both, webhooks and the runtime configuration.  These are provided as samples or subsets and will not be kept current with the values configured in the test/integration/production environments.
+
+These ConfigMaps have already been configured and provided when deployed into the official OpenShift environments.  

deployment/templates/configmap-config.yaml

@@ -0,0 +1,78 @@
+{{- if .Values.development }}
+apiVersion: v1
+data:
+  lodestar-runtime-config.yaml: |
+   ---
+   basic_information:
+     project_name:
+       validators:
+         - kind: regex
+           value: ^\w+[\w- ()]*$
+           message: Only alphanumeric characters and spaces are allowed
+     customer_name:
+       validators:
+         - kind: regex
+           value: ^\w+[\w- ()]*$
+           message: Only alphanumeric characters and spaces are allowed
+   cloud_options:
+     providers:
+       options:
+         - label: AWS
+           value: ec2
+           options:
+             - label: US East 1 (N. Virginia)
+               value: us-east-1
+             - label: US East 2 (Ohio)
+               value: us-east-2
+             - label: US West 1 (N. California)
+               value: us-west-1
+             - label: US West 2 (Oregon)
+               value: us-west-2
+         - label: Other
+           value: other
+           options:
+             - label: Other
+               value: other
+   openshift_options:
+     versions:
+       options:
+         - label: v4.4
+           value: 4.4.10
+         - label: v4.5
+           value: 4.5.0
+     persistent_storage:
+       validators:
+         - kind: notnull
+       options:
+         - label: None
+           value: none
+         - label: 50GB
+           value: 50G
+     cluster_size:
+       options:
+         - label: Small
+           value: small
+   user_options:
+     user_roles:
+       options:
+         - label: Developer
+           value: developer
+         - label: Observer
+           value: observer
+         - label: Admin
+           value: admin
+   logistics_options:
+     start_date:
+     end_date:
+       validators:
+         - kind: date
+           value:
+             min: "@today"
+           message: "End date must be after today"
+     technical_contact_email:
+     env_default_grace_period: 30
+     env_grace_period_max: 180
+kind: ConfigMap
+metadata:
+  name: lodestar-runtime-cm
+{{- end }}

deployment/templates/deploymentconfig.yaml

@@ -44,7 +44,11 @@ spec:
         terminationMessagePolicy: File
         volumeMounts:
         - name: hook-cm-volume
-          mountPath: {{ .Values.config.hookFile.path }}
+          mountPath: {{ .Values.config.hookFile.path }}/{{ .Values.config.hookFile.name }}
+          subPath: {{ .Values.config.hookFile.name }}
+        - name: lodestar-runtime-cm-volume
+          mountPath: {{ .Values.config.runtimeConfigFile.path }}/{{ .Values.config.runtimeConfigFile.name }}
+          subPath: {{ .Values.config.runtimeConfigFile.name }}
       dnsPolicy: ClusterFirst
       restartPolicy: Always
       schedulerName: default-scheduler
@@ -54,6 +58,9 @@ spec:
       - name: hook-cm-volume
         configMap:
           name: hook-cm
+      - name: lodestar-runtime-cm-volume
+        configMap:
+          name: lodestar-runtime-cm
   test: false
   triggers:
   - type: ConfigChange

deployment/templates/gitlab-secret.yaml

@@ -5,7 +5,6 @@ metadata:
   name: omp-gitlab-configuration
 type: Opaque
 stringData:
-  CONFIG_FILE: "{{ .Values.configFile }}"
   CONFIG_REPOSITORY_ID: "{{ .Values.configRepositoryId }}"
   DEPLOY_KEY: "{{ .Values.deployKey }}"
   GITLAB_API_URL: "{{ .Values.gitLabApiUrl }}"

deployment/values-dev.yaml

@@ -13,7 +13,6 @@ git:
   uri: https://github.com/rht-labs/open-management-portal-git-api.git
   ref: master
 
-configFile: false
 configRepositoryId: false
 deployKey: false
 gitLabApiUrl: false
@@ -22,7 +21,7 @@ engagementsRepositoryId: false
 
 config:
   hookFile:
-    path: /schema
+    path: /runtime
     name: webhooks.yaml
   hooks:
     - name: hook1
@@ -31,4 +30,7 @@ config:
     - name: hook2
       baseUrl: http://localhost/hook2
       token: anunoby
-      
+  runtimeConfigFile:
+    path: /runtime
+    name: lodestar-runtime-config.yaml
+

deployment/values.yaml

@@ -6,3 +6,11 @@ imageName: "quay.io/rht-labs/omp-git-api"
 imageTag: "latest" # This is intended to be overridden by the parent Helm chart.
 
 gitlabRef: "master"
+
+config:
+  hookFile:
+    path: /runtime
+    name: webhooks.yaml
+  configFile:
+    path: /runtime
+    name: lodestar-runtime-config.yaml

src/main/java/com/redhat/labs/omp/service/ConfigService.java

@@ -1,5 +1,9 @@
 package com.redhat.labs.omp.service;
 
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
@@ -25,58 +29,87 @@ public class ConfigService {
 
     @ConfigProperty(name = "config.file")
     String configFile;
-    
+
     @ConfigProperty(name = "webhook.file")
     String webHooksFile;
 
     @ConfigProperty(name = "config.repository.id", defaultValue = "9407")
     String configRepositoryId;
-    
+
     @ConfigProperty(name = "config.gitlab.ref", defaultValue = "master")
     String gitRef;
-    
+
     List<HookConfig> hookConfigList;
+    File configuration;
 
     @Inject
     FileService fileService;
-    
+
     @Inject
     JsonMarshaller marshaller;
-    
+
     void onStart(@Observes StartupEvent event) {
         hookConfigList = marshaller.fromYamlFile(webHooksFile, HookConfig.class);
         LOGGER.debug("Hook Config List {}", hookConfigList);
+        String content = readFile(configFile);
+        if (null != content) {
+            configuration = File.builder().filePath(configFile).content(content).build();
+            LOGGER.debug("Loaded Runtime Config from File, {}", configFile);
+        }
+       
     }
 
     public File getConfigFile() {
 
-        Optional<File> optional = fileService.getFile(configRepositoryId, configFile, gitRef);
+        if (null != configuration) {
+            return configuration;
+        }
+
+        String gitLabConfigFile = configFile.charAt(0) == '/' ? configFile.substring(1) : configFile;
+        Optional<File> optional = fileService.getFile(configRepositoryId, gitLabConfigFile, gitRef);
 
         if (!optional.isPresent()) {
             throw new FileNotFoundException("the configured file was not found in the gitlab repository.");
         }
 
         return optional.get();
     }
-    
+
     public List<HookConfig> getHookConfig() {
 
-        if(hookConfigList != null) {
+        if (hookConfigList != null) {
             return hookConfigList;
         }
-        
+
         String gitLabHookFile = webHooksFile.charAt(0) == '/' ? webHooksFile.substring(1) : webHooksFile;
         Optional<File> optional = fileService.getFile(configRepositoryId, gitLabHookFile, gitRef);
 
         if (!optional.isPresent()) {
             LOGGER.error("No webhook file could be found. This is abnormal but not a deal breaker");
             return new ArrayList<>();
         }
-        
+
         File file = optional.get();
-       
+
         return marshaller.fromYaml(file.getContent(), HookConfig.class);
-        
+
+    }
+
+    private String readFile(String file) {
+
+        Path path = Paths.get(file);
+
+        if (Files.isReadable(path)) {
+            LOGGER.debug("Loading config file {}", file);
+            try {
+                return new String(Files.readAllBytes(path));
+            } catch (IOException e) {
+                LOGGER.error(String.format("Found but unable to read file %s", file), e);
+            }
+        }
+
+        return null;
+
     }
 
 }

src/main/resources/application.properties

@@ -26,8 +26,8 @@ gitlab.deploy.key=${DEPLOY_KEY:0}
 
 # config 
 config.repository.id=${CONFIG_REPOSITORY_ID:1}
-config.file=${CONFIG_FILE:schema/config.yml}
-webhook.file=${WEBHOOK_FILE:/schema/webhooks.yaml}
+config.file=${CONFIG_FILE:/runtime/lodestar-runtime-config.yaml}
+webhook.file=${WEBHOOK_FILE:/runtime/webhooks.yaml}
 webhook.default.token=${WEBHOOK_DEFAULT_TOKEN:tolkien}
 config.gitlab.ref=${CONFIG_GITLAB_REF:master}
 commit.page.size=100

src/test/java/com/redhat/labs/omp/mocks/MockGitLabService.java

@@ -157,7 +157,7 @@ public File getFile(String projectId, String filePath, String ref) {
 
         }
 
-        if ("schema/webhooks.yaml".equalsIgnoreCase(filePath)) {
+        if ("runtime/webhooks.yaml".equalsIgnoreCase(filePath)) {
             String content = ResourceLoader.load("webhooks.yaml");
             content = new String(EncodingUtils.base64Encode(content.getBytes()), StandardCharsets.UTF_8);
             return File.builder().filePath(filePath).content(content).build();
@@ -186,8 +186,8 @@ public File getFile(String projectId, String filePath, String ref) {
             throw new WebApplicationException(500);
         }
 
-        if("schema/config.yml".equals(filePath)) {
-            String content = ResourceLoader.load("config.yml");
+        if("runtime/lodestar-runtime-config.yaml".equals(filePath)) {
+            String content = ResourceLoader.load("lodestar-runtime-config.yaml");
             content = new String(EncodingUtils.base64Encode(content.getBytes()), StandardCharsets.UTF_8);
             return File.builder().filePath(filePath).content(content).build();
         }

src/test/java/com/redhat/labs/omp/resource/ConfigResourceTest.java

@@ -15,7 +15,7 @@ class ConfigResourceTest {
     void testGetConfigFileSuccess() {
 
         given().when().contentType(ContentType.JSON).get("/api/v1/config").then().statusCode(200).body(is(
-                "{\"content\":\"---\\nproviders:\\n- label: AWS\\n  value: ec2\\n  regions:\\n  - label: US East 1 (N. Virginia)\\n    value: us-east-1\\n  - label: US East 2 (Ohio)\\n    value: us-east-2\\nopenshift:\\n  versions:\\n  - label: v4.1\\n    value: 4.1.31\\n  - label: v4.2\\n    value: 4.2.16\\n  - label: v4.3\\n    value: 4.3.0\\n  persistent-storage:\\n  - label: None\\n    value: none\\n  - label: 50GB\\n    value: 50G\\n  - label: 100GB\\n    value: 100G\\n  - label: 250GB\\n    value: 250G\\n  - label: 500GB\\n    value: 500G\\n  cluster-size:\\n  - label: Small\\n    value: small\\nuser-management:\\n  rbac:\\n    roles:\\n    - label: Developer \\n      value: developer\\n    - label: Observer \\n      value: observer\\n    - label: Admin \\n      value: admin\\n\",\"encoding\":\"base64\",\"file_path\":\"schema/config.yml\"}"));
+                "{\"content\":\"---\\nproviders:\\n- label: AWS\\n  value: ec2\\n  regions:\\n  - label: US East 1 (N. Virginia)\\n    value: us-east-1\\n  - label: US East 2 (Ohio)\\n    value: us-east-2\\nopenshift:\\n  versions:\\n  - label: v4.1\\n    value: 4.1.31\\n  - label: v4.2\\n    value: 4.2.16\\n  - label: v4.3\\n    value: 4.3.0\\n  persistent-storage:\\n  - label: None\\n    value: none\\n  - label: 50GB\\n    value: 50G\\n  - label: 100GB\\n    value: 100G\\n  - label: 250GB\\n    value: 250G\\n  - label: 500GB\\n    value: 500G\\n  cluster-size:\\n  - label: Small\\n    value: small\\nuser-management:\\n  rbac:\\n    roles:\\n    - label: Developer \\n      value: developer\\n    - label: Observer \\n      value: observer\\n    - label: Admin \\n      value: admin\\n\",\"encoding\":\"base64\",\"file_path\":\"runtime/lodestar-runtime-config.yaml\"}"));
 
     }