diff --git a/charts/document-engine/CHANGELOG.md b/charts/document-engine/CHANGELOG.md index d7db427..78d422b 100644 --- a/charts/document-engine/CHANGELOG.md +++ b/charts/document-engine/CHANGELOG.md @@ -1,6 +1,7 @@ # Changelog - [Changelog](#changelog) + - [8.9.0 (2026-11-04)](#890-2026-11-04) - [8.8.0 (2026-10-30)](#880-2026-10-30) - [8.7.1 (2026-10-28)](#871-2026-10-28) - [8.7.0 (2026-09-30)](#870-2026-09-30) @@ -244,6 +245,10 @@ - [2.0.0](#200) - [Changed](#changed-68) +## 8.9.0 (2026-11-04) + +* Added `config.urlFetchPoolSize`, `config.urlFetchQueueTimeoutSeconds` and `config.urlFetchQueueMaxSize`, which control how many documents Document Engine fetches from a remote URL at once per pod, how long a fetch waits for a free slot, and how many may wait at once. Defaults match the values Document Engine used previously, so an existing deployment is unaffected. + ## 8.8.0 (2026-10-30) * Updated Document Engine to 1.20.0. diff --git a/charts/document-engine/Chart.yaml b/charts/document-engine/Chart.yaml index fedd908..937a00f 100644 --- a/charts/document-engine/Chart.yaml +++ b/charts/document-engine/Chart.yaml @@ -4,7 +4,7 @@ type: application description: Document Engine is a backend software for processing documents and powering automation workflows. home: https://www.nutrient.io/sdk/document-engine icon: https://cdn.prod.website-files.com/65fdb7696055f07a05048833/66e58e33c3880ff24aa34027_nutrient-logo.png -version: 8.8.0 +version: 8.9.0 appVersion: "1.20.0" keywords: diff --git a/charts/document-engine/README.md b/charts/document-engine/README.md index 0857565..f4f97d5 100644 --- a/charts/document-engine/README.md +++ b/charts/document-engine/README.md @@ -1,6 +1,6 @@ # Document Engine Helm chart -![Version: 8.8.0](https://img.shields.io/badge/Version-8.8.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.20.0](https://img.shields.io/badge/AppVersion-1.20.0-informational?style=flat-square) +![Version: 8.9.0](https://img.shields.io/badge/Version-8.9.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.20.0](https://img.shields.io/badge/AppVersion-1.20.0-informational?style=flat-square) Document Engine is a backend software for processing documents and powering automation workflows. @@ -404,56 +404,59 @@ Note: | Key | Description | Default | |-----|-------------|---------| | [`config`](./values.yaml#L82) | General configuration, see more in [our guide](https://www.nutrient.io/guides/document-engine/configuration/options/) | | -| [`config.allowDocumentGeneration`](./values.yaml#L187) | `ALLOW_DOCUMENT_GENERATION` | `true` | -| [`config.allowDocumentUploads`](./values.yaml#L181) | `ALLOW_DOCUMENT_UPLOADS` | `true` | -| [`config.allowRemoteAssetsInGeneration`](./values.yaml#L190) | `ALLOW_REMOTE_ASSETS_IN_GENERATION` | `true` | -| [`config.allowRemoteDocuments`](./values.yaml#L184) | `ALLOW_REMOTE_DOCUMENTS` | `true` | -| [`config.asyncAdmissionQueueLimits`](./values.yaml#L153) | `ASYNC_ADMISSION_QUEUE_LIMITS` — optional comma-separated queue limits, for example `default=100`. Missing queues are unlimited. | `none` | -| [`config.asyncAdmissionQueues`](./values.yaml#L148) | `ASYNC_ADMISSION_QUEUES` — comma-separated async queues accepted by this node. Set to an empty string to reject async operation admission. | `"default"` | -| [`config.asyncJobEncryption`](./values.yaml#L162) | Async job metadata encryption settings. | [...](./values.yaml#L162) | -| [`config.asyncJobEncryption.externalSecret`](./values.yaml#L172) | Use an external secret for `ASYNC_JOB_ENCRYPTION_KEYS` | [...](./values.yaml#L172) | -| [`config.asyncJobEncryption.externalSecret.key`](./values.yaml#L178) | Secret key name for the async job encryption keyring | `"ASYNC_JOB_ENCRYPTION_KEYS"` | -| [`config.asyncJobEncryption.externalSecret.name`](./values.yaml#L175) | External secret name | `""` | -| [`config.asyncJobEncryption.keys`](./values.yaml#L167) | `ASYNC_JOB_ENCRYPTION_KEYS` — comma-separated `key_id:base64_key[:current]` entries for encrypting async job metadata. Required for async Build API requests with remote URLs or PDF passwords. | `none` | -| [`config.asyncJobMaxRetries`](./values.yaml#L141) | `ASYNC_JOB_MAX_RETRIES` | `2` | -| [`config.asyncJobRetryBackoffSeconds`](./values.yaml#L144) | `ASYNC_JOB_RETRY_BACKOFF_SECONDS` | `15` | -| [`config.asyncJobTimeoutSeconds`](./values.yaml#L138) | `ASYNC_JOB_TIMEOUT` in seconds | `600` | -| [`config.asyncJobsMetadataTtlSeconds`](./values.yaml#L135) | `ASYNC_JOBS_METADATA_TTL` in seconds. Must be greater than or equal to `config.asyncJobsTtlSeconds`. | `604800` | -| [`config.asyncJobsTtlSeconds`](./values.yaml#L132) | `ASYNC_JOBS_TTL` | `172800` | -| [`config.asyncWorkerQueues`](./values.yaml#L157) | `ASYNC_WORKER_QUEUES` — comma-separated async worker queues with concurrency, for example `default=5`. Set to an empty string to make this node skip async background work. | `"default=5"` | -| [`config.automaticLinkExtraction`](./values.yaml#L196) | `AUTOMATIC_LINK_EXTRACTION` | `false` | -| [`config.batchRender`](./values.yaml#L117) | Batch render request settings. | [...](./values.yaml#L117) | -| [`config.batchRender.maxConcurrency`](./values.yaml#L120) | `BATCH_RENDER_MAX_CONCURRENCY` | `4` | -| [`config.batchRender.maxPages`](./values.yaml#L123) | `BATCH_RENDER_MAX_PAGES` | `500` | -| [`config.batchRender.pageTimeoutSeconds`](./values.yaml#L126) | `BATCH_RENDER_PAGE_TIMEOUT_MS` in seconds | `120` | +| [`config.allowDocumentGeneration`](./values.yaml#L196) | `ALLOW_DOCUMENT_GENERATION` | `true` | +| [`config.allowDocumentUploads`](./values.yaml#L190) | `ALLOW_DOCUMENT_UPLOADS` | `true` | +| [`config.allowRemoteAssetsInGeneration`](./values.yaml#L199) | `ALLOW_REMOTE_ASSETS_IN_GENERATION` | `true` | +| [`config.allowRemoteDocuments`](./values.yaml#L193) | `ALLOW_REMOTE_DOCUMENTS` | `true` | +| [`config.asyncAdmissionQueueLimits`](./values.yaml#L162) | `ASYNC_ADMISSION_QUEUE_LIMITS` — optional comma-separated queue limits, for example `default=100`. Missing queues are unlimited. | `none` | +| [`config.asyncAdmissionQueues`](./values.yaml#L157) | `ASYNC_ADMISSION_QUEUES` — comma-separated async queues accepted by this node. Set to an empty string to reject async operation admission. | `"default"` | +| [`config.asyncJobEncryption`](./values.yaml#L171) | Async job metadata encryption settings. | [...](./values.yaml#L171) | +| [`config.asyncJobEncryption.externalSecret`](./values.yaml#L181) | Use an external secret for `ASYNC_JOB_ENCRYPTION_KEYS` | [...](./values.yaml#L181) | +| [`config.asyncJobEncryption.externalSecret.key`](./values.yaml#L187) | Secret key name for the async job encryption keyring | `"ASYNC_JOB_ENCRYPTION_KEYS"` | +| [`config.asyncJobEncryption.externalSecret.name`](./values.yaml#L184) | External secret name | `""` | +| [`config.asyncJobEncryption.keys`](./values.yaml#L176) | `ASYNC_JOB_ENCRYPTION_KEYS` — comma-separated `key_id:base64_key[:current]` entries for encrypting async job metadata. Required for async Build API requests with remote URLs or PDF passwords. | `none` | +| [`config.asyncJobMaxRetries`](./values.yaml#L150) | `ASYNC_JOB_MAX_RETRIES` | `2` | +| [`config.asyncJobRetryBackoffSeconds`](./values.yaml#L153) | `ASYNC_JOB_RETRY_BACKOFF_SECONDS` | `15` | +| [`config.asyncJobTimeoutSeconds`](./values.yaml#L147) | `ASYNC_JOB_TIMEOUT` in seconds | `600` | +| [`config.asyncJobsMetadataTtlSeconds`](./values.yaml#L144) | `ASYNC_JOBS_METADATA_TTL` in seconds. Must be greater than or equal to `config.asyncJobsTtlSeconds`. | `604800` | +| [`config.asyncJobsTtlSeconds`](./values.yaml#L141) | `ASYNC_JOBS_TTL` | `172800` | +| [`config.asyncWorkerQueues`](./values.yaml#L166) | `ASYNC_WORKER_QUEUES` — comma-separated async worker queues with concurrency, for example `default=5`. Set to an empty string to make this node skip async background work. | `"default=5"` | +| [`config.automaticLinkExtraction`](./values.yaml#L205) | `AUTOMATIC_LINK_EXTRACTION` | `false` | +| [`config.batchRender`](./values.yaml#L126) | Batch render request settings. | [...](./values.yaml#L126) | +| [`config.batchRender.maxConcurrency`](./values.yaml#L129) | `BATCH_RENDER_MAX_CONCURRENCY` | `4` | +| [`config.batchRender.maxPages`](./values.yaml#L132) | `BATCH_RENDER_MAX_PAGES` | `500` | +| [`config.batchRender.pageTimeoutSeconds`](./values.yaml#L135) | `BATCH_RENDER_PAGE_TIMEOUT_MS` in seconds | `120` | | [`config.daemonReadTimeoutSeconds`](./values.yaml#L100) | `PSPDFKITD_READ_TIMEOUT` in seconds | `120` | | [`config.daemonWriteTimeoutSeconds`](./values.yaml#L103) | `PSPDFKITD_WRITE_TIMEOUT` in seconds | `10` | | [`config.generationTimeoutSeconds`](./values.yaml#L106) | `PDF_GENERATION_TIMEOUT` in seconds | `20` | -| [`config.hoard`](./values.yaml#L249) | Hoard — internal caching service parameters | [...](./values.yaml#L249) | -| [`config.hoard.maxSizeMegaBytes`](./values.yaml#L252) | `HOARD_MAX_SIZE` — maximum size in millions of bytes | `100` | -| [`config.http2SharedRendering`](./values.yaml#L261) | Optimised rendering relying on HTTP/2 | [...](./values.yaml#L261) | -| [`config.http2SharedRendering.enabled`](./values.yaml#L264) | `HTTP2_SHARED_RENDERING_PROCESS_ENABLE` — enable shared rendering processes | `false` | -| [`config.ignoreInvalidAnnotations`](./values.yaml#L193) | `IGNORE_INVALID_ANNOTATIONS` | `true` | -| [`config.instantPermissionAwareLongPoll`](./values.yaml#L203) | `INSTANT_PERMISSION_AWARE_LONG_POLL` — keep Instant long-poll requests waiting when only records hidden by collaboration permissions change. Hidden changes are delivered with the next visible change or at the request timeout, so group changes that revoke visibility can reach clients late. | `false` | -| [`config.maxUploadSizeMegaBytes`](./values.yaml#L129) | `MAX_UPLOAD_SIZE_BYTES` in megabytes | `950` | -| [`config.minSearchQueryLength`](./values.yaml#L199) | `MIN_SEARCH_QUERY_LENGTH` | `3` | -| [`config.port`](./values.yaml#L282) | `PORT` for the Document Engine API | `5000` | -| [`config.proxy`](./values.yaml#L277) | Proxy settings, `HTTP_PROXY` and `HTTPS_PROXY` | `{"http":"","https":""}` | -| [`config.readAnnotationBatchTimeoutSeconds`](./values.yaml#L112) | `READ_ANNOTATION_BATCH_TIMEOUT` in seconds | `20` | -| [`config.remoteUrlFetch`](./values.yaml#L208) | Customer-controlled remote URL fetch policy. | [...](./values.yaml#L208) | -| [`config.remoteUrlFetch.allowEmbeddedCredentials`](./values.yaml#L222) | `REMOTE_URL_FETCH_ALLOW_EMBEDDED_CREDENTIALS` | `false` | -| [`config.remoteUrlFetch.allowedCidrs`](./values.yaml#L219) | `REMOTE_URL_FETCH_ALLOWED_CIDRS` — comma-separated CIDR ranges. | `none` | -| [`config.remoteUrlFetch.allowedHosts`](./values.yaml#L215) | `REMOTE_URL_FETCH_ALLOWED_HOSTS` — comma-separated DNS hostnames or wildcard DNS patterns. | `none` | -| [`config.remoteUrlFetch.policy`](./values.yaml#L211) | `REMOTE_URL_FETCH_POLICY` | `"public_only"` | -| [`config.replaceSecretsFromEnv`](./values.yaml#L287) | `REPLACE_SECRETS_FROM_ENV` — whether to consider environment variables, values and secrets for `JWT_PUBLIC_KEY`, `SECRET_KEY_BASE` and `DASHBOARD_PASSWORD` | `true` | +| [`config.hoard`](./values.yaml#L258) | Hoard — internal caching service parameters | [...](./values.yaml#L258) | +| [`config.hoard.maxSizeMegaBytes`](./values.yaml#L261) | `HOARD_MAX_SIZE` — maximum size in millions of bytes | `100` | +| [`config.http2SharedRendering`](./values.yaml#L270) | Optimised rendering relying on HTTP/2 | [...](./values.yaml#L270) | +| [`config.http2SharedRendering.enabled`](./values.yaml#L273) | `HTTP2_SHARED_RENDERING_PROCESS_ENABLE` — enable shared rendering processes | `false` | +| [`config.ignoreInvalidAnnotations`](./values.yaml#L202) | `IGNORE_INVALID_ANNOTATIONS` | `true` | +| [`config.instantPermissionAwareLongPoll`](./values.yaml#L212) | `INSTANT_PERMISSION_AWARE_LONG_POLL` — keep Instant long-poll requests waiting when only records hidden by collaboration permissions change. Hidden changes are delivered with the next visible change or at the request timeout, so group changes that revoke visibility can reach clients late. | `false` | +| [`config.maxUploadSizeMegaBytes`](./values.yaml#L138) | `MAX_UPLOAD_SIZE_BYTES` in megabytes | `950` | +| [`config.minSearchQueryLength`](./values.yaml#L208) | `MIN_SEARCH_QUERY_LENGTH` | `3` | +| [`config.port`](./values.yaml#L291) | `PORT` for the Document Engine API | `5000` | +| [`config.proxy`](./values.yaml#L286) | Proxy settings, `HTTP_PROXY` and `HTTPS_PROXY` | `{"http":"","https":""}` | +| [`config.readAnnotationBatchTimeoutSeconds`](./values.yaml#L121) | `READ_ANNOTATION_BATCH_TIMEOUT` in seconds | `20` | +| [`config.remoteUrlFetch`](./values.yaml#L217) | Customer-controlled remote URL fetch policy. | [...](./values.yaml#L217) | +| [`config.remoteUrlFetch.allowEmbeddedCredentials`](./values.yaml#L231) | `REMOTE_URL_FETCH_ALLOW_EMBEDDED_CREDENTIALS` | `false` | +| [`config.remoteUrlFetch.allowedCidrs`](./values.yaml#L228) | `REMOTE_URL_FETCH_ALLOWED_CIDRS` — comma-separated CIDR ranges. | `none` | +| [`config.remoteUrlFetch.allowedHosts`](./values.yaml#L224) | `REMOTE_URL_FETCH_ALLOWED_HOSTS` — comma-separated DNS hostnames or wildcard DNS patterns. | `none` | +| [`config.remoteUrlFetch.policy`](./values.yaml#L220) | `REMOTE_URL_FETCH_POLICY` | `"public_only"` | +| [`config.replaceSecretsFromEnv`](./values.yaml#L296) | `REPLACE_SECRETS_FROM_ENV` — whether to consider environment variables, values and secrets for `JWT_PUBLIC_KEY`, `SECRET_KEY_BASE` and `DASHBOARD_PASSWORD` | `true` | | [`config.requestTimeoutSeconds`](./values.yaml#L88) | Full request timeout in seconds (`SERVER_REQUEST_TIMEOUT`). Should be smaller than `terminationGracePeriodSeconds`, so a request cannot still be running when Kubernetes sends `SIGKILL`. | `60` | -| [`config.search`](./values.yaml#L227) | Full-text search settings. | [...](./values.yaml#L227) | -| [`config.search.ftsBuildOnWrite`](./values.yaml#L239) | `SEARCH_FTS_BUILD_ON_WRITE` | `false` | -| [`config.search.ftsEnabled`](./values.yaml#L230) | `SEARCH_FTS_ENABLED` | `false` | -| [`config.search.ftsEnrichment`](./values.yaml#L233) | `SEARCH_FTS_ENRICHMENT` | `"daemon"` | -| [`config.search.maxGlyphSidecarPageBytes`](./values.yaml#L236) | `SEARCH_MAX_GLYPH_SIDECAR_PAGE_BYTES` | `2000000` | -| [`config.tileMaxScale`](./values.yaml#L244) | `TILE_MAX_SCALE` — maximum allowed tile scale, calculated as requested tile size divided by actual page size. Must be greater than 1. When unset, no limit is enforced. | `unlimited` | -| [`config.trustedProxies`](./values.yaml#L274) | `TRUSTED_PROXIES` — comma-separated list of IP addresses or IP address ranges of trusted proxies. Setting to `default` will use private IP ranges. | `"default"` | +| [`config.search`](./values.yaml#L236) | Full-text search settings. | [...](./values.yaml#L236) | +| [`config.search.ftsBuildOnWrite`](./values.yaml#L248) | `SEARCH_FTS_BUILD_ON_WRITE` | `false` | +| [`config.search.ftsEnabled`](./values.yaml#L239) | `SEARCH_FTS_ENABLED` | `false` | +| [`config.search.ftsEnrichment`](./values.yaml#L242) | `SEARCH_FTS_ENRICHMENT` | `"daemon"` | +| [`config.search.maxGlyphSidecarPageBytes`](./values.yaml#L245) | `SEARCH_MAX_GLYPH_SIDECAR_PAGE_BYTES` | `2000000` | +| [`config.tileMaxScale`](./values.yaml#L253) | `TILE_MAX_SCALE` — maximum allowed tile scale, calculated as requested tile size divided by actual page size. Must be greater than 1. When unset, no limit is enforced. | `unlimited` | +| [`config.trustedProxies`](./values.yaml#L283) | `TRUSTED_PROXIES` — comma-separated list of IP addresses or IP address ranges of trusted proxies. Setting to `default` will use private IP ranges. | `"default"` | +| [`config.urlFetchPoolSize`](./values.yaml#L112) | `DOWNLOADER_WORKER_POOL_SIZE`. How many documents are fetched from a remote URL at once, per pod. | `16` | +| [`config.urlFetchQueueMaxSize`](./values.yaml#L118) | `DOWNLOADER_BROKER_CLIENT_QUEUE_MAX_SIZE`. How many remote fetches may wait for a free slot at once. Once the queue is full, further requests are rejected immediately instead of waiting. | `128` | +| [`config.urlFetchQueueTimeoutSeconds`](./values.yaml#L115) | `DOWNLOADER_BROKER_CLIENT_QUEUE_TIMEOUT` in seconds. How long a remote fetch waits for a free slot before it is rejected. A Build API request is rejected with `503`. Should not be greater than `config.requestTimeoutSeconds`. | `5` | | [`config.urlFetchTimeoutSeconds`](./values.yaml#L109) | `REMOTE_URL_FETCH_TIMEOUT` in seconds | `5` | | [`config.workerPoolMaxRestarts`](./values.yaml#L94) | Maximum number of restarts (`PSPDFKIT_WORKER_POOL_MAX_RESTARTS`) before supervisor starts throttling them. | `20` | | [`config.workerPoolMaxSeconds`](./values.yaml#L97) | Time window in which the supervisor monitors the number of restarts (`PSPDFKIT_WORKER_POOL_MAX_SECONDS`). | `60` | @@ -464,314 +467,314 @@ Note: | Key | Description | Default | |-----|-------------|---------| -| [`certificateTrust`](./values.yaml#L292) | [Certificate trust](https://www.nutrient.io/guides/document-engine/configuration/certificate-trust/) | | -| [`certificateTrust.customCertificates`](./values.yaml#L305) | ConfigMap and Secret references for trust configuration, stored in `/certificate-stores-custom` | `[]` | -| [`certificateTrust.digitalSignatures`](./values.yaml#L296) | CAs for digital signatures (`/certificate-stores/`) from ConfigMap and Secret resources. | `[]` | -| [`certificateTrust.downloaderTrustFileName`](./values.yaml#L315) | Override `DOWNLOADER_CERT_FILE_PATH` to set HTTP client trust. If empty, defaults to Mozilla's CA bundle. | `""` | +| [`certificateTrust`](./values.yaml#L301) | [Certificate trust](https://www.nutrient.io/guides/document-engine/configuration/certificate-trust/) | | +| [`certificateTrust.customCertificates`](./values.yaml#L314) | ConfigMap and Secret references for trust configuration, stored in `/certificate-stores-custom` | `[]` | +| [`certificateTrust.digitalSignatures`](./values.yaml#L305) | CAs for digital signatures (`/certificate-stores/`) from ConfigMap and Secret resources. | `[]` | +| [`certificateTrust.downloaderTrustFileName`](./values.yaml#L324) | Override `DOWNLOADER_CERT_FILE_PATH` to set HTTP client trust. If empty, defaults to Mozilla's CA bundle. | `""` | ### Database | Key | Description | Default | |-----|-------------|---------| -| [`database`](./values.yaml#L320) | Database | | -| [`database.connections`](./values.yaml#L329) | `DATABASE_CONNECTIONS` | `20` | -| [`database.enabled`](./values.yaml#L323) | Persistent storage enabled | `true` | -| [`database.engine`](./values.yaml#L326) | Database engine: only `postgres` is currently supported | `"postgres"` | -| [`database.migrationJob`](./values.yaml#L393) | Database migration jobs. | [...](./values.yaml#L393) | -| [`database.migrationJob.enabled`](./values.yaml#L396) | It `true`, results in `ENABLE_DATABASE_MIGRATIONS=false` in the main Document Engine container | `false` | -| [`database.postgres`](./values.yaml#L334) | PostgreSQL database settings | [...](./values.yaml#L334) | -| [`database.postgres.adminPassword`](./values.yaml#L355) | `PG_ADMIN_PASSWORD` | `"despair"` | -| [`database.postgres.adminUsername`](./values.yaml#L352) | `PG_ADMIN_USER` | `"postgres"` | -| [`database.postgres.database`](./values.yaml#L343) | `PGDATABASE` | `"document-engine"` | -| [`database.postgres.externalAdminSecretName`](./values.yaml#L364) | External secret for administrative database credentials, used for migrations: `PG_ADMIN_USER` and `PG_ADMIN_PASSWORD` | `""` | -| [`database.postgres.externalSecretName`](./values.yaml#L360) | Use external secret for database credentials. `PGUSER` and `PGPASSWORD` must be provided and, if not defined: `PGDATABASE`, `PGHOST`, `PGPORT`, `PGSSL` | `""` | -| [`database.postgres.host`](./values.yaml#L337) | `PGHOST`, if not set, and `cloudNativePG.enabled`, will rely on the Cluster | `""` | -| [`database.postgres.password`](./values.yaml#L349) | `PGPASSWORD` | `"despair"` | -| [`database.postgres.port`](./values.yaml#L340) | `PGPORT` | `5432` | -| [`database.postgres.tls`](./values.yaml#L369) | TLS settings | [...](./values.yaml#L369) | -| [`database.postgres.tls.commonName`](./values.yaml#L382) | Common name for the certificate (`PGSSL_CERT_COMMON_NAME`), defaults to `PGHOST` value | `""` | -| [`database.postgres.tls.enabled`](./values.yaml#L372) | Enable TLS (`PGSSL`) | `false` | -| [`database.postgres.tls.hostVerify`](./values.yaml#L378) | Negated `PGSSL_DISABLE_HOSTNAME_VERIFY` | `true` | -| [`database.postgres.tls.trustBundle`](./values.yaml#L386) | Trust bundle for PostgreSQL, sets `PGSSL_CA_CERTS`, mutually exclusive with `trustFileName` and takes precedence | `""` | -| [`database.postgres.tls.trustFileName`](./values.yaml#L389) | Path from `certificateTrust.customCertificates`, wraps around `PGSSL_CA_CERT_PATH` | `""` | -| [`database.postgres.tls.verify`](./values.yaml#L375) | Negated `PGSSL_DISABLE_VERIFY` | `true` | -| [`database.postgres.username`](./values.yaml#L346) | `PGUSER` | `"postgres"` | +| [`database`](./values.yaml#L329) | Database | | +| [`database.connections`](./values.yaml#L338) | `DATABASE_CONNECTIONS` | `20` | +| [`database.enabled`](./values.yaml#L332) | Persistent storage enabled | `true` | +| [`database.engine`](./values.yaml#L335) | Database engine: only `postgres` is currently supported | `"postgres"` | +| [`database.migrationJob`](./values.yaml#L402) | Database migration jobs. | [...](./values.yaml#L402) | +| [`database.migrationJob.enabled`](./values.yaml#L405) | It `true`, results in `ENABLE_DATABASE_MIGRATIONS=false` in the main Document Engine container | `false` | +| [`database.postgres`](./values.yaml#L343) | PostgreSQL database settings | [...](./values.yaml#L343) | +| [`database.postgres.adminPassword`](./values.yaml#L364) | `PG_ADMIN_PASSWORD` | `"despair"` | +| [`database.postgres.adminUsername`](./values.yaml#L361) | `PG_ADMIN_USER` | `"postgres"` | +| [`database.postgres.database`](./values.yaml#L352) | `PGDATABASE` | `"document-engine"` | +| [`database.postgres.externalAdminSecretName`](./values.yaml#L373) | External secret for administrative database credentials, used for migrations: `PG_ADMIN_USER` and `PG_ADMIN_PASSWORD` | `""` | +| [`database.postgres.externalSecretName`](./values.yaml#L369) | Use external secret for database credentials. `PGUSER` and `PGPASSWORD` must be provided and, if not defined: `PGDATABASE`, `PGHOST`, `PGPORT`, `PGSSL` | `""` | +| [`database.postgres.host`](./values.yaml#L346) | `PGHOST`, if not set, and `cloudNativePG.enabled`, will rely on the Cluster | `""` | +| [`database.postgres.password`](./values.yaml#L358) | `PGPASSWORD` | `"despair"` | +| [`database.postgres.port`](./values.yaml#L349) | `PGPORT` | `5432` | +| [`database.postgres.tls`](./values.yaml#L378) | TLS settings | [...](./values.yaml#L378) | +| [`database.postgres.tls.commonName`](./values.yaml#L391) | Common name for the certificate (`PGSSL_CERT_COMMON_NAME`), defaults to `PGHOST` value | `""` | +| [`database.postgres.tls.enabled`](./values.yaml#L381) | Enable TLS (`PGSSL`) | `false` | +| [`database.postgres.tls.hostVerify`](./values.yaml#L387) | Negated `PGSSL_DISABLE_HOSTNAME_VERIFY` | `true` | +| [`database.postgres.tls.trustBundle`](./values.yaml#L395) | Trust bundle for PostgreSQL, sets `PGSSL_CA_CERTS`, mutually exclusive with `trustFileName` and takes precedence | `""` | +| [`database.postgres.tls.trustFileName`](./values.yaml#L398) | Path from `certificateTrust.customCertificates`, wraps around `PGSSL_CA_CERT_PATH` | `""` | +| [`database.postgres.tls.verify`](./values.yaml#L384) | Negated `PGSSL_DISABLE_VERIFY` | `true` | +| [`database.postgres.username`](./values.yaml#L355) | `PGUSER` | `"postgres"` | ### Document lifecycle | Key | Description | Default | |-----|-------------|---------| -| [`documentLifecycle`](./values.yaml#L409) | Document lifecycle management | | -| [`documentLifecycle.bulkDocumentDeletionEnabled`](./values.yaml#L412) | `ENABLE_BULK_DOCUMENT_DELETION`: enable `/api/async/delete_documents` API endpoint | `false` | -| [`documentLifecycle.expirationJob`](./values.yaml#L416) | Regular job to remove documents from the database, requires `documentLifecycle.bulkDocumentDeletionEnabled` to be `true` | [...](./values.yaml#L416) | -| [`documentLifecycle.expirationJob.deletionPrefix`](./values.yaml#L429) | Only delete documents with IDs beginning with this prefix. Leave empty to delete all documents matching the time filter. | `"ephemeral"` | -| [`documentLifecycle.expirationJob.enabled`](./values.yaml#L419) | Enable the document expiration job | `false` | -| [`documentLifecycle.expirationJob.keepHours`](./values.yaml#L425) | Documents TTL in hours | `24` | -| [`documentLifecycle.expirationJob.schedule`](./values.yaml#L422) | Expiration job schedule in cron format | `"13 * * * *"` | -| [`documentLifecycle.expirationJob.serviceAccountName`](./values.yaml#L440) | Service account name to specify for the expiration jobs | `""` | +| [`documentLifecycle`](./values.yaml#L418) | Document lifecycle management | | +| [`documentLifecycle.bulkDocumentDeletionEnabled`](./values.yaml#L421) | `ENABLE_BULK_DOCUMENT_DELETION`: enable `/api/async/delete_documents` API endpoint | `false` | +| [`documentLifecycle.expirationJob`](./values.yaml#L425) | Regular job to remove documents from the database, requires `documentLifecycle.bulkDocumentDeletionEnabled` to be `true` | [...](./values.yaml#L425) | +| [`documentLifecycle.expirationJob.deletionPrefix`](./values.yaml#L438) | Only delete documents with IDs beginning with this prefix. Leave empty to delete all documents matching the time filter. | `"ephemeral"` | +| [`documentLifecycle.expirationJob.enabled`](./values.yaml#L428) | Enable the document expiration job | `false` | +| [`documentLifecycle.expirationJob.keepHours`](./values.yaml#L434) | Documents TTL in hours | `24` | +| [`documentLifecycle.expirationJob.schedule`](./values.yaml#L431) | Expiration job schedule in cron format | `"13 * * * *"` | +| [`documentLifecycle.expirationJob.serviceAccountName`](./values.yaml#L449) | Service account name to specify for the expiration jobs | `""` | ### Asset storage | Key | Description | Default | |-----|-------------|---------| -| [`assetStorage`](./values.yaml#L451) | Everything about storing and caching assets | | -| [`assetStorage.azure`](./values.yaml#L523) | Azure blob storage settings, in case `assetStorage.backendType` is set to `azure` | [...](./values.yaml#L523) | -| [`assetStorage.azure.container`](./values.yaml#L534) | `AZURE_STORAGE_DEFAULT_CONTAINER` | `""` | -| [`assetStorage.backendFallback`](./values.yaml#L470) | Asset storage fallback settings | [...](./values.yaml#L470) | -| [`assetStorage.backendFallback.enabled`](./values.yaml#L473) | `ENABLE_ASSET_STORAGE_FALLBACK` | `false` | -| [`assetStorage.backendFallback.enabledAzure`](./values.yaml#L482) | `ENABLE_ASSET_STORAGE_FALLBACK_AZURE` | `false` | -| [`assetStorage.backendFallback.enabledPostgres`](./values.yaml#L476) | `ENABLE_ASSET_STORAGE_FALLBACK_POSTGRES` | `false` | -| [`assetStorage.backendFallback.enabledS3`](./values.yaml#L479) | `ENABLE_ASSET_STORAGE_FALLBACK_S3` | `false` | -| [`assetStorage.backendType`](./values.yaml#L463) | Asset storage backend is only available if `database.enabled` is `true` Sets `ASSET_STORAGE_BACKEND`: `built-in`, `s3` or `azure` | `"built-in"` | -| [`assetStorage.fileUploadTimeoutSeconds`](./values.yaml#L466) | `FILE_UPLOAD_TIMEOUT_MS` in seconds | `30` | -| [`assetStorage.localCacheSizeMegabytes`](./values.yaml#L455) | Sets local asset storage value in megabytes Results in `ASSET_STORAGE_CACHE_SIZE` (in bytes) | `2000` | -| [`assetStorage.localCacheTimeoutSeconds`](./values.yaml#L459) | Sets local asset storage cache timeout in seconds Results in `ASSET_STORAGE_CACHE_TIMEOUT` (in milliseconds) | `5` | -| [`assetStorage.redis`](./values.yaml#L552) | Redis settings for caching and prerendering | [...](./values.yaml#L552) | -| [`assetStorage.redis.database`](./values.yaml#L570) | `REDIS_DATABASE` | `""` | -| [`assetStorage.redis.enabled`](./values.yaml#L555) | `USE_REDIS_CACHE` | `false` | -| [`assetStorage.redis.externalSecretName`](./values.yaml#L607) | External secret name. Must contain `REDIS_USERNAME` and `REDIS_PASSWORD` if they are needed, and _may_ set other values | `""` | -| [`assetStorage.redis.host`](./values.yaml#L564) | `REDIS_HOST` | `"{{ .Release.Name }}-redis-master"` | -| [`assetStorage.redis.password`](./values.yaml#L596) | `REDIS_PASSWORD` | `""` | -| [`assetStorage.redis.port`](./values.yaml#L567) | `REDIS_PORT` | `6379` | -| [`assetStorage.redis.sentinel`](./values.yaml#L575) | Redis Sentinel | [...](./values.yaml#L575) | -| [`assetStorage.redis.tls`](./values.yaml#L600) | TLS settings | | -| [`assetStorage.redis.tls.enabled`](./values.yaml#L603) | Enable TLS (`REDIS_SSL`) | `false` | -| [`assetStorage.redis.ttlSeconds`](./values.yaml#L561) | `REDIS_TTL` Time to live in seconds | `86400` | -| [`assetStorage.redis.useTtl`](./values.yaml#L558) | `USE_REDIS_TTL_FOR_PRERENDERING` | `true` | -| [`assetStorage.redis.username`](./values.yaml#L593) | `REDIS_USERNAME` | `""` | -| [`assetStorage.s3`](./values.yaml#L486) | S3 backend storage settings, in case `assetStorage.backendType` is set to `s3 | [...](./values.yaml#L486) | -| [`assetStorage.s3.bucket`](./values.yaml#L497) | `ASSET_STORAGE_S3_BUCKET` | `"document-engine-assets"` | -| [`assetStorage.s3.region`](./values.yaml#L500) | `ASSET_STORAGE_S3_REGION` | `"us-east-1"` | +| [`assetStorage`](./values.yaml#L460) | Everything about storing and caching assets | | +| [`assetStorage.azure`](./values.yaml#L532) | Azure blob storage settings, in case `assetStorage.backendType` is set to `azure` | [...](./values.yaml#L532) | +| [`assetStorage.azure.container`](./values.yaml#L543) | `AZURE_STORAGE_DEFAULT_CONTAINER` | `""` | +| [`assetStorage.backendFallback`](./values.yaml#L479) | Asset storage fallback settings | [...](./values.yaml#L479) | +| [`assetStorage.backendFallback.enabled`](./values.yaml#L482) | `ENABLE_ASSET_STORAGE_FALLBACK` | `false` | +| [`assetStorage.backendFallback.enabledAzure`](./values.yaml#L491) | `ENABLE_ASSET_STORAGE_FALLBACK_AZURE` | `false` | +| [`assetStorage.backendFallback.enabledPostgres`](./values.yaml#L485) | `ENABLE_ASSET_STORAGE_FALLBACK_POSTGRES` | `false` | +| [`assetStorage.backendFallback.enabledS3`](./values.yaml#L488) | `ENABLE_ASSET_STORAGE_FALLBACK_S3` | `false` | +| [`assetStorage.backendType`](./values.yaml#L472) | Asset storage backend is only available if `database.enabled` is `true` Sets `ASSET_STORAGE_BACKEND`: `built-in`, `s3` or `azure` | `"built-in"` | +| [`assetStorage.fileUploadTimeoutSeconds`](./values.yaml#L475) | `FILE_UPLOAD_TIMEOUT_MS` in seconds | `30` | +| [`assetStorage.localCacheSizeMegabytes`](./values.yaml#L464) | Sets local asset storage value in megabytes Results in `ASSET_STORAGE_CACHE_SIZE` (in bytes) | `2000` | +| [`assetStorage.localCacheTimeoutSeconds`](./values.yaml#L468) | Sets local asset storage cache timeout in seconds Results in `ASSET_STORAGE_CACHE_TIMEOUT` (in milliseconds) | `5` | +| [`assetStorage.redis`](./values.yaml#L561) | Redis settings for caching and prerendering | [...](./values.yaml#L561) | +| [`assetStorage.redis.database`](./values.yaml#L579) | `REDIS_DATABASE` | `""` | +| [`assetStorage.redis.enabled`](./values.yaml#L564) | `USE_REDIS_CACHE` | `false` | +| [`assetStorage.redis.externalSecretName`](./values.yaml#L616) | External secret name. Must contain `REDIS_USERNAME` and `REDIS_PASSWORD` if they are needed, and _may_ set other values | `""` | +| [`assetStorage.redis.host`](./values.yaml#L573) | `REDIS_HOST` | `"{{ .Release.Name }}-redis-master"` | +| [`assetStorage.redis.password`](./values.yaml#L605) | `REDIS_PASSWORD` | `""` | +| [`assetStorage.redis.port`](./values.yaml#L576) | `REDIS_PORT` | `6379` | +| [`assetStorage.redis.sentinel`](./values.yaml#L584) | Redis Sentinel | [...](./values.yaml#L584) | +| [`assetStorage.redis.tls`](./values.yaml#L609) | TLS settings | | +| [`assetStorage.redis.tls.enabled`](./values.yaml#L612) | Enable TLS (`REDIS_SSL`) | `false` | +| [`assetStorage.redis.ttlSeconds`](./values.yaml#L570) | `REDIS_TTL` Time to live in seconds | `86400` | +| [`assetStorage.redis.useTtl`](./values.yaml#L567) | `USE_REDIS_TTL_FOR_PRERENDERING` | `true` | +| [`assetStorage.redis.username`](./values.yaml#L602) | `REDIS_USERNAME` | `""` | +| [`assetStorage.s3`](./values.yaml#L495) | S3 backend storage settings, in case `assetStorage.backendType` is set to `s3 | [...](./values.yaml#L495) | +| [`assetStorage.s3.bucket`](./values.yaml#L506) | `ASSET_STORAGE_S3_BUCKET` | `"document-engine-assets"` | +| [`assetStorage.s3.region`](./values.yaml#L509) | `ASSET_STORAGE_S3_REGION` | `"us-east-1"` | ### Statefulness | Key | Description | Default | |-----|-------------|---------| -| [`persistence`](./values.yaml#L625) | Persistent storage settings for StatefulSet pods. Only used when `workloadType` is `StatefulSet`. | [...](./values.yaml#L625) | -| [`persistence.accessModes`](./values.yaml#L631) | PVC access modes | `["ReadWriteOnce"]` | -| [`persistence.annotations`](./values.yaml#L641) | Annotations for each PVC | `{}` | -| [`persistence.mountPath`](./values.yaml#L638) | Mount path inside the container | `"/srv/pspdfkit/assets"` | -| [`persistence.selectorLabels`](./values.yaml#L644) | Selector labels for PVCs | `{}` | -| [`persistence.size`](./values.yaml#L635) | PVC storage size | `"10Gi"` | -| [`persistence.storageClassName`](./values.yaml#L628) | Storage class for PVCs. Empty string uses cluster default. | `"standard"` | -| [`podManagementPolicy`](./values.yaml#L619) | Pod management policy for StatefulSet: `OrderedReady` or `Parallel`. Only used when `workloadType` is `StatefulSet`. | `"OrderedReady"` | -| [`workloadType`](./values.yaml#L614) | Workload type: `Deployment` or `StatefulSet`. When `StatefulSet`, persistent storage is provisioned per pod via volumeClaimTemplates. **Note:** Switching an existing release from Deployment to StatefulSet requires deleting the existing Deployment first, as Kubernetes cannot change a resource kind in-place. | `"Deployment"` | +| [`persistence`](./values.yaml#L634) | Persistent storage settings for StatefulSet pods. Only used when `workloadType` is `StatefulSet`. | [...](./values.yaml#L634) | +| [`persistence.accessModes`](./values.yaml#L640) | PVC access modes | `["ReadWriteOnce"]` | +| [`persistence.annotations`](./values.yaml#L650) | Annotations for each PVC | `{}` | +| [`persistence.mountPath`](./values.yaml#L647) | Mount path inside the container | `"/srv/pspdfkit/assets"` | +| [`persistence.selectorLabels`](./values.yaml#L653) | Selector labels for PVCs | `{}` | +| [`persistence.size`](./values.yaml#L644) | PVC storage size | `"10Gi"` | +| [`persistence.storageClassName`](./values.yaml#L637) | Storage class for PVCs. Empty string uses cluster default. | `"standard"` | +| [`podManagementPolicy`](./values.yaml#L628) | Pod management policy for StatefulSet: `OrderedReady` or `Parallel`. Only used when `workloadType` is `StatefulSet`. | `"OrderedReady"` | +| [`workloadType`](./values.yaml#L623) | Workload type: `Deployment` or `StatefulSet`. When `StatefulSet`, persistent storage is provisioned per pod via volumeClaimTemplates. **Note:** Switching an existing release from Deployment to StatefulSet requires deleting the existing Deployment first, as Kubernetes cannot change a resource kind in-place. | `"Deployment"` | ### Digital signatures | Key | Description | Default | |-----|-------------|---------| -| [`documentSigningService`](./values.yaml#L649) | Signing service parameters | | -| [`documentSigningService.cadesLevel`](./values.yaml#L675) | `DIGITAL_SIGNATURE_CADES_LEVEL` | `"b-lt"` | -| [`documentSigningService.certificateCheckTime`](./values.yaml#L678) | `DIGITAL_SIGNATURE_CERTIFICATE_CHECK_TIME` | `"current_time"` | -| [`documentSigningService.defaultSignatureLocation`](./values.yaml#L669) | `DEFAULT_SIGNATURE_LOCATION` | `"Head Quarters"` | -| [`documentSigningService.defaultSignatureReason`](./values.yaml#L665) | `DEFAULT_SIGNATURE_REASON` | `"approved"` | -| [`documentSigningService.defaultSignerName`](./values.yaml#L661) | `DEFAULT_SIGNER_NAME` | `"John Doe"` | -| [`documentSigningService.enabled`](./values.yaml#L652) | Enable signing service integration | `false` | -| [`documentSigningService.hashAlgorithm`](./values.yaml#L672) | `DIGITAL_SIGNATURE_HASH_ALGORITHM` | `"sha512"` | -| [`documentSigningService.timeoutSeconds`](./values.yaml#L658) | `SIGNING_SERVICE_TIMEOUT` in seconds | `10` | -| [`documentSigningService.timestampAuthority`](./values.yaml#L682) | Timestamp Authority (TSA) settings | [...](./values.yaml#L682) | -| [`documentSigningService.timestampAuthority.url`](./values.yaml#L685) | `TIMESTAMP_AUTHORITY_URL` | `"https://freetsa.org/"` | -| [`documentSigningService.url`](./values.yaml#L655) | `SIGNING_SERVICE_URL` | `"https://signing-thing.local/sign"` | +| [`documentSigningService`](./values.yaml#L658) | Signing service parameters | | +| [`documentSigningService.cadesLevel`](./values.yaml#L684) | `DIGITAL_SIGNATURE_CADES_LEVEL` | `"b-lt"` | +| [`documentSigningService.certificateCheckTime`](./values.yaml#L687) | `DIGITAL_SIGNATURE_CERTIFICATE_CHECK_TIME` | `"current_time"` | +| [`documentSigningService.defaultSignatureLocation`](./values.yaml#L678) | `DEFAULT_SIGNATURE_LOCATION` | `"Head Quarters"` | +| [`documentSigningService.defaultSignatureReason`](./values.yaml#L674) | `DEFAULT_SIGNATURE_REASON` | `"approved"` | +| [`documentSigningService.defaultSignerName`](./values.yaml#L670) | `DEFAULT_SIGNER_NAME` | `"John Doe"` | +| [`documentSigningService.enabled`](./values.yaml#L661) | Enable signing service integration | `false` | +| [`documentSigningService.hashAlgorithm`](./values.yaml#L681) | `DIGITAL_SIGNATURE_HASH_ALGORITHM` | `"sha512"` | +| [`documentSigningService.timeoutSeconds`](./values.yaml#L667) | `SIGNING_SERVICE_TIMEOUT` in seconds | `10` | +| [`documentSigningService.timestampAuthority`](./values.yaml#L691) | Timestamp Authority (TSA) settings | [...](./values.yaml#L691) | +| [`documentSigningService.timestampAuthority.url`](./values.yaml#L694) | `TIMESTAMP_AUTHORITY_URL` | `"https://freetsa.org/"` | +| [`documentSigningService.url`](./values.yaml#L664) | `SIGNING_SERVICE_URL` | `"https://signing-thing.local/sign"` | ### Document conversion | Key | Description | Default | |-----|-------------|---------| -| [`documentConversion`](./values.yaml#L698) | Document conversion parameters | | -| [`documentConversion.spreadsheetMaxContentHeightMm`](./values.yaml#L702) | Maximal spreadsheet content height in millimetres (`SPREADSHEET_MAX_CONTENT_HEIGHT_MM`). Defaults to `0` for unlimited height. | `0` | -| [`documentConversion.spreadsheetMaxContentWidthMm`](./values.yaml#L706) | Maximal spreadsheet content width in millimetres (`SPREADSHEET_MAX_CONTENT_WIDTH_MM`). Defaults to `0` for unlimited width. | `0` | +| [`documentConversion`](./values.yaml#L707) | Document conversion parameters | | +| [`documentConversion.spreadsheetMaxContentHeightMm`](./values.yaml#L711) | Maximal spreadsheet content height in millimetres (`SPREADSHEET_MAX_CONTENT_HEIGHT_MM`). Defaults to `0` for unlimited height. | `0` | +| [`documentConversion.spreadsheetMaxContentWidthMm`](./values.yaml#L715) | Maximal spreadsheet content width in millimetres (`SPREADSHEET_MAX_CONTENT_WIDTH_MM`). Defaults to `0` for unlimited width. | `0` | ### Clustering | Key | Description | Default | |-----|-------------|---------| -| [`clustering`](./values.yaml#L711) | Clustering settings | | -| [`clustering.enabled`](./values.yaml#L714) | `CLUSTERING_ENABLED`, enable clustering, only works when `replicaCount` is greater than 1 | `false` | -| [`clustering.method`](./values.yaml#L717) | `CLUSTERING_METHOD`, only `kubernetes_dns` is currently supported | `"kubernetes_dns"` | +| [`clustering`](./values.yaml#L720) | Clustering settings | | +| [`clustering.enabled`](./values.yaml#L723) | `CLUSTERING_ENABLED`, enable clustering, only works when `replicaCount` is greater than 1 | `false` | +| [`clustering.method`](./values.yaml#L726) | `CLUSTERING_METHOD`, only `kubernetes_dns` is currently supported | `"kubernetes_dns"` | ### Dashboard | Key | Description | Default | |-----|-------------|---------| -| [`dashboard`](./values.yaml#L728) | Document Engine Dashboard settings | | -| [`dashboard.auth`](./values.yaml#L748) | Dashboard authentication | [...](./values.yaml#L748) | -| [`dashboard.auth.externalSecret`](./values.yaml#L758) | Use an external secret for dashboard credentials | [...](./values.yaml#L758) | -| [`dashboard.auth.externalSecret.name`](./values.yaml#L761) | External secret name | `""` | -| [`dashboard.auth.externalSecret.passwordKey`](./values.yaml#L767) | Secret key name for the password | `"DASHBOARD_PASSWORD"` | -| [`dashboard.auth.externalSecret.usernameKey`](./values.yaml#L764) | Secret key name for the username | `"DASHBOARD_USERNAME"` | -| [`dashboard.auth.password`](./values.yaml#L754) | `DASHBOARD_PASSWORD` — will generate a random password if not set | `""` | -| [`dashboard.auth.username`](./values.yaml#L751) | `DASHBOARD_USERNAME` | `"admin"` | -| [`dashboard.enabled`](./values.yaml#L731) | Enable dashboard | `true` | -| [`dashboard.rateLimitingEnabled`](./values.yaml#L736) | `DASHBOARD_RATE_LIMITING_ENABLED` — enables rate limiting for dashboard authentication to prevent brute force attacks. When enabled, failed authentication attempts are tracked per IP address. | `true` | -| [`dashboard.rateLimitingMaxRequests`](./values.yaml#L740) | `DASHBOARD_RATE_LIMITING_MAX_REQUESTS` — maximum number of failed authentication attempts allowed per IP address within the time window before blocking. | `5` | -| [`dashboard.rateLimitingWindowMs`](./values.yaml#L744) | `DASHBOARD_RATE_LIMITING_WINDOW_MS` — time window in milliseconds for tracking failed authentication attempts. After this period, the counter resets. | `60000` | +| [`dashboard`](./values.yaml#L737) | Document Engine Dashboard settings | | +| [`dashboard.auth`](./values.yaml#L757) | Dashboard authentication | [...](./values.yaml#L757) | +| [`dashboard.auth.externalSecret`](./values.yaml#L767) | Use an external secret for dashboard credentials | [...](./values.yaml#L767) | +| [`dashboard.auth.externalSecret.name`](./values.yaml#L770) | External secret name | `""` | +| [`dashboard.auth.externalSecret.passwordKey`](./values.yaml#L776) | Secret key name for the password | `"DASHBOARD_PASSWORD"` | +| [`dashboard.auth.externalSecret.usernameKey`](./values.yaml#L773) | Secret key name for the username | `"DASHBOARD_USERNAME"` | +| [`dashboard.auth.password`](./values.yaml#L763) | `DASHBOARD_PASSWORD` — will generate a random password if not set | `""` | +| [`dashboard.auth.username`](./values.yaml#L760) | `DASHBOARD_USERNAME` | `"admin"` | +| [`dashboard.enabled`](./values.yaml#L740) | Enable dashboard | `true` | +| [`dashboard.rateLimitingEnabled`](./values.yaml#L745) | `DASHBOARD_RATE_LIMITING_ENABLED` — enables rate limiting for dashboard authentication to prevent brute force attacks. When enabled, failed authentication attempts are tracked per IP address. | `true` | +| [`dashboard.rateLimitingMaxRequests`](./values.yaml#L749) | `DASHBOARD_RATE_LIMITING_MAX_REQUESTS` — maximum number of failed authentication attempts allowed per IP address within the time window before blocking. | `5` | +| [`dashboard.rateLimitingWindowMs`](./values.yaml#L753) | `DASHBOARD_RATE_LIMITING_WINDOW_MS` — time window in milliseconds for tracking failed authentication attempts. After this period, the counter resets. | `60000` | ### Environment | Key | Description | Default | |-----|-------------|---------| -| [`extraEnvFrom`](./values.yaml#L962) | Extra environment variables from resources | `[]` | -| [`extraEnvs`](./values.yaml#L959) | Extra environment variables | `[]` | -| [`extraVolumeMounts`](./values.yaml#L968) | Additional volume mounts for Document Engine container | `[]` | -| [`extraVolumes`](./values.yaml#L965) | Additional volumes | `[]` | -| [`image`](./values.yaml#L919) | Image settings | [...](./values.yaml#L919) | -| [`imagePullSecrets`](./values.yaml#L926) | Pull secrets | `[]` | -| [`initContainers`](./values.yaml#L974) | Init containers | `[]` | -| [`podSecurityContext`](./values.yaml#L945) | Pod security context | `{"fsGroup":999}` | -| [`securityContext`](./values.yaml#L949) | Security context | `{}` | -| [`serviceAccount`](./values.yaml#L938) | ServiceAccount | [...](./values.yaml#L938) | -| [`sidecars`](./values.yaml#L971) | Additional containers | `[]` | +| [`extraEnvFrom`](./values.yaml#L971) | Extra environment variables from resources | `[]` | +| [`extraEnvs`](./values.yaml#L968) | Extra environment variables | `[]` | +| [`extraVolumeMounts`](./values.yaml#L977) | Additional volume mounts for Document Engine container | `[]` | +| [`extraVolumes`](./values.yaml#L974) | Additional volumes | `[]` | +| [`image`](./values.yaml#L928) | Image settings | [...](./values.yaml#L928) | +| [`imagePullSecrets`](./values.yaml#L935) | Pull secrets | `[]` | +| [`initContainers`](./values.yaml#L983) | Init containers | `[]` | +| [`podSecurityContext`](./values.yaml#L954) | Pod security context | `{"fsGroup":999}` | +| [`securityContext`](./values.yaml#L958) | Security context | `{}` | +| [`serviceAccount`](./values.yaml#L947) | ServiceAccount | [...](./values.yaml#L947) | +| [`sidecars`](./values.yaml#L980) | Additional containers | `[]` | ### Metadata | Key | Description | Default | |-----|-------------|---------| -| [`deploymentAnnotations`](./values.yaml#L984) | Workload annotations (`Deployment`/`StatefulSet`) | `{}` | -| [`deploymentExtraSelectorLabels`](./values.yaml#L989) | Additional selector labels for the workload (`Deployment`/`StatefulSet`) **Note:** Kubernetes selectors are immutable. Changing this value after first install may require recreating the workload. | `{}` | -| [`fullnameOverride`](./values.yaml#L933) | Release full name override | `""` | -| [`nameOverride`](./values.yaml#L930) | Release name override | `""` | -| [`podAnnotations`](./values.yaml#L981) | Pod annotations | `{}` | -| [`podLabels`](./values.yaml#L978) | Pod labels | `{}` | +| [`deploymentAnnotations`](./values.yaml#L993) | Workload annotations (`Deployment`/`StatefulSet`) | `{}` | +| [`deploymentExtraSelectorLabels`](./values.yaml#L998) | Additional selector labels for the workload (`Deployment`/`StatefulSet`) **Note:** Kubernetes selectors are immutable. Changing this value after first install may require recreating the workload. | `{}` | +| [`fullnameOverride`](./values.yaml#L942) | Release full name override | `""` | +| [`nameOverride`](./values.yaml#L939) | Release name override | `""` | +| [`podAnnotations`](./values.yaml#L990) | Pod annotations | `{}` | +| [`podLabels`](./values.yaml#L987) | Pod labels | `{}` | ### Networking | Key | Description | Default | |-----|-------------|---------| -| [`envoySidecar`](./values.yaml#L1158) | Envoy sidecar for consistent hashing by document ID | [...](./values.yaml#L1158) | -| [`envoySidecar.adminPort`](./values.yaml#L1174) | Admin port for Envoy | `9901` | -| [`envoySidecar.enabled`](./values.yaml#L1161) | Enable Envoy sidecar for consistent hashing | `false` | -| [`envoySidecar.healthCheck`](./values.yaml#L1178) | Health check configuration for upstream cluster | [...](./values.yaml#L1178) | -| [`envoySidecar.healthCheck.healthyThreshold`](./values.yaml#L1190) | Healthy threshold | `2` | -| [`envoySidecar.healthCheck.interval`](./values.yaml#L1184) | Health check interval | `"10s"` | -| [`envoySidecar.healthCheck.timeout`](./values.yaml#L1181) | Health check timeout | `"5s"` | -| [`envoySidecar.healthCheck.unhealthyThreshold`](./values.yaml#L1187) | Unhealthy threshold | `2` | -| [`envoySidecar.image`](./values.yaml#L1165) | Envoy sidecar image configuration | [...](./values.yaml#L1165) | -| [`envoySidecar.port`](./values.yaml#L1171) | Port where Envoy sidecar listens | `8080` | -| [`envoySidecar.resources`](./values.yaml#L1194) | Resource limits for Envoy sidecar | [...](./values.yaml#L1194) | -| [`extraIngresses`](./values.yaml#L1049) | Additional ingresses, e.g. for the dashboard | [...](./values.yaml#L1049) | -| [`gateway`](./values.yaml#L1065) | Kubernetes [Gateway API](https://gateway-api.sigs.k8s.io/) | [...](./values.yaml#L1065) | -| [`gateway.annotations`](./values.yaml#L1071) | Annotations for the HTTPRoute resource | `{}` | -| [`gateway.enabled`](./values.yaml#L1068) | Enable Gateway API HTTPRoute | `false` | -| [`gateway.extraHTTPRoutes`](./values.yaml#L1139) | Additional HTTPRoutes, e.g. for the dashboard | [...](./values.yaml#L1139) | -| [`gateway.gateway`](./values.yaml#L1101) | Optional [Gateway](https://gateway-api.sigs.k8s.io/api-types/gateway/) resource. Most clusters have Gateways managed by platform teams; enable this only if you want the chart to create one. | [...](./values.yaml#L1101) | -| [`gateway.gateway.addresses`](./values.yaml#L1134) | Gateway [addresses](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayAddress) | `[]` | -| [`gateway.gateway.annotations`](./values.yaml#L1110) | Annotations for the Gateway resource | `{}` | -| [`gateway.gateway.enabled`](./values.yaml#L1104) | Create a Gateway resource | `false` | -| [`gateway.gateway.gatewayClassName`](./values.yaml#L1107) | GatewayClass name (e.g. `amazon-vpc-lattice`, or a custom ALB class) | `""` | -| [`gateway.gateway.infrastructure`](./values.yaml#L1127) | [Infrastructure](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayInfrastructure) parameters, e.g. `parametersRef` for AWS Load Balancer Controller | `{}` | -| [`gateway.gateway.labels`](./values.yaml#L1113) | Labels for the Gateway resource | `{}` | -| [`gateway.gateway.listeners`](./values.yaml#L1116) | Gateway [listeners](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.Listener) | `[]` | -| [`gateway.hostnames`](./values.yaml#L1085) | Hostnames for the HTTPRoute | `[]` | -| [`gateway.labels`](./values.yaml#L1074) | Labels for the HTTPRoute resource | `{}` | -| [`gateway.parentRefs`](./values.yaml#L1079) | References to Gateway resources this route attaches to. When `gateway.gateway.enabled` is true and this is empty, the chart-created Gateway is used automatically. See [ParentRef](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.ParentReference) | `[]` | -| [`gateway.rules`](./values.yaml#L1091) | HTTP routing rules. When empty, a default catch-all rule routing to the chart service is created. When rules are provided without `backendRefs`, the chart service is used as the default backend. | `[]` | -| [`ingress`](./values.yaml#L1014) | Ingress | [...](./values.yaml#L1014) | -| [`ingress.annotations`](./values.yaml#L1023) | Ingress annotations | `{}` | -| [`ingress.className`](./values.yaml#L1020) | Ingress class name | `""` | -| [`ingress.enabled`](./values.yaml#L1017) | Enable ingress | `false` | -| [`ingress.hosts`](./values.yaml#L1026) | Hosts | `[]` | -| [`ingress.tls`](./values.yaml#L1040) | Ingress TLS section | `[]` | -| [`networkPolicy`](./values.yaml#L1206) | [Network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies/) | [...](./values.yaml#L1206) | -| [`networkPolicy.allowExternal`](./values.yaml#L1214) | Allow access from anywhere | `true` | -| [`networkPolicy.allowExternalEgress`](./values.yaml#L1238) | Allow the pod to access any range of port and all destinations. | `true` | -| [`networkPolicy.enabled`](./values.yaml#L1209) | Enable network policy | `true` | -| [`networkPolicy.extraEgress`](./values.yaml#L1241) | Extra egress rules | `[]` | -| [`networkPolicy.extraIngress`](./values.yaml#L1217) | Additional ingress rules | `[]` | -| [`networkPolicy.ingressMatchSelectorLabels`](./values.yaml#L1232) | Allow traffic from other namespaces | `[]` | -| [`service`](./values.yaml#L994) | Service | [...](./values.yaml#L994) | -| [`service.annotations`](./values.yaml#L1003) | Service annotations | `{}` | -| [`service.internalTrafficPolicy`](./values.yaml#L1006) | Service internal traffic policy | `"Cluster"` | -| [`service.port`](./values.yaml#L1000) | Service port — see also `config.port` | `5000` | -| [`service.trafficDistribution`](./values.yaml#L1009) | Service [traffic distribution policy](https://kubernetes.io/docs/concepts/services-networking/service/#traffic-distribution) | `nil` | -| [`service.type`](./values.yaml#L997) | Service type | `"ClusterIP"` | +| [`envoySidecar`](./values.yaml#L1167) | Envoy sidecar for consistent hashing by document ID | [...](./values.yaml#L1167) | +| [`envoySidecar.adminPort`](./values.yaml#L1183) | Admin port for Envoy | `9901` | +| [`envoySidecar.enabled`](./values.yaml#L1170) | Enable Envoy sidecar for consistent hashing | `false` | +| [`envoySidecar.healthCheck`](./values.yaml#L1187) | Health check configuration for upstream cluster | [...](./values.yaml#L1187) | +| [`envoySidecar.healthCheck.healthyThreshold`](./values.yaml#L1199) | Healthy threshold | `2` | +| [`envoySidecar.healthCheck.interval`](./values.yaml#L1193) | Health check interval | `"10s"` | +| [`envoySidecar.healthCheck.timeout`](./values.yaml#L1190) | Health check timeout | `"5s"` | +| [`envoySidecar.healthCheck.unhealthyThreshold`](./values.yaml#L1196) | Unhealthy threshold | `2` | +| [`envoySidecar.image`](./values.yaml#L1174) | Envoy sidecar image configuration | [...](./values.yaml#L1174) | +| [`envoySidecar.port`](./values.yaml#L1180) | Port where Envoy sidecar listens | `8080` | +| [`envoySidecar.resources`](./values.yaml#L1203) | Resource limits for Envoy sidecar | [...](./values.yaml#L1203) | +| [`extraIngresses`](./values.yaml#L1058) | Additional ingresses, e.g. for the dashboard | [...](./values.yaml#L1058) | +| [`gateway`](./values.yaml#L1074) | Kubernetes [Gateway API](https://gateway-api.sigs.k8s.io/) | [...](./values.yaml#L1074) | +| [`gateway.annotations`](./values.yaml#L1080) | Annotations for the HTTPRoute resource | `{}` | +| [`gateway.enabled`](./values.yaml#L1077) | Enable Gateway API HTTPRoute | `false` | +| [`gateway.extraHTTPRoutes`](./values.yaml#L1148) | Additional HTTPRoutes, e.g. for the dashboard | [...](./values.yaml#L1148) | +| [`gateway.gateway`](./values.yaml#L1110) | Optional [Gateway](https://gateway-api.sigs.k8s.io/api-types/gateway/) resource. Most clusters have Gateways managed by platform teams; enable this only if you want the chart to create one. | [...](./values.yaml#L1110) | +| [`gateway.gateway.addresses`](./values.yaml#L1143) | Gateway [addresses](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayAddress) | `[]` | +| [`gateway.gateway.annotations`](./values.yaml#L1119) | Annotations for the Gateway resource | `{}` | +| [`gateway.gateway.enabled`](./values.yaml#L1113) | Create a Gateway resource | `false` | +| [`gateway.gateway.gatewayClassName`](./values.yaml#L1116) | GatewayClass name (e.g. `amazon-vpc-lattice`, or a custom ALB class) | `""` | +| [`gateway.gateway.infrastructure`](./values.yaml#L1136) | [Infrastructure](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.GatewayInfrastructure) parameters, e.g. `parametersRef` for AWS Load Balancer Controller | `{}` | +| [`gateway.gateway.labels`](./values.yaml#L1122) | Labels for the Gateway resource | `{}` | +| [`gateway.gateway.listeners`](./values.yaml#L1125) | Gateway [listeners](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.Listener) | `[]` | +| [`gateway.hostnames`](./values.yaml#L1094) | Hostnames for the HTTPRoute | `[]` | +| [`gateway.labels`](./values.yaml#L1083) | Labels for the HTTPRoute resource | `{}` | +| [`gateway.parentRefs`](./values.yaml#L1088) | References to Gateway resources this route attaches to. When `gateway.gateway.enabled` is true and this is empty, the chart-created Gateway is used automatically. See [ParentRef](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io/v1.ParentReference) | `[]` | +| [`gateway.rules`](./values.yaml#L1100) | HTTP routing rules. When empty, a default catch-all rule routing to the chart service is created. When rules are provided without `backendRefs`, the chart service is used as the default backend. | `[]` | +| [`ingress`](./values.yaml#L1023) | Ingress | [...](./values.yaml#L1023) | +| [`ingress.annotations`](./values.yaml#L1032) | Ingress annotations | `{}` | +| [`ingress.className`](./values.yaml#L1029) | Ingress class name | `""` | +| [`ingress.enabled`](./values.yaml#L1026) | Enable ingress | `false` | +| [`ingress.hosts`](./values.yaml#L1035) | Hosts | `[]` | +| [`ingress.tls`](./values.yaml#L1049) | Ingress TLS section | `[]` | +| [`networkPolicy`](./values.yaml#L1215) | [Network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies/) | [...](./values.yaml#L1215) | +| [`networkPolicy.allowExternal`](./values.yaml#L1223) | Allow access from anywhere | `true` | +| [`networkPolicy.allowExternalEgress`](./values.yaml#L1247) | Allow the pod to access any range of port and all destinations. | `true` | +| [`networkPolicy.enabled`](./values.yaml#L1218) | Enable network policy | `true` | +| [`networkPolicy.extraEgress`](./values.yaml#L1250) | Extra egress rules | `[]` | +| [`networkPolicy.extraIngress`](./values.yaml#L1226) | Additional ingress rules | `[]` | +| [`networkPolicy.ingressMatchSelectorLabels`](./values.yaml#L1241) | Allow traffic from other namespaces | `[]` | +| [`service`](./values.yaml#L1003) | Service | [...](./values.yaml#L1003) | +| [`service.annotations`](./values.yaml#L1012) | Service annotations | `{}` | +| [`service.internalTrafficPolicy`](./values.yaml#L1015) | Service internal traffic policy | `"Cluster"` | +| [`service.port`](./values.yaml#L1009) | Service port — see also `config.port` | `5000` | +| [`service.trafficDistribution`](./values.yaml#L1018) | Service [traffic distribution policy](https://kubernetes.io/docs/concepts/services-networking/service/#traffic-distribution) | `nil` | +| [`service.type`](./values.yaml#L1006) | Service type | `"ClusterIP"` | ### Observability | Key | Description | Default | |-----|-------------|---------| -| [`observability`](./values.yaml#L772) | Observability settings | | -| [`observability.log`](./values.yaml#L776) | Logs | [...](./values.yaml#L776) | -| [`observability.log.healthcheckLevel`](./values.yaml#L791) | `HEALTHCHECK_LOGLEVEL` — log level for health checks | `"debug"` | -| [`observability.log.level`](./values.yaml#L779) | `LOG_LEVEL` | `"info"` | -| [`observability.log.structured`](./values.yaml#L782) | `LOG_STRUCTURED` — enable structured logging in JSON format | `false` | -| [`observability.log.structuredFlatten`](./values.yaml#L788) | `LOG_STRUCTURED_FLATTEN` — when structured logging is enabled, emit `meta`, `location`, `exception`, and `extra` fields as top-level dotted fields (e.g. `meta.event`, `location.file`) instead of nested JSON. Useful for OpenTelemetry collector pipelines and log backends that index top-level attributes. Only applies when `observability.log.structured` is `true`. | `true` | -| [`observability.metrics`](./values.yaml#L826) | Metrics configuration | [...](./values.yaml#L826) | -| [`observability.metrics.customTags`](./values.yaml#L832) | Global metrics tags for all exporters: `METRICS_CUSTOM_TAGS` | *generated* | -| [`observability.metrics.grafanaDashboard`](./values.yaml#L874) | Grafana dashboard | [...](./values.yaml#L874) | -| [`observability.metrics.grafanaDashboard.configMap`](./values.yaml#L882) | ConfigMap parameters | [...](./values.yaml#L882) | -| [`observability.metrics.grafanaDashboard.configMap.labels`](./values.yaml#L885) | ConfigMap labels | `{"grafana_dashboard":"1"}` | -| [`observability.metrics.grafanaDashboard.enabled`](./values.yaml#L878) | Enable Grafana dashboard. To work, requires Prometheus metrics enabled in `observability.metrics.prometheusEndpoint.enabled` | `false` | -| [`observability.metrics.grafanaDashboard.tags`](./values.yaml#L895) | Dashboard tags | `["Nutrient","document-engine"]` | -| [`observability.metrics.grafanaDashboard.title`](./values.yaml#L892) | Dashboard title | *generated* | -| [`observability.metrics.prometheusEndpoint`](./values.yaml#L836) | Prometheus metrics endpoint settings | [...](./values.yaml#L836) | -| [`observability.metrics.prometheusEndpoint.enabled`](./values.yaml#L839) | Enable Prometheus metrics endpoint, `ENABLE_PROMETHEUS` | `false` | -| [`observability.metrics.prometheusEndpoint.port`](./values.yaml#L842) | Port for the Prometheus metrics endpoint, `PROMETHEUS_PORT` | `10254` | -| [`observability.metrics.prometheusRule`](./values.yaml#L866) | Prometheus [PrometheusRule](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PrometheusRule) Requires `observability.metrics.prometheusEndpoint.enabled` to be `true` | [...](./values.yaml#L866) | -| [`observability.metrics.serviceMonitor`](./values.yaml#L851) | Prometheus [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor) Requires `observability.metrics.prometheusEndpoint.enabled` to be `true` | [...](./values.yaml#L851) | -| [`observability.metrics.statsd`](./values.yaml#L901) | StatsD parameters | [...](./values.yaml#L901) | -| [`observability.metrics.statsd.customTags`](./values.yaml#L914) | StatsD custom tags, `STATSD_CUSTOM_TAGS` | `` | -| [`observability.metrics.statsd.port`](./values.yaml#L910) | StatsD port, `STATSD_PORT` | `9125` | -| [`observability.opentelemetry`](./values.yaml#L795) | OpenTelemetry settings | [...](./values.yaml#L795) | -| [`observability.opentelemetry.enabled`](./values.yaml#L798) | Enable OpenTelemetry (`ENABLE_OPENTELEMETRY`), only tracing is currently supported | `false` | -| [`observability.opentelemetry.otelPropagators`](./values.yaml#L814) | `OTEL_PROPAGATORS`, propagators | `""` | -| [`observability.opentelemetry.otelResourceAttributes`](./values.yaml#L811) | `OTEL_RESOURCE_ATTRIBUTES`, resource attributes | `""` | -| [`observability.opentelemetry.otelServiceName`](./values.yaml#L808) | `OTEL_SERVICE_NAME`, service name | `""` | -| [`observability.opentelemetry.otelTracesSampler`](./values.yaml#L819) | `OTEL_TRACES_SAMPLER`, should normally not be touched to allow custom `parent_based` work, but something like `parentbased_traceidratio` may be considered | `""` | -| [`observability.opentelemetry.otelTracesSamplerArg`](./values.yaml#L822) | `OTEL_TRACES_SAMPLER_ARG`, argument for the sampler | `""` | -| [`observability.opentelemetry.otlpExporterEndpoint`](./values.yaml#L802) | https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/ `OTEL_EXPORTER_OTLP_ENDPOINT`, if not set, defaults to `http://localhost:4317` | `""` | -| [`observability.opentelemetry.otlpExporterProtocol`](./values.yaml#L805) | `OTEL_EXPORTER_OTLP_PROTOCOL`, if not set, defaults to `grpc` | `""` | +| [`observability`](./values.yaml#L781) | Observability settings | | +| [`observability.log`](./values.yaml#L785) | Logs | [...](./values.yaml#L785) | +| [`observability.log.healthcheckLevel`](./values.yaml#L800) | `HEALTHCHECK_LOGLEVEL` — log level for health checks | `"debug"` | +| [`observability.log.level`](./values.yaml#L788) | `LOG_LEVEL` | `"info"` | +| [`observability.log.structured`](./values.yaml#L791) | `LOG_STRUCTURED` — enable structured logging in JSON format | `false` | +| [`observability.log.structuredFlatten`](./values.yaml#L797) | `LOG_STRUCTURED_FLATTEN` — when structured logging is enabled, emit `meta`, `location`, `exception`, and `extra` fields as top-level dotted fields (e.g. `meta.event`, `location.file`) instead of nested JSON. Useful for OpenTelemetry collector pipelines and log backends that index top-level attributes. Only applies when `observability.log.structured` is `true`. | `true` | +| [`observability.metrics`](./values.yaml#L835) | Metrics configuration | [...](./values.yaml#L835) | +| [`observability.metrics.customTags`](./values.yaml#L841) | Global metrics tags for all exporters: `METRICS_CUSTOM_TAGS` | *generated* | +| [`observability.metrics.grafanaDashboard`](./values.yaml#L883) | Grafana dashboard | [...](./values.yaml#L883) | +| [`observability.metrics.grafanaDashboard.configMap`](./values.yaml#L891) | ConfigMap parameters | [...](./values.yaml#L891) | +| [`observability.metrics.grafanaDashboard.configMap.labels`](./values.yaml#L894) | ConfigMap labels | `{"grafana_dashboard":"1"}` | +| [`observability.metrics.grafanaDashboard.enabled`](./values.yaml#L887) | Enable Grafana dashboard. To work, requires Prometheus metrics enabled in `observability.metrics.prometheusEndpoint.enabled` | `false` | +| [`observability.metrics.grafanaDashboard.tags`](./values.yaml#L904) | Dashboard tags | `["Nutrient","document-engine"]` | +| [`observability.metrics.grafanaDashboard.title`](./values.yaml#L901) | Dashboard title | *generated* | +| [`observability.metrics.prometheusEndpoint`](./values.yaml#L845) | Prometheus metrics endpoint settings | [...](./values.yaml#L845) | +| [`observability.metrics.prometheusEndpoint.enabled`](./values.yaml#L848) | Enable Prometheus metrics endpoint, `ENABLE_PROMETHEUS` | `false` | +| [`observability.metrics.prometheusEndpoint.port`](./values.yaml#L851) | Port for the Prometheus metrics endpoint, `PROMETHEUS_PORT` | `10254` | +| [`observability.metrics.prometheusRule`](./values.yaml#L875) | Prometheus [PrometheusRule](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.PrometheusRule) Requires `observability.metrics.prometheusEndpoint.enabled` to be `true` | [...](./values.yaml#L875) | +| [`observability.metrics.serviceMonitor`](./values.yaml#L860) | Prometheus [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#monitoring.coreos.com/v1.ServiceMonitor) Requires `observability.metrics.prometheusEndpoint.enabled` to be `true` | [...](./values.yaml#L860) | +| [`observability.metrics.statsd`](./values.yaml#L910) | StatsD parameters | [...](./values.yaml#L910) | +| [`observability.metrics.statsd.customTags`](./values.yaml#L923) | StatsD custom tags, `STATSD_CUSTOM_TAGS` | `` | +| [`observability.metrics.statsd.port`](./values.yaml#L919) | StatsD port, `STATSD_PORT` | `9125` | +| [`observability.opentelemetry`](./values.yaml#L804) | OpenTelemetry settings | [...](./values.yaml#L804) | +| [`observability.opentelemetry.enabled`](./values.yaml#L807) | Enable OpenTelemetry (`ENABLE_OPENTELEMETRY`), only tracing is currently supported | `false` | +| [`observability.opentelemetry.otelPropagators`](./values.yaml#L823) | `OTEL_PROPAGATORS`, propagators | `""` | +| [`observability.opentelemetry.otelResourceAttributes`](./values.yaml#L820) | `OTEL_RESOURCE_ATTRIBUTES`, resource attributes | `""` | +| [`observability.opentelemetry.otelServiceName`](./values.yaml#L817) | `OTEL_SERVICE_NAME`, service name | `""` | +| [`observability.opentelemetry.otelTracesSampler`](./values.yaml#L828) | `OTEL_TRACES_SAMPLER`, should normally not be touched to allow custom `parent_based` work, but something like `parentbased_traceidratio` may be considered | `""` | +| [`observability.opentelemetry.otelTracesSamplerArg`](./values.yaml#L831) | `OTEL_TRACES_SAMPLER_ARG`, argument for the sampler | `""` | +| [`observability.opentelemetry.otlpExporterEndpoint`](./values.yaml#L811) | https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/ `OTEL_EXPORTER_OTLP_ENDPOINT`, if not set, defaults to `http://localhost:4317` | `""` | +| [`observability.opentelemetry.otlpExporterProtocol`](./values.yaml#L814) | `OTEL_EXPORTER_OTLP_PROTOCOL`, if not set, defaults to `grpc` | `""` | ### Pod lifecycle | Key | Description | Default | |-----|-------------|---------| -| [`lifecycle`](./values.yaml#L1301) | [Lifecycle](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) | `map[]` | -| [`livenessProbe`](./values.yaml#L1271) | [Liveness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | [...](./values.yaml#L1271) | -| [`readinessProbe`](./values.yaml#L1284) | [Readiness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | [...](./values.yaml#L1284) | -| [`startupProbe`](./values.yaml#L1258) | [Startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | [...](./values.yaml#L1258) | -| [`terminationGracePeriodSeconds`](./values.yaml#L1297) | [Termination grace period](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/). How long Kubernetes waits after `SIGTERM` before `SIGKILL`. To let a long request finish, keep the pod out of rotation before `SIGTERM` using `lifecycle`, and size this above that delay. | `65` | +| [`lifecycle`](./values.yaml#L1310) | [Lifecycle](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) | `map[]` | +| [`livenessProbe`](./values.yaml#L1280) | [Liveness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | [...](./values.yaml#L1280) | +| [`readinessProbe`](./values.yaml#L1293) | [Readiness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | [...](./values.yaml#L1293) | +| [`startupProbe`](./values.yaml#L1267) | [Startup probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | [...](./values.yaml#L1267) | +| [`terminationGracePeriodSeconds`](./values.yaml#L1306) | [Termination grace period](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/). How long Kubernetes waits after `SIGTERM` before `SIGKILL`. To let a long request finish, keep the pod out of rotation before `SIGTERM` using `lifecycle`, and size this above that delay. | `65` | ### Scheduling | Key | Description | Default | |-----|-------------|---------| -| [`affinity`](./values.yaml#L1356) | Node affinity | `{}` | -| [`autoscaling`](./values.yaml#L1309) | [Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | [...](./values.yaml#L1309) | -| [`nodeSelector`](./values.yaml#L1353) | [Node selector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) | `{}` | -| [`podDisruptionBudget`](./values.yaml#L1346) | [Pod disruption budget](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) | [...](./values.yaml#L1346) | -| [`priorityClassName`](./values.yaml#L1365) | [Priority classs](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/) | `""` | -| [`replicaCount`](./values.yaml#L1334) | Number of replicas | `1` | -| [`resources`](./values.yaml#L1331) | [Resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) | `{}` | -| [`schedulerName`](./values.yaml#L1368) | [Scheduler](https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/) | `""` | -| [`tolerations`](./values.yaml#L1359) | [Node tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) | `[]` | -| [`topologySpreadConstraints`](./values.yaml#L1362) | [Topology spread constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) | `[]` | -| [`updateStrategy`](./values.yaml#L1337) | [Update strategy](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy) | `{"rollingUpdate":{},"type":"RollingUpdate"}` | +| [`affinity`](./values.yaml#L1365) | Node affinity | `{}` | +| [`autoscaling`](./values.yaml#L1318) | [Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) | [...](./values.yaml#L1318) | +| [`nodeSelector`](./values.yaml#L1362) | [Node selector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) | `{}` | +| [`podDisruptionBudget`](./values.yaml#L1355) | [Pod disruption budget](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) | [...](./values.yaml#L1355) | +| [`priorityClassName`](./values.yaml#L1374) | [Priority classs](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/) | `""` | +| [`replicaCount`](./values.yaml#L1343) | Number of replicas | `1` | +| [`resources`](./values.yaml#L1340) | [Resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) | `{}` | +| [`schedulerName`](./values.yaml#L1377) | [Scheduler](https://kubernetes.io/docs/concepts/scheduling-eviction/kube-scheduler/) | `""` | +| [`tolerations`](./values.yaml#L1368) | [Node tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) | `[]` | +| [`topologySpreadConstraints`](./values.yaml#L1371) | [Topology spread constraints](https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/) | `[]` | +| [`updateStrategy`](./values.yaml#L1346) | [Update strategy](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy) | `{"rollingUpdate":{},"type":"RollingUpdate"}` | ### Storage resource definitions | Key | Description | Default | |-----|-------------|---------| -| [`cloudNativePG`](./values.yaml#L1373) | [CloudNativePG](https://cloudnative-pg.io/) resources | [...](./values.yaml#L1373) | -| [`cloudNativePG.clusterAnnotations`](./values.yaml#L1408) | Cluster annotations | `{}` | -| [`cloudNativePG.clusterLabels`](./values.yaml#L1405) | Cluster labels | `{}` | -| [`cloudNativePG.clusterName`](./values.yaml#L1385) | CloudNativePG custom Cluster name | `"{{ .Release.Name }}-postgres"` | -| [`cloudNativePG.clusterSpec`](./values.yaml#L1389) | CloudNativePG [cluster spec](https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-ClusterSpec) | [...](./values.yaml#L1389) | -| [`cloudNativePG.enabled`](./values.yaml#L1376) | Enable CloudNativePG resources | `false` | -| [`cloudNativePG.networkPolicy`](./values.yaml#L1417) | Network policy to allow access to the cluster | `{"enabled":true}` | -| [`cloudNativePG.operatorNamespace`](./values.yaml#L1379) | CloudNativePG operator namespace | `"cnpg-system"` | -| [`cloudNativePG.operatorReleaseName`](./values.yaml#L1382) | CloudNativePG operator release name | `"cloudnative-pg"` | -| [`cloudNativePG.superuserSecret`](./values.yaml#L1411) | Superuser secret to use with the cluster | `{"create":true,"password":"despair","username":"postgres"}` | +| [`cloudNativePG`](./values.yaml#L1382) | [CloudNativePG](https://cloudnative-pg.io/) resources | [...](./values.yaml#L1382) | +| [`cloudNativePG.clusterAnnotations`](./values.yaml#L1417) | Cluster annotations | `{}` | +| [`cloudNativePG.clusterLabels`](./values.yaml#L1414) | Cluster labels | `{}` | +| [`cloudNativePG.clusterName`](./values.yaml#L1394) | CloudNativePG custom Cluster name | `"{{ .Release.Name }}-postgres"` | +| [`cloudNativePG.clusterSpec`](./values.yaml#L1398) | CloudNativePG [cluster spec](https://cloudnative-pg.io/documentation/current/cloudnative-pg.v1/#postgresql-cnpg-io-v1-ClusterSpec) | [...](./values.yaml#L1398) | +| [`cloudNativePG.enabled`](./values.yaml#L1385) | Enable CloudNativePG resources | `false` | +| [`cloudNativePG.networkPolicy`](./values.yaml#L1426) | Network policy to allow access to the cluster | `{"enabled":true}` | +| [`cloudNativePG.operatorNamespace`](./values.yaml#L1388) | CloudNativePG operator namespace | `"cnpg-system"` | +| [`cloudNativePG.operatorReleaseName`](./values.yaml#L1391) | CloudNativePG operator release name | `"cloudnative-pg"` | +| [`cloudNativePG.superuserSecret`](./values.yaml#L1420) | Superuser secret to use with the cluster | `{"create":true,"password":"despair","username":"postgres"}` | ### Other Values | Key | Description | Default | |-----|-------------|---------| -| [`config.hoard.binaryCopyEnabled`](./values.yaml#L254) | `HOARD_BINARY_COPY_ENABLED` — internal parameter, do not change unless explicitly recommended by Nutrient support. | `true` | -| [`config.hoard.binaryCopyThreshold`](./values.yaml#L256) | `HOARD_BINARY_COPY_THRESHOLD` — internal parameter, do not change unless explicitly recommended by Nutrient support. | `2` | -| [`config.http2SharedRendering.checkinTimeoutMilliseconds`](./values.yaml#L267) | `HTTP2_SHARED_RENDERING_PROCESS_CHECKIN_TIMEOUT` — document processing daemon checkin timeout. Do not change unless explicitly recommended by Nutrient support. | `0` | -| [`config.http2SharedRendering.checkoutTimeoutMilliseconds`](./values.yaml#L270) | `HTTP2_SHARED_RENDERING_PROCESS_CHECKOUT_TIMEOUT` — document processing daemon checkout timeout. Do not change unless explicitly recommended by Nutrient support. | `5000` | -| [`revisionHistoryLimit`](./values.yaml#L1341) | [Revision history limit](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy) | `10` | +| [`config.hoard.binaryCopyEnabled`](./values.yaml#L263) | `HOARD_BINARY_COPY_ENABLED` — internal parameter, do not change unless explicitly recommended by Nutrient support. | `true` | +| [`config.hoard.binaryCopyThreshold`](./values.yaml#L265) | `HOARD_BINARY_COPY_THRESHOLD` — internal parameter, do not change unless explicitly recommended by Nutrient support. | `2` | +| [`config.http2SharedRendering.checkinTimeoutMilliseconds`](./values.yaml#L276) | `HTTP2_SHARED_RENDERING_PROCESS_CHECKIN_TIMEOUT` — document processing daemon checkin timeout. Do not change unless explicitly recommended by Nutrient support. | `0` | +| [`config.http2SharedRendering.checkoutTimeoutMilliseconds`](./values.yaml#L279) | `HTTP2_SHARED_RENDERING_PROCESS_CHECKOUT_TIMEOUT` — document processing daemon checkout timeout. Do not change unless explicitly recommended by Nutrient support. | `5000` | +| [`revisionHistoryLimit`](./values.yaml#L1350) | [Revision history limit](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#clean-up-policy) | `10` | ## Contribution diff --git a/charts/document-engine/templates/configmap.yaml b/charts/document-engine/templates/configmap.yaml index efb193b..07177b2 100644 --- a/charts/document-engine/templates/configmap.yaml +++ b/charts/document-engine/templates/configmap.yaml @@ -18,6 +18,9 @@ data: PSPDFKIT_WORKER_POOL_MAX_SECONDS: {{ .Values.config.workerPoolMaxSeconds | quote }} PDF_GENERATION_TIMEOUT: {{ mul 1000 .Values.config.generationTimeoutSeconds | quote }} REMOTE_URL_FETCH_TIMEOUT: {{ mul 1000 .Values.config.urlFetchTimeoutSeconds | quote }} + DOWNLOADER_WORKER_POOL_SIZE: {{ .Values.config.urlFetchPoolSize | quote }} + DOWNLOADER_BROKER_CLIENT_QUEUE_TIMEOUT: {{ mul 1000 .Values.config.urlFetchQueueTimeoutSeconds | quote }} + DOWNLOADER_BROKER_CLIENT_QUEUE_MAX_SIZE: {{ .Values.config.urlFetchQueueMaxSize | quote }} READ_ANNOTATION_BATCH_TIMEOUT: {{ mul 1000 .Values.config.readAnnotationBatchTimeoutSeconds | quote }} {{- with .Values.config.batchRender }} BATCH_RENDER_MAX_CONCURRENCY: {{ .maxConcurrency | quote }} diff --git a/charts/document-engine/values.schema.json b/charts/document-engine/values.schema.json index 88c98a2..02f7a58 100644 --- a/charts/document-engine/values.schema.json +++ b/charts/document-engine/values.schema.json @@ -648,6 +648,18 @@ "trustedProxies": { "type": "string" }, + "urlFetchPoolSize": { + "type": "integer", + "minimum": 1 + }, + "urlFetchQueueMaxSize": { + "type": "integer", + "minimum": 1 + }, + "urlFetchQueueTimeoutSeconds": { + "type": "integer", + "minimum": 1 + }, "urlFetchTimeoutSeconds": { "type": "integer" }, diff --git a/charts/document-engine/values.yaml b/charts/document-engine/values.yaml index c9ea885..9be1d40 100644 --- a/charts/document-engine/values.yaml +++ b/charts/document-engine/values.yaml @@ -107,6 +107,15 @@ config: # -- `REMOTE_URL_FETCH_TIMEOUT` in seconds # @section -- 03. Configuration options urlFetchTimeoutSeconds: 5 + # -- `DOWNLOADER_WORKER_POOL_SIZE`. How many documents are fetched from a remote URL at once, per pod. + # @section -- 03. Configuration options + urlFetchPoolSize: 16 # @schema minimum: 1 + # -- `DOWNLOADER_BROKER_CLIENT_QUEUE_TIMEOUT` in seconds. How long a remote fetch waits for a free slot before it is rejected. A Build API request is rejected with `503`. Should not be greater than `config.requestTimeoutSeconds`. + # @section -- 03. Configuration options + urlFetchQueueTimeoutSeconds: 5 # @schema minimum: 1 + # -- `DOWNLOADER_BROKER_CLIENT_QUEUE_MAX_SIZE`. How many remote fetches may wait for a free slot at once. Once the queue is full, further requests are rejected immediately instead of waiting. + # @section -- 03. Configuration options + urlFetchQueueMaxSize: 128 # @schema minimum: 1 # -- `READ_ANNOTATION_BATCH_TIMEOUT` in seconds # @section -- 03. Configuration options readAnnotationBatchTimeoutSeconds: 20