Skip to content

[enterprise-4.13] OCPBUGS-49969: Removed 4.10 and 4.11 references from MetalLB docs #92257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ include::modules/installing-oadp-aws-sts.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console]
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub by using the web console]
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]

[id="oadp-aws-sts-backing-up-and-cleaning"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ include::modules/installing-oadp-rosa-sts.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub using the web console].
* xref:../../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-from-operatorhub-using-web-console_olm-installing-operators-in-namespace[Installing from OperatorHub by using the web console].
* xref:../../../backup_and_restore/application_backup_and_restore/backing_up_and_restoring/backing-up-applications.adoc#backing-up-applications[Backing up applications]

[id="oadp-rosa-backing-up-and-cleaning"]
Expand Down
2 changes: 1 addition & 1 deletion modules/installing-oadp-aws-sts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ $ oc -n openshift-adp create secret generic cloud-credentials \
====
In {product-title} versions 4.14 and later, the OADP Operator supports a new standardized {sts-short} workflow through the Operator Lifecycle Manager (OLM)
and Cloud Credentials Operator (CCO). In this workflow, you do not need to create the above
secret, you only need to supply the role ARN during the installation of OLM-managed operators using the {product-title} web console, for more information see _Installing from OperatorHub using the web console_.
secret, you only need to supply the role ARN during the installation of OLM-managed operators using the {product-title} web console, for more information see _Installing from OperatorHub by using the web console_.

The preceding secret is created automatically by CCO.
====
Expand Down
2 changes: 1 addition & 1 deletion modules/installing-oadp-rosa-sts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ $ oc -n openshift-adp create secret generic cloud-credentials \
====
In {product-title} versions 4.14 and later, the OADP Operator supports a new standardized {sts-short} workflow through the Operator Lifecycle Manager (OLM)
and Cloud Credentials Operator (CCO). In this workflow, you do not need to create the above
secret, you only need to supply the role ARN during the installation of OLM-managed operators using the {product-title} web console, for more information see _Installing from OperatorHub using the web console_.
secret, you only need to supply the role ARN during the installation of OLM-managed operators using the {product-title} web console, for more information see _Installing from OperatorHub by using the web console_.

The preceding secret is created automatically by CCO.
====
Expand Down
75 changes: 57 additions & 18 deletions modules/nw-metalLB-basic-upgrade-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,61 +3,100 @@
// * networking/metallb/metallb-upgrading-operator.adoc

:_mod-docs-content-type: PROCEDURE

[id="upgrading-metallb-operator_{context}"]
= Upgrading the MetalLB Operator
= Manually upgrading the MetalLB Operator

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.

.Prerequisites

* You updated your cluster to the latest z-stream release.
* You used OperatorHub to install the MetalLB Operator.
* Access the cluster as a user with the `cluster-admin` role.

.Procedure

. Verify that the `metallb-system` namespace still exists:
. Get the YAML definition of the `metallb-operator` subscription in the `metallb-system` namespace by entering the following command:
+
[source,terminal]
----
$ oc get namespaces | grep metallb-system
$ oc -n metallb-system get subscription metallb-operator -o yaml
----

. Edit the `Subscription` CR by setting the `installPlanApproval` parameter to `Manual`:
+
.Example output
[source,terminal]
[source,yaml]
----
metallb-system Active 31m
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: metallb-operator
namespace: metallb-system
# ...
spec:
channel: stable
installPlanApproval: Manual
name: metallb-operator
source: redhat-operators
sourceNamespace: openshift-marketplace
# ...
----

. Verify the `metallb` custom resource still exists:
. Find the latest {product-title} {product-version} version of the MetalLB Operator by entering the following command:
+
[source,terminal]
----
$ oc get metallb -n metallb-system
$ oc -n metallb-system get csv
----
+
.Example output
[source,terminal,subs="attributes+"]
----
NAME DISPLAY VERSION REPLACES PHASE
metallb-operator.v{product-version}.0 MetalLB Operator {product-version}.0 Succeeded
----

. Check the install plan that exists in the namespace by entering the following command.
+
[source,terminal]
----
NAME AGE
metallb 33m
$ oc -n metallb-system get installplan
----
+
.Example output that shows install-tsz2g as a manual install plan
[source,terminal,subs="attributes+"]
----
NAME CSV APPROVAL APPROVED
install-shpmd metallb-operator.v{product-version}.0-202502261233 Automatic true
install-tsz2g metallb-operator.v{product-version}.0-202503102139 Manual false
----

. Follow the guidance in "Installing from OperatorHub using the CLI" to install the latest {product-version} version of the MetalLB Operator.
. 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`.
+
[source,terminal]
----
$ oc edit installplan <name_of_installplan> -n metallb-system
----
+
.. With the install plan open in your editor, set the `spec.approval` parameter to `Manual` and set the `spec.approved` parameter to `true`.
+
[NOTE]
====
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.
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.
====

. Verify the upgraded version of the Operator is now the {product-version} version.
.Verification

. Verify the upgrade was successful by entering the following command:
+
[source,terminal]
----
$ oc get csv -n metallb-system
$ oc -n metallb-system get csv
----
+
.Example output
[source,terminal,subs="attributes+"]
[source,terminal]
----
NAME DISPLAY VERSION REPLACES PHASE
metallb-operator.{product-version}.0-202207051316 MetalLB Operator {product-version}.0-202207051316 Succeeded
NAME DISPLAY VERSION REPLACE PHASE
metallb-operator.v<latest>.0-202503102139 MetalLB Operator {product-version}.0-202503102139 metallb-operator.v{product-version}.0-202502261233 Succeeded
----
2 changes: 1 addition & 1 deletion modules/nw-metallb-installing-operator-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_mod-docs-content-type: PROCEDURE
[id="nw-metallb-installing-operator-cli_{context}"]
= Installing from OperatorHub using the CLI
= Installing from OperatorHub by using the CLI

Instead of using the {product-title} web console, you can install an Operator from OperatorHub using the CLI. You can use the OpenShift CLI (`oc`) to install the MetalLB Operator.

Expand Down

This file was deleted.

This file was deleted.

12 changes: 6 additions & 6 deletions modules/olm-installing-from-operatorhub-using-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ endif::[]

:_mod-docs-content-type: PROCEDURE
[id="olm-installing-operator-from-operatorhub-using-cli_{context}"]
= Installing from OperatorHub using the CLI
= Installing from OperatorHub by using the CLI

Instead of using the {product-title} web console, you can install an Operator from OperatorHub by using the CLI. Use the `oc` command to create or update a `Subscription` object.

.Prerequisites

ifndef::olm-user[]
- Access to an {product-title} cluster using an account with
* Access to an {product-title} cluster using an account with
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
`cluster-admin` permissions.
endif::[]
Expand All @@ -30,10 +30,10 @@ endif::[]
endif::[]

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

- You have installed the OpenShift CLI (`oc`).
* You have installed the OpenShift CLI (`oc`).

.Procedure

Expand Down Expand Up @@ -82,7 +82,7 @@ However, if the Operator uses the `SingleNamespace` mode and you do not already
* The web console version of this procedure handles the creation of the `OperatorGroup` and `Subscription` objects automatically behind the scenes for you when choosing `SingleNamespace` mode.
* You can only have one Operator group per namespace. For more information, see "Operator groups".
====

+
.. Create an `OperatorGroup` object YAML file, for example `operatorgroup.yaml`:
+
.Example `OperatorGroup` object
Expand All @@ -101,7 +101,7 @@ spec:
--
include::snippets/operator-group-unique-name.adoc[]
--

+
.. Create the `OperatorGroup` object:
+
[source,terminal]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ endif::[]

:_mod-docs-content-type: PROCEDURE
[id="olm-installing-from-operatorhub-using-web-console_{context}"]
= Installing from OperatorHub using the web console
= Installing from OperatorHub by using the web console

You can install and subscribe to an Operator from OperatorHub by using the {product-title} web console.

Expand Down
Loading