@sap/cds-dk 6.4.1 → 6.5.1

package/lib/init/template/helm/subcharts/content-deployment/values.schema.json

@@ -0,0 +1,589 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://github.tools.sap/cki/content-deployment/blob/main/values.schema.json",
+    "type": "object",
+    "required": [
+        "image", "bindings"
+    ],
+    "additionalProperties": false,
+    "properties": {
+        "global": {
+            "$id": "#/properties/global",
+            "type": "object",
+            "title": "Helm global values",
+            "description": "For more information, see https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#global-chart-values",
+            "x-ignore-untested": true,
+            "additionalProperties": true,
+            "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": true,
+                    "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"
+                        },
+                        "dockerconfigjson": {
+                            "title": "Secret content",
+                            "description": "The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret. Can't be used with the `name` option.",
+                            "type": "string"
+                        }
+                    },
+                    "dependencies": {
+                        "name": {
+                            "not": {
+                                "required": [
+                                    "dockerconfigjson"
+                                ]
+                            }
+                        },
+                        "dockerconfigjson": {
+                            "not": {
+                                "required": [
+                                    "name"
+                                ]
+                            }
+                        }
+                    }
+                },
+                "image": {
+                    "$id": "#/properties/global/image",
+                    "title": "Image configuration",
+                    "description": "Either name or repository is required.",
+                    "type": "object",
+                    "required": [],
+                    "additionalProperties": true,
+                    "properties": {
+                        "tag": {
+                            "$id": "#/properties/image/global/properties/tag",
+                            "$ref": "#/definitions/ImageTag"
+                        },
+                        "registry": {
+                            "$id": "#/properties/image/global/properties/registry",
+                            "$ref": "#/definitions/ImageRegistry"
+                        }
+                    }
+                }
+            }
+        },
+        "nameOverride": {
+            "$id": "#/properties/nameOverride",
+            "title": "Chart name override",
+            "description": "Will be used instead of the `.Chart.Name`, e.g. when generating the Deployment name.",
+            "type": "string",
+            "pattern": "[0-9a-z][0-9a-z-.]*"
+        },
+        "fullnameOverride": {
+            "$id": "#/properties/fullnameOverride",
+            "title": "Override for the `.fullname` helper function.",
+            "description": "Will be used as an override for the `.fullname` helper function (i.e. `.Release.Name-.Chart.Name`).",
+            "type": "string",
+            "pattern": "[0-9a-z][0-9a-z-.]*"
+        },
+        "image": {
+            "$id": "#/properties/image",
+            "title": "Image configuration",
+            "type": "object",
+            "required": [
+                "repository"
+            ],
+            "additionalProperties": false,
+            "properties": {
+                "repository": {
+                    "$id": "#/properties/image/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": {
+                    "$id": "#/properties/image/properties/tag",
+                    "$ref": "#/definitions/ImageTag"
+                },
+                "registry": {
+                    "$id": "#/properties/image/properties/registry",
+                    "$ref": "#/definitions/ImageRegistry"
+                }
+            }
+        },
+        "imagePullSecret": {
+            "$id": "#/properties/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"
+                },
+                "dockerconfigjson": {
+                    "title": "Secret content",
+                    "description": "The content for the dynamically generated Kubernetes Secret, which will be used as an image pull secret. Can't be used with the `name` option.",
+                    "type": "string"
+                }
+            },
+            "dependencies": {
+                "name": {
+                    "not": {
+                        "required": [
+                            "dockerconfigjson"
+                        ]
+                    }
+                },
+                "dockerconfigjson": {
+                    "not": {
+                        "required": [
+                            "name"
+                        ]
+                    }
+                }
+            }
+        },
+        "resources": {
+            "$id": "#/properties/resources",
+            "type": "object",
+            "title": "Pod resources configuration",
+            "additionalProperties": false,
+            "properties": {
+                "requests": {
+                    "type": "object",
+                    "description": "Minimal required resources for the application to operate, that will be reserved for each replica.",
+                    "additionalProperties": false,
+                    "properties": {
+                        "cpu": {
+                            "$id": "#/properties/resources/properties/requests/properties/cpu",
+                            "description": "CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu",
+                            "type": ["number", "string"]
+                        },
+                        "ephemeral-storage": {
+                            "$id": "#/properties/resources/properties/requests/properties/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": {
+                            "$id": "#/properties/resources/properties/requests/properties/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",
+                    "additionalProperties": false,
+                    "properties": {
+                        "cpu": {
+                            "$id": "#/properties/resources/properties/limits/properties/cpu",
+                            "description": "CPU resource units, as described here https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu",
+                            "type": ["number", "string"]
+                        },
+                        "ephemeral-storage": {
+                            "$id": "#/properties/resources/properties/limits/properties/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": {
+                            "$id": "#/properties/resources/properties/limits/properties/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"
+                        }
+                    }
+                }
+            }
+        },
+        "env": {
+            "$id": "#/properties/env",
+            "description": "Key-value map of environment variables, which should be added to the Pod spec.",
+            "anyOf": [
+                {
+
+                    "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": [
+                                {
+                                    "description": "Plain value of an environment variable.",
+                                    "type": ["integer", "string"]
+                                },
+                                {
+                                    "description": "`valueFrom` configuration for the environment variable https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/",
+                                    "type": "object",
+                                    "additionalProperties": false,
+                                    "maxProperties": 1,
+                                    "properties": {
+                                        "configMapKeyRef": {
+                                            "description": "Selects a key of a ConfigMap.",
+                                            "type": "object",
+                                            "additionalProperties": false,
+                                            "properties": {
+                                                "name": {
+                                                    "description": "Name of a ConfigMap.",
+                                                    "$ref": "#/definitions/KubernetesName"
+                                                },
+                                                "key": {
+                                                    "description": "Key in that ConfigMap, which value will be used.",
+                                                    "type": "string"
+                                                }
+                                            }
+                                        },
+                                        "secretKeyRef": {
+                                            "description": "Selects a key of a Secret.",
+                                            "type": "object",
+                                            "additionalProperties": false,
+                                            "properties": {
+                                                "name": {
+                                                    "description": "Name of a Secret.",
+                                                    "$ref": "#/definitions/KubernetesName"
+                                                },
+                                                "key": {
+                                                    "description": "Key in that Secret, which value will be used.",
+                                                    "type": "string"
+                                                }
+                                            }
+                                        },
+                                        "resourceFieldRef": {
+                                            "description": "Selects a resource of the container.",
+                                            "type": "object",
+                                            "additionalProperties": false,
+                                            "properties": {
+                                                "containerName": {
+                                                    "description": "Name of a Container.",
+                                                    "$ref": "#/definitions/KubernetesName"
+                                                },
+                                                "resource": {
+                                                    "description": "Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.",
+                                                    "type": "string"
+                                                }
+                                            }
+                                        },
+                                        "fieldRef": {
+                                            "description": "Selects a field of the pod.",
+                                            "type": "object",
+                                            "additionalProperties": false,
+                                            "properties": {
+                                                "fieldPath": {
+                                                    "type": "string",
+                                                    "description": "Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    "additionalProperties": false,
+                    "default": {}
+                },
+                {
+                    "type": "array",
+                    "uniqueItems": true,
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "maxProperties": 2,
+                        "required": [
+                            "name"
+                        ],
+                        "properties": {
+                            "name": {
+                                "type": "string",
+                                "pattern": "^[-._a-zA-Z][-._a-zA-Z0-9]*$"
+                            },
+                            "value": {
+                                "type": ["string", "integer"]
+                            },
+                            "configMapKeyRef": {
+                                "description": "Selects a key of a ConfigMap.",
+                                "type": "object",
+                                "additionalProperties": false,
+                                "properties": {
+                                    "name": {
+                                        "description": "Name of a ConfigMap.",
+                                        "$ref": "#/definitions/KubernetesName"
+                                    },
+                                    "key": {
+                                        "description": "Key in that ConfigMap, which value will be used.",
+                                        "type": "string"
+                                    }
+                                }
+                            },
+                            "secretKeyRef": {
+                                "description": "Selects a key of a Secret.",
+                                "type": "object",
+                                "additionalProperties": false,
+                                "properties": {
+                                    "name": {
+                                        "description": "Name of a Secret.",
+                                        "$ref": "#/definitions/KubernetesName"
+                                    },
+                                    "key": {
+                                        "description": "Key in that Secret, which value will be used.",
+                                        "type": "string"
+                                    }
+                                }
+                            },
+                            "resourceFieldRef": {
+                                "description": "Selects a resource of the container.",
+                                "type": "object",
+                                "additionalProperties": false,
+                                "properties": {
+                                    "containerName": {
+                                        "description": "Name of a Container.",
+                                        "$ref": "#/definitions/KubernetesName"
+                                    },
+                                    "resource": {
+                                        "description": "Only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.",
+                                        "type": "string"
+                                    }
+                                }
+                            },
+                            "fieldRef": {
+                                "description": "Selects a field of the pod.",
+                                "type": "object",
+                                "additionalProperties": false,
+                                "properties": {
+                                    "fieldPath": {
+                                        "type": "string",
+                                        "description": "Supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            ],
+            "default": {}
+        },
+        "envSecretNames": {
+            "$id": "#/properties/envSecretNames",
+            "description": "[Deprecated] Use `envFrom` instead",
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+                "type": "string",
+                "$ref": "#/definitions/KubernetesName"
+            }
+        },
+        "envFrom": {
+            "$id": "#/properties/envFrom",
+            "description": "List of sources to populate environment variables in the pod.",
+            "type": "array",
+            "default": [],
+            "items": {
+                "type": "object",
+                "oneOf": [
+                    {
+                        "additionalProperties": false,
+                        "properties": {
+                            "configMapRef": {
+                                "description": "The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
+                                "properties": {
+                                    "name": {
+                                        "description": "Name of a ConfigMap.",
+                                        "type": "string"
+                                    },
+                                    "tpl": {
+                                        "description": "Flag which tells whether the name is a template string or not.",
+                                        "type": "boolean",
+                                        "default": false
+                                    }
+                                },
+                                "required": [ "name" ],
+                                "additionalProperties": false,
+                                "type": "object"
+                            }
+                        },
+                        "required": [ "configMapRef" ]
+                    },
+                    {
+                        "additionalProperties": false,
+                        "properties": {
+                            "secretRef": {
+                                "description": "The contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
+                                "properties": {
+                                    "name": {
+                                        "description": "Name of a Secret.",
+                                        "type": "string"
+                                    },
+                                    "tpl": {
+                                        "description": "Flag which tells whether the name is a template string or not.",
+                                        "type": "boolean",
+                                        "default": false
+                                    }
+                                },
+                                "required": [ "name" ],
+                                "additionalProperties": false,
+                                "type": "object"
+                            }
+                        },
+                        "required": [ "secretRef" ]
+                    }
+                ]
+            }
+        },
+        "ttlDaysAfterFinished": {
+            "$id": "#/properties/ttlDaysAfterFinished",
+            "title": "Time to keep the Job after it has finished.",
+            "description": "Number of days to keep the Kubernetes Job once it is finished. 0 means it is removed as soon as it is finished.",
+            "type": "integer",
+            "minimum": 0,
+            "default": 14
+        },
+        "bindings": {
+            "$id": "#/properties/bindings",
+            "title": "Service Binding configuration",
+            "type": "object",
+            "additionalProperties": false,
+            "minProperties": 1,
+            "patternProperties": {
+                "^[-._a-zA-Z][-._a-zA-Z0-9]*$": {
+                    "oneOf": [
+                        {
+                            "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"
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+    },
+    "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])?)*$"
+        },
+        "ImageRegistry": {
+            "type": "string",
+            "title": "Image registry",
+            "description": "Image registry e.g. docker.io",
+            "pattern": "^[\\w-./]+$"
+        },
+        "ImageTag": {
+            "title": "Image tag",
+            "description": "Image tag without the name (everything after the `:` sign, potentially including the `@sha256` section at the end).",
+            "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,}))?$"        }
+    }
+}

package/lib/init/template/helm/subcharts/content-deployment/values.yaml

@@ -0,0 +1,54 @@
+global:
+  imagePullSecret: {}
+    # name: ""
+    # dockerconfigjson: ""
+  image: {}
+    # registry: gcr.io/my-project
+    # tag: latest
+
+image: {}
+  # repository: repo/image
+  # registry: gcr.io/my-project
+  # tag: latest
+
+imagePullSecret: {}
+  # name: ""
+  # dockerconfigjson: ""
+
+# resources:
+#   limits:
+#     cpu: 100m
+#     ephemeral-storage: 1G
+#     memory: 1G
+#   requests:
+#     cpu: 100m
+#     ephemeral-storage: 1G
+#     memory: 1G
+
+env: {}
+
+envFrom: []
+# - configMapRef:
+#     name: my-configmap1
+# - secretRef:
+#     name: my-secret-ref1
+
+# 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
+
+ttlDaysAfterFinished: 14