[Feat] Configurable templates helm chart variant and conversion CLI (#30

)

README.md

@@ -39,6 +39,17 @@ To integrate the CAP Operator Plugin into your project, follow these steps:
         ```
         ![](.images/cds-add-cap-operator-with-templates.gif)
 
+    * `--with-configurable-templates`
+
+        With this option, the plugin adds a chart with configurable templates. This is required when applications need to utilize template functions in the CAP Operator resources. In this version of the chart, all the CAP Operator resource configurations are defined in `templates/cap-operator-cros.yaml`. If you choose this option, you can skip the `cds build` step since the chart already contains the `templates` folder.
+
+        ```sh
+        cds add cap-operator --with-configurable-templates
+        ```
+        ![](.images/cds-add-cap-operator-with-configurable-templates.gif)
+
+        > If you have already added your chart and want to switch to `--with-configurable-templates`, you can use the plugin to convert the existing chart. For more information, see the [Converting to Configurable Templates](#converting-to-configurable-templates-chart) section.
+
     * `--force`
 
         This option allows you to overwrite the existing chart folder.
@@ -73,18 +84,23 @@ To integrate the CAP Operator Plugin into your project, follow these steps:
 
 3. Once you've executed the command above, the basic chart folder or chart folder with templates is added to your project directory, depending on your choice.
 
-## Configure the Plugin
+## Configure Your Chart
 
 The generated `chart/values.yaml` contains two types of information:
 
    * Design-time deployment
-        - [serviceInstances](https://github.com/SAP/sap-btp-service-operator?tab=readme-ov-file#service-instance)
-        - [serviceBindings](https://github.com/SAP/sap-btp-service-operator?tab=readme-ov-file#service-binding)
-        - workloads - There are two types of workloads:
-            - [Deployment definition](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#workloads-with-deploymentdefinition)
-            - [Job definition](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#workloads-with-jobdefinition)
-        - [tenantOperations](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#sequencing-tenant-operations)
-        - [contentJobs](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#sequencing-content-jobs)
+        * Without option `--with-configurable-templates`
+            - [serviceInstances](https://github.com/SAP/sap-btp-service-operator?tab=readme-ov-file#service-instance)
+            - [serviceBindings](https://github.com/SAP/sap-btp-service-operator?tab=readme-ov-file#service-binding)
+            - workloads - There are two types of workloads:
+                - [Deployment definition](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#workloads-with-deploymentdefinition)
+                - [Job definition](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#workloads-with-jobdefinition)
+            - [tenantOperations](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#sequencing-tenant-operations)
+            - [contentJobs](https://sap.github.io/cap-operator/docs/usage/resources/capapplicationversion/#sequencing-content-jobs)
+        * With option `--with-configurable-templates`
+            - [serviceInstances](https://github.com/SAP/sap-btp-service-operator?tab=readme-ov-file#service-instance)
+            - [serviceBindings](https://github.com/SAP/sap-btp-service-operator?tab=readme-ov-file#service-binding)
+            - workloads - With this option all the workload configuations are maintained in `templates/cap-operator-cros.yaml` and in the `values.yaml` you can only define the images for the workloads.
 
    * Runtime deployment
         - app
@@ -111,7 +127,7 @@ The generated `chart/values.yaml` contains two types of information:
 
    ![](.images/cds-build.gif)
 
-   > If you've already added the `templates` folder during the initial plugin call using `--with-templates` option, you can skip this step as the Helm chart is already complete.
+   > If you've already added the `templates` folder during the initial plugin call using `--with-templates` or `--with-configurable-templates` option, you can skip this step as the Helm chart is already complete.
 
 2. Up to this point, you've only filled in the design time information in the chart. But to deploy the application, you need to create a `runtime-values.yaml` file with all the runtime values, as mentioned in the section on configuration. You can generate the file using the plugin itself.
 
@@ -175,6 +191,21 @@ The generated `chart/values.yaml` contains two types of information:
    helm upgrade -i -n <namespace> <release-name> <project-path>/gen/chart --set-file serviceInstances.xsuaa.jsonParameters=<project-path>/xs-security.json -f <project-path>/chart/runtime-values.yaml
    ```
 
+## Converting to Configurable Templates Chart
+
+If you've already added the basic chart folder and want to switch to configurable templates chart, you can use the plugin to convert the chart. To do so, run the following command:
+
+```sh
+npx cap-op-plugin convert-to-configurable-template-chart
+```
+
+If you want to convert the existing `runtime-values.yaml` as well to the new format, you can do so by passing the `runtime-values.yaml` path via the `--with-runtime-yaml` option:
+
+```sh
+npx cap-op-plugin convert-to-configurable-template-chart --with-runtime-yaml <project-path>/chart/runtime-values.yaml
+```
+![](.images/cap-op-plugin-convert-to-configurable-templates.gif)
+
 ## Example
 
 As a reference, check out the [CAP Operator Helm chart](https://github.com/cap-js/incidents-app/tree/cap-operator-plugin/chart) in the sample incident app. Also, take a look at the corresponding [runtime-values.yaml](https://github.com/cap-js/incidents-app/blob/cap-operator-plugin/chart/runtime-values.yaml) file.

bin/cap-op-plugin.js

@@ -7,18 +7,35 @@ const yaml = require('@sap/cds-foss').yaml
 const Mustache = require('mustache')
 const { spawn } = require('child_process')
 
-const { ask, mergeObj, isCAPOperatorChart } = require('../lib/util')
+const { ask, mergeObj, isCAPOperatorChart, isConfigurableTemplateChart, transformValuesAndFillCapOpCroYaml } = require('../lib/util')
 
-const SUPPORTED = { 'generate-runtime-values': ['--with-input-yaml'] }
+const SUPPORTED = { 'generate-runtime-values': ['--with-input-yaml'], 'convert-to-configurable-template-chart': ['--with-runtime-yaml'] }
 
-async function capOperatorPlugin(cmd, option, inputYamlPath) {
+async function capOperatorPlugin(cmd, option, yamlPath) {
     try {
         if (!cmd) return _usage()
         if (!Object.keys(SUPPORTED).includes(cmd)) return _usage(`Unknown command ${cmd}.`)
         if (option && !SUPPORTED[cmd].includes(option)) return _usage(`Invalid option ${option}.`)
-        if (option === '--with-input-yaml' && !inputYamlPath) return _usage(`Input yaml path is missing.`)
 
-        if (cmd === 'generate-runtime-values') await generateRuntimeValues(option, inputYamlPath)
+        if (cmd === 'generate-runtime-values') {
+            if (option === '--with-input-yaml' && !yamlPath)
+                return _usage(`Input yaml path is missing.`)
+
+            if (option === '--with-input-yaml' && !yamlPath && cds.utils.exists(cds.utils.path.join(cds.root,yamlPath)))
+                return _usage(`Input yaml path ${yamlPath} does not exist.`)
+
+            await generateRuntimeValues(option, yamlPath)
+        }
+
+        if (cmd === 'convert-to-configurable-template-chart') {
+            if (option === '--with-runtime-yaml' && !yamlPath)
+                return _usage(`Input runtime yaml path is missing.`)
+
+            if (option === '--with-runtime-yaml' && !yamlPath && cds.utils.exists(cds.utils.path.join(cds.root,yamlPath)))
+                return _usage(`Input runtime yaml path ${yamlPath} does not exist.`)
+
+            await convertToconfigurableTemplateChart(option, yamlPath)
+        }
     } catch (e) {
         if (isCli) {
             console.error(e.message)
@@ -46,21 +63,82 @@ COMMANDS
 
     generate-runtime-values [--with-input-yaml <input-yaml-path>]   Generate runtime-values.yaml file for the cap-operator chart
 
+    convert-to-configurable-template-chart [--with-runtime-yaml <runtime-yaml-path>]  Convert existing chart to configurable template chart
+
 EXAMPLES
 
     cap-op-plugin generate-runtime-values
     cap-op-plugin generate-runtime-values --with-input-yaml /path/to/input.yaml
+
+    cap-op-plugin convert-to-configurable-template-chart
+    cap-op-plugin convert-to-configurable-template-chart --with-runtime-yaml /path/to/runtime.yaml
 `
     )
 }
 
+async function transformRuntimeValues(runtimeYamlPath) {
+    console.log('Transforming runtime values file '+ cds.utils.path.join(cds.root,runtimeYamlPath) + ' to the configurable template chart format.')
+    let runtimeYaml = yaml.parse(await cds.utils.read(cds.utils.path.join(cds.root, runtimeYamlPath)))
+    if (runtimeYaml?.workloads?.server?.deploymentDefinition?.env) {
+        const index = runtimeYaml.workloads.server.deploymentDefinition.env.findIndex(e => e.name === 'CDS_CONFIG')
+        if (index > -1) {
+            const cdsConfigValueJson = JSON.parse(runtimeYaml.workloads.server.deploymentDefinition.env[index].value)
+            if (cdsConfigValueJson?.requires?.['cds.xt.DeploymentService']?.hdi?.create?.database_id){
+                runtimeYaml['hanaInstanceId'] = cdsConfigValueJson.requires['cds.xt.DeploymentService'].hdi.create.database_id
+                delete runtimeYaml['workloads']
+                await cds.utils.write(yaml.stringify(runtimeYaml)).to(cds.utils.path.join(cds.root, runtimeYamlPath))
+            }
+        }
+    }
+}
+
+async function isRuntimeValueAlreadyTransformed(runtimeYamlPath) {
+    let runtimeYaml = yaml.parse(await cds.utils.read(cds.utils.path.join(cds.root, runtimeYamlPath)))
+    return !!runtimeYaml['hanaInstanceId']
+}
+
+async function convertToconfigurableTemplateChart(option, runtimeYamlPath) {
+    if (!((cds.utils.exists('chart') && isCAPOperatorChart(cds.utils.path.join(cds.root,'chart')))))
+        throw new Error("No CAP Operator chart found in the project. Please run 'cds add cap-operator --force' to add the CAP Operator chart folder.")
+
+    if (isConfigurableTemplateChart(cds.utils.path.join(cds.root,'chart'))){
+        console.log("Exisiting chart is already a configurable template chart. No need for conversion.")
+        if (option === '--with-runtime-yaml' && runtimeYamlPath && !(await isRuntimeValueAlreadyTransformed(runtimeYamlPath)))
+            await transformRuntimeValues(runtimeYamlPath)
+        else
+            console.log('Runtime values file '+ cds.utils.path.join(cds.root,runtimeYamlPath) + ' already in the configurable template chart format.')
+        return
+    }
+
+    console.log('Converting chart '+cds.utils.path.join(cds.root,'chart')+' to configurable template chart.')
+
+    // Copy templates
+    await cds.utils.copy(cds.utils.path.join(__dirname, '../files/configurableTemplatesChart/templates')).to(cds.utils.path.join(cds.root,'chart','templates'))
+
+    // Copy values.schema.json
+    await cds.utils.copy(cds.utils.path.join(__dirname, '../files/configurableTemplatesChart/values.schema.json')).to(cds.utils.path.join(cds.root,'chart', 'values.schema.json'))
+
+    // Add annotation to chart.yaml
+    const chartYaml = yaml.parse(await cds.utils.read(cds.utils.path.join(cds.root, 'chart/Chart.yaml')))
+    chartYaml['annotations']['app.kubernetes.io/part-of'] = 'cap-operator-configurable-templates'
+    await cds.utils.write(yaml.stringify(chartYaml)).to(cds.utils.path.join(cds.root, 'chart/Chart.yaml'))
+
+    // Transform
+    await transformValuesAndFillCapOpCroYaml()
+
+    if (option === '--with-runtime-yaml' && runtimeYamlPath) {
+        await transformRuntimeValues(runtimeYamlPath)
+    }
+}
+
 async function generateRuntimeValues(option, inputYamlPath) {
     if (!((cds.utils.exists('chart') && isCAPOperatorChart(cds.utils.path.join(cds.root,'chart'))))) {
         throw new Error("No CAP Operator chart found in the project. Please run 'cds add cap-operator --force' to add the CAP Operator chart folder.")
     }
 
     let answerStruct = {}
     const { appName, appDescription } = getAppDetails()
+    const isConfigurableTempChart = isConfigurableTemplateChart(cds.utils.path.join(cds.root,'chart'))
 
     if (option === '--with-input-yaml' && inputYamlPath) {
 
@@ -104,6 +182,17 @@ async function generateRuntimeValues(option, inputYamlPath) {
     if (!answerStruct['imagePullSecret'])
         delete runtimeValuesYaml['imagePullSecrets']
 
+    if (isConfigurableTempChart && answerStruct['hanaInstanceId'])
+        runtimeValuesYaml['hanaInstanceId'] = answerStruct['hanaInstanceId']
+
+    if (!isConfigurableTempChart)
+        updateWorkloadEnv(runtimeValuesYaml, valuesYaml, answerStruct)
+
+    await cds.utils.write(yaml.stringify(runtimeValuesYaml)).to(cds.utils.path.join(cds.root, 'chart/runtime-values.yaml'))
+    console.log("Generated 'runtime-values.yaml' file in the 'chart' folder.")
+}
+
+function updateWorkloadEnv(runtimeValuesYaml, valuesYaml, answerStruct) {
     runtimeValuesYaml['workloads'] = {}
     for (const [workloadKey, workloadDetails] of Object.entries(valuesYaml.workloads)) {
 
@@ -131,17 +220,10 @@ async function generateRuntimeValues(option, inputYamlPath) {
 
     // remove workload definition where env is empty
     for (const [workloadKey, workloadDetails] of Object.entries(runtimeValuesYaml.workloads)) {
-        if (workloadDetails?.deploymentDefinition?.env.length === 0) {
-            delete runtimeValuesYaml['workloads'][workloadKey]
-        }
-
-        if (workloadDetails?.jobDefinition?.env.length === 0) {
+        if (workloadDetails?.deploymentDefinition?.env.length === 0 || workloadDetails?.jobDefinition?.env.length === 0) {
             delete runtimeValuesYaml['workloads'][workloadKey]
         }
     }
-
-    await cds.utils.write(yaml.stringify(runtimeValuesYaml)).to(cds.utils.path.join(cds.root, 'chart/runtime-values.yaml'))
-    console.log("Generated 'runtime-values.yaml' file in the 'chart' folder.")
 }
 
 function getServiceInstanceKeyName(serviceInstances, offeringName) {
@@ -193,8 +275,8 @@ async function getShootDomain() {
 }
 
 if (isCli) {
-    const [, , cmd, option, inputYamlPath] = process.argv;
-    (async () => await capOperatorPlugin(cmd, option, inputYamlPath ?? undefined))()
+    const [, , cmd, option, yamlPath] = process.argv;
+    (async () => await capOperatorPlugin(cmd, option, yamlPath ?? undefined))()
 }
 
 module.exports = { capOperatorPlugin }

files/approuter.yaml.hbs

@@ -1,5 +1,5 @@
 workloads:
-    app-router:
+    appRouter:
         name: app-router
         labels:
             sme.sap.com/app-type: {{appName}}

files/chart/templates/_helpers.tpl

@@ -1,8 +1,12 @@
 {{- define "capApplicationVersionName" -}}
-{{ printf "cav-%s-%d" (include "appName" $) (.Release.Revision) }}
+{{ printf "%s-%d" (include "appName" $) (.Release.Revision) }}
 {{- end -}}
 
 {{- define "appName" -}}
-{{- $xsuaa := index .Values.serviceInstances "xsuaa" -}}
-{{ printf "%s" $xsuaa.parameters.xsappname }}
+{{- range $sik, $siv := .Values.serviceInstances}}
+    {{- if and (eq (get $siv "serviceOfferingName") "xsuaa") (eq (get $siv "servicePlanName") "broker") -}}
+        {{ printf "%s" $siv.parameters.xsappname }}
+        {{- break -}}
+    {{- end -}}
+{{- end -}}
 {{- end -}}

files/chart/templates/cap-operator-cros.yaml

@@ -2,7 +2,7 @@
 apiVersion: sme.sap.com/v1alpha1
 kind: CAPApplication
 metadata:
-  name: cap-{{ include "appName" $ }}
+  name: {{ include "appName" $ }}
 spec:
   domains:
     primary: {{.Values.app.domains.primary}}
@@ -18,10 +18,10 @@ spec:
       value: {{ $v | default "invalidValue"}}
     {{- end }}
   btpAppName: {{ include "appName" $ }}
-  globalAccountId: "{{.Values.btp.globalAccountId}}"
+  globalAccountId: {{.Values.btp.globalAccountId}}
   provider:
-    subDomain: "{{.Values.btp.provider.subdomain}}"
-    tenantId: "{{.Values.btp.provider.tenantId}}"
+    subDomain: {{.Values.btp.provider.subdomain}}
+    tenantId: {{.Values.btp.provider.tenantId}}
   btp:
     services:
     {{- $serviceInstances := .Values.serviceInstances }}
@@ -51,8 +51,8 @@ metadata:
     helm.sh/resource-policy: keep
   name: {{ include "capApplicationVersionName" $ }}
 spec:
-  capApplicationInstance: "cap-{{ include "appName" $ }}"
-  version: "{{ .Release.Revision }}"
+  capApplicationInstance: {{ include "appName" $ }}
+  version: {{ .Release.Revision }}
   registrySecrets:
     {{- range .Values.imagePullSecrets }}
     - {{.}}

files/configurableTemplatesChart/Chart.yaml.hbs

@@ -0,0 +1,9 @@
+apiVersion: v2
+name: {{appName}}
+description: Helm chart to deploy {{appName}} using CAP Operator
+type: application
+version: 0.0.1
+appVersion: {{appVersion}}
+annotations:
+    app.kubernetes.io/managed-by: cap-operator-plugin
+    app.kubernetes.io/part-of: cap-operator-configurable-templates

files/configurableTemplatesChart/templates/_helpers.tpl

@@ -0,0 +1,41 @@
+{{- define "capApplicationVersionName" -}}
+{{ printf "%s-%d" (include "appName" $) (.Release.Revision) }}
+{{- end -}}
+
+{{- define "appName" -}}
+{{- range $sik, $siv := .Values.serviceInstances}}
+    {{- if and (eq (get $siv "serviceOfferingName") "xsuaa") (eq (get $siv "servicePlanName") "broker") -}}
+        {{ printf "%s" $siv.parameters.xsappname }}
+        {{- break -}}
+    {{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{- define "hasService" -}}
+{{- $found := "false" -}}
+{{- $offeringName := .offeringName -}}
+{{- $planName := .planName -}}
+{{- $si := .si -}}
+{{- range $sik, $siv := $si}}
+    {{- if and (eq (get $siv "serviceOfferingName") $offeringName) (eq (get $siv "servicePlanName") $planName) -}}
+        {{- $found = "true" -}}
+    {{- end -}}
+{{- end -}}
+{{- $found -}}
+{{- end -}}
+
+{{- define "domainPatterns" -}}
+    {{- if .Values.app.domains.secondary -}}
+        {{- $doms := list .Values.app.domains.primary -}}
+        {{- range .Values.app.domains.secondary -}}
+            {{- $doms = append $doms . -}}
+        {{- end -}}
+        {{- if gt (len $doms) 1 -}}
+            {{- join "|" $doms | printf "(%s)" -}}
+        {{- else -}}
+            {{- first $doms -}}
+        {{- end -}}
+    {{- else -}}
+        {{- printf "%s" .Values.app.domains.primary -}}
+    {{- end -}}
+{{- end -}}