Skip to content

Commit 49668e1

Browse files
authored
Merge pull request #89609 from dfitzmau/OCPBUGS-49969
OCPBUGS-49969: Removed 4.10 and 4.11 references from MetalLB docs
2 parents 6b5d850 + 856827c commit 49668e1

7 files changed

+86
-266
lines changed

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

+57-18
Original file line numberDiff line numberDiff line change
@@ -3,61 +3,100 @@
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`. A `Subscription` CR is created as part of the Operator installation and the CR has the `installPlanApproval` parameter set to `Automatic` by default.
1010

1111
.Prerequisites
1212

13+
* You updated your cluster to the latest z-stream release.
14+
* You used OperatorHub to install the MetalLB Operator.
1315
* Access the cluster as a user with the `cluster-admin` role.
1416
1517
.Procedure
1618

17-
. Verify that the `metallb-system` namespace still exists:
19+
. Get the YAML definition of the `metallb-operator` subscription in the `metallb-system` namespace by entering the following command:
1820
+
1921
[source,terminal]
2022
----
21-
$ oc get namespaces | grep metallb-system
23+
$ oc -n metallb-system get subscription metallb-operator -o yaml
2224
----
25+
26+
. Edit the `Subscription` CR by setting the `installPlanApproval` parameter to `Manual`:
2327
+
24-
.Example output
25-
[source,terminal]
28+
[source,yaml]
2629
----
27-
metallb-system Active 31m
30+
apiVersion: operators.coreos.com/v1alpha1
31+
kind: Subscription
32+
metadata:
33+
name: metallb-operator
34+
namespace: metallb-system
35+
# ...
36+
spec:
37+
channel: stable
38+
installPlanApproval: Manual
39+
name: metallb-operator
40+
source: redhat-operators
41+
sourceNamespace: openshift-marketplace
42+
# ...
2843
----
2944

30-
. Verify the `metallb` custom resource still exists:
45+
. Find the latest {product-title} {product-version} version of the MetalLB Operator by entering the following command:
3146
+
3247
[source,terminal]
3348
----
34-
$ oc get metallb -n metallb-system
49+
$ oc -n metallb-system get csv
3550
----
3651
+
3752
.Example output
53+
[source,terminal,subs="attributes+"]
54+
----
55+
NAME DISPLAY VERSION REPLACES PHASE
56+
metallb-operator.v{product-version}.0 MetalLB Operator {product-version}.0 Succeeded
57+
----
58+
59+
. Check the install plan that exists in the namespace by entering the following command.
60+
+
3861
[source,terminal]
3962
----
40-
NAME AGE
41-
metallb 33m
63+
$ oc -n metallb-system get installplan
64+
----
65+
+
66+
.Example output that shows install-tsz2g as a manual install plan
67+
[source,terminal,subs="attributes+"]
68+
----
69+
NAME CSV APPROVAL APPROVED
70+
install-shpmd metallb-operator.v4.18.0-202502261233 Automatic true
71+
install-tsz2g metallb-operator.v{product-version}.0-202503102139 Manual false
4272
----
4373

44-
. Follow the guidance in "Installing from OperatorHub using the CLI" to install the latest {product-version} version of the MetalLB Operator.
74+
. Edit the install plan that exists in the namespace by entering the following command. Ensure that you replace `<name_of_installplan>` with the name of the install plan, such as `install-tsz2g`.
75+
+
76+
[source,terminal]
77+
----
78+
$ oc edit installplan <name_of_installplan> -n metallb-system
79+
----
80+
+
81+
.. With the install plan open in your editor, set the `spec.approval` parameter to `Manual` and set the `spec.approved` parameter to `true`.
4582
+
4683
[NOTE]
4784
====
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.
85+
After you edit the install plan, the upgrade operation starts. If you enter the `oc -n metallb-system get csv` command during the upgrade operation, the output might show the `Replacing` or the `Pending` status.
4986
====
5087

51-
. Verify the upgraded version of the Operator is now the {product-version} version.
88+
.Verification
89+
90+
. Verify the upgrade was successful by entering the following command:
5291
+
5392
[source,terminal]
5493
----
55-
$ oc get csv -n metallb-system
94+
$ oc -n metallb-system get csv
5695
----
5796
+
5897
.Example output
59-
[source,terminal,subs="attributes+"]
98+
[source,terminal]
6099
----
61-
NAME DISPLAY VERSION REPLACES PHASE
62-
metallb-operator.{product-version}.0-202207051316 MetalLB Operator {product-version}.0-202207051316 Succeeded
100+
NAME DISPLAY VERSION REPLACE PHASE
101+
metallb-operator.v4.19.0-202503102139 MetalLB Operator {product-version}.0-202503102139 metallb-operator.v4.18.0-202502261233 Succeeded
63102
----

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-installing-from-operatorhub-using-cli.adoc

+19-21
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ In most cases, the web console method of this procedure is preferred because it
2727
.Prerequisites
2828

2929
ifndef::olm-user[]
30-
- Access to an {product-title} cluster using an account with
30+
* Access to an {product-title} cluster using an account with
3131
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
3232
`cluster-admin` permissions.
3333
endif::[]
@@ -37,10 +37,10 @@ endif::[]
3737
endif::[]
3838

3939
ifdef::olm-user[]
40-
- Access to an {product-title} cluster using an account with Operator installation permissions.
40+
* Access to an {product-title} cluster using an account with Operator installation permissions.
4141
endif::[]
4242

43-
- You have installed the OpenShift CLI (`oc`).
43+
* You have installed the OpenShift CLI (`oc`).
4444
4545
.Procedure
4646

@@ -129,7 +129,7 @@ $ oc get packagemanifests <operator_name> -n <catalog_namespace> -o yaml
129129
----
130130
====
131131

132-
** If more than one catalog is installed in a namespace, run the following command to look up the available versions and channels of an Operator from a specific catalog:
132+
. If more than one catalog is installed in a namespace, run the following command to look up the available versions and channels of an Operator from a specific catalog:
133133
+
134134
[source,terminal]
135135
----
@@ -155,7 +155,7 @@ If the Operator you intend to install supports the `SingleNamespace` install mod
155155
====
156156
You can only have one Operator group per namespace. For more information, see "Operator groups".
157157
====
158-
158+
+
159159
.. Create an `OperatorGroup` object YAML file, for example `operatorgroup.yaml`, for `SingleNamespace` install mode:
160160
+
161161
.Example `OperatorGroup` object for `SingleNamespace` install mode
@@ -171,7 +171,7 @@ spec:
171171
- <namespace> <1>
172172
----
173173
<1> For `SingleNamespace` install mode, use the same `<namespace>` value for both the `metadata.namespace` and `spec.targetNamespaces` fields.
174-
174+
+
175175
.. Create the `OperatorGroup` object:
176176
+
177177
[source,terminal]
@@ -180,7 +180,7 @@ $ oc apply -f operatorgroup.yaml
180180
----
181181

182182
. Create a `Subscription` object to subscribe a namespace to an Operator:
183-
183+
+
184184
.. Create a YAML file for the `Subscription` object, for example `subscription.yaml`:
185185
+
186186
[NOTE]
@@ -264,9 +264,9 @@ spec:
264264
<1> Set the approval strategy to `Manual` in case your specified version is superseded by a later version in the catalog. This plan prevents an automatic upgrade to a later version and requires manual approval before the starting CSV can complete the installation.
265265
<2> Set a specific version of an Operator CSV.
266266
====
267-
267+
+
268268
.. For clusters on cloud providers with token authentication enabled, such as {aws-first} {sts-first}, {entra-first}, or {gcp-wid-first}, configure your `Subscription` object by following these steps:
269-
269+
+
270270
... Ensure the `Subscription` object is set to manual update approvals:
271271
+
272272
.Example `Subscription` object with manual update approvals
@@ -281,11 +281,10 @@ spec:
281281
----
282282
<1> Subscriptions with automatic approvals for updates are not recommended because there might be permission changes to make before updating. Subscriptions with manual approvals for updates ensure that administrators have the opportunity to verify the permissions of the later version, take any necessary steps, and then update.
283283
====
284-
284+
+
285285
... Include the relevant cloud provider-specific fields in the `Subscription` object's `config` section:
286286
+
287-
--
288-
* If the cluster is in AWS STS mode, include the following fields:
287+
If the cluster is in AWS STS mode, include the following fields:
289288
+
290289
.Example `Subscription` object with {aws-short} {sts-short} variables
291290
[%collapsible]
@@ -302,8 +301,8 @@ spec:
302301
----
303302
<1> Include the role ARN details.
304303
====
305-
306-
* If the cluster is in {entra-short} mode, include the following fields:
304+
+
305+
If the cluster is in {entra-short} mode, include the following fields:
307306
+
308307
.Example `Subscription` object with {entra-short} variables
309308
[%collapsible]
@@ -326,8 +325,8 @@ spec:
326325
<2> Include the tenant ID.
327326
<3> Include the subscription ID.
328327
====
329-
330-
* If the cluster is in {gcp-wid-short} mode, include the following fields:
328+
+
329+
If the cluster is in {gcp-wid-short} mode, include the following fields:
331330
+
332331
.Example `Subscription` object with {gcp-wid-short} variables
333332
[%collapsible]
@@ -344,9 +343,10 @@ spec:
344343
- name: SERVICE_ACCOUNT_EMAIL
345344
value: "<service_account_email>" <2>
346345
----
347-
346+
====
347+
+
348348
where:
349-
349+
+
350350
`<audience>`:: Created in {gcp-short} by the administrator when they set up {gcp-wid-short}, the `AUDIENCE` value must be a preformatted URL in the following format:
351351
+
352352
[source,text]
@@ -359,9 +359,7 @@ where:
359359
----
360360
<service_account_name>@<project_id>.iam.gserviceaccount.com
361361
----
362-
====
363-
--
364-
362+
+
365363
.. Create the `Subscription` object by running the following command:
366364
+
367365
[source,terminal]

0 commit comments

Comments
 (0)