Skip to content

Commit e65a322

Browse files
authored
Note that WAL failover path may *not* be relocated (#20313)
Fixes DOC-10998 NB. Ported changes to supported versions v24.1+
1 parent e323711 commit e65a322

File tree

5 files changed

+40
-0
lines changed

5 files changed

+40
-0
lines changed

src/current/v24.1/wal-failover.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,14 @@ No, the secondary (failover) disk **must be durable and retain its data across V
478478

479479
Always provision the failover disk with the same persistence guarantees as the primary store.
480480

481+
### 14. Can I relocate or rename the WAL directory?
482+
483+
No. When WAL failover is enabled, the WAL directory path is stored as an absolute path in the [store]({% link {{ page.version.version}}/cockroach-start.md %}#store)'s data. It is not treated as a relative path. As a result, it is not sufficient to stop CockroachDB, move or rename that directory, and restart with a different `--wal-failover` path.
484+
485+
Instead, to change the WAL directory path, you must first [disable WAL failover]({% link {{ page.version.version }}/cockroach-start.md %}#disable-wal-failover), [restart the node(s)]({% link {{ page.version.version }}/node-shutdown.md %}#stop-and-restart-a-node), and then [re-enable WAL failover with the new path]({% link {{ page.version.version }}/cockroach-start.md %}#enable-wal-failover).
486+
487+
Using filesystem indirection such as symlinks or mount-point changes is not supported or tested by Cockroach Labs.
488+
481489
## Video demo: WAL failover
482490

483491
For a demo of WAL Failover in CockroachDB and what happens when you enable or disable it, play the following video:

src/current/v24.3/wal-failover.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,14 @@ No, the secondary (failover) disk **must be durable and retain its data across V
476476

477477
Always provision the failover disk with the same persistence guarantees as the primary store.
478478

479+
### 14. Can I relocate or rename the WAL directory?
480+
481+
No. When WAL failover is enabled, the WAL directory path is stored as an absolute path in the [store]({% link {{ page.version.version}}/cockroach-start.md %}#store)'s data. It is not treated as a relative path. As a result, it is not sufficient to stop CockroachDB, move or rename that directory, and restart with a different `--wal-failover` path.
482+
483+
Instead, to change the WAL directory path, you must first [disable WAL failover]({% link {{ page.version.version }}/cockroach-start.md %}#disable-wal-failover), [restart the node(s)]({% link {{ page.version.version }}/node-shutdown.md %}#stop-and-restart-a-node), and then [re-enable WAL failover with the new path]({% link {{ page.version.version }}/cockroach-start.md %}#enable-wal-failover).
484+
485+
Using filesystem indirection such as symlinks or mount-point changes is not supported or tested by Cockroach Labs.
486+
479487
## Video demo: WAL failover
480488

481489
For a demo of WAL Failover in CockroachDB and what happens when you enable or disable it, play the following video:

src/current/v25.2/wal-failover.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,14 @@ No, the secondary (failover) disk **must be durable and retain its data across V
476476

477477
Always provision the failover disk with the same persistence guarantees as the primary store.
478478

479+
### 14. Can I relocate or rename the WAL directory?
480+
481+
No. When WAL failover is enabled, the WAL directory path is stored as an absolute path in the [store]({% link {{ page.version.version}}/cockroach-start.md %}#store)'s data. It is not treated as a relative path. As a result, it is not sufficient to stop CockroachDB, move or rename that directory, and restart with a different `--wal-failover` path.
482+
483+
Instead, to change the WAL directory path, you must first [disable WAL failover]({% link {{ page.version.version }}/cockroach-start.md %}#disable-wal-failover), [restart the node(s)]({% link {{ page.version.version }}/node-shutdown.md %}#stop-and-restart-a-node), and then [re-enable WAL failover with the new path]({% link {{ page.version.version }}/cockroach-start.md %}#enable-wal-failover).
484+
485+
Using filesystem indirection such as symlinks or mount-point changes is not supported or tested by Cockroach Labs.
486+
479487
## Video demo: WAL failover
480488

481489
For a demo of WAL Failover in CockroachDB and what happens when you enable or disable it, play the following video:

src/current/v25.3/wal-failover.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,14 @@ No, the secondary (failover) disk **must be durable and retain its data across V
476476

477477
Always provision the failover disk with the same persistence guarantees as the primary store.
478478

479+
### 14. Can I relocate or rename the WAL directory?
480+
481+
No. When WAL failover is enabled, the WAL directory path is stored as an absolute path in the [store]({% link {{ page.version.version}}/cockroach-start.md %}#store)'s data. It is not treated as a relative path. As a result, it is not sufficient to stop CockroachDB, move or rename that directory, and restart with a different `--wal-failover` path.
482+
483+
Instead, to change the WAL directory path, you must first [disable WAL failover]({% link {{ page.version.version }}/cockroach-start.md %}#disable-wal-failover), [restart the node(s)]({% link {{ page.version.version }}/node-shutdown.md %}#stop-and-restart-a-node), and then [re-enable WAL failover with the new path]({% link {{ page.version.version }}/cockroach-start.md %}#enable-wal-failover).
484+
485+
Using filesystem indirection such as symlinks or mount-point changes is not supported or tested by Cockroach Labs.
486+
479487
## Video demo: WAL failover
480488

481489
For a demo of WAL Failover in CockroachDB and what happens when you enable or disable it, play the following video:

src/current/v25.4/wal-failover.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,14 @@ No, the secondary (failover) disk **must be durable and retain its data across V
476476

477477
Always provision the failover disk with the same persistence guarantees as the primary store.
478478

479+
### 14. Can I relocate or rename the WAL directory?
480+
481+
No. When WAL failover is enabled, the WAL directory path is stored as an absolute path in the [store]({% link {{ page.version.version}}/cockroach-start.md %}#store)'s data. It is not treated as a relative path. As a result, it is not sufficient to stop CockroachDB, move or rename that directory, and restart with a different `--wal-failover` path.
482+
483+
Instead, to change the WAL directory path, you must first [disable WAL failover]({% link {{ page.version.version }}/cockroach-start.md %}#disable-wal-failover), [restart the node(s)]({% link {{ page.version.version }}/node-shutdown.md %}#stop-and-restart-a-node), and then [re-enable WAL failover with the new path]({% link {{ page.version.version }}/cockroach-start.md %}#enable-wal-failover).
484+
485+
Using filesystem indirection such as symlinks or mount-point changes is not supported or tested by Cockroach Labs.
486+
479487
## Video demo: WAL failover
480488

481489
For a demo of WAL Failover in CockroachDB and what happens when you enable or disable it, play the following video:

0 commit comments

Comments
 (0)