docs: fix configuration reference discrepancies#976
Open
Conversation
… example The blobCache stanza with enabled: false causes a crash loop due to Micronaut eager-loading related beans. The stanza must be omitted entirely when blob cache is not desired. Ref: FD-7221 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
Source: application.yml overrides the @value annotation default of 2.0 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
…64, update image defaults - wave.build.cleanup -> wave.cleanup.strategy (CleanupConfig.groovy:40) - wave.build.singularity-image-arm64 removed (no longer exists in source) - buildkit image: moby/buildkit -> public.cr.seqera.io/wave/buildkit - singularity image: quay.io v3.11.4 -> public.cr.seqera.io/wave v4.2.1-r4 Source: application.yml, CleanupConfig.groovy Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
wave.build.logs.bucket does not exist in source code. wave.build.logs.prefix is auto-computed from wave.build.logs.path. Updated all references to clarify that logs.path and locks.path take full paths (S3 URIs or local). Source: BuildConfig.groovy lines 138, 146, 206 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
Source: K8sHelper.groovy line 96 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
scan.enabled defaults to false per ScanEnabled.groovy. Scanner image is wave/scanner, not aquasec/trivy. Source: ScanEnabled.groovy:34, application.yml Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
build.anonymous: 25/1d -> 10/1h, build.authenticated: 100/1h -> 10/1m, pull.anonymous: 250/1h -> 100/1h, pull.authenticated: 2000/1m -> 100/1m Source: RateLimiterConfig.groovy lines 44-59 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
Property is bound as wave.blobCache.url-signature-duration, not nested under wave.blobCache.cloudflare. Source: BlobCacheConfig.groovy line 102 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
Property paths were flat (blobCache.requestsCpu) but the actual bindings are nested (blobCache.k8s.resources.requests.cpu). Also adds the undocumented limits.cpu and limits.memory properties. Source: BlobCacheConfig.groovy lines 86-99 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
status.delay: 5s -> 2s, status.duration: 5d -> 1h, timeout: 5m -> 10m Source: BlobCacheConfig.groovy lines 43, 54, 57 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
These credentials are unconditionally passed to AwsBasicCredentials.create() in S3ClientFactory, causing NPE if null. IAM-based auth is not yet supported for blob cache. Ref: FD-7221 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
wave.build.cache is bound as a simple String in BuildConfig.groovy, not a nested object with enabled/repository sub-properties. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Rob Syme <rob.syme@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Systematic audit of Wave documentation against source code, triggered by customer crash when enabling blob cache without static credentials. Fixes 10 categories of discrepancies across 5 doc files.
Crash-inducing fixes
blobCache.enabled: falsefrom K8s install example — causes crash loop due to Micronaut eager-loading (install/kubernetes.md)blobCache.storage.accessKey/secretKeyas required — code unconditionally passes toAwsBasicCredentials.create(), NPE if null (configuration.md)build.cachefrom nested object to flat string —BuildConfig.groovybinds as@Value('${wave.build.cache}') String, not a map (configure-wave.md)Silent misconfiguration fixes
blobCache.requestsCpu/Memoryproperty paths — docs said flatblobCache.requestsCpu, code usesblobCache.k8s.resources.requests.cpu; also adds undocumentedlimitspropertiesurlSignatureDurationpath — docs nested undercloudflare, code binds atblobCache.url-signature-durationwave.build.cleanup— property renamed towave.cleanup.strategyin Sep 2024Default value corrections
status.delay5s→2s,status.duration5d→1h,timeout5m→10mpublic.cr.seqera.io/wave/...)build.anonymous25/1d→10/1h)Phantom property removal
wave.build.logs.bucket— removed from code in May 2025; updated acrossconfiguration.md,db-migration.md,migrations/1-21-0.mdwave.build.logs.prefix— auto-computed, never configurablewave.build.singularity-image-arm64— removed from codebaseOther
node-selectorvalue format (key=value)All discrepancies verified on both
masterandv1.32.2.Files changed
docs/configuration.md— bulk of fixesdocs/configure-wave.md— build cache YAML structuredocs/install/kubernetes.md— remove crash-inducing exampledocs/db-migration.md— remove phantomlogs.bucketreferencedocs/migrations/1-21-0.md— remove phantomlogs.bucketreferenceTest plan
blobCachestanza is absent from K8s install ConfigMap example🤖 Generated with Claude Code