feat: implement comprehensive global replica defaults #746
Conversation
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
This feature allows users to define global default settings for replica configurations,
eliminating the need to duplicate common settings across multiple database entries.
## What's Changed
- **New ReplicaSettings struct**: Contains all configurable replica fields (S3, ABS, SFTP, NATS, Age encryption, timing settings)
- **Embedded in Config**: Global defaults can be set at the top level of configuration files
- **Embedded in ReplicaConfig**: Individual replicas inherit from global settings but can override any field
- **Smart default propagation**: SetDefaults() method merges global settings with replica-specific settings
- **Full backward compatibility**: Existing configurations continue to work unchanged
- **Comprehensive test coverage**: Tests cover all replica types and override scenarios
## Supported Global Settings
- **S3**: access-key-id, secret-access-key, region, endpoint, force-path-style, skip-verify
- **ABS**: account-name, account-key
- **SFTP**: host, user, password, key-path, concurrent-writes
- **NATS**: jwt, seed, creds, nkey, username, token, tls, root-cas, client-cert, client-key, etc.
- **Timing**: sync-interval, validation-interval
- **Encryption**: age identities and recipients
## Example Configuration
Before (verbose with duplication):
```yaml
dbs:
- path: /db1.sqlite
replica:
type: s3
access-key-id: AKIA...
secret-access-key: xxx...
region: us-west-2
endpoint: custom.endpoint.com
bucket: bucket1
- path: /db2.sqlite
replica:
type: s3
access-key-id: AKIA... # duplicated
secret-access-key: xxx... # duplicated
region: us-west-2 # duplicated
endpoint: custom.endpoint.com # duplicated
bucket: bucket2
```
After (clean with global defaults):
```yaml
# Global defaults
access-key-id: AKIA...
secret-access-key: xxx...
region: us-west-2
endpoint: custom.endpoint.com
dbs:
- path: /db1.sqlite
replica:
type: s3
bucket: bucket1
- path: /db2.sqlite
replica:
type: s3
bucket: bucket2
```
Fixes #504
Closes #553
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Consolidate tests into existing test file instead of creating a separate file. All tests remain unchanged, just moved to the appropriate location.
corylanou
force-pushed
the
feature/global-replica-defaults
branch
from
dfab6a2 to
b8dc34c
Compare
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.
Summary
Implements comprehensive global replica defaults to eliminate configuration duplication. This addresses issue #504 and replaces the outdated PR #553.
Users can now set global default settings for replica configurations at the top level of their configuration files, which are automatically inherited by all replicas while still allowing per-replica overrides.
Key Features
Configuration Examples
Before: Verbose with duplication
After: Clean with global defaults
Multi-replica-type example
Global Settings Supported
All Replica Types:
sync-intervalvalidation-intervalS3 & Compatible:
access-key-id,secret-access-keyregion,endpointforce-path-style,skip-verifyAzure Blob Storage:
account-name,account-keySFTP:
host,user,password,key-pathconcurrent-writesNATS JetStream:
jwt,seed,creds,nkeyusername,password,tokentls,root-cas,client-cert,client-keymax-reconnects,reconnect-wait,timeoutAge Encryption:
age.identities[],age.recipients[]Implementation Details
ReplicaSettingsstruct: Contains all shared replica configuration fieldsSetDefaults()method handles inheritance with override logicTesting
Added comprehensive test coverage including:
replicas:array format supportRelated
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com