Skip to content

Commit fa20ef7

Browse files
Copiloteddyashtonachamayou
authored
Deprecate snapshots.read_only_directory configuration option (#7800)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: eddyashton <6000239+eddyashton@users.noreply.github.com> Co-authored-by: Amaury Chamayou <amchamay@microsoft.com>
1 parent 880a0b5 commit fa20ef7

3 files changed

Lines changed: 11 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1818
- The `ConsensusCommittedEndpointFunction` callback signature now receives a `CommittedTxInfo&` struct (containing `rpc_ctx`, `tx_id`, `status`, `write_set_digest`, `commit_evidence`, `claims_digest`) instead of individual arguments. This enables commit callbacks to construct receipts inline (#7785).
1919
- `ccf::endpoints::default_respond_on_commit_func` has been removed from the public API. A sample implementation is provided in the logging and basic sample apps (#7785).
2020

21+
### Deprecated
22+
23+
- `snapshots.read_only_directory` configuration option is deprecated and will be removed in a future release. A warning will be logged if this option is set at startup. Use `snapshots.backup_fetch` to have backup nodes automatically fetch snapshots from the primary node instead.
24+
2125
## [7.0.0-rc0]
2226

2327
[7.0.0-rc0]: https://github.com/microsoft/CCF/releases/tag/ccf-7.0.0-rc0

doc/host_config_schema/cchost_config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@
507507
},
508508
"read_only_directory": {
509509
"type": ["string", "null"],
510-
"description": "Path to read-only snapshots directory"
510+
"description": "Path to read-only snapshots directory. Deprecated: this option is deprecated and will be removed in a future release. Use join.fetch_recent_snapshot and snapshots.backup_fetch to have joining and/or backup nodes automatically fetch snapshots from the primary node instead."
511511
},
512512
"backup_fetch": {
513513
"type": "object",

src/host/run.cpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,12 @@ namespace ccf
615615
config.ledger.read_only_directories);
616616
ledger.register_message_handlers(buffer_processor.get_dispatcher());
617617

618+
if (config.snapshots.read_only_directory.has_value())
619+
{
620+
LOG_INFO_FMT(
621+
"snapshots.read_only_directory is deprecated and will be removed in a "
622+
"future release");
623+
}
618624
snapshots::SnapshotManager snapshots(
619625
config.snapshots.directory,
620626
writer_factory,

0 commit comments

Comments
 (0)