Skip to content

Commit 70f64a1

Browse files
authored
Merge pull request #90856 from openshift-cherrypick-robot/cherry-pick-89986-to-enterprise-4.16
[enterprise-4.16] OSSM-9018 Add a note to Disable the old gateway in the documentation
2 parents 4937633 + ccf452d commit 70f64a1

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

modules/ossm-migrating-from-smcp-defined-gateways-to-gateway-injection.adoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ This procedure explains how to migrate with zero downtime from gateways defined
1818
1919
.Procedure
2020

21-
. Create a new ingress gateway that is configured to use gateway injection.
21+
. Create a new ingress gateway that is configured to use gateway injection.
2222
+
2323
[NOTE]
2424
====
25-
This procedure migrates away from the default ingress gateway deployment defined in the `ServiceMeshControlPlane` resource to gateway injection. The procedure may be modified to migrate from additional ingress gateways configured in the SMCP.
25+
This procedure migrates away from the default ingress gateway deployment defined in the `ServiceMeshControlPlane` resource to gateway injection. The procedure may be modified to migrate from additional ingress gateways configured in the SMCP.
2626
====
2727
+
2828
.Example ingress gateway resource with gateway injection
@@ -31,13 +31,13 @@ This procedure migrates away from the default ingress gateway deployment defined
3131
apiVersion: apps/v1
3232
kind: Deployment
3333
metadata:
34-
name: istio-ingressgateway-canary
34+
name: istio-ingressgateway-canary
3535
namespace: istio-system <1>
3636
spec:
3737
selector:
3838
matchLabels:
3939
app: istio-ingressgateway
40-
istio: ingressgateway
40+
istio: ingressgateway
4141
template:
4242
metadata:
4343
annotations:
@@ -94,16 +94,16 @@ spec:
9494
- {}
9595
policyTypes:
9696
- Ingress
97-
----
98-
<1> The gateway injection deployment and all supporting resources should be deployed in the same namespace as the SMCP-defined gateway.
97+
----
98+
<1> The gateway injection deployment and all supporting resources should be deployed in the same namespace as the SMCP-defined gateway.
9999
<2> Ensure that the labels specified in the pod template include all of the label selectors specified in the `Service` object associated with the existing SMCP-defined gateway.
100100
<3> Grant access to the new gateway from outside the cluster. This access is required whenever the `spec.security.manageNetworkPolicy` of the `ServiceMeshControlPlane` resource is set to `true`, which is the default setting.
101101

102-
. Verify that the new gateway deployment is successfully handling requests.
102+
. Verify that the new gateway deployment is successfully handling requests.
103103
+
104104
If access logging was configured in the `ServiceMeshControlPlane` resource, view the access logs of the new gateway deployment to confirm the behavior.
105105

106-
. Scale down the old deployment and scale up the new deployment.
106+
. Scale down the old deployment and scale up the new deployment.
107107
+
108108
Gradually shift traffic from the old gateway deployment to the new gateway deployment by performing the following steps:
109109

@@ -120,7 +120,7 @@ $ oc scale -n istio-system deployment/<new_gateway_deployment> --replicas <new_n
120120
$ oc scale -n istio-system deployment/<old_gateway_deployment> --replicas <new_number_of_replicas>
121121
----
122122

123-
.. Repeat running the previous two commands. Each time, increase the number of replicas for the new gateway deployment and decrease the number of replicas for the old gateway deployment. Continue repeating until the new gateway deployment handles all traffic to the gateway `Service` object.
123+
.. Repeat running the previous two commands. Each time, increase the number of replicas for the new gateway deployment and decrease the number of replicas for the old gateway deployment. Continue repeating until the new gateway deployment handles all traffic to the gateway `Service` object.
124124

125125
. Remove the `app.kubernetes.io/managed-by` label from the gateway `Service` object by running the following command:
126126
+
@@ -129,7 +129,7 @@ $ oc scale -n istio-system deployment/<old_gateway_deployment> --replicas <new_n
129129
$ oc label service -n istio-system istio-ingressgateway app.kubernetes.io/managed-by-
130130
----
131131
+
132-
Removing the label prevents the service from being deleted when the gateway is disabled in the `ServiceMeshControlPlane` resource.
132+
Removing the label prevents the service from being deleted when the gateway is disabled in the `ServiceMeshControlPlane` resource.
133133

134134
. Remove the `ownerReferences` object from the gateway `Service` object by running the following command:
135135
+
@@ -149,5 +149,6 @@ $ oc patch smcp -n istio-system <smcp_name> --type='json' -p='[{"op": "replace",
149149
+
150150
[NOTE]
151151
====
152-
When the old ingress gateway `Service` object is disabled it is not deleted. You may save this `Service` object to a file and manage it alongside the new gateway injection resources.
152+
* When the old ingress gateway `Service` object is disabled it is not deleted. You may save this `Service` object to a file and manage it alongside the new gateway injection resources.
153+
* The `/spec/gateways/ingress/enabled` path is available if you explicitly set it for the `ServiceMeshControlPlane` resource. If you are using the default value, you must patch the `/spec/gateways/enabled` path for both ingress and egress gateways.
153154
====

0 commit comments

Comments
 (0)