@sap/cds-dk 7.4.1 → 7.5.1

package/lib/init/template/helm/files/chart/values.schema.json

@@ -0,0 +1,366 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "type": "object",
+    "required": [
+        "global",
+        "srv"
+    ],
+    "properties": {
+        "global": {
+            "$id": "#/properties/global",
+            "title": "Helm global values",
+            "description": "For more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values",
+            "type": "object",
+            "required": [
+                "domain"
+            ],
+            "properties": {
+                "imagePullSecret": {
+                    "$id": "#/properties/global/imagePullSecret",
+                    "title": "Image Pull Secret configuration",
+                    "description": "For more information, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
+                    "additionalProperties": false,
+                    "type": "object",
+                    "properties": {
+                        "name": {
+                            "title": "Secret name",
+                            "description": "Name of the Kubernetes Secret, used as an image pull secret (must be of type kubernetes.io/dockerconfigjson). Can't be used with the `dockerconfigjson` option.",
+                            "$ref": "#/definitions/KubernetesName"
+                        }
+                    }
+                },
+                "domain": {
+                    "$id": "#/properties/global/doamin",
+                    "title": "Domain Name",
+                    "description": "Full-qualified domain name used to access applications in your Kyma cluster",
+                    "type": "string",
+                    "pattern": "[0-9a-z][0-9a-z-.]*"
+                }
+            }
+        },
+        "srv": {
+            "$id": "#/properties/srv",
+            "description": "Deployment"
+        },
+        "hana-deployer": {
+            "$id": "#/properties/hana-deployer",
+            "description": "Content Deployment"
+        },
+        "html5-apps-deployer": {
+            "$id": "#/properties/html5-apps-deployer",
+            "description": "Content Deployment"
+        },
+        "approuter": {
+            "$id": "#/properties/approuter",
+            "description": "Deployment"
+        },
+        "event-mesh": {
+            "$id": "#/properties/event-mesh",
+            "description": "Service Instance"
+        },
+        "html5-apps-repo-host": {
+            "$id": "#/properties/html5-apps-repo-host",
+            "description": "Service Instance"
+        },
+        "xsuaa": {
+            "$id": "#/properties/xsuaa",
+            "description": "Service Instance"
+        },
+        "destination": {
+            "$id": "#/properties/destination",
+            "description": "Service Instance"
+        },
+        "hana": {
+            "$id": "#/properties/hana",
+            "description": "Service Instance"
+        },
+        "saas-registry": {
+            "$id": "#/properties/saas-registry",
+            "description": "Service Instance"
+        },
+        "service-manager": {
+            "$id": "#/properties/service-manager",
+            "description": "Service Instance"
+        },
+        "backendDestinations": {
+            "$id": "#/properties/backendDestinations",
+            "title": "Backend Destinations for Approuter or HTML5 Apps Deployer",
+            "type": "object",
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "description": "Name of the backend Destination",
+                    "required": [
+                        "service"
+                    ],
+                    "properties": {
+                        "service": {
+                            "type": "string",
+                            "description": "Target Kubernetes service"
+                        },
+                        "path": {
+                            "type": "string",
+                            "description": "This path will be appended to the URL"
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "definitions": {
+        "KubernetesName": {
+            "type": "string",
+            "$comment": "running `kubectl create secret generic invalid_name` will print this regex",
+            "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
+        },
+        "ServiceInstance": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "serviceOfferingName",
+                "servicePlanName"
+            ],
+            "properties": {
+                "fullnameOverride": {
+                    "type": "string",
+                    "pattern": "[0-9a-z][0-9a-z-.]*",
+                    "maxLength": 63,
+                    "description": "If present then this will be used instead of the generated name"
+                },
+                "enabled": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Service instance will be created (default: true)"
+                },
+                "serviceOfferingName": {
+                    "type": "string",
+                    "description": "Technical service offering name from service catalog"
+                },
+                "servicePlanName": {
+                    "type": "string",
+                    "description": "Technical service plan name from service catalog"
+                },
+                "parameters": {
+                    "type": "object",
+                    "description": "Some services support the provisioning of additional configuration parameters during the instance creation. For the list of supported parameters, check the documentation of the particular service offering."
+                },
+                "config": {
+                    "type": "string",
+                    "description": "File name of JSON configuration file in chart folder. Values from the file will be copied and placed in the parameters for the service instance. If both parameters and config are specified, the values in parameters override those read from config."
+                }
+            }
+        },
+        "Image": {
+            "title": "Image configuration",
+            "type": "object",
+            "required": [
+                "repository"
+            ],
+            "additionalProperties": false,
+            "properties": {
+                "repository": {
+                    "title": "Repository of the image",
+                    "description": "Should also include the image name (i.e. everything before the `:` sign).",
+                    "type": "string",
+                    "pattern": "^[\\w-./:]*[@sha256]*$"
+                },
+                "tag": {
+                    "title": "Image tag",
+                    "description": "Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).",
+                    "type": "string",
+                    "pattern": "^((?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:(?:\\.(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))+)?(?::[0-9]+)?/)?[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?(?:(?:/[a-z0-9]+(?:(?:(?:[._]|__|[-]*)[a-z0-9]+)+)?)+)?)(?::([\\w][\\w.-]{0,127}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]{32,}))?$"
+                }
+            }
+        },
+        "Bindings": {
+            "$id": "#/properties/bindings",
+            "title": "Service Binding configuration",
+            "type": "object",
+            "additionalProperties": false,
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "anyOf": [
+                        {
+                            "type": "object",
+                            "additionalProperties": false,
+                            "required": [
+                                "fromSecret"
+                            ],
+                            "properties": {
+                                "fromSecret": {
+                                    "description": "Name of a Kubernetes Secret, with the binding content, compliant to the SAP Kubernetes Service Binding spec https://github.tools.sap/Kubernetes-Service-Bindings/doc/",
+                                    "$ref": "#/definitions/KubernetesName"
+                                }
+                            }
+                        },
+                        {
+                            "type": "object",
+                            "additionalProperties": false,
+                            "properties": {
+                                "serviceInstanceName": {
+                                    "description": "Name of a BTP Operator Service Instance, created by the `service-instance` Helm chart. Can't be used with the `serviceInstanceFullname` option.",
+                                    "$ref": "#/definitions/KubernetesName"
+                                },
+                                "serviceInstanceFullname": {
+                                    "description": "Full name of a BTP Operator Service Instance. Can't be used with the `serviceInstanceName` option.",
+                                    "$ref": "#/definitions/KubernetesName"
+                                },
+                                "externalName": {
+                                    "description": "The name for the service binding in SAP BTP",
+                                    "type": "string"
+                                },
+                                "secretName": {
+                                    "description": "The name of the secret where the credentials are stored.",
+                                    "$ref": "#/definitions/KubernetesName"
+                                },
+                                "parameters": {
+                                    "description": "Some services support the provisioning of additional configuration parameters during the bind request. For the list of supported parameters, check the documentation of the particular service offering.",
+                                    "type": "object"
+                                },
+                                "parametersFrom": {
+                                    "description": "List of sources to populate parameters.",
+                                    "type": "array",
+                                    "items": {
+                                        "anyOf": [
+                                            {
+                                                "type": "object",
+                                                "description": "Kubernetes Secret as a parameters source.",
+                                                "additionalProperties": false,
+                                                "properties": {
+                                                    "secretKeyRef": {
+                                                        "type": "object",
+                                                        "additionalProperties": false,
+                                                        "required": [
+                                                            "name",
+                                                            "key"
+                                                        ],
+                                                        "properties": {
+                                                            "name": {
+                                                                "description": "Name of a Secret.",
+                                                                "$ref": "#/definitions/KubernetesName"
+                                                            },
+                                                            "key": {
+                                                                "description": "Key in that Secret, which contains a string that represents the json to include in the set of parameters to be sent to the broker.",
+                                                                "type": "string"
+                                                            }
+                                                        }
+                                                    }
+                                                }
+                                            },
+                                            {
+                                                "type": "object",
+                                                "description": "Kubernetes Config Map as a parameters source.",
+                                                "additionalProperties": false,
+                                                "properties": {
+                                                    "configMapKeyRef": {
+                                                        "type": "object",
+                                                        "additionalProperties": false,
+                                                        "required": [
+                                                            "name",
+                                                            "key"
+                                                        ],
+                                                        "properties": {
+                                                            "name": {
+                                                                "description": "Name of a Config Map",
+                                                                "$ref": "#/definitions/KubernetesName"
+                                                            },
+                                                            "key": {
+                                                                "description": "Key in that Config Map, which contains a string that represents the json to include in the set of parameters to be sent to the broker.",
+                                                                "type": "string"
+                                                            }
+                                                        }
+                                                    }
+                                                }
+                                            }
+                                        ]
+                                    }
+                                },
+                                "credentialsRotationPolicy": {
+                                    "description": "Holds automatic credentials rotation configuration. For more details, see https://github.com/SAP/sap-btp-service-operator#spec-1",
+                                    "type": "object"
+                                }
+                            },
+                            "dependencies": {
+                                "serviceInstanceName": {
+                                    "not": {
+                                        "required": [
+                                            "serviceInstanceFullname"
+                                        ]
+                                    }
+                                },
+                                "serviceInstanceFullname": {
+                                    "not": {
+                                        "required": [
+                                            "serviceInstanceName"
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    ]
+                }
+            }
+        },
+        "Resources": {
+            "title": "Pod resources configuration",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "requests",
+                "limits"
+            ],
+            "properties": {
+                "requests": {
+                    "type": "object",
+                    "description": "Minimal required resources for the application to operate, that will be reserved.",
+                    "additionalProperties": false,
+                    "required": [
+                        "cpu",
+                        "memory"
+                    ],
+                    "properties": {
+                        "cpu": {
+                            "description": "CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu",
+                            "type": [
+                                "string",
+                                "number"
+                            ]
+                        },
+                        "ephemeral-storage": {
+                            "description": "Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage",
+                            "type": "string"
+                        },
+                        "memory": {
+                            "description": "Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory",
+                            "type": "string"
+                        }
+                    }
+                },
+                "limits": {
+                    "type": "object",
+                    "description": "If a process tries to use more resources than specified in the limits, the system kernel terminates the process that attempted the allocation, with an out of memory (OOM) error.",
+                    "additionalProperties": false,
+                    "required": [
+                        "memory"
+                    ],
+                    "properties": {
+                        "cpu": {
+                            "description": "CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu",
+                            "type": [
+                                "string",
+                                "number"
+                            ]
+                        },
+                        "ephemeral-storage": {
+                            "description": "Size of the local ephemeral storage, measured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#local-ephemeral-storage",
+                            "type": "string"
+                        },
+                        "memory": {
+                            "description": "Amount of memory, mesaured in bytes. For more info, see https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory",
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/lib/init/template/helm/{subcharts → files}/web-application/Chart.yaml

@@ -5,4 +5,4 @@ name: web-application
 sources:
 - https://github.tools.sap/unified-runtime/web-application
 type: application
-version: 1.8.0
+version: 1.9.0

package/lib/init/template/helm/{subcharts → files}/web-application/templates/_api.tpl

@@ -52,7 +52,7 @@ app.kubernetes.io/instance: {{ .Release.Name }}
 app.kubernetes.io/component:{{ .Values.global.component }}
 {{- end }}
 {{- if .Values.global.partOf }}
-app.kubernetes.io/partOf: {{ .Values.global.partOf }}
+app.kubernetes.io/part-of: {{ .Values.global.partOf }}
 {{- end }}
 {{- end }}
 {{- end }}

package/lib/init/template/helm/{subcharts → files}/web-application/values.yaml

@@ -15,7 +15,7 @@ global:
     _internal:
       web-application:
         versions:
-          1.8.0: true
+          1.9.0: true
 ## Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.
 # nameOverride: name
 

package/lib/init/template/helm/index.js

@@ -1,28 +1,10 @@
 const { join } = require('path');
 const cds = require('../../../cds')
-const { exists, rimraf } = cds.utils
-const { readProject } = require('../../util/projectReader');
-const { mergeYAML } = require('../../util/merge')
-const { parseMd5File, writeMd5File, copyAndTrack } = require('../../util/md5')
+const { exists, rimraf, copy } = cds.utils
+const { readProject } = require('../../projectReader');
+const { merge } = require('../../merge')
 
-module.exports = class HelmTemplate extends require('../templateBase') {
-
-    constructor(oldTrackingData = undefined, newTrackingData = {}) {
-        super()
-        this.oldTrackingData = oldTrackingData;
-        this.newTrackingData = newTrackingData;
-    }
-
-    getRelatedFacets() {
-        return ['hana', 'xsuaa', 'enterprise-messaging', 'enterprise-messaging-shared', 'destination' , 'multitenancy', 'extensibility', 'approuter', 'connectivity']
-    }
-
-    static hasFacet() {
-        // REVISIT: this works, but could be semantically nicer with a 'shouldRunDependentMerging' or the like
-        const { add } = cds.cli.options
-        if (add.has('mta') && !add.has('helm')) return false
-        return exists(join('chart', 'values.yaml'))
-    }
+module.exports = class HelmTemplate extends require('../../plugin') {
 
     async canRun() {
         if (cds.cli.options.force) {
@@ -32,76 +14,93 @@ module.exports = class HelmTemplate extends require('../templateBase') {
         return true
     }
 
-    async addSubChart(subchart, force = false) {
-        const subchartPath = join('chart', 'charts', subchart);
-        const isInternal = !force && await this.isInternal();
-        if(!exists(subchartPath) && !isInternal) {
-            await copyAndTrack(
-                join(__dirname, 'subcharts', subchart),
-                subchartPath,
-                this
-            )
-
-            return true;
-        }
-
-        return false;
+    static hasInProduction() {
+        const { add } = cds.cli.options
+        return exists(join('chart', 'charts', 'web-application')) && exists(join('chart', 'values.yaml') || add.has('helm'))
     }
 
-    async isInternal() {
-        return !exists(join('chart', 'charts', 'web-application')) || cds.cli.options['internal-unified-runtime-charts'];
-    }
+    async run() {
+        const project = readProject()
+        await copy(join(__dirname, 'files', 'chart')).to('chart')
+        await merge(__dirname, 'files/Chart.yaml.hbs').into('chart/Chart.yaml', { with: project })
+        await merge(__dirname, 'files/values.yaml.hbs').into('chart/values.yaml', { with: project })
+        await this._mergeDependency('web-application', 'srv')
 
-    async addDependency(name, alias){
-        const project = await readProject();
-        const isInternal = await this.isInternal();
-        await mergeYAML(
-            join('chart', 'Chart.yaml'),
-            {
-                dependencies: [
-                    {
-                        name,
-                        alias,
-                        version: '>0.0.0',
-                        ...(isInternal) && { repository: 'https://int.repositories.cloud.sap/artifactory/virtual-unified-runtime-helm-dmz' }
-                    }
-                ]
-            },
-            project,
-            { additions: [{
-                in: `dependencies`,
-                where: [{
-                    property: 'alias',
-                    isEqualTo: alias
-                }]
-            }]}
-        )
+        await copy(join(__dirname, 'files', 'web-application')).to('chart/charts/web-application')
     }
 
-    async run() {
-        const project = await readProject()
-        const isInternal = cds.cli.options['internal-unified-runtime-charts'] !== undefined && cds.cli.options['internal-unified-runtime-charts'];
-        this.oldTrackingData = await parseMd5File(join('chart', '.cds-add-helm-files.md5'));
-        await this.addSubChart('web-application', !isInternal);
-        await copyAndTrack(
-            join(__dirname, 'chart'),
-            join('chart'),
-            this
-        )
+    async combine() {
+        const { hasDestination, hasEnterpriseMessaging, hasHana, hasMultitenancy, hasXsuaa, hasHtml5Repo, hasApprouter } = readProject()
+        let hasContentDeployment = false
 
-        await mergeYAML(
-            join('chart', 'Chart.yaml'),
-            join(__dirname, 'files', 'Chart.yaml.hbs'),
-            project
-        )
+        if (!exists('chart/charts/service-instance') && (hasHtml5Repo || hasMultitenancy || hasDestination || hasEnterpriseMessaging || hasXsuaa || hasHana)) {
+            await copy(join(__dirname, 'files', 'service-instance')).to('chart/charts/service-instance')
+        }
+        if (hasApprouter) {
+            await this._mergeDependency('web-application', 'approuter')
+        }
 
-        await this.addDependency('web-application', 'srv');
+        if (hasHtml5Repo) {
+            hasContentDeployment = true
+            await this._mergeDependency('service-instance', 'html5-apps-repo-host')
+            await this._mergeDependency('content-deployment', 'html5-apps-deployer')
 
-        await mergeYAML(
-            join('chart', 'values.yaml'),
-            join(__dirname, 'files', 'values.yaml.hbs'),
-            project
-        )
-        await writeMd5File(join('chart', '.cds-add-helm-files.md5'), this.newTrackingData);
+            if (hasApprouter) {
+                await this._mergeDependency('service-instance', 'html5-apps-repo-runtime')
+                await merge({
+                    'html5-apps-repo-runtime': {
+                        serviceOfferingName: 'html5-apps-repo',
+                        servicePlanName: 'app-runtime'
+                    },
+                    approuter: {
+                        bindings: {
+                            'html5-apps-repo-runtime': { serviceInstanceName: 'html5-apps-repo-runtime' }
+                        }
+                    },
+                }).into('chart/values.yaml')
+            }
+        }
+        if (hasMultitenancy) {
+            await this._mergeDependency('web-application', 'sidecar')
+            await this._mergeDependency('service-instance', 'saas-registry')
+        }
+        if (hasDestination) {
+            await this._mergeDependency('service-instance', 'destination')
+        }
+        if (hasEnterpriseMessaging) {
+            await this._mergeDependency('service-instance', 'event-mesh')
+        }
+        if (hasXsuaa) {
+            await this._mergeDependency('service-instance', 'xsuaa')
+        }
+        if (hasHana) {
+            if (hasMultitenancy) {
+                await this._mergeDependency('service-instance', 'service-manager')
+            } else {
+                hasContentDeployment = true
+                await this._mergeDependency('service-instance', 'hana')
+                await this._mergeDependency('content-deployment', 'hana-deployer')
+            }
+        }
+        if(!exists('chart/charts/content-deployment') && hasContentDeployment) {
+            await copy(join(__dirname, 'files', 'content-deployment')).to('chart/charts/content-deployment')
+        }
+    }
+
+    async _mergeDependency(name, alias) {
+        const project = readProject()
+        await merge({
+            dependencies: [{
+                name,
+                alias,
+                version: '>0.0.0'
+            }]
+        }).into('chart/Chart.yaml', {
+            project,
+            additions: [{
+                in: 'dependencies',
+                where: { alias }
+            }]
+        })
     }
 }

package/lib/init/template/helm-unified-runtime/files/Chart.yaml.hbs

@@ -0,0 +1,10 @@
+---
+#
+# This file is generated by "cds add helm"
+apiVersion: v2
+name: {{appName}}
+description: {{appDescription}}
+type: application
+version: {{appVersion}}
+appVersion: {{appVersion}}
+

package/lib/init/template/helm-unified-runtime/files/values.yaml.hbs

@@ -0,0 +1,26 @@
+---
+global:
+  domain: null
+  imagePullSecret: {}
+srv:
+  bindings: {}
+  image:
+    repository: <your-container-registry>/{{appName}}-srv
+    tag: latest
+  {{#isJava}}
+  env:
+    SPRING_PROFILES_ACTIVE: cloud
+  {{/isJava}}
+  resources:
+    limits:
+      ephemeral-storage: 1G
+      memory: {{#isJava}}1G{{/isJava}}{{^isJava}}500M{{/isJava}}
+    requests:
+      ephemeral-storage: 1G
+      cpu: {{#isJava}}1000m{{/isJava}}{{^isJava}}500m{{/isJava}}
+      memory: {{#isJava}}1G{{/isJava}}{{^isJava}}500M{{/isJava}}
+  health:
+    liveness:
+      path: /
+    readiness:
+      path: /