status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add known issues to Raft WAL docs. (#16600) 

* Add known issues to Raft WAL docs.

* Refactor update based on review feedback
This commit is contained in:
Paul Banks 2023-03-15 04:21:31 +00:00 committed by GitHub
parent ad25ba3068
commit e557fb4e8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/content/docs/agent/wal-logstore/enable.mdx
View File

@ -19,7 +19,7 @@ The overall process for enabling the WAL LogStore backend for one server consist
1. Start the target server. 1. Start the target server.
1. Monitor target server raft metrics and logs. 1. Monitor target server raft metrics and logs.
!> **Experimental feature:** The WAL LogStore backend is experimental. !> **Experimental feature:** The WAL LogStore backend is experimental and may contain bugs that could cause data loss. Follow this guide to manage risk during testing.
## Requirements ## Requirements
@ -32,6 +32,15 @@ We recommend taking the following additional measures:
- Monitor Consul server metrics and logs, and set an alert on specific log events that occur when WAL is enabled. Refer to [Monitor Raft metrics and logs for WAL](/consul/docs/agent/wal-logstore/monitoring) for more information. - Monitor Consul server metrics and logs, and set an alert on specific log events that occur when WAL is enabled. Refer to [Monitor Raft metrics and logs for WAL](/consul/docs/agent/wal-logstore/monitoring) for more information.
- Enable WAL in a pre-production environment and run it for a several days before enabling it in production. - Enable WAL in a pre-production environment and run it for a several days before enabling it in production.
## Known issues
The following issues were discovered after release of Consul 1.15.1 and will be
fixed in a future patch release.
* A follower that is disconnected 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.
## Risks ## Risks
While their likelihood remains low to very low, be aware of the following risks before implementing the WAL backend: While their likelihood remains low to very low, be aware of the following risks before implementing the WAL backend:

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

@ -7,9 +7,14 @@ description: >-
# Experimental WAL LogStore backend overview # Experimental WAL LogStore backend overview
This topic provides an overview of the experimental WAL (write-ahead log) LogStore backend. This topic provides an overview of the WAL (write-ahead log) LogStore backend.
The WAL backend is an experimental feature. Refer to
[Requirements](/consul/docs/agent/wal-logstore/enable#requirements) for
supported environments and known issues.
!> **Experimental feature:** The WAL LogStore backend is experimental. We do not recommend enabling the WAL backend in production without following
[our guide for safe
testing](/consul/docs/agent/wal-logstore/enable).
## WAL versus BoltDB ## WAL versus BoltDB