Skip to content

Commit 0bc7d9a

Browse files
committed
Docs: add warning about mismatching versions
1 parent 74b73cb commit 0bc7d9a

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

cmd/liqoctl/cmd/peer.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ This command enables a peering towards an already known remote cluster, without
4949
need of specifying all authentication parameters. It adopts the same approach already
5050
used while peering for the first time with the given remote cluster.
5151
52+
Warning: the establishment of a peering with a remote cluster leveraging a different
53+
version of Liqo, net of patch releases, is currently *not supported*, and could
54+
lead to unexpected results.
55+
5256
Examples:
5357
$ {{ .Executable }} peer eternal-donkey
5458
or

docs/installation/liqoctl.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@ Specifically, it abstracts the creation and modification of Liqo defined custom
1010
* Enable and configure **workload offloading** on a per-namespace basis.
1111
* Retrieve the **status** of Liqo, as well as of given peering relationships and offloading setups.
1212

13+
```{warning}
14+
Make sure to always **use the *liqoctl* version matching that of Liqo** installed (or to be installed) in your cluster(s).
15+
```
16+
17+
{{ env.config.html_context.generate_liqoctl_version_warning() }}
18+
1319
```{admonition} Note
1420
*liqoctl* displays a *kubectl* compatible behavior concerning Kubernetes API access, hence supporting the `KUBECONFIG` environment variable, as well as all the standard flags, including `--kubeconfig` and `--context`.
1521
Moreover, subcommands interacting with two clusters (e.g., *liqoctl peer in-band*) feature a parallel set of flags concerning Kubernetes API access to the remote cluster, in the form `--remote-<flag>` (e.g., `--remote-kubeconfig`, `--remote-context`).
1622
```
1723

18-
{{ env.config.html_context.generate_liqoctl_version_warning() }}
19-
2024
(InstallationLiqoctlWithHomebrew)=
2125

2226
## Install liqoctl with Homebrew

docs/usage/peer.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
This section describes the procedure to **establish a peering** with a remote cluster, using one of the two alternative approaches featured by Liqo.
44
You can refer to the [dedicated features section](FeaturesPeeringApproaches) for a high-level presentation of their characteristics, and the associated trade-offs.
55

6+
```{warning}
7+
The establishment of a peering with a remote cluster leveraging a **different version of Liqo**, net of patch releases, is currently **not supported**, and could lead to unexpected results.
8+
```
9+
610
## Overview
711

812
The peering process leverages **[liqoctl](/installation/liqoctl.md)** to interact with the clusters, abstracting the creation and update of the appropriate custom resources.

pkg/liqoctl/install/handler.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ func (o *Options) Run(ctx context.Context, provider Provider) error {
187187
}
188188

189189
s.Success(fmt.Sprintf("All Set! You can now proceed establishing a peering (%v peer --help for more information)", o.CommandName))
190+
o.Printer.Success.Println("Make sure to use the same version of Liqo on all remote clusters")
190191
return nil
191192
}
192193

0 commit comments

Comments
 (0)