Files
nplus/charts/application/values.schema.json

726 lines
29 KiB
JSON
Raw Permalink Normal View History

2025-01-24 16:18:47 +01:00
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"docAreas": {
"default": "",
"description": "Provide a list of docareas to create. Please also see the example files",
"title": "docAreas"
},
"download": {
"default": "",
"description": "A list of URLs (Links) to Assets to download before anything else if the download is a .tar.gz, it is automatically untared to /pool/downloads",
"title": "download"
},
"env": {
"default": "",
"description": "Sets additional environment variables for the configuration.",
"title": "env"
},
"envMap": {
"default": "",
"description": "Sets the name of a configMap, which holds additional environment variables for the configuration. It is added as envFrom configMap to the container.",
"title": "envMap"
},
"envSecret": {
"default": "",
"description": "Sets the name of a secret, which holds additional environment variables for the configuration. It is added as envFrom secretRef to the container.",
"title": "envSecret"
},
"fullnameOverride": {
"default": "",
"description": "This overrides the output of the internal fullname function",
"title": "fullnameOverride"
},
"global": {
"description": "Global values are values that can be accessed from any chart or subchart by exactly the same name.",
"title": "global",
"type": "object"
},
"globals": {
"description": "nplus Global Functions Library Chart",
"properties": {
"global": {
"description": "Global values are values that can be accessed from any chart or subchart by exactly the same name.",
"title": "global",
"type": "object"
}
},
"title": "nplus-globals",
"type": "object"
},
"image": {
"additionalProperties": false,
"description": "provide the image to be used for this component",
"properties": {
"name": {
"default": "application-layer",
"description": "the name of the image to use",
"title": "name"
},
"pullSecrets": {
"description": "you can provide your own pullSecrets, in case you use a private repo.",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"title": "pullSecrets"
},
"repo": {
"default": "ceyoniq.azurecr.io/release/nscale",
"description": "if you use a private repo, feel free to set it here",
"title": "repo"
},
"tag": {
"default": "ubi.9.3.1300.2024121814",
"description": "the tag of the image to use",
"title": "tag"
}
},
"title": "image"
},
"meta": {
"additionalProperties": false,
"properties": {
"componentVersion": {
"default": "",
"description": "This is the version of the component, used for display @internal -- set by devOps pipeline, so do not modify",
"title": "componentVersion"
},
"language": {
"default": "",
"description": "Sets the language of the main service (in the *service* container). This is used for instance if you turn OpenTelemetry on, to know which Agent to inject into the container.",
"title": "language"
},
"ports": {
"additionalProperties": false,
"description": "lists the ports this component exposes. This is important for zero trust mode and others.",
"properties": {
"http": {
"default": "",
"description": "The http port this component uses (if any). In zero trust mode, this will be disabled. @internal -- this is a constant value of the component and should not be changed.",
"title": "http"
},
"https": {
"default": "",
"description": "The tls / https port, this component uses (if any) @internal -- this is a constant value of the component and should not be changed.",
"title": "https"
},
"rmi": {
"default": "",
"description": "A potential rmi port, this component uses (if any) @internal -- this is a constant value of the component and should not be changed.",
"title": "rmi"
},
"tcp": {
"default": "",
"description": "A potential tcp port, this component uses (if any) @internal -- this is a constant value of the component and should not be changed.",
"title": "tcp"
},
"tcps": {
"default": "",
"description": "A potential tls / tcps port, this component uses (if any) @internal -- this is a constant value of the component and should not be changed.",
"title": "tcps"
}
},
"title": "ports"
},
"provider": {
"default": "",
"description": "sets provider (partner, reseller) information to be able to invoice per use in a cloud environment",
"title": "provider"
},
"serviceContainer": {
"default": "",
"description": "The container name of the main service for this component. This is used to define where to inject the telemetry agents, if any",
"title": "serviceContainer"
},
"stage": {
"default": "",
"description": "A optional parameter to indicate the stage (DEV, QA, PROD, ...) this component, instance or environment runs in. This can be used in template functions to add the stage to for instance the service name of telemetry services like open telemetry. (see telemetry example)",
"title": "stage"
},
"tenant": {
"default": "",
"description": "sets tenant information to be able to invoice per use in a cloud environment",
"title": "tenant"
},
"type": {
"default": "application",
"description": "the type of the component. You should not change this value, except if you use a pipeliner in core mode. In core mode, it should be *core*, else *pipeliner* This type is used to create cluster communication for nappl and nstl and potentially group multiple replicaSets into one service.",
"title": "type"
},
"wave": {
"default": "",
"description": "Sets the wave in which this component should be deployed within an ArgoCD deployment if unset, it uses the default wave thus all components are installed in one wave, then relying on correct wait settings just like in a helm installation",
"title": "wave"
}
},
"title": "meta",
"type": "object"
},
"minReplicaCountType": {
"default": "",
"description": "if you set minReplicaCountType, a podDesruptionBudget will be created with this value as minAvailable, using the component type as selector. This is useful for components, that are spread across multiple replicaSets, like sharepoint or storage layer",
"title": "minReplicaCountType"
},
"mounts": {
"additionalProperties": false,
"properties": {
"caCerts": {
"additionalProperties": false,
"description": "You can add a file with trusted Root Certificates (e.g. Azure), to be able to connect to alien services via https. If you have a self-signed root certificate, you can also add it here.",
"properties": {
"configMap": {
"default": "",
"description": "Alternative 2: the name of the configMap to use. The Key has to be the File Name used in the path setting",
"title": "configMap"
},
"paths": {
"default": "",
"description": "Sets the path to the certs folder. @internal -- do not change this value",
"title": "paths"
},
"secret": {
"default": "",
"description": "Alternative 1: the name of the secret to use. The Key has to be the File Name used in the path setting",
"title": "secret"
}
},
"title": "caCerts"
},
"componentCerts": {
"additionalProperties": false,
"description": "the java based nscale components have their own certificates, that you might want to upload. You can normally do so via the environment configuration, but should you want to use a secret, you can set it here",
"properties": {
"configMap": {
"default": "",
"description": "Alternative 2: the name of the configMap to use. The Key has to be the File Name used in the path setting",
"title": "configMap"
},
"paths": {
"default": "",
"description": "Sets the path to the component certs. @internal -- do not change this value",
"title": "paths"
},
"secret": {
"default": "",
"description": "Alternative 1: the name of the secret to use. The Key has to be the File Name used in the path setting",
"title": "secret"
}
},
"title": "componentCerts"
},
"conf": {
"additionalProperties": false,
"description": "The conf volume is a RWX volume mounted by the environment, that holds all configurations of all instances and components in this environment",
"properties": {
"path": {
"default": "/application",
"description": "Sets the path to the conf files @internal -- do not change this value",
"title": "path"
},
"paths": {
"default": "",
"description": "Sets a list of paths to the conf files @internal -- do not change this value",
"title": "paths"
}
},
"title": "conf"
},
"data": {
"additionalProperties": false,
"properties": {
"class": {
"default": "",
"description": "Sets the class of the data disk",
"title": "class"
},
"path": {
"default": "",
"description": "Sets the path to the data files @internal -- do not change this value",
"title": "path"
},
"paths": {
"default": "",
"description": "Sets a list of paths to the data files @internal -- do not change this value",
"title": "paths"
},
"size": {
"default": "",
"description": "Sets the size of the data disk",
"title": "size"
},
"volumeName": {
"default": "",
"description": "If you do not want to have a Volume created by the provisioner, you can set the name of your volume here to attach to this pre-existing one",
"title": "volumeName"
}
},
"title": "data",
"type": "object"
},
"disk": {
"additionalProperties": false,
"properties": {
"class": {
"default": "",
"description": "Sets the class of the disk",
"title": "class"
},
"enabled": {
"default": "false",
"description": "enables the use of the second data disk. If enabled, all paths defined will end up on this disk. In case of the (default) disabled, the paths will be added to the primaty data disk.",
"title": "enabled"
},
"migration": {
"default": "false",
"description": "Enables the migration init container. This will copy the data in paths from the primary data disk to the newly enabled secondary disk. This is done only once and only if there is legacy data at all. No files are overwritten!",
"title": "migration"
},
"path": {
"default": "",
"description": "Sets the path to the disk files @internal -- do not change this value",
"title": "path"
},
"paths": {
"default": "",
"description": "Sets a list of paths to the data files @internal -- do not change this value",
"title": "paths"
},
"size": {
"default": "",
"description": "Sets the size of the disk",
"title": "size"
},
"volumeName": {
"default": "",
"description": "If you do not want to have a Volume created by the provisioner, you can set the name of your volume here to attach to this pre-existing one",
"title": "volumeName"
}
},
"title": "disk",
"type": "object"
},
"file": {
"additionalProperties": false,
"properties": {
"class": {
"default": "",
"description": "Sets the class of the shared disk",
"title": "class"
},
"path": {
"default": "",
"description": "Sets the path to the shared files @internal -- do not change this value",
"title": "path"
},
"paths": {
"default": "",
"description": "Sets a list of paths to the shared files @internal -- do not change this value",
"title": "paths"
},
"size": {
"default": "",
"description": "Sets the size of the shared disk",
"title": "size"
},
"volumeName": {
"default": "",
"description": "If you do not want to have a Volume created by the provisioner, you can set the name of your volume here to attach to this pre-existing one",
"title": "volumeName"
}
},
"title": "file",
"type": "object"
},
"fonts": {
"additionalProperties": false,
"description": "If you want to use additional fonts like the msttcorefonts (Microsoft Core Fonts). This mounts the fonts directory from the environment pool",
"properties": {
"path": {
"default": "",
"description": "Sets the path to the fonts folder. @internal -- do not change this value",
"title": "path"
}
},
"title": "fonts"
},
"generic": {
"default": "",
"description": "Allows to define generic mounts of pre-provisioned PVs into any container. This can be used e.g. to mount migration nfs, cifs / samba shares into a pipeliner container.",
"title": "generic"
},
"license": {
"additionalProperties": false,
"description": "some nscale Components require a license file and this defines it's location",
"properties": {
"path": {
"default": "",
"description": "Sets the path to the license files @internal -- do not change this value",
"title": "path"
}
},
"title": "license"
},
"logs": {
"additionalProperties": false,
"description": "The log volume is used to take any left-over logging in the container. The container should log to stdout, but if any component still tries to log to disk this disk needs to be writeable",
"properties": {
"path": {
"default": "",
"description": "Sets the path to the log files @internal -- do not change this value",
"title": "path"
},
"paths": {
"default": "",
"description": "Sets a list of paths to the log files @internal -- do not change this value",
"title": "paths"
},
"size": {
"default": "",
"description": "Sets the size of the log disk (all paths)",
"title": "size"
}
},
"title": "logs"
},
"pool": {
"additionalProperties": false,
"properties": {
"path": {
"default": "/pool",
"description": "Sets the path to a directory, there the `pool` folder from the `conf` volume should be mounted. this is used to store scripts, apps and assets that are required to deploy an application / solution @internal -- do not change this value",
"title": "path"
}
},
"title": "pool",
"type": "object"
},
"ptemp": {
"additionalProperties": false,
"description": "The temp volume is used to hold any superflues and temporary data. it is deleted when the pod terminates. However, it is extremely important as all pods filesystems are read only",
"properties": {
"path": {
"default": "",
"description": "Sets the path for temporary files that are persisted @internal -- do not change this value",
"title": "path"
},
"paths": {
"default": "",
"description": "Sets a list of paths for temporary files that are persisted @internal -- do not change this value",
"title": "paths"
}
},
"title": "ptemp"
},
"temp": {
"additionalProperties": false,
"description": "The temp volume is used to hold any superflues and temporary data. it is deleted when the pod terminates. However, it is extremely important as all pods filesystems are read only",
"properties": {
"path": {
"default": "/tmp",
"description": "Sets the path to the temporary files @internal -- do not change this value",
"title": "path"
},
"paths": {
"default": "",
"description": "Sets a list of paths to the temporary files @internal -- do not change this value",
"title": "paths"
},
"size": {
"default": "",
"description": "Sets the size of the temporary disk (all paths)",
"title": "size"
}
},
"title": "temp"
}
},
"title": "mounts",
"type": "object"
},
"nameOverride": {
"default": "",
"description": "This overrides the output of the internal name function",
"title": "nameOverride"
},
"nappl": {
"additionalProperties": false,
"description": "The nscale Application Layer, this component should talk to",
"properties": {
"account": {
"default": "",
"description": "The technical account to login with",
"title": "account"
},
"domain": {
"default": "",
"description": "The domain of the technical account",
"title": "domain"
},
"host": {
"default": "",
"description": "nappl host name",
"title": "host"
},
"instance": {
"default": "",
"description": "instance of the Application Layer, likely `instance1`",
"title": "instance"
},
"password": {
"default": "",
"description": "The password of the technical accunt (if not set by secret)",
"title": "password"
},
"port": {
"default": "",
"description": "nappl port (http 8080 or https 8443)",
"title": "port"
},
"secret": {
"default": "",
"description": "An optional secret that holds the credentials (the keys must be `account` and `password`)",
"title": "secret"
},
"ssl": {
"default": "",
"description": "sets the Advanced Connect to tls",
"title": "ssl"
}
},
"title": "nappl"
},
"nodeSelector": {
"default": "",
"description": "select specific nodes for this component",
"title": "nodeSelector"
},
"nstl": {
"additionalProperties": false,
"properties": {
"host": {
"default": "",
"description": "The dns of the *nscale Server Storage Layer*. This is used to add it to the nappl configuration",
"title": "host"
}
},
"title": "nstl",
"type": "object"
},
"prerun": {
"default": "",
"description": "A list of scripts to run before the deployment of Apps",
"title": "prerun"
},
"resources": {
"additionalProperties": false,
"description": "Assigns hardware resources to container",
"properties": {
"limits": {
"additionalProperties": false,
"description": "Limits the maximum resources",
"properties": {
"cpu": {
"default": "",
"description": "The maximum allowed CPU for the container",
"title": "cpu"
},
"memory": {
"default": "",
"description": "The maximum allowed RAM for the container",
"title": "memory"
}
},
"title": "limits"
},
"requests": {
"additionalProperties": false,
"description": "Requests are used to assign a minimum to a container. This is the guaranteed amount",
"properties": {
"cpu": {
"default": "",
"description": "Set the share of guaranteed CPU to the container.",
"title": "cpu"
},
"memory": {
"default": "",
"description": "Set the share of guaranteed RAM to the container",
"title": "memory"
}
},
"title": "requests"
}
},
"title": "resources"
},
"rs": {
"additionalProperties": false,
"properties": {
"host": {
"default": "",
"description": "The dns of the *nscale rendition Server*. This is used to add it to the nappl configuration",
"title": "host"
}
},
"title": "rs",
"type": "object"
},
"run": {
"default": "",
"description": "A list of scripts to run after the deployment of Apps",
"title": "run"
},
"security": {
"additionalProperties": false,
"description": "Security Section defining default runtime environment for your container",
"properties": {
"containerSecurityContext": {
"additionalProperties": false,
"properties": {
"allowPrivilegeEscalation": {
"default": "false",
"description": "Some functionality may need the possibility to allow privilege escalation. This should be very restrictive @internal -- you should not change this",
"title": "allowPrivilegeEscalation"
},
"capabilities": {
"additionalProperties": false,
"description": "Capabilities this container should have. Only allow the necessity, and drop as many as possible @internal -- you should not change this",
"properties": {
"drop": {
"items": {
"anyOf": [
{
"type": "string"
}
]
},
"title": "drop",
"type": "array"
}
},
"title": "capabilities"
},
"readOnlyRootFilesystem": {
"default": "true",
"description": "sets the container root file system to read only. This should be the case in production environment @internal -- you should not change this",
"title": "readOnlyRootFilesystem"
}
},
"title": "containerSecurityContext",
"type": "object"
},
"podSecurityContext": {
"additionalProperties": false,
"properties": {
"fsGroup": {
"default": "1001",
"description": "The file system group as which new files are created @internal -- there is normally no need to change this",
"title": "fsGroup"
},
"fsGroupChangePolicy": {
"default": "OnRootMismatch",
"description": "Under which condition should the fsGroup be changed @internal -- there is normally no need to change this",
"title": "fsGroupChangePolicy"
},
"runAsUser": {
"default": "1001",
"description": "The user under which the container ist run. Avoid 0 / root. The container should run in a non-root context for security @internal -- there is normally no need to change this",
"title": "runAsUser"
}
},
"title": "podSecurityContext",
"type": "object"
},
"zeroTrust": {
"default": "`false`",
"description": "turns on *Zero Trust* Mode, disabling *all* http communication, even the internal http probes",
"title": "zeroTrust"
}
},
"title": "security"
},
"telemetry": {
"additionalProperties": false,
"description": "Settings for telemetry tools",
"properties": {
"openTelemetry": {
"default": "",
"description": "turns Open Telemetry on",
"title": "openTelemetry"
},
"serviceName": {
"default": "",
"description": "Sets the service name for the telemetry service to more convenient identify the displayed component Example: \"{{ .this.meta.type }}-{{ .instance.name }}\"",
"title": "serviceName"
}
},
"title": "telemetry"
},
"terminationGracePeriodSeconds": {
"default": "",
"description": "Sets the terminationGracePeriodSeconds for the component If not set, it uses the Kubernetes defaults",
"title": "terminationGracePeriodSeconds"
},
"timezone": {
"default": "`Europe/Berlin`",
"description": "set the time zone for this component to make sure log output has a specific timestamp, internal dates and times are correct (like the creationDate in nappl) etc.",
"title": "timezone"
},
"tolerations": {
"default": "",
"description": "Set tolerations for this component",
"title": "tolerations"
},
"utils": {
"additionalProperties": false,
"properties": {
"debug": {
"default": "`false`",
"description": "Turn debugging *on* will give you stack trace etc. Please check out the Chart Developer Guide",
"title": "debug"
},
"disableWait": {
"default": "`false`",
"description": "in case you use the argoCD Wave feature, you might think about switching off the waitFor mechanism, that makes sure PODs are only started after pre-requisites are fulfilled. You can disable the starndard wait mechanism, but at your own risk, as this might start components even if they are not intended to run yet.",
"title": "disableWait"
},
"disableWave": {
"default": "`false`",
"description": "If you use argoCD, you most likely want to use the argo Wave Feature as well, making sure the components of an instance are deployed ordered. However, in DEV you might want to disable this to allow live changing components while previous waves are not finished yet.",
"title": "disableWave"
},
"includeNamespace": {
"default": "`true`",
"description": "By default, the namespace is rendered into the manifest. However, if you want to use `helm template` and store manifests for later applying them to multiple namespaces, you might want to turn this `false` to be able to use `kubectl apply -n <namespace> -f template.yaml` later",
"title": "includeNamespace"
},
"maintenance": {
"default": "`false`",
"description": "in Maintenance Mode, all *waitFor* actions will be skipped, the *Health Checks* are ignored and the pods will start in idle, not starting the service at all. This will allow you to gain access to the container to perform recovery and maintenance tasks while having the real container up.",
"title": "maintenance"
},
"renderComments": {
"default": "`true`",
"description": "You can turn Comment rendering *on* to get descriptive information inside the manifests. It will also fail on depricated functions and keys, so it is recommended to only switch it off in PROD",
"title": "renderComments"
}
},
"title": "utils",
"type": "object"
},
"waitFor": {
"default": "",
"description": "Defines a list of conditions that need to be met before this components starts. The condition must be a network port that opens, when the master component is ready. Mostly, this will be a service, since a component is only added to a service if the probes succeed.",
"title": "waitFor"
}
},
"type": "object"
}