Skip to content

document-engine-3.0.4

Compare
Choose a tag to compare
@github-actions github-actions released this 22 Aug 04:02
7db8196

Warning

Breaking changes.
We hope that values.yaml will now be much more readable and usable.

Changed

  • Massive internal refactoring.
  • Documentation generation.
  • pspdfkit.license.isOffline is removed, as it is no longer necessary
  • pspdfkit.license section moved to the top level as documentEngineLicense.
  • pspdfkit.auth.api section moved to the top level as apiAuth, both pspdfkit.auth.api.apiToken and pspdfkit.auth.api.jwt section.
  • pspdfkit.secretKeyBase restructured:
    • pspdfkit.secretKeyBase.value moved to apiAuth.secretKeyBase
    • Former optional pspdfkit.secretKeyBase.externalSecret integrated into apiAuth.externalSecret:
      • In case apiAuth.externalSecret.secretKeyBaseKey is set, the value is used.
  • pspdfkit.storage.cleanupJob becomes documentLifecycle.cleanupJob
  • Database-related part of pspdfkit.storage moved to database:
    • pspdfkit.storage.postgres.enabled becomes database.enabled
    • The rest of pspdfkit.storage.postgres becomes database.postgres
    • pspdfkit.storage.databaseEngine becomes database.engine, only postgres is currently supported (formerly postgresql)
    • pspdfkit.storage.databaseConnections becomes database.connections
    • pspdfkit.storage.databaseMigrationJob becomes database.migrationJob
  • The remaining pspdfkit.storage section moved to the top level as assetStorage.
    • pspdfkit.assetStorageCacheSizeMegaBytes renamed to assetStorage.localCacheSizeMegabytes.
    • pspdfkit.storage.assetStorageBackend renamed to assetStorage.backendType
    • pspdfkit.storage.enableAssetStorageFallback* moved to assetStorage.backendFallback section
    • pspdfkit.storage.redis.useTtlForPrerendering renamed to assetStorage.redis.useTtl
  • pspdfkit.signingService section moved to the top level as documentSigningService.
    • pspdfkit.signingService.digitalSignatureHashAlgorithm renamed to documentSigningService.hashAlgorithm
    • pspdfkit.signingService.digitalSignatureCadesLevel renamed to documentSigningService.cadesLevel
    • pspdfkit.signingService.digitalSignatureCertificateCheckTime renamed to documentSigningService.certificateCheckTime
  • Certificate trust configuration restructured into the new certificateTrust section:
    • Map pspdfkit.signingTrustConfigMaps becomes list certificateTrust.digitalSignatures allowing both ConfigMaps and Secrets
    • Map pspdfkit.trustConfigMaps becomes list certificateTrust.customCertificates allowing both ConfigMaps and Secrets
    • pspdfkit.downloaderTrustFileName moved to certificateTrust.downloaderTrustFileName and is now empty by default which will set HTTP client trust to Mozilla CA bundle
    • assetStorage.postgres.tls.trustFileName will assume a file name from /certificate-stores-custom, which is filled from certificateTrust.customCertificates
  • pspdfkit.observability section moved to the top level as observability.
    • pspdfkit.log.level moved into observability.log.level.
    • metrics section moved to observability.metrics.
  • pspdfkit.auth.dashboard section became dashboard:
    • pspdfkit.auth.dashboard.enabled renamed to dashboard.enabled
    • The rest of the former section to pspdfkit.dashboard.auth
  • The remaining pspdfkit section renamed to config.
  • Aligned default values with the default Document Engine configuration values, affects the following default values:
    • config.workerPoolSize changed from 8 to 16
    • config.maxUploadSizeMegaBytes changed from 128 to 950
    • config.urlFetchTimeoutSeconds changed from 20 to 5
    • config.generationTimeoutSeconds changed from 120 to 20
    • config.requestTimeoutSeconds changed from 120 to 60
    • config.automaticLinkExtraction changed from true to false
  • Exceptions to the previous list:
    • config.trustedProxies is left as default for safety reasons

Added

  • Health check log level as observability.healthcheckLevel.
  • Direct trust bundle for PostgreSQL as assetStorage.postgres.trustBundle.
  • Option for host verification of PostgreSQL, assetStorage.postgres.hostVerify.
  • Worker timeout in seconds as config.workerTimeoutSeconds.
  • Asynchronous jobs timeout in seconds as config.asyncJobsTtlSeconds.
  • HTTP proxy settings: config.proxy.http for HTTP and config.proxy.https for HTTPS
  • Explicit StatsD exporting parameters in observability.metrics.statsd section.
  • One more chart test.