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

Refactor update based on review feedback

pull/16600/head
Paul Banks 2023-03-13 17:38:16 +00:00
parent 00ca421957
commit 2e3c67c773
2 changed files with 22 additions and 18 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. 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
@ -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.
- 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
While their likelihood remains low to very low, be aware of the following risks before implementing the WAL backend:

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

@ -7,11 +7,14 @@ description: >-
# 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.
!> **Known Issues:** Consul 1.15.0 and 1.15.1 have [known issues](#known-issues) so should not have WAL enabled in production.
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
@ -48,11 +51,3 @@ 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.
## 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.