Sign inSign up

ghga/data-portal-chart

Sponsored OSS

By German Human Genome-Phenome Archive

Updated 10 days ago

GHGA Data Portal - the web front end for browsing metadata, submitting and uploading datasets, reque

Helm
0

120

ghga/data-portal-chart repository overview

data-portal

GHGA Data Portal - the web front end for browsing metadata, submitting and uploading datasets, requesting access to, and downloading GHGA-hosted data.

Installing

helm install data-portal oci://registry-1.docker.io/ghga/data-portal-chart

Source

Part of the GHGA monorepo. See values.yaml for the full set of configurable values.

Service Configuration

NameDescriptionValue
config.host"0.0.0.0"
config.oidc_use_discoveryfalse
config.root_files{}

Parameters

NameDescriptionValue
global.imageRegistryRegistry override applied to every image reference in the umbrella (read by the vendored common library chart's common.images.image helper)""
global.imagePullSecretsPull secrets applied to every workload in the umbrella, combined with each image's own pullSecrets below (read by the vendored common library chart's common.images.renderPullSecrets helper)[]
commandPrefixPath prefix prepended to executable before it's rendered into command/args""
commandStyle"shell": wrap executable+args in command via a shell string (needs a shell in the image). "exec": render command=[prefixed executable], args as a real argv list - for shell-less hardened runtime images."exec"
executableExecutable name and arguments (will be combined into a shell command)""
executableArgs[]
deployment.enabledRender the Deployment resource; disable for Job/CronJob-only chartstrue
job.enabledRender a one-off Job resource alongside (or instead of) the Deploymentfalse
cronjobs.default.enabledfalse
nameOverrideOverride just the chart-name portion of generated resource names (the vendored common library chart's common.names.name convention)""
fullnameOverrideOverride the entire generated resource name, bypassing the <release>-<chart> convention (the vendored common library chart's common.names.fullname)""
namespaceOverrideOverride the namespace resources render into instead of .Release.Namespace (the vendored common library chart's common.names.namespace)""
commonLabelsLabels merged onto every rendered resource's metadata - Deployment, CronJob, Job, Service, HPA, DestinationRule, HTTPRoute, Probe, ConfigMap, ServiceAccount, NetworkPolicy, KafkaUser. No separate, narrower per-workload-only value: use service.labels below for Service/DestinationRule-only labels{}
commonAnnotationsAnnotations merged onto the same set of resources as commonLabels (see there); use service.annotations below for Service/DestinationRule-only annotations{}
image.registryDefault image registry; overridden by global.imageRegistry when set"docker.io"
image.repositoryImage repository path (create_charts.py fills this in per member)"ghga/data-portal"
image.tagImage tag; left empty so it falls back to the chart's appVersion == the platform version (ADR-0004)""
image.digestPin the image by digest instead of tag, when set (takes precedence in the vendored common library chart's common.images.image helper)"sha256:441c78babdcda927960c74e4d16a06c52cff9e81976e19cb678233115119ba45"
image.pullPolicyimagePullPolicy override; null defaults to Always for a latest tag, IfNotPresent otherwisenull
image.pullSecretsExtra pull secrets for just this image reference[]
replicaCountDeployment replica count; ignored when autoscaling.enabled1
revisionHistoryLimitNumber of old ReplicaSets Kubernetes keeps around for rollback1
shareProcessNamespaceShare the pod's process namespace across containers; forced true whenever vaultAgent.enabled (the agent sends signals to the app's PID)false
podSecurityContext.fsGroupGroup ID Kubernetes chowns mounted volumes to1000
initContainersExtra init containers to run before the main container (the migration init container below is prepended to this list when enabled)[]
migrationInitContainer.enabledRun a dedicated init container for DB migrations before the main container startsfalse
migrationInitContainer.imageImage for the migration init container; defaults to the main container's image when empty""
migrationInitContainer.imagePullPolicyimagePullPolicy for just the migration init container; defaults to the main container's own imagePullPolicy when unsetnull
migrationInitContainer.executableExecutable name and arguments run inside the migration init container""
migrationInitContainer.executableArgs[]
migrationInitContainer.envExtra env vars for just the migration init container[]
migrationInitContainer.resources{}
migrationInitContainer.volumeMountsExtra volume mounts for just the migration init container (on top of the shared volumeMounts every container gets)[]
hostAliasesExtra /etc/hosts entries for the pod[]
podLabelsLabels applied only to the Pod template (Deployment/CronJob/Job pod spec), distinct from labels/commonLabels on the parent resource{}
podAnnotationsAnnotations applied only to the Pod template; combined with any Vault Agent annotations when vaultAgent.enabled{}
podAffinityPresetPod-affinity preset name (e.g. "soft"/"hard"), from the vendored common library chart; empty disables it""
podAntiAffinityPresetPod-anti-affinity preset name (vendored common library chart convention); "soft" spreads replicas across nodes when possible"soft"
nodeAffinityPreset.typeNode-affinity preset type ("soft"/"hard"), from the vendored common library chart; empty disables it""
nodeAffinityPreset.keyNode label key to match""
nodeAffinityPreset.valuesNode label values to match[]
affinityRaw Kubernetes affinity spec; overrides all three presets above when set{}
nodeSelectorPlain node-selector labels for pod scheduling{}
tolerationsTaints the pod tolerates[]
topologySpreadConstraintsKubernetes pod topology spread constraints[]
priorityClassNamePriorityClass to schedule the pod with""
schedulerNameAlternate Kubernetes scheduler to use""
terminationGracePeriodSecondsGrace period before SIGKILL on pod termination""
updateStrategy.typeDeployment rollout strategy (e.g. RollingUpdate/Recreate)"RollingUpdate"
podRestartPolicyPod-level restart policy for the Deployment (Jobs/CronJobs set their own, ignoring this)"Always"
containerPorts.http8080
livenessProbe.enabledRender a container livenessProbe from this block (minus enabled)false
livenessProbe.tcpSocket.port8080
livenessProbe.initialDelaySeconds30
livenessProbe.periodSeconds15
readinessProbe.enabledRender a container readinessProbe from this block (minus enabled)false
readinessProbe.tcpSocket.port8080
readinessProbe.initialDelaySeconds30
readinessProbe.periodSeconds15
startupProbe.enabledRender a container startupProbe from this block (minus enabled)false
startupProbe.tcpSocket.port8080
startupProbe.periodSeconds10
startupProbe.failureThreshold30
containerSecurityContext.enabledRender the container securityContext from this block (minus enabled)true
containerSecurityContext.runAsUser1000
containerSecurityContext.capabilities.drop["ALL"]
containerSecurityContext.seccompProfile.type"RuntimeDefault"
containerSecurityContext.readOnlyRootFilesystemfalse
containerSecurityContext.runAsNonRoottrue
containerSecurityContext.allowPrivilegeEscalationfalse
lifecycleHooksContainer lifecycle hooks (postStart/preStop){}
resources.limits.cpu"1500m"
resources.limits.memory"2048M"
resources.requests.cpu"1000m"
resources.requests.memory"1024M"
extraVolumesExtra volumes for the pod (on top of the config/kafka-secret volumes this chart already renders)[]
extraVolumeMountsExtra volume mounts for the main container (on top of the shared ones every container gets)[]
sidecarsExtra full container specs appended alongside the main container[]
envVarsExtra literal env vars for the main container (the generated CONFIG_YAML env var is appended to this list when configMap.envVar.enabled)[]
envVarsConfigMapName of a ConfigMap to load as bulk env vars via envFrom""
envVarsSecretName of a Secret to load as bulk env vars via envFrom""
service.enabledRender the Service resourcetrue
service.type"ClusterIP"
service.labelsExtra labels on just the Service (and DestinationRule, which shares its address){}
service.annotationsExtra annotations on just the Service (and DestinationRule, which shares its address) - e.g. cloud load-balancer or ingress-controller annotations{}
serviceAccount.createCreate a dedicated ServiceAccount for this releasetrue
autoscaling.enabledRender a HorizontalPodAutoscaler targeting the Deploymentfalse
autoscaling.minReplicas3
autoscaling.maxReplicas5
autoscaling.targetCPUTarget average CPU utilization percentage; omit/empty to skip this metric80
autoscaling.targetMemoryTarget average memory utilization percentage; omit/empty to skip this metric80
autoscaling.metricsExtra raw HPA metric entries appended after CPU/memory[]
topicPrefixPrefix prepended to every Kafka topic name this chart renders/references""
kafkaTopicsParametersFold _topics/_consumerGroup into the rendered config.yaml as service config parameters (topic name/type env vars); set false to render topics for KafkaUser ACLs only, without also injecting them as configtrue
kafkaUser.enabledRender a Strimzi KafkaUser (TLS cert + ACLs from _topics/_consumerGroup)false
kafkaUser.clusterName"kafka"
kafkaUser.clusterNamespace"strimzi"
kafkaUser.caCertSecretNameSecret holding the Kafka cluster's CA cert, mounted alongside the user's own TLS secret"kafka-cluster-ca-cert"
mongodb.dbNameDatabase name; combined with dbNamePrefix and injected into config.yaml as db_name. NOTE: mongodb.dbName is the fallback used when the top-level dbName (set per-member, not defaulted here) is empty""
mongodb.service.namespaceTogether with mongodb.service.name and cluster.name, forms the Vault KV path this chart reads a dynamic MongoDB credential from"mongodb"
mongodb.service.name"mongodb"
apiBasePathPublic API path prefix; combined with apiBasePathPrefix (set by an aliasing umbrella) and injected into config.yaml as api_root_path"/"
serviceNameLogical service name; combined with serviceNamePrefix and injected into config.yaml as service_name""
serviceInstanceId.fromPodNameInject a <CONFIG_PREFIX>_SERVICE_INSTANCE_ID env var sourced from the Kubernetes Downward API (metadata.name), overriding config.service_instance_id per-pod. Env vars beat the YAML config file in hexkit config_from_yaml priority order, so this makes the value genuinely unique per replica instead of the static per-member string every service currently hardcodes in its own chart-values.yaml config block (which collides across replicas once replicaCount > 1, contradicting hexkit KafkaConfig.service_instance_id's own "uniquely identifies this instance" contract).false
configMap.enabledRender the ConfigMap holding config.yaml and mount it into the containertrue
configMap.mountPath"/app/data-portal.yaml"
configMap.subPath"config.yaml"
configMap.envVar.enabledAlso add a <CONFIG_PREFIX>_CONFIG_YAML env var pointing at mountPathtrue
configPrefixPrefix for the generated CONFIG_YAML env var and every Vault Agent-injected env var; create_charts.py derives this automatically from the package name"data_portal"
enableServiceLinksStandard Kubernetes field: whether to inject <SVC>_SERVICE_HOST-style env vars for every Service in the namespacetrue
successfulJobsHistoryLimitFallback successfulJobsHistoryLimit for any cronjobs entry that doesn't set its own5
environment.nameIdentifies which environment this release belongs to; part of the Vault secret path for the "service" secrets bundle"default"
cluster.nameIdentifies which cluster this release belongs to; part of the Vault secret path for MongoDB credentials"default"
httpRoute.enabledRender an HTTPRoute (Gateway API, ADR-0012) routing to this servicefalse
httpRoute.port8080
httpRoute.rewritePathstrip the base path before forwarding. Services that reconstruct their own public URLs (an OIDC discovery document, for example) need the full path instead and rely on api_root_path to route - set this to false for them.true
httpRoute.rulesExtra HTTPRoute rules rendered before the generated default rule (deduplicated)[]
probe.enabledRender a Prometheus-Operator Probe CR blackbox-checking this service over HTTPfalse
probe.hostnamePublic hostname the blackbox exporter probes (combined with the API base path and healthEndpoint below to build the target URL)"default.ghga.dev"
healthEndpointPath appended to the probe target URL (after the API base path)"/health"
destinationRule.enabledRender an Istio DestinationRule for this servicefalse
networkPolicy.enabledRender a NetworkPolicy restricting ingress traffic to the podfalse
networkPolicy.ingressOnly allow traffic from namespaces labeled ghga-ingress: allow, on the Service's own ports[{"from": [{"namespaceSelector": {"matchLabels": {"ghga-ingress": "allow"}}}]}]
strimziApiVersionapiVersion used for the rendered Strimzi KafkaUser resource"kafka.strimzi.io/v1"
vaultAgent.enabledInject a Vault Agent sidecar (via pod annotations) that populates secrets/env vars from Vault before/alongside the main containerfalse
vaultAgent.annotations.vault.hashicorp.com/tls-skip-verify"false"
vaultAgent.annotations.vault.hashicorp.com/agent-inject"true"
vaultAgent.annotations.vault.hashicorp.com/agent-init-first"true"
vaultAgent.annotations.vault.hashicorp.com/agent-cache-enable"true"
vaultAgent.annotations.vault.hashicorp.com/agent-pre-populate-only"false"
vaultAgent.annotations.vault.hashicorp.com/agent-run-as-same-user"true"
vaultAgent.roleVault auth role to assume; defaults to the release name when empty""
vaultAgent.rolePrefixPrefix prepended to the resolved role name above""
vaultAgent.caCertPath to a custom CA cert for Vault TLS verification""
vaultAgent.tlsSecretKubernetes secret providing the Vault Agent's TLS material""
vaultAgent.serviceOverride the Vault service address the agent talks to""
vaultAgent.tlsServerNameTLS server name override for the Vault connection""
vaultAgent.pgrepPatternProcess name the Agent's "kill -TERM" hook searches for to restart the app on secret rotation"python"
vaultAgent.secrets.genericArbitrary Vault KV paths to inject as individual env vars, keyed by name; each entry needs path/parameterName (and optionally dataKey){}
vaultAgent.secrets.mongodb.enabledInject a MongoDB connection string built from a Vault-issued dynamic credentialfalse
vaultAgent.secrets.mongodb.secretPathVault KV path to read the credential from; computed from mongodb.service.{namespace,name} + cluster.name when empty""
vaultAgent.secrets.mongodb.connectionStringConnection-string template; {{username}}/{{password}} are substituted by Vault's own templating, not Helm's"mongodb://{{username}}:{{password}}@mongodb:27017/admin"
vaultAgent.secrets.service.enabledInject every key/value pair from one Vault secret as env varsfalse
vaultAgent.secrets.service.secretPathVault KV path to read from; computed from pathPrefix + environment.name + the release name when empty""
vaultAgent.secrets.service.pathPrefix"operational-secrets/data/unique/apps/archive"
vaultAgent.secrets.crypt4ghInternalPub.enabledInject GHGA's shared internal Crypt4GH public keyfalse
vaultAgent.secrets.crypt4ghInternalPub.secretPath"operational-secrets/data/shared/managed-keys/crypt4gh-internal"
vaultAgent.secrets.crypt4ghInternalPub.mountPathWhere to write the key when renderToFile is true"/keys/crypt4gh-internal/crypt4gh.pub"
vaultAgent.secrets.crypt4ghInternalPub.dataKeyField name to read within the Vault secret"crypt4gh.pub"
vaultAgent.secrets.crypt4ghInternalPub.renderToFiletrue: write to mountPath as a file. false: inject as an env var named parameterName insteadtrue
vaultAgent.secrets.crypt4ghInternalPub.parameterName"CRYPT4GH_PUBLIC_KEY"
vaultAgent.secrets.crypt4ghInternalPriv.enabledInject GHGA's shared internal Crypt4GH private key (same fields as crypt4ghInternalPub above)false
vaultAgent.secrets.crypt4ghInternalPriv.secretPath"operational-secrets/data/shared/managed-keys/crypt4gh-internal"
vaultAgent.secrets.crypt4ghInternalPriv.mountPath"/keys/crypt4gh-internal/crypt4gh.sec"
vaultAgent.secrets.crypt4ghInternalPriv.dataKey"crypt4gh.sec"
vaultAgent.secrets.crypt4ghInternalPriv.renderToFiletrue
vaultAgent.secrets.crypt4ghInternalPriv.parameterName"CRYPT4GH_PRIVATE_KEY"
vaultAgent.secrets.crypt4ghExternalPriv.enabledInject GHGA's shared external-facing Crypt4GH private key (same fields as crypt4ghInternalPub above)false
vaultAgent.secrets.crypt4ghExternalPriv.secretPath"operational-secrets/data/shared/managed-keys/crypt4gh-external"
vaultAgent.secrets.crypt4ghExternalPriv.mountPath"/keys/crypt4gh-external/crypt4gh.sec"
vaultAgent.secrets.crypt4ghExternalPriv.dataKey"crypt4gh.sec"
vaultAgent.secrets.crypt4ghExternalPriv.renderToFiletrue
vaultAgent.secrets.crypt4ghExternalPriv.parameterName"CRYPT4GH_PRIVATE_KEY"

Tag summary

Content type

Helm

Digest

sha256:4ea3c33b3

Size

47.6 kB

Last updated

10 days ago

helm pull oci://registry-1.docker.io/ghga/data-portal-chart --version 15.3.1-rc.5

This week's pulls

Pulls:

29

Last week