[v1.29] Add async replication docs #2974
Conversation
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Secrets |  0  0  0  0 |
View in Orca |
|
Great to see you again! Thanks for the contribution. |
| ### Configuring async replication | ||
|
|
||
| :::info Added in `v1.29` | ||
| Async replication support has been added in `v1.26`while the [environment variables](/developers/weaviate/config-refs/env-vars#multi-node-instances) for configuring async replication (`ASYNC_*`) have been introduced in `v1.29`. |
There was a problem hiding this comment.
I wonder if we can remove this altogether - wdyt?
Async replication support has been added in `v1.26`while
| Async replication support has been added in `v1.26`while the [environment variables](/developers/weaviate/config-refs/env-vars#multi-node-instances) for configuring async replication (`ASYNC_*`) have been introduced in `v1.29`. | ||
| ::: | ||
|
|
||
| Async replication is a background synchronization process in Weaviate that ensures eventual consistency across nodes storing the same shard. When a collection is partitioned into multiple shards, each shard is replicated across several nodes (as defined by the replication factor `REPLICATION_MINIMUM_FACTOR`). Async replication guarantees that all nodes holding the same shard remain in sync by periodically comparing and propagating data. |
There was a problem hiding this comment.
I wonder if this belongs more in the concepts section (/developers/weaviate/concepts/replication-architecture/consistency#async-replication). Wdyt?
|
|
||
| Async replication is a background synchronization process in Weaviate that ensures eventual consistency across nodes storing the same shard. When a collection is partitioned into multiple shards, each shard is replicated across several nodes (as defined by the replication factor `REPLICATION_MINIMUM_FACTOR`). Async replication guarantees that all nodes holding the same shard remain in sync by periodically comparing and propagating data. | ||
|
|
||
| #### 1. Periodic data comparison |
There was a problem hiding this comment.
I like the explanation overall.
One question that I have is whether this could be phrased more like a how-to guide. As currently, written, I wonder if it reads more like an explanation, rather than a guide on how to do things.
Ultimately the reader can figure it out by inference, but I wonder if we can make the link more explicit. Wdyt?
What's being changed:
Docs updates for the upcoming v1.29 release concerning the async replication configuration:
Type of change:
How Has This Been Tested?
yarn start