Skip to content

Commit 1056ffe

Browse files
committed
OCPBUGS-499969: Removed 4.10 and 4.11 references from MetalLB docs
1 parent 5a3a3c8 commit 1056ffe

6 files changed

+39
-148
lines changed

modules/nw-metalLB-basic-upgrade-operator.adoc

+27-34
Original file line numberDiff line numberDiff line change
@@ -3,61 +3,54 @@
33
// * networking/metallb/metallb-upgrading-operator.adoc
44

55
:_mod-docs-content-type: PROCEDURE
6-
76
[id="upgrading-metallb-operator_{context}"]
8-
= Upgrading the MetalLB Operator
7+
= Manually upgrading the MetalLB Operator
98

9+
To manually control upgrading the MetalLB Operator, you must edit the `Subscription` custom resource (CR) that subscribes the namespace to `metallb-system`.
1010

1111
.Prerequisites
1212

13+
* You used OperatorHub to install to the MetalLB Operator.
1314
* Access the cluster as a user with the `cluster-admin` role.
1415
1516
.Procedure
1617

17-
. Verify that the `metallb-system` namespace still exists:
18+
. Get the name of the install plan from the subscription:
1819
+
1920
[source,terminal]
2021
----
21-
$ oc get namespaces | grep metallb-system
22-
----
23-
+
24-
.Example output
25-
[source,terminal]
26-
----
27-
metallb-system Active 31m
22+
$ oc -n metallb-system get subscription metallb-operator-sub -o yaml
2823
----
2924

30-
. Verify the `metallb` custom resource still exists:
25+
. Edit `Subscription` CR by setting the `installPlanApproval` parameter to `Manual`:
3126
+
32-
[source,terminal]
33-
----
34-
$ oc get metallb -n metallb-system
35-
----
36-
+
37-
.Example output
38-
[source,terminal]
39-
----
40-
NAME AGE
41-
metallb 33m
42-
----
43-
44-
. Follow the guidance in "Installing from OperatorHub using the CLI" to install the latest {product-version} version of the MetalLB Operator.
45-
+
46-
[NOTE]
47-
====
48-
When installing the latest {product-version} version of the MetalLB Operator, you must install the Operator to the same namespace it was previously installed to.
49-
====
50-
51-
. Verify the upgraded version of the Operator is now the {product-version} version.
27+
[source,yaml]
28+
----
29+
apiVersion: operators.coreos.com/v1alpha1
30+
kind: Subscription
31+
metadata:
32+
name: metallb-operator-sub
33+
namespace: metallb-system
34+
# ...
35+
spec:
36+
channel: stable
37+
installPlanApproval: Manual
38+
name: metallb-operator
39+
source: redhat-operators
40+
sourceNamespace: openshift-marketplace
41+
# ...
42+
----
43+
44+
. Confirm the install plan is in the namespace:
5245
+
5346
[source,terminal]
5447
----
55-
$ oc get csv -n metallb-system
48+
$ oc get installplan -n metallb-system
5649
----
5750
+
5851
.Example output
5952
[source,terminal,subs="attributes+"]
6053
----
61-
NAME DISPLAY VERSION REPLACES PHASE
62-
metallb-operator.{product-version}.0-202207051316 MetalLB Operator {product-version}.0-202207051316 Succeeded
54+
NAME CSV APPROVAL APPROVED
55+
install-wzg94 metallb-operator.{product-title}.0-202502250302 Manual true
6356
----

modules/olm-deleting-metallb-operators-from-a-cluster-using-cli.adoc

-56
This file was deleted.

modules/olm-deleting-metallb-operators-from-a-cluster-using-web-console.adoc

-31
This file was deleted.

modules/olm-updating-metallb-operatorgroup.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
[id="olm-updating-metallb-operatorgroup_{context}"]
77
= Editing the MetalLB Operator Operator group
88

9-
When upgrading from any MetalLB Operator version up to and including 4.10 to 4.11 and later, remove `spec.targetNamespaces` from the Operator group custom resource (CR). You must remove the spec regardless of whether you used the web console or the CLI to delete the MetalLB Operator.
9+
When upgrading from any MetalLB Operator version, remove `spec.targetNamespaces` from the Operator group custom resource (CR). You must remove the spec regardless of whether you used the web console or the CLI to delete the MetalLB Operator.
1010
[NOTE]
1111
====
12-
The MetalLB Operator version 4.11 or later only supports the `AllNamespaces` install mode, whereas 4.10 or earlier versions support `OwnNamespace` or `SingleNamespace` modes.
12+
The MetalLB Operator only supports the `AllNamespaces` install mode.
1313
====
1414

1515
.Prerequisites

networking/networking_operators/metallb-operator/metallb-upgrading-operator.adoc

+4-23
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,11 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
If you are currently running version 4.10 or an earlier version of the MetalLB Operator, please note that automatic updates to any version later than 4.10 do not work. Upgrading to a newer version from any version of the MetalLB Operator that is 4.11 or later is successful. For example, upgrading from version 4.12 to version 4.13 will occur smoothly.
9+
// Is the relationship with OCP updates correct? What about z-streams?
10+
A `Subscription` custom resource (CR) that subscribes the namespace to `metallb-system` by default sets the `installPlanApproval` parameter to `Automatic`. This means that when you update to the latest version of {product-title}, the MetalLB Operator is automatically upgraded to the latst version of the Operator.
1011

11-
A summary of the upgrade procedure for the MetalLB Operator from 4.10 and earlier is as follows:
12-
13-
. Delete the installed MetalLB Operator version for example 4.10. Ensure that the namespace and the `metallb` custom resource are not removed.
14-
15-
. Using the CLI, install the MetalLB Operator {product-version} in the same namespace where the previous version of the MetalLB Operator was installed.
16-
17-
[NOTE]
18-
====
19-
This procedure does not apply to automatic z-stream updates of the MetalLB Operator, which follow the standard straightforward method.
20-
====
21-
22-
For detailed steps to upgrade the MetalLB Operator from 4.10 and earlier, see the guidance that follows. As a cluster administrator, start the upgrade process by deleting the MetalLB Operator by using the OpenShift CLI (`oc`) or the web console.
23-
24-
//Delete metallb using web console
25-
include::modules/olm-deleting-metallb-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1]
26-
27-
//Delete metallb using cli
28-
include::modules/olm-deleting-metallb-operators-from-a-cluster-using-cli.adoc[leveloffset=+1]
29-
30-
//Delete targetNamespace
31-
include::modules/olm-updating-metallb-operatorgroup.adoc[leveloffset=+1]
12+
// Any consequences to doing this?
13+
If you need to manual control upgrading the MetalLB Operator, set the `installPlanApproval` parameter to `Manual`.
3214

3315
//Upgrade the MetalLB
3416
include::modules/nw-metalLB-basic-upgrade-operator.adoc[leveloffset=+1]
@@ -39,4 +21,3 @@ include::modules/nw-metalLB-basic-upgrade-operator.adoc[leveloffset=+1]
3921
* xref:../../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster]
4022

4123
* xref:../../../networking/networking_operators/metallb-operator/metallb-operator-install.adoc#metallb-operator-install[Installing the MetalLB Operator]
42-

operators/admin/olm-adding-operators-to-cluster.adoc

+6-2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ include::modules/olm-installing-operators-from-operatorhub.adoc[leveloffset=+1]
3838
3939
* xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding OperatorHub]
4040
41+
// Installing from OperatorHub by using the CLI
4142
include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloffset=+1]
4243
4344
[role="_additional-resources"]
@@ -46,6 +47,8 @@ include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloff
4647
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator update]
4748
4849
ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
50+
51+
// Installing from OperatorHub by using the CLI
4952
include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
5053
5154
[role="_additional-resources"]
@@ -58,7 +61,7 @@ include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
5861
include::modules/olm-preparing-multitenant-operators.adoc[leveloffset=+1]
5962
.Next steps
6063
61-
* Install the Operator in the tenant Operator namespace. This task is more easily performed by using the OperatorHub in the web console instead of the CLI; for a detailed procedure, see xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console].
64+
* Install the Operator in the tenant Operator namespace. This task is more easily performed by using the OperatorHub in the web console instead of the CLI; for a detailed procedure, "Installing from OperatorHub using the web console".
6265
+
6366
[NOTE]
6467
====
@@ -71,9 +74,10 @@ After completing the Operator installation, the Operator resides in the tenant O
7174
* xref:../../operators/understanding/olm-multitenancy.adoc#olm-multitenancy[Operators in multitenant clusters]
7275
7376
include::modules/olm-installing-global-namespaces.adoc[leveloffset=+1]
77+
7478
.Next steps
7579
76-
* Install the desired Operator in your custom global namespace. Because the web console does not populate the *Installed Namespace* menu during Operator installation with custom global namespaces, this task can only be performed with the OpenShift CLI (`oc`). For a detailed procedure, see xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-operatorhub-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI].
80+
* Install the desired Operator in your custom global namespace. Because the web console does not populate the *Installed Namespace* menu during Operator installation with custom global namespaces, this task can only be performed with the OpenShift CLI (`oc`). For a detailed procedure, see "Installing from OperatorHub using the CLI".
7781
+
7882
[NOTE]
7983
====

0 commit comments

Comments
 (0)