document-engine-3.0.4
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 necessarypspdfkit.license
section moved to the top level asdocumentEngineLicense
.pspdfkit.auth.api
section moved to the top level asapiAuth
, bothpspdfkit.auth.api.apiToken
andpspdfkit.auth.api.jwt
section.pspdfkit.secretKeyBase
restructured:pspdfkit.secretKeyBase.value
moved toapiAuth.secretKeyBase
- Former optional
pspdfkit.secretKeyBase.externalSecret
integrated intoapiAuth.externalSecret
:- In case
apiAuth.externalSecret.secretKeyBaseKey
is set, the value is used.
- In case
pspdfkit.storage.cleanupJob
becomesdocumentLifecycle.cleanupJob
- Database-related part of
pspdfkit.storage
moved todatabase
:pspdfkit.storage.postgres.enabled
becomesdatabase.enabled
- The rest of
pspdfkit.storage.postgres
becomesdatabase.postgres
pspdfkit.storage.databaseEngine
becomesdatabase.engine
, onlypostgres
is currently supported (formerlypostgresql
)pspdfkit.storage.databaseConnections
becomesdatabase.connections
pspdfkit.storage.databaseMigrationJob
becomesdatabase.migrationJob
- The remaining
pspdfkit.storage
section moved to the top level asassetStorage
.pspdfkit.assetStorageCacheSizeMegaBytes
renamed toassetStorage.localCacheSizeMegabytes
.pspdfkit.storage.assetStorageBackend
renamed toassetStorage.backendType
pspdfkit.storage.enableAssetStorageFallback*
moved toassetStorage.backendFallback
sectionpspdfkit.storage.redis.useTtlForPrerendering
renamed toassetStorage.redis.useTtl
pspdfkit.signingService
section moved to the top level asdocumentSigningService
.pspdfkit.signingService.digitalSignatureHashAlgorithm
renamed todocumentSigningService.hashAlgorithm
pspdfkit.signingService.digitalSignatureCadesLevel
renamed todocumentSigningService.cadesLevel
pspdfkit.signingService.digitalSignatureCertificateCheckTime
renamed todocumentSigningService.certificateCheckTime
- Certificate trust configuration restructured into the new
certificateTrust
section:- Map
pspdfkit.signingTrustConfigMaps
becomes listcertificateTrust.digitalSignatures
allowing both ConfigMaps and Secrets - Map
pspdfkit.trustConfigMaps
becomes listcertificateTrust.customCertificates
allowing both ConfigMaps and Secrets pspdfkit.downloaderTrustFileName
moved tocertificateTrust.downloaderTrustFileName
and is now empty by default which will set HTTP client trust to Mozilla CA bundleassetStorage.postgres.tls.trustFileName
will assume a file name from/certificate-stores-custom
, which is filled fromcertificateTrust.customCertificates
- Map
pspdfkit.observability
section moved to the top level asobservability
.pspdfkit.log.level
moved intoobservability.log.level
.metrics
section moved toobservability.metrics
.
pspdfkit.auth.dashboard
section becamedashboard
:pspdfkit.auth.dashboard.enabled
renamed todashboard.enabled
- The rest of the former section to
pspdfkit.dashboard.auth
- The remaining
pspdfkit
section renamed toconfig
. - Aligned default values with the default Document Engine configuration values, affects the following default values:
config.workerPoolSize
changed from8
to16
config.maxUploadSizeMegaBytes
changed from128
to950
config.urlFetchTimeoutSeconds
changed from20
to5
config.generationTimeoutSeconds
changed from120
to20
config.requestTimeoutSeconds
changed from120
to60
config.automaticLinkExtraction
changed fromtrue
tofalse
- Exceptions to the previous list:
config.trustedProxies
is left asdefault
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 andconfig.proxy.https
for HTTPS - Explicit StatsD exporting parameters in
observability.metrics.statsd
section. - One more chart test.