refactor(config): unify OB_* env vars onto the OPENBUCKET_* prefix (1.0 prep) - #61
Merged
Merged
Conversation
….0 prep) The standalone env-var feature blocks were inconsistently prefixed: replication/backup/integrity used OB_* while tiering/endpoint/region/sse used OPENBUCKET_*. Standardize onto OPENBUCKET_* before 1.0. Renames (hard rename, no backward-compat aliases): - OB_REPLICATION_* -> OPENBUCKET_REPLICATION_* - OB_SCHEDULED_BACKUP_* -> OPENBUCKET_SCHEDULED_BACKUP_* - OB_INTEGRITY_* -> OPENBUCKET_INTEGRITY_* Applied across the Zod env schema + superRefine, config-source mapping, app-config getters, replication/backup config resolvers, the secret-redaction serializer, tests, .env.example, README config tables, PM docs, and the Docusaurus guides/reference. Bare core vars and already-bare feature knobs (WEBHOOK_*, METRICS_*, RESTORE_*, KEY_ENCRYPTION_SECRET, ...) are untouched, as is the OB_FAULT test-harness knob and the programmatic forRoot API. Also (NH-1) documents that a few standalone features (KEY_ENCRYPTION_SECRET, the cold-tiering OPENBUCKET_TIER_* family) are env-only with no forRoot counterpart — the library options are a deliberate subset. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.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
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.
What
Standalone env-var feature blocks were inconsistently prefixed: replication, scheduled-backup, and integrity-scrub used
OB_*, while every other feature block (tiering, endpoint, region, SSE) usedOPENBUCKET_*. This unifies the three stragglers ontoOPENBUCKET_*before 1.0.Why
The standalone env vars are the Docker/compose users' stable API. Pre-1.0 is the moment to remove the
OB_*vsOPENBUCKET_*inconsistency (API review MF-6) so the 1.0 surface is uniform.Rename table
OB_REPLICATION_*OPENBUCKET_REPLICATION_*OB_SCHEDULED_BACKUP_*OPENBUCKET_SCHEDULED_BACKUP_*OB_INTEGRITY_*OPENBUCKET_INTEGRITY_*Breaking change
This is a pre-1.0 hard rename with no backward-compatible aliases — the old
OB_*names are no longer read. Standalone operators must update their.env/ compose / deploy config. The bare core vars (DATA_DIR,JWT_SECRET,ROOT_ACCESS_KEY_ID,PORT, …) and the already-bare feature knobs (WEBHOOK_*,METRICS_*,RESTORE_*,KEY_ENCRYPTION_SECRET, …) are unchanged, as is the internalOB_FAULTtest-harness knob and the programmaticOpenBucketModule.forRootAPI.Scope
Applied consistently across: the Zod env schema +
superRefinecross-field checks,config-sourceoption→env mapping,app-configgetters, the replication/backup config resolvers, the secret-redaction serializer, all tests,.env.example, README config tables, PM docs (stories/tasks/test-plans), and the Docusaurus guides + reference.Also documents (NH-1) that a few standalone features (
KEY_ENCRYPTION_SECRET, the cold-tieringOPENBUCKET_TIER_*family) are env-only with noforRootcounterpart — the library options are a deliberate subset.Verification
npx nx build nestjs— passnpx nx test nestjs— 138 suites / 1199 tests pass (1 skipped)npx nx lint nestjs— 0 errors (92 pre-existing warnings, unrelated files)apps/docsdocusaurus build— succeeds (only the one pre-existing "Noncharacter in input stream" minifier warning on the whitepaper page)OB_REPLICATION/OB_SCHEDULED_BACKUP/OB_INTEGRITYreferences remain except the CHANGELOG rename note🤖 Generated with Claude Code