Skip to content

Commit 8f71bae

Browse files
authored
Merge pull request #93327 from jldohmann/OSDOCS-13326
OSDOCS-13326: add management succession procedure
2 parents 404e934 + 220e061 commit 8f71bae

File tree

2 files changed

+65
-1
lines changed

2 files changed

+65
-1
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
// Modules included in the following assemblies:
2+
//
3+
// * networking/configuring_ingress_cluster_traffic/ingress-gateway-api.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="nw-ingress-gateway-api-manage-succession_{context}"]
7+
= Preparing for Gateway API management succession by the Ingress Operator
8+
9+
Starting in {product-title} 4.19, the Ingress Operator manages the lifecycle of any Gateway API custom resource definitions (CRDs). Updating from a version before 4.19 of {product-title} where this management was not present requires you to replace or remove any Gateway API CRDs that already exist in the cluster so that they conform to the specific {product-title} specification required by the Ingress Operator. {product-title} version 4.19 requires Gateway API Standard version 1.2.0 CRDs.
10+
11+
[WARNING]
12+
====
13+
Updating or deleting Gateway API resources can result in downtime and loss of service or data. Be sure you understand how this will affect your cluster before performing the steps in this procedure. If necessary, back up any Gateway API objects in YAML format in order to restore it later.
14+
====
15+
16+
.Prerequisites
17+
* You have installed the OpenShift CLI (`oc`).
18+
* You have access to an {product-title} account with cluster administrator access.
19+
* Optional: You have backed up any necessary Gateway API objects.
20+
21+
.Procedure
22+
23+
. List all the Gateway API CRDs that you need to remove by running the following command:
24+
+
25+
[source,terminal]
26+
----
27+
$ oc get crd | grep "gateway.networking"
28+
----
29+
+
30+
.Example output
31+
+
32+
[source,terminal]
33+
----
34+
gatewayclasses.gateway.networking.k8s.io
35+
gateways.gateway.networking.k8s.io
36+
grpcroutes.gateway.networking.k8s.io
37+
httproutes.gateway.networking.k8s.io
38+
referencegrants.gateway.networking.k8s.io
39+
----
40+
41+
. Delete the Gateway API CRDs from the previous step by running the following command:
42+
+
43+
[source,terminal]
44+
----
45+
$ oc delete crd gatewayclasses.networking.k8s.io && \
46+
oc delete crd gateways.networking.k8s.io && \
47+
oc delete crd grpcroutes.gateway.networking.k8s.io && \
48+
oc delete crd httproutes.gateway.networking.k8s.io && \
49+
oc delete crd referencesgrants.gateway.networking.k8s.io
50+
----
51+
+
52+
[IMPORTANT]
53+
====
54+
Any controller that was previously managing the lifecycle of the Gateway API CRDs will fail to operate properly. Attempting to force its use in conjunction with the Ingress Operator to manage Gateway API CRDs might prevent the cluster update from succeeding.
55+
====
56+
57+
. Get the supported Gateway API CRDs by running the following command:
58+
+
59+
[source,terminal]
60+
----
61+
$ oc apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v1.2.0/standard-install.yaml
62+
----

updating/preparing_for_updates/updating-cluster-prepare-past-4-18.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
Before you update from {product-title} 4.18 to a newer version, learn about some of the specific concerns around {op-system-base-full} compute machines.
9+
Before you update from {product-title} 4.18 to a newer version, learn about some of the specific concerns around {op-system-base-full} compute machines and Gateway API networking resources.
1010

1111
[id="migrating-workloads-to-different-nodes_{context}"]
1212
== Migrating workloads off of package-based {op-system-base} worker nodes
@@ -121,3 +121,5 @@ If you need additional compute nodes for your workloads, you can provision new o
121121
* xref:../../machine_management/user_infra/adding-compute-user-infra-general.adoc#adding-compute-user-infra-general[Adding compute machines to clusters with user-provisioned infrastructure manually]
122122

123123
For installer-provisioned infrastructure installations, automatic scaling adds {op-system} nodes by default. For user-provisioned infrastructure installations on bare metal platforms, you can manually xref:../../post_installation_configuration/node-tasks.adoc#post-install-config-adding-fcos-compute[add {op-system} compute nodes to your cluster].
124+
125+
include::modules/nw-ingress-gateway-api-manage-succession.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)