imrove: add json schema and readme for helm chart

quarkiverse · Aug 22, 2023 · dcd1c49 · dcd1c49
1 parent 0191e07
commit dcd1c49
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 5 deletions.
diff --git a/...ployment/src/main/java/io/quarkiverse/operatorsdk/deployment/helm/HelmChartProcessor.java b/...ployment/src/main/java/io/quarkiverse/operatorsdk/deployment/helm/HelmChartProcessor.java
@@ -48,6 +48,10 @@ public class HelmChartProcessor {
             "service.yaml",
             "serviceaccount.yaml"
     };
+    private static final String[] ROOT_STATIC_FILES = new String[] {
+            "README.md",
+            "values.schema.json"
+    };
     public static final String CHART_YAML_FILENAME = "Chart.yaml";
     public static final String VALUES_YAML_FILENAME = "values.yaml";
     public static final String CRD_DIR = "crds";
@@ -71,18 +75,23 @@ public void handleHelmCharts(
             var controllerConfigs = controllerConfigurations.getControllerConfigs().values();
 
             createRelatedDirectories(helmDir);
-            copyTemplates(helmDir);
+            addTemplateFiles(helmDir);
             addClusterRolesForReconcilers(helmDir, controllerConfigs);
             addPrimaryClusterRoleBindings(helmDir, controllerConfigs);
             addGeneratedDeployment(helmDir, generatedResources, controllerConfigurations);
             addChartYaml(helmDir, appInfo.getName(), appInfo.getVersion());
             addValuesYaml(helmDir, containerImageInfoBuildItem.getTag());
+            addReadmeAndSchema(helmDir);
             addCRDs(new File(helmDir, CRD_DIR), generatedCRDInfoBuildItem);
         } else {
             log.debug("Generating helm chart is disabled");
         }
     }
 
+    private void addTemplateFiles(File helmDir) {
+        copyTemplates(helmDir.toPath().resolve(TEMPLATES_DIR), TEMPLATE_FILES);
+    }
+
     private void addGeneratedDeployment(File helmDir, List<GeneratedKubernetesResourceBuildItem> generatedResources,
             ControllerConfigurationsBuildItem controllerConfigurations) {
         final var resources = GeneratedResourcesUtils.loadFrom(generatedResources);
@@ -178,6 +187,10 @@ private void addValuesYaml(File helmDir, String tag) {
         }
     }
 
+    private void addReadmeAndSchema(File helmDir) {
+        copyTemplates(helmDir.toPath(), ROOT_STATIC_FILES);
+    }
+
     private void addChartYaml(File helmDir, String name, String version) {
         try {
             Chart chart = new Chart();
@@ -191,15 +204,14 @@ private void addChartYaml(File helmDir, String name, String version) {
         }
     }
 
-    private void copyTemplates(File helmDir) {
-        final var destinationDir = helmDir.toPath().resolve(TEMPLATES_DIR);
-        for (String template : TEMPLATE_FILES) {
+    private void copyTemplates(Path path, String[] staticTemplateFiles) {
+        for (String template : staticTemplateFiles) {
             try (InputStream is = Thread.currentThread().getContextClassLoader()
                     .getResourceAsStream(HELM_TEMPLATES_STATIC_DIR + template)) {
                 if (is == null) {
                     throw new IllegalArgumentException("Template file " + template + " doesn't exist");
                 }
-                Files.copy(is, destinationDir.resolve(template), REPLACE_EXISTING);
+                Files.copy(is, path.resolve(template), REPLACE_EXISTING);
             } catch (IOException e) {
                 throw new IllegalStateException(e);
             }

diff --git a/core/deployment/src/main/resources/helm/static/README.md b/core/deployment/src/main/resources/helm/static/README.md
@@ -0,0 +1,9 @@
+## Configuration
+
+The following values are configurable:
+
+- `watchNamespaces` - namespaces to be watched, it's either a list of namespaces one of special values:
+  - `JOSDK_ALL_NAMESPACES` to watch all namespaces, or
+  - `JOSDK_WATCH_CURRENT` to watch the current namespace
+- `version` - the current version of the application.
+
diff --git a/core/deployment/src/main/resources/helm/static/values.schema.json b/core/deployment/src/main/resources/helm/static/values.schema.json
@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema#",
+  "title": "Values",
+  "type": "object",
+  "properties": {
+    "watchNamespaces": {
+      "type": "String"
+    },
+    "version": {
+      "type": "String"
+    }
+  }
+}