Authentication adapter and services used for the GHGA data portal
133
Authentication adapter and services used for the GHGA data portal
helm install auth-service oci://registry-1.docker.io/ghga/auth-service-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.host | IP of the host. | "127.0.0.1" |
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.auth_topic | The name of the topic containing auth-related events. | null |
config.second_factor_recreated_type | The event type for recreation of the second factor for authentication | null |
config.iva_state_changed_topic | The name of the topic containing IVA events. | null |
config.iva_state_changed_type | The type to use for IVA state changed events. | null |
config.iva_send_code_type | The type to use for IVA send code events. | null |
config.dataset_change_topic | Name of the topic announcing, among other things, the list of files included in a new dataset. | null |
config.dataset_deletion_type | Event type used for communicating dataset deletions | null |
config.dataset_upsertion_type | Event type used for communicating dataset upsertions | null |
config.claims_collection | Name of the collection for user claims | "claims" |
config.user_topic | The name of the topic containing user events. | "users" |
config.users_collection | Name of the collection for users | "users" |
config.user_tokens_collection | Name of the collection for user tokens | "user_tokens" |
config.ivas_collection | Name of the collection for IVAs | "ivas" |
config.service_name | Short name of this service. 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. | "auth_service" |
config.service_instance_id | A string that uniquely identifies this instance across all instances of this service. This is included in log messages. | 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 inbound requests don't possess a correlation ID. If True, requests without a correlation ID will be assigned a newly generated ID in the correlation ID middleware function. | 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_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.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 | the 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. | "auth-db" |
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 |
config.log_level | The minimum log level to capture. | "INFO" |
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.max_ivas | Maximum number of IVAs a user can create per day and in total | 5 |
config.max_iva_verification_attempts | Maximum number of verification attempts for an IVA | 10 |
config.max_iva_code_validity_days | Maximum number of days an IVA verification code is valid | 7 |
config.max_iva_codes_per_day | Maximum number of verification code requests per IVA and day | 3 |
config.auto_send_iva_code_for_types | IVA types for which verification codes are sent automatically | ["Phone"] |
config.totp_issuer | Issuer name for TOTP provisioning URIs | "GHGA" |
config.totp_image | URL of the PNG image provided in the TOTP provisioning URIs | null |
config.totp_algorithm | "sha1" | |
config.totp_digits | Number of digits used for the TOTP code | 6 |
config.totp_interval | Time interval in seconds for generating TOTP codes | 30 |
config.totp_tolerance | Number of intervals to check before and after the current time | 1 |
config.totp_attempts_per_code | Maximum number of attempts to verify an individual TOTP code | 3 |
config.totp_max_failed_attempts | Maximum number of consecutive failed attempts to verify TOTP codes | 10 |
config.totp_secret_size | Size of the Base32 encoded TOTP secrets | 32 |
config.totp_encryption_key | Base64 encoded key used to encrypt TOTP secrets | null |
config.session_id_bytes | Number of bytes to be used for a session ID. | 24 |
config.csrf_token_bytes | Number of bytes to be used for a CSRF token. | 24 |
config.session_timeout_seconds | Session timeout in seconds | 3600 |
config.session_max_lifetime_seconds | Maximum lifetime of a session in seconds | 43200 |
config.auth_key | internal public key for the auth service (key pair for auth adapter) | null |
config.auth_algs | A list of all algorithms used for signing GHGA internal tokens. | ["ES256"] |
config.auth_check_claims | A dict of all GHGA internal claims that shall be verified. | {"id": null, "name": null, "email": null, "iat": null, "exp": null} |
config.auth_map_claims | A mapping of claims to attributes in the GHGA auth context. | {} |
config.port | Port to expose the server on the specified host | 8080 |
config.auto_reload | A development feature. Set to True to automatically reload the server upon code changes | false |
config.workers | Number of workers processes to run. | 1 |
config.timeout_keep_alive | The time in seconds to keep an idle connection open for subsequent requests before closing it. This value should be higher than the timeout used by any client or reverse proxy to avoid premature connection closures. | 90 |
config.api_root_path | Root path at which the API is reachable. This is relative to the specified host and port. NOTE: this chart's configmap.tpl always overwrites config.api_root_path with the value computed from apiBasePath - a value set directly under config.api_root_path is silently discarded. Set apiBasePath instead. | "" |
config.openapi_url | Path to get the openapi specification in JSON format. This is relative to the specified host and port. | "/openapi.json" |
config.docs_url | Path to host the swagger documentation. This is relative to the specified host and port. | "/docs" |
config.cors_allowed_origins | A list of origins that should be permitted to make cross-origin requests. By default, cross-origin requests are not allowed. You can use ['*'] to allow any origin. | null |
config.cors_allow_credentials | Indicate that cookies should be supported for cross-origin requests. Defaults to False. Also, cors_allowed_origins cannot be set to ['*'] for credentials to be allowed. The origins must be explicitly specified. | null |
config.cors_allowed_methods | A list of HTTP methods that should be allowed for cross-origin requests. Defaults to ['GET']. You can use ['*'] to allow all standard methods. | null |
config.cors_allowed_headers | A list of HTTP request headers that should be supported for cross-origin requests. Defaults to []. You can use ['*'] to allow all request headers. The Accept, Accept-Language, Content-Language, Content-Type and some are always allowed for CORS requests. | null |
config.cors_exposed_headers | A list of HTTP response headers that should be exposed for cross-origin responses. Defaults to []. Note that you can NOT use ['*'] to expose all response headers. The Cache-Control, Content-Language, Content-Length, Content-Type, Expires, Last-Modified and Pragma headers are always exposed for CORS responses. | null |
config.api_ext_path | external API path for the auth related endpoints (user, session and TOTP management) | "/api/auth" |
config.auth_ext_keys | external public key set for auth adapter (used only by the auth adapter, determined using OIDC discovery if None) | null |
config.auth_ext_algs | allowed algorithms for signing external tokens | ["RS256", "ES256"] |
config.auth_paths | path prefixes that can generate an internal auth token | ["/api/"] |
config.basic_auth_credentials | credentials for basic authentication, separated by whitespace | null |
config.basic_auth_realm | realm for basic authentication | "GHGA Data Portal" |
config.allow_read_paths | paths that are public or use their own authentication mechanism | ["/.well-known/*", "/service-logo.png"] |
config.allow_write_paths | paths for writing that use their own authentication mechanism | [] |
config.provide_apis | Which REST APIs should be provided. | [] |
config.run_consumer | Whether the service should run as an event consumer | false |
config.add_as_data_stewards | A list of of data stewards to seed the claims repository with. All other data steward claims will be removed. This is only used with the claims API. | [] |
config.oidc_authority_url | external OIDC authority URL used by the auth adapter | "https://login.aai.lifescience-ri.eu/oidc/" |
config.oidc_issuer | external OIDC issuer for access tokens used by the auth adapter (URL format with or without end slash, determined using OIDC discovery if empty) | "https://login.aai.lifescience-ri.eu/oidc/" |
config.oidc_userinfo_endpoint | external OIDC userinfo endpoint used by the auth adapter (determined using OIDC discovery if None) | "https://login.aai.lifescience-ri.eu/oidc/userinfo" |
config.oidc_client_id | the registered OIDC client ID | "ghga-data-portal" |
config.organization_url | the URL used as source for internal claims | "https://ghga.de" |
| 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) | "auth-service" |
executableArgs | [] | |
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/auth-service" |
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:abd966177de382cc446812fa94afe47643fcab66eff48f2a367a9236f370e633" |
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 | "" |
migrationInitContainer.executableArgs | [] | |
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.http | 8080 | |
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) | [] |
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/auth-service/README.md
Content type
Helm
Digest
sha256:f94637003…
Size
58.5 kB
Last updated
10 days ago
helm pull oci://registry-1.docker.io/ghga/auth-service-chart --version 15.3.1-rc.5Pulls:
29
Last week