@sap/cds-dk 4.9.6 → 6.0.2

package/lib/k8s/deployment/subchart/values.schema.json

@@ -0,0 +1,449 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://github.tools.sap/cki/web-application/blob/main/values.schema.json",
+    "type": "object",
+    "required": [
+        "image",
+        "resources"
+    ],
+    "additionalProperties": false,
+    "properties": {
+        "global": {
+            "$id": "#/properties/global",
+            "type": "object",
+            "x-ignore-untested": true,
+            "additionalProperties": true,
+            "properties": {
+                "imagePullSecret": {
+                    "$id": "#/properties/global/imagePullSecret",
+                    "additionalProperties": true,
+                    "type": "object",
+                    "properties": {
+                        "name": {
+                            "$ref": "#/definitions/KubernetesName"
+                        },
+                        "dockerconfigjson": {
+                            "type": "string"
+                        }
+                    },
+                    "dependencies": {
+                        "name": {
+                            "not": {
+                                "required": [
+                                    "dockerconfigjson"
+                                ]
+                            }
+                        },
+                        "dockerconfigjson": {
+                            "not": {
+                                "required": [
+                                    "name"
+                                ]
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "nameOverride": {
+            "$id": "#/properties/nameOverride",
+            "type": "string",
+            "pattern": "[0-9a-z][0-9a-z-.]*"
+        },
+        "fullnameOverride": {
+            "$id": "#/properties/fullnameOverride",
+            "type": "string",
+            "pattern": "[0-9a-z][0-9a-z-.]*"
+        },
+        "replicaCount": {
+            "$id": "#/properties/replicaCount",
+            "type": "integer",
+            "minimum": 1,
+            "default": 1
+        },
+        "port": {
+            "$id": "#/properties/port",
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 65535,
+            "default": 8080
+        },
+        "serviceAccountName": {
+            "$id": "#/properties/serviceAccountName",
+            "default": "default",
+            "allOf": [
+                {
+                    "$ref": "#/definitions/KubernetesName"
+                }
+            ]
+        },
+        "image": {
+            "$id": "#/properties/image",
+            "type": "object",
+            "required": [
+                "repository"
+            ],
+            "additionalProperties": false,
+            "properties": {
+                "repository": {
+                    "$id": "#/properties/image/properties/repository",
+                    "type": "string",
+                    "pattern": "^[\\w-./:]*[@sha256]*$"
+                },
+                "tag": {
+                    "$id": "#/properties/image/properties/tag",
+                    "type": "string",
+                    "$comment": "Copied from https://github.com/containers/image/blob/18d58d29fdc4fc32fb8a8a6d186b829b217f1bf5/docker/reference/regexp.go#L68-L70",
+                    "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,}))?$",
+                    "default": "latest"
+                }
+            }
+        },
+        "imagePullSecret": {
+            "$id": "#/properties/imagePullSecret",
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+                "name": {
+                    "$ref": "#/definitions/KubernetesName"
+                },
+                "dockerconfigjson": {
+                    "type": "string"
+                }
+            },
+            "dependencies": {
+                "name": {
+                    "not": {
+                        "required": [
+                            "dockerconfigjson"
+                        ]
+                    }
+                },
+                "dockerconfigjson": {
+                    "not": {
+                        "required": [
+                            "name"
+                        ]
+                    }
+                }
+            }
+        },
+        "additionalVolumes": {
+            "$id": "#/properties/additionalVolumes",
+            "type": "array",
+            "additionalItems": false,
+            "default": [],
+            "items": {
+                "type": "object",
+                "additionalProperties": true,
+                "required": [
+                    "name",
+                    "volumeMount"
+                ],
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "$ref": "#/definitions/KubernetesName"
+                    },
+                    "volumeMount": {
+                        "type": "object",
+                        "required": [
+                            "mountPath"
+                        ],
+                        "additionalProperties": false,
+                        "properties": {
+                            "mountPath": {
+                                "type": "string",
+                                "pattern": "^[^:]*$"
+                            },
+                            "mountPropagation": {
+                                "type": "string"
+                            },
+                            "readOnly": {
+                                "type": "boolean"
+                            },
+                            "subPath": {
+                                "type": "string"
+                            },
+                            "subPathExpr": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "ha": {
+            "$id": "#/properties/ha",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "enabled": {
+                    "$id": "#/properties/ha/properties/enabled",
+                    "type": "boolean",
+                    "default": true
+                }
+            }
+        },
+        "resources": {
+            "$id": "#/properties/resources",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "requests",
+                "limits"
+            ],
+            "properties": {
+                "requests": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "cpu",
+                        "memory"
+                    ],
+                    "properties": {
+                        "cpu": {
+                            "$id": "#/properties/resources/properties/requests/properties/cpu",
+                            "oneOf": [
+                                {
+                                    "type": "number"
+                                },
+                                {
+                                    "type": "string"
+                                }
+                            ]
+                        },
+                        "ephemeral-storage": {
+                            "$id": "#/properties/resources/properties/requests/properties/ephemeral-storage",
+                            "type": "string"
+                        },
+                        "memory": {
+                            "$id": "#/properties/resources/properties/requests/properties/memory",
+                            "type": "string"
+                        }
+                    }
+                },
+                "limits": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                        "memory"
+                    ],
+                    "properties": {
+                        "cpu": {
+                            "$id": "#/properties/resources/properties/limits/properties/cpu",
+                            "oneOf": [
+                                {
+                                    "type": "number"
+                                },
+                                {
+                                    "type": "string"
+                                }
+                            ]
+                        },
+                        "ephemeral-storage": {
+                            "$id": "#/properties/resources/properties/limits/properties/ephemeral-storage",
+                            "type": "string"
+                        },
+                        "memory": {
+                            "$id": "#/properties/resources/properties/limits/properties/memory",
+                            "type": "string"
+                        }
+                    }
+                }
+            }
+        },
+        "health_check": {
+            "$id": "#/properties/health_check",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "liveness": {
+                    "$id": "#/properties/health_check/properties/liveness",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "path": {
+                            "type": "string",
+                            "default": "/healthz"
+                        }
+                    }
+                },
+                "readiness": {
+                    "$id": "#/properties/health_check/properties/readiness",
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "path": {
+                            "type": "string",
+                            "default": "/healthz"
+                        }
+                    }
+                }
+            }
+        },
+        "startupTimeout": {
+            "$id": "#/properties/startupTimeout",
+            "type": "integer",
+            "minimum": 1,
+            "default": 30
+        },
+        "env": {
+            "$id": "#/properties/env",
+            "type": "object",
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "$comment": "regex above copied from https://github.com/kubernetes/kubernetes/blob/ea0764452222146c47ec826977f49d7001b0ea8c/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L402",
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "integer"
+                        }
+                    ]
+                }
+            },
+            "additionalProperties": false,
+            "default": {}
+        },
+        "envSecretNames": {
+            "$id": "#/properties/envSecretNames",
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+                "$ref": "#/definitions/KubernetesName"
+            },
+            "default": []
+        },
+        "expose": {
+            "$id": "#/properties/expose",
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "host": {
+                    "$id": "#/properties/expose/properties/host",
+                    "type": "string"
+                },
+                "enabled": {
+                    "$id": "#/properties/expose/properties/enabled",
+                    "type": "boolean",
+                    "default": true
+                }
+            }
+        },
+        "bindings": {
+            "$id": "#/properties/bindings",
+            "type": "object",
+            "additionalProperties": false,
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "anyOf": [
+                        {
+                            "type": "object",
+                            "additionalProperties": false,
+                            "required": [
+                                "fromSecret"
+                            ],
+                            "properties": {
+                                "fromSecret": {
+                                    "$ref": "#/definitions/KubernetesName"
+                                }
+                            }
+                        },
+                        {
+                            "type": "object",
+                            "additionalProperties": false,
+                            "properties": {
+                                "serviceInstanceName": {
+                                    "$ref": "#/definitions/KubernetesName"
+                                },
+                                "serviceInstanceFullname": {
+                                    "$ref": "#/definitions/KubernetesName"
+                                },
+                                "externalName": {
+                                    "type": "string"
+                                },
+                                "secretName": {
+                                    "$ref": "#/definitions/KubernetesName"
+                                },
+                                "parameters": {
+                                    "type": "object"
+                                },
+                                "parametersFrom": {
+                                    "type": "array",
+                                    "items": {
+                                        "anyOf": [
+                                            {
+                                                "type": "object",
+                                                "additionalProperties": false,
+                                                "properties": {
+                                                    "secretKeyRef": {
+                                                        "type": "object",
+                                                        "additionalProperties": false,
+                                                        "properties": {
+                                                            "name": {
+                                                                "$ref": "#/definitions/KubernetesName"
+                                                            },
+                                                            "key": {
+                                                                "type": "string"
+                                                            }
+                                                        }
+                                                    }
+                                                }
+                                            },
+                                            {
+                                                "type": "object",
+                                                "additionalProperties": false,
+                                                "properties": {
+                                                    "configMapKeyRef": {
+                                                        "type": "object",
+                                                        "additionalProperties": false,
+                                                        "properties": {
+                                                            "name": {
+                                                                "$ref": "#/definitions/KubernetesName"
+                                                            },
+                                                            "key": {
+                                                                "type": "string"
+                                                            }
+                                                        }
+                                                    }
+                                                }
+                                            }
+                                        ]
+                                    }
+                                },
+                                "credentialsRotationPolicy": {
+                                    "type": "object"
+                                }
+                            },
+                            "dependencies": {
+                                "serviceInstanceName": {
+                                    "not": {
+                                        "required": [
+                                            "serviceInstanceFullname"
+                                        ]
+                                    }
+                                },
+                                "serviceInstanceFullname": {
+                                    "not": {
+                                        "required": [
+                                            "serviceInstanceName"
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+    },
+    "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])?)*$"
+        }
+    }
+}

package/lib/k8s/deployment/subchart/values.yaml

@@ -0,0 +1,76 @@
+global:
+  imagePullSecret: {}
+    # name: ""
+    # dockerconfigjson: ""
+
+replicaCount: 1
+port: 8080
+serviceAccountName: default
+
+  # To use a digest, change those values like that
+  # repository: nginx@sha256
+  # tag: 2834dc507516af02784808c5f48b7cbe38b8ed5d0f4837f16e78d00deb7e7767
+image:
+  # repository: gcr.io/repo/image
+  tag: latest
+
+imagePullSecret: {}
+  # name: ""
+  # dockerconfigjson: ""
+
+additionalVolumes: []
+# - name: my-volume
+#   secret:
+#     secretName: my-secret
+#   volumeMount:
+#     mountPath: /etc/mysecret
+#     readOnly: true
+
+ha:
+  enabled: true
+
+# resources:
+#   limits:
+#     cpu: 100m
+#     ephemeral-storage: 1G
+#     memory: 1G
+#   requests:
+#     cpu: 100m
+#     ephemeral-storage: 1G
+#     memory: 1G
+
+health_check:
+  liveness:
+    path: /healthz
+  readiness:
+    path: /healthz
+
+startupTimeout: 30
+
+envSecretNames: []
+
+env: {}
+# env:
+#   key: value
+
+expose:
+  enabled: true
+  # host: ""
+
+# bindings:
+#   ui5-repo-servicerepo:
+#     serviceInstanceName: ui5-repo-instance
+#     externalName: ui5-kyma-binding
+#     secretName: ui5-repo-binding-secret
+#     parameters:
+#       foo: bar
+#     parametersFrom:
+#       - secretKeyRef:
+#           key: test
+#           name: test
+#     credentialsRotationPolicy:
+#       enabled: true
+#   hana:
+#     serviceInstanceName: hana-manual
+#   portal:
+#     fromSecret: manual-secret # user-provided-service

package/lib/k8s/deployment/subchart-override/templates/_web_application_helpers.tpl

@@ -0,0 +1,81 @@
+{{/*
+Old Service Bindings: volumes
+*/}}
+{{- define "cap.web-application.serviceVolumes" -}}
+    {{- $ := . -}}
+    {{ range $bindingName, $binding := $.Values.bindings -}}
+        {{- $secret := default (print $.Release.Name "-" $.Chart.Name "-" $bindingName) $binding.fromSecret }}
+- name: {{ $bindingName }}-secret
+  secret:
+    secretName: {{ $secret | quote }}
+      {{- if $.Values.global.oldServiceBindings }}
+- name: {{ $bindingName }}-metadata
+  secret:
+    secretName: {{ $secret | quote }}
+    optional: true
+    items:
+    - key: label
+      path: label
+    - key: plan
+      path: plan
+    - key: tags
+      path: tags
+      {{- end }}
+    {{- end -}}
+{{- end -}}
+
+{{/*
+Service Bindings: env vars
+*/}}
+{{- define "cap.web-application.env" }}
+  {{- $ := . }}
+    {{- range $key, $binding := $.Values.bindings }}
+        {{- $cleanKey := $key | upper | replace "-" "" | replace "_" "" | replace "." "" }}
+        {{- $prefix := print "CDS_ENVIRONMENT_K8S_SERVICEBINDINGS_" $cleanKey }}
+        {{- $secret := default (print $.Release.Name "-" $.Chart.Name "-" $key) $binding.fromSecret }}
+- name: {{ $prefix }}_SERVICE
+  valueFrom:
+    secretKeyRef:
+      name: {{ $secret | quote }}
+      key: label
+- name: {{ $prefix }}_PLAN
+  valueFrom:
+    secretKeyRef:
+      name: {{ $secret | quote }}
+      key: plan
+      optional: true
+  {{- if $.Values.global.oldServiceBindings }}
+- name: CDS_CONFIG
+  value: /etc/secrets/cds
+- name: {{ $prefix }}_SECRETSPATH
+  value: /etc/secrets/cds/requires/{{ $key }}/credentials
+        {{- else }}
+- name: {{ $prefix }}_SECRETSPATH
+  value: /bindings/{{ $key }}
+        {{- end }}
+  {{- end }}
+{{- end }}
+
+
+{{/*
+Old Service Bindings: volume mounts
+*/}}
+{{- define "cap.web-application.serviceMounts" }}
+    {{- $ := . -}}
+    {{- range $key, $binding := $.Values.bindings }}
+      {{- if not $.Values.global.oldServiceBindings }}
+- name: {{ $key }}-secret
+  mountPath: /bindings/{{ $key }}
+  readOnly: true
+      {{- else }}
+- name: {{ $key }}-secret
+  mountPath: /etc/secrets/cds/requires/{{ $key }}/credentials
+  readOnly: true
+- name: {{ $key }}-metadata
+  mountPath: /etc/secrets/cds/requires/{{ $key }}/vcap
+  readOnly: true
+      {{- end }}
+    {{- end }}
+{{- end }}
+
+

package/lib/k8s/destinations/index.js

@@ -0,0 +1,40 @@
+const wrapFeature = require('../wrapFeature');
+const { checkNeedDestinations } = require('./lib');
+
+module.exports = wrapFeature('destinations', {
+
+    async checkNeedDestinations(context) {
+        const env = await context.get('env');
+        return checkNeedDestinations(env);
+    },
+
+    async isRequired(context) {
+        return await this.checkNeedDestinations(context) || await context.collect('getDestinationsParameters');
+    },
+
+    async getServiceBindings(context) {
+        return await this.checkNeedDestinations(context) && {destinations: { serviceInstanceName: 'destinations' } };
+    },
+
+    async getChartCapabilities(context) {
+        return {
+            destinations: {
+                serviceOfferingName: 'destination',
+                servicePlanName: 'lite',
+                parameters: {
+                    version: "1.0.0",
+                    ...await context.collect('getDestinationsParameters')
+                }
+            }
+        }
+    },
+
+    async addToChart(builder, { destinations }) {
+        await builder.addAllTemplates(__dirname);
+
+        const { config } = destinations;
+        if (config) {
+            await builder.addChartFile(config);
+        }
+    }
+});

package/lib/k8s/destinations/lib.js

@@ -0,0 +1,16 @@
+function checkNeedDestinations(env) {
+  const kinds = [ 'odata', 'odata-v2', 'odata-v4', 'rest' ].reduce( (map, key) => {
+      map[key] = true;
+      return map;
+  }, {});
+  for (const service in env.requires) {
+      const require = env.requires[service];
+      if (!kinds[service] && kinds[require.kind]) return true;
+  }
+
+  return false;
+}
+
+module.exports = {
+  checkNeedDestinations
+};

package/lib/k8s/destinations/templates/destinations.yaml

@@ -0,0 +1 @@
+{{- include "cap.service-instance" . }}

package/lib/k8s/docker/push.js

@@ -0,0 +1,8 @@
+const { exec } = require('../../util/exec');
+
+async function push(imageName, fullImageName) {
+    await exec `docker tag ${imageName} ${fullImageName}`;
+    await exec `docker push ${fullImageName}`;
+}
+
+module.exports = push;