Internal File Registry Service - This service acts as a registry for the internal location and repre
121
Internal File Registry Service - This service acts as a registry for the internal location and representation of files.
helm install ifrs oci://registry-1.docker.io/ghga/ifrs-chart
Part of the GHGA monorepo. See values.yaml for the full set of configurable values.
| Name | Description | Value |
|---|---|---|
config.mongo_dsn | MongoDB connection string. Might include credentials. For more information see: https://naiveskill.com/mongodb-connection-string/ | null |
config.object_storages | null | |
config.kafka_enable_dlq | A flag to toggle the dead letter queue. If set to False, the service will crash upon exhausting retries instead of publishing events to the DLQ. If set to True, the service will publish events to the DLQ topic after exhausting all retries | false |
config.enable_opentelemetry | If set to true, this will run necessary setup code.If set to false, no setup code is run, which leaves tracing disabled. | false |
config.db_version_collection | The name of the collection containing DB version information for this service | null |
config.migration_wait_sec | The number of seconds to wait before checking the DB version again | null |
config.otel_trace_sampling_rate | Determines which proportion of spans should be sampled. A value of 1.0 means all and is equivalent to the previous behaviour. Setting this to 0 will result in no spans being sampled, but this does not automatically set enable_opentelemetry to False. | 1.0 |
config.log_level | The minimum log level to capture. | "INFO" |
config.service_name | NOTE: this chart's configmap.tpl always overwrites config.service_name with the value computed from serviceName - a value set directly under config.service_name is silently discarded. Set serviceName instead. | "ifrs" |
config.service_instance_id | A string that uniquely identifies this instance across all instances of this service. A globally unique Kafka client ID will be created by concatenating the service_name and the service_instance_id. | null |
config.log_format | If set, will replace JSON formatting with the specified string format. If not set, has no effect. In addition to the standard attributes, the following can also be specified: timestamp, service, instance, level, correlation_id, and details | null |
config.log_traceback | Whether to include exception tracebacks in log messages. | true |
config.file_upload_topic | Topic containing published FileUpload outbox events | null |
config.file_internally_registered_topic | Name of the topic used for events indicating that a file has been registered for download. | null |
config.file_internally_registered_type | The type used for event indicating that that a file has been registered for download. | null |
config.file_deleted_topic | Name of the topic used for events indicating that a file has been deleted. | null |
config.file_deleted_type | The type used for events indicating that a file has been deleted. | null |
config.file_staged_topic | Name of the topic used for events indicating that a new file has been internally registered. | null |
config.file_staged_type | The type used for events indicating that a new file has been internally registered. | null |
config.file_deletion_request_topic | The name of the topic to receive events informing about files to delete. | null |
config.file_deletion_request_type | The type used for events indicating that a request to delete a file has been received. | null |
config.files_to_stage_topic | Name of the topic used for events indicating that a download was requested for a file that is not yet available in the outbox. | null |
config.files_to_stage_type | The type used for non-staged file request events | null |
config.kafka_servers | A list of connection strings to connect to Kafka bootstrap servers. | null |
config.kafka_security_protocol | Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL. | "PLAINTEXT" |
config.kafka_ssl_cafile | Certificate Authority file path containing certificates used to sign broker certificates. If a CA is not specified, the default system CA will be used if found by OpenSSL. | "" |
config.kafka_ssl_certfile | Optional filename of client certificate, as well as any CA certificates needed to establish the certificate's authenticity. | "" |
config.kafka_ssl_keyfile | Optional filename containing the client private key. | "" |
config.kafka_ssl_password | Optional password to be used for the client private key. | "" |
config.generate_correlation_id | A flag, which, if False, will result in an error when trying to publish an event without a valid correlation ID set for the context. If True, a new correlation ID will be generated and used in the event header. | true |
config.kafka_max_message_size | The largest message size that can be transmitted, in bytes, before compression. Only services that have a need to send/receive larger messages should set this. When used alongside compression, this value can be set to something greater than the broker's message.max.bytes field, which effectively concerns the compressed message size. | 1048576 |
config.kafka_compression_type | The compression type used for messages. Valid values are: None, gzip, snappy, lz4, and zstd. If None, no compression is applied. This setting is only relevant for the producer and has no effect on the consumer. If set to a value, the producer will compress messages before sending them to the Kafka broker. If unsure, zstd provides a good balance between speed and compression ratio. | null |
config.kafka_max_retries | The maximum number of times to immediately retry consuming an event upon failure. Works independently of the dead letter queue. | 0 |
config.kafka_dlq_topic | The name of the topic used to resolve error-causing events. | "dlq" |
config.kafka_retry_backoff | The number of seconds to wait before retrying a failed event. The backoff time is doubled for each retry attempt. | 0 |
config.db_name | Name of the database located on the MongoDB server. NOTE: this chart's configmap.tpl always overwrites config.db_name with the value computed from mongodb.dbName - a value set directly under config.db_name is silently discarded. Set mongodb.dbName instead. | null |
config.mongo_timeout | Timeout in seconds for API calls to MongoDB. The timeout applies to all steps needed to complete the operation, including server selection, connection checkout, serialization, and server-side execution. When the timeout expires, PyMongo raises a timeout exception. If set to None, the operation will not time out (default MongoDB behavior). | null |
config.migration_max_wait_sec | The maximum number of seconds to wait for migrations to complete before raising an error. | null |
| Name | Description | Value |
|---|---|---|
global.imageRegistry | Registry override applied to every image reference in the umbrella (read by the vendored common library chart's common.images.image helper) | "" |
global.imagePullSecrets | Pull 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) | [] |
commandPrefix | Path 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" |
executable | Executable name and arguments (will be combined into a shell command) | "ifrs" |
executableArgs | ["consume-events"] | |
deployment.enabled | Render the Deployment resource; disable for Job/CronJob-only charts | true |
job.enabled | Render a one-off Job resource alongside (or instead of) the Deployment | false |
cronjobs.default.enabled | false | |
nameOverride | Override just the chart-name portion of generated resource names (the vendored common library chart's common.names.name convention) | "" |
fullnameOverride | Override the entire generated resource name, bypassing the <release>-<chart> convention (the vendored common library chart's common.names.fullname) | "" |
namespaceOverride | Override the namespace resources render into instead of .Release.Namespace (the vendored common library chart's common.names.namespace) | "" |
commonLabels | Labels 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 | {} |
commonAnnotations | Annotations merged onto the same set of resources as commonLabels (see there); use service.annotations below for Service/DestinationRule-only annotations | {} |
image.registry | Default image registry; overridden by global.imageRegistry when set | "docker.io" |
image.repository | Image repository path (create_charts.py fills this in per member) | "ghga/ifrs" |
image.tag | Image tag; left empty so it falls back to the chart's appVersion == the platform version (ADR-0004) | "" |
image.digest | Pin the image by digest instead of tag, when set (takes precedence in the vendored common library chart's common.images.image helper) | "sha256:af23b62b61f86d42d2a99565a3c6866b6718fd967881173fee079f210be3cf05" |
image.pullPolicy | imagePullPolicy override; null defaults to Always for a latest tag, IfNotPresent otherwise | null |
image.pullSecrets | Extra pull secrets for just this image reference | [] |
replicaCount | Deployment replica count; ignored when autoscaling.enabled | 1 |
revisionHistoryLimit | Number of old ReplicaSets Kubernetes keeps around for rollback | 1 |
shareProcessNamespace | Share the pod's process namespace across containers; forced true whenever vaultAgent.enabled (the agent sends signals to the app's PID) | false |
podSecurityContext.fsGroup | Group ID Kubernetes chowns mounted volumes to | 1000 |
initContainers | Extra init containers to run before the main container (the migration init container below is prepended to this list when enabled) | [] |
migrationInitContainer.enabled | Run a dedicated init container for DB migrations before the main container starts | false |
migrationInitContainer.image | Image for the migration init container; defaults to the main container's image when empty | "" |
migrationInitContainer.imagePullPolicy | imagePullPolicy for just the migration init container; defaults to the main container's own imagePullPolicy when unset | null |
migrationInitContainer.executable | Executable name and arguments run inside the migration init container | "ifrs" |
migrationInitContainer.executableArgs | ["migrate-db"] | |
migrationInitContainer.env | Extra env vars for just the migration init container | [] |
migrationInitContainer.resources | {} | |
migrationInitContainer.volumeMounts | Extra volume mounts for just the migration init container (on top of the shared volumeMounts every container gets) | [] |
hostAliases | Extra /etc/hosts entries for the pod | [] |
podLabels | Labels applied only to the Pod template (Deployment/CronJob/Job pod spec), distinct from labels/commonLabels on the parent resource | {} |
podAnnotations | Annotations applied only to the Pod template; combined with any Vault Agent annotations when vaultAgent.enabled | {} |
podAffinityPreset | Pod-affinity preset name (e.g. "soft"/"hard"), from the vendored common library chart; empty disables it | "" |
podAntiAffinityPreset | Pod-anti-affinity preset name (vendored common library chart convention); "soft" spreads replicas across nodes when possible | "soft" |
nodeAffinityPreset.type | Node-affinity preset type ("soft"/"hard"), from the vendored common library chart; empty disables it | "" |
nodeAffinityPreset.key | Node label key to match | "" |
nodeAffinityPreset.values | Node label values to match | [] |
affinity | Raw Kubernetes affinity spec; overrides all three presets above when set | {} |
nodeSelector | Plain node-selector labels for pod scheduling | {} |
tolerations | Taints the pod tolerates | [] |
topologySpreadConstraints | Kubernetes pod topology spread constraints | [] |
priorityClassName | PriorityClass to schedule the pod with | "" |
schedulerName | Alternate Kubernetes scheduler to use | "" |
terminationGracePeriodSeconds | Grace period before SIGKILL on pod termination | "" |
updateStrategy.type | Deployment rollout strategy (e.g. RollingUpdate/Recreate) | "RollingUpdate" |
podRestartPolicy | Pod-level restart policy for the Deployment (Jobs/CronJobs set their own, ignoring this) | "Always" |
containerPorts | Container ports, name -> port (bare number = TCP; {port, protocol} for anything else). Also the single source the Service's and NetworkPolicy's own ports: are derived from - a Service always exposes exactly what its container listens on here, so there's one map to keep in sync, not several. A map, not a list, so an overlay can add/override one named port without repeating the rest. Empty = no ports declared anywhere. | {} |
livenessProbe.enabled | Render a container livenessProbe from this block (minus enabled) | false |
livenessProbe.tcpSocket.port | 8080 | |
livenessProbe.initialDelaySeconds | 30 | |
livenessProbe.periodSeconds | 15 | |
readinessProbe.enabled | Render a container readinessProbe from this block (minus enabled) | false |
readinessProbe.tcpSocket.port | 8080 | |
readinessProbe.initialDelaySeconds | 30 | |
readinessProbe.periodSeconds | 15 | |
startupProbe.enabled | Render a container startupProbe from this block (minus enabled) | false |
startupProbe.tcpSocket.port | 8080 | |
startupProbe.periodSeconds | 10 | |
startupProbe.failureThreshold | 30 | |
containerSecurityContext.enabled | Render the container securityContext from this block (minus enabled) | true |
containerSecurityContext.runAsUser | 1000 | |
containerSecurityContext.capabilities.drop | ["ALL"] | |
containerSecurityContext.seccompProfile.type | "RuntimeDefault" | |
containerSecurityContext.readOnlyRootFilesystem | true | |
containerSecurityContext.runAsNonRoot | true | |
containerSecurityContext.allowPrivilegeEscalation | false | |
lifecycleHooks | Container lifecycle hooks (postStart/preStop) | {} |
resources.limits.cpu | "1500m" | |
resources.limits.memory | "2048M" | |
resources.requests.cpu | "1000m" | |
resources.requests.memory | "1024M" | |
extraVolumes | Extra volumes for the pod (on top of the config/kafka-secret volumes this chart already renders) | [] |
extraVolumeMounts | Extra volume mounts for the main container (on top of the shared ones every container gets) | [] |
sidecars | Extra full container specs appended alongside the main container | [] |
envVars | Extra literal env vars for the main container (the generated CONFIG_YAML env var is appended to this list when configMap.envVar.enabled) | [] |
envVarsConfigMap | Name of a ConfigMap to load as bulk env vars via envFrom | "" |
envVarsSecret | Name of a Secret to load as bulk env vars via envFrom | "" |
service.enabled | Render the Service resource | false |
service.type | "ClusterIP" | |
service.labels | Extra labels on just the Service (and DestinationRule, which shares its address) | {} |
service.annotations | Extra annotations on just the Service (and DestinationRule, which shares its address) - e.g. cloud load-balancer or ingress-controller annotations | {} |
serviceAccount.create | Create a dedicated ServiceAccount for this release | true |
autoscaling.enabled | Render a HorizontalPodAutoscaler targeting the Deployment | false |
autoscaling.minReplicas | 3 | |
autoscaling.maxReplicas | 5 | |
autoscaling.targetCPU | Target average CPU utilization percentage; omit/empty to skip this metric | 80 |
autoscaling.targetMemory | Target average memory utilization percentage; omit/empty to skip this metric | 80 |
autoscaling.metrics | Extra raw HPA metric entries appended after CPU/memory | [] |
topicPrefix | Prefix prepended to every Kafka topic name this chart renders/references | "" |
kafkaTopicsParameters | Fold _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 config | true |
kafkaUser.enabled | Render a Strimzi KafkaUser (TLS cert + ACLs from _topics/_consumerGroup) | false |
kafkaUser.clusterName | "kafka" | |
kafkaUser.clusterNamespace | "strimzi" | |
kafkaUser.caCertSecretName | Secret holding the Kafka cluster's CA cert, mounted alongside the user's own TLS secret | "kafka-cluster-ca-cert" |
mongodb.dbName | Database 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 | "internal-file-registry" |
mongodb.service.namespace | Together 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" | |
apiBasePath | Public API path prefix; combined with apiBasePathPrefix (set by an aliasing umbrella) and injected into config.yaml as api_root_path | "" |
serviceName | Logical service name; combined with serviceNamePrefix and injected into config.yaml as service_name | "ifrs" |
serviceInstanceId.fromPodName | Inject 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.enabled | Render the ConfigMap holding config.yaml and mount it into the container | true |
configMap.mountPath | "/etc/config.yaml" | |
configMap.subPath | "config.yaml" | |
configMap.envVar.enabled | Also add a <CONFIG_PREFIX>_CONFIG_YAML env var pointing at mountPath | true |
configPrefix | Prefix for the generated CONFIG_YAML env var and every Vault Agent-injected env var; create_charts.py derives this automatically from the package name | "ifrs" |
enableServiceLinks | Standard Kubernetes field: whether to inject <SVC>_SERVICE_HOST-style env vars for every Service in the namespace | true |
successfulJobsHistoryLimit | Fallback successfulJobsHistoryLimit for any cronjobs entry that doesn't set its own | 5 |
environment.name | Identifies which environment this release belongs to; part of the Vault secret path for the "service" secrets bundle | "default" |
cluster.name | Identifies which cluster this release belongs to; part of the Vault secret path for MongoDB credentials | "default" |
httpRoute.enabled | Render an HTTPRoute (Gateway API, ADR-0012) routing to this service | false |
httpRoute.port | 8080 | |
httpRoute.rewritePath | strip 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.rules | Extra HTTPRoute rules rendered before the generated default rule (deduplicated) | [] |
probe.enabled | Render a Prometheus-Operator Probe CR blackbox-checking this service over HTTP | false |
probe.hostname | Public hostname the blackbox exporter probes (combined with the API base path and healthEndpoint below to build the target URL) | "default.ghga.dev" |
healthEndpoint | Path appended to the probe target URL (after the API base path) | "/health" |
destinationRule.enabled | Render an Istio DestinationRule for this service | false |
networkPolicy.enabled | Render a NetworkPolicy restricting ingress traffic to the pod | false |
networkPolicy.ingress | Only allow traffic from namespaces labeled ghga-ingress: allow, on the Service's own ports | [{"from": [{"namespaceSelector": {"matchLabels": {"ghga-ingress": "allow"}}}]}] |
strimziApiVersion | apiVersion used for the rendered Strimzi KafkaUser resource | "kafka.strimzi.io/v1" |
This README is longer than Docker Hub's 25000-character overview limit, so it has been cut short here. Read the rest on GitHub: https://github.com/ghga-de/ghga/blob/main/deploy/charts/ifrs/README.md
Content type
Helm
Digest
sha256:0adb1d0d4…
Size
54.4 kB
Last updated
9 days ago
helm pull oci://registry-1.docker.io/ghga/ifrs-chart --version 15.3.1-rc.5Pulls:
28
Last week