Skip to content

Commit 32807f5

Browse files
authored
Merge pull request #7435 from fabriziopandini/clarify-clusterctl-move-limitations
📖 Clarify clusterctl move supported use case and limitations
2 parents fa1bd81 + 104ea10 commit 32807f5

File tree

1 file changed

+22
-0
lines changed
  • docs/book/src/clusterctl/commands

1 file changed

+22
-0
lines changed

docs/book/src/clusterctl/commands/move.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,28 @@ process completes.
3636

3737
</aside>
3838

39+
<aside class="note warning">
40+
41+
<h1> Warning </h1>
42+
43+
`clusterctl move` has been designed and developed around the bootstrap use case described below, and currently this is the only
44+
use case verified by Cluster API E2E tests.
45+
46+
If someone intends to use `clusterctl move` outside of this scenario, it's recommended to set up a custom validation pipeline of
47+
it before using the command on a production environment.
48+
49+
Also, it is important to notice that move has not been designed for being used as a backup/restore solution and it has
50+
several limitation for this scenario, like e.g. the implementation assumes the cluster must be stable
51+
while doing the move operation, and possible race conditions happening while the cluster is upgrading, scaling up,
52+
remediating etc. has never been investigated nor addressed.
53+
54+
In order to avoid further confusion about this point, `clusterctl backup` and `clusterctl restore` commands have been
55+
deprecated because they were built on top of `clusterctl move` logic and they were sharing he same limitations.
56+
User can use `clusterctl move --to-directory` and `clusterctl move --from-directory` instead; this will hopefully
57+
make it clear those operation have the same limitations of the move command.
58+
59+
</aside>
60+
3961
## Pivot
4062

4163
Pivoting is a process for moving the provider components and declared Cluster API resources from a source management

0 commit comments

Comments
 (0)