github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add known issues to Raft WAL docs.

pull/16600/head
Paul Banks 2023-03-10 13:32:53 +00:00 committed by GitHub
parent 40312ac072
commit 00ca421957
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/content/docs/agent/wal-logstore/index.mdx
View File

@ -11,6 +11,8 @@ This topic provides an overview of the experimental WAL (write-ahead log) LogSto
!> **Experimental feature:** The WAL LogStore backend is experimental.
!> **Known Issues:** Consul 1.15.0 and 1.15.1 have [known issues](#known-issues) so should not have WAL enabled in production.
## WAL versus BoltDB
WAL implements a traditional log with rotating, append-only log files. WAL resolves many issues with the existing `LogStore` provided by the BoltDB backend. The BoltDB `LogStore` is a copy-on-write BTree, which is not optimized for append-only, write-heavy workloads.
@ -45,4 +47,12 @@ The WAL backend has been tested thoroughly during development:
We are aware of how complex and critical disk-persistence is for your data.
We hope that many users at different scales will try WAL in their environments after upgrading to 1.15 or later and report success or failure so that we can confidently replace BoltDB as the default for new clusters in a future release.
We hope that many users at different scales will try WAL in their environments after upgrading to 1.15 or later and report success or failure so that we can confidently replace BoltDB as the default for new clusters in a future release.
## Known Issues
The following issues were discovered after release of Consul 1.15.1. Fixes should be available in the next patch release.
* A follower that is disconnected for a while may be unable to catch up if it is using the WAL backend.
* Restoring user snapshots can break replication to WAL-enabled followers.
* Restoring user snapshots can cause a WAL-enabled leader to panic.