-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSSM-11032 [DOCS] Modify upgrade procedure for ambient mode #101283
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
briandooley
merged 1 commit into
openshift:service-mesh-docs-main
from
shreyasiddhartha:OSSM-11032
Nov 7, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // Module included in the following assemblies: | ||
| // update/ossm-updating-openshift-service-mesh-in-ambient-mode.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="ossm-updating-cross-namespace-waypoint_{context}"] | ||
| = Updating cross-namespace waypoint | ||
|
|
||
| [role="_abstract"] | ||
| If you are using cross-namespace waypoints, verify that the `istio.io/use-waypoint-namespace` and `istio.io/use-waypoint` labels are correctly applied to the relevant namespaces before updating. | ||
|
|
||
| . Verify the namespace with any of the waypoint labels by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc get ns bookinfo --show-labels | grep waypoint | ||
| ---- | ||
|
|
||
| . If there is no namespace with the label or if the label is wrong, re-apply the labels: | ||
|
|
||
| .. Apply the `istio.io/use-waypoint-namespace` by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc label ns bookinfo istio.io/use-waypoint-namespace=foo --overwrite | ||
| ---- | ||
|
|
||
| .. Apply the `istio.io/use-waypoint` by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc label ns bookinfo istio.io/use-waypoint=waypoint-foo --overwrite | ||
| ---- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
modules/ossm-updating-waypoint-proxies-with-inplace-strategy.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // Module included in the following assemblies: | ||
| // update/ossm-updating-openshift-service-mesh-in-ambient-mode.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="ossm-updating-waypoint-proxies-with-inplace-strategy_{context}"] | ||
| = Updating waypoint proxies with InPlace strategy in ambient mode | ||
|
|
||
| [role="_abstract"] | ||
| During an `InPlace` update in ambient mode, waypoint proxies are going to be updated to the latest control plane version without restarting application workloads because they are deployed and managed as separate Gateway API resources that scale and upgrade independently. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have updated the {istio} control plane with `InPlace` update strategy. | ||
|
|
||
| .Procedure | ||
|
|
||
| * Confirm that the waypoint proxy was updated proxy version by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ istioctl proxy-status | grep waypoint | ||
| ---- | ||
| + | ||
| You should see an output similar to the following example: | ||
| + | ||
| [source,terminal,subs="+attributes"] | ||
| ---- | ||
| waypoint-5d9c8b7f9-abc12.bookinfo SYNCED SYNCED SYNCED SYNCED istiod-6cf8d4f9cb-wm7x6.istio-system {istio-latest} | ||
| ---- | ||
| + | ||
| You can run the command to query the {istio} control plane and verify that the waypoint proxy connects and synchronizes. The output lists the waypoint proxy name and namespace, the synchronization status for each configuration type, the connected `istiod` pod, and the {istio} version of the running proxy. Columns showing `SYNCED` confirm that the waypoint proxy is successfully receiving configuration from the control plane. |
51 changes: 51 additions & 0 deletions
51
modules/ossm-updating-waypoint-proxies-with-revisionbased-strategy.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| // Module included in the following assemblies: | ||
| // update/ossm-updating-openshift-service-mesh-in-ambient-mode.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="ossm-updating-waypoint-proxies-with-revisionbased-strategy_{context}"] | ||
| = Updating waypoint proxies with RevisionBased strategy in ambient mode | ||
|
|
||
| [role="_abstract"] | ||
| In ambient mode, you can update waypoint proxies by using the `RevisionBased` update strategy. During the migration period, the proxies remain compatible with many control plane versions and automatically connect to the active control plane revision. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| Keep waypoint proxies within one minor version of the control plane (same version or `n–1`). This recommendation aligns with the support policy of {istio}, which states that data plane components must not run ahead of the control plane version. Apply the same versioning guidance to {istio} Container Network Interface (CNI) and `Ztunnel` components. For more details, see the "{istio} Supported Releases" documentation. | ||
| ==== | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have updated the {istio} control plane with `RevisionBased` update strategy. | ||
|
|
||
| .Procedure | ||
|
|
||
| . After the new {istio} control plane revision is ready, verify waypoint proxy pods are running by entering the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc get pods -n bookinfo -l gateway.networking.k8s.io/gateway-name=waypoint | ||
| ---- | ||
| + | ||
| You should see an output similar to the following example: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| NAME READY STATUS RESTARTS AGE | ||
| waypoint-5d9c8b7f9-abc12 1/1 Running 0 5m | ||
| ---- | ||
|
|
||
| . Confirm that the waypoint proxy is updated to the latest version by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ istioctl proxy-status | grep waypoint | ||
| ---- | ||
| + | ||
| You should see an output similar to the following example: | ||
| + | ||
| [source,terminal,subs="+attributes"] | ||
| ---- | ||
| waypoint-5d9c8b7f9-abc12.bookinfo SYNCED SYNCED SYNCED SYNCED istiod-1-27-3-7b9f8c5d6-xyz78.istio-system {istio-latest} | ||
| ---- | ||
| + | ||
| You can run the command to query the {istio} control plane and verify that the waypoint proxy is connected to the new revision. The output lists the revision-specific `istiod` pod (for example, `istiod-1-27-3`) and shows that the waypoint proxy is running the updated version, {istio-latest}. The revision-specific name in the `ISTIOD` column confirms that the waypoint proxy has successfully migrated to the new control plane revision. |
80 changes: 80 additions & 0 deletions
80
modules/ossm-verifying-l7-features-with-authorization-policies.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| // Module included in the following assemblies: | ||
| // update/ossm-updating-openshift-service-mesh-in-ambient-mode.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="ossm-verifying-l7-features-with-authorization-policies_{context}"] | ||
| = Verifying Layer 7 (L7) features with authorization policies | ||
|
|
||
| [role="_abstract"] | ||
| After updating the waypoint proxies, verify that the Layer 7 (L7) authorization policies are enforced correctly. In this example, the `AuthorizationPolicy` resource named `productpage-waypoint` allows only requests from the `default/sa/curl` service account to send `GET` requests to the `productpage` service. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have updated the waypoint proxies. | ||
|
|
||
| * You have created an application pod using the described service account in the `AuthorizationPolicy` resource. | ||
|
|
||
| * You have created an `AuthorizationPolicy` resource. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Optional: Create the `AuthorizationPolicy` resource if it does not already exist by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc apply -f - <<EOF | ||
| apiVersion: security.istio.io/v1 | ||
| kind: AuthorizationPolicy | ||
| metadata: | ||
| name: productpage-waypoint | ||
| namespace: bookinfo | ||
| spec: | ||
| targetRefs: | ||
| - kind: Service | ||
| group: "" | ||
| name: productpage | ||
| action: ALLOW | ||
| rules: | ||
| - from: | ||
| - source: | ||
| principals: | ||
| - cluster.local/ns/default/sa/curl | ||
| to: | ||
| - operation: | ||
| methods: ["GET"] | ||
| EOF | ||
| ---- | ||
|
|
||
| . Verify that services not included in the allow list, such as the ratings service, are denied access by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc exec "$( | ||
| kubectl get pod \ | ||
| -l app=ratings \ | ||
| -n bookinfo \ | ||
| -o jsonpath='{.items[0].metadata.name}' | ||
| )" \ | ||
| -c ratings \ | ||
| -n bookinfo -- \ | ||
| curl -sS productpage:9080/productpage | ||
| ---- | ||
| + | ||
| The request will be denied because the `ratings` service is not included in the authorization policy’s `allow` list. Only the `curl` pod using the `default/curl` service account can access `productpage` service. | ||
|
|
||
| . Verify that the `curl` service can access the `productpage` service with `GET` requests by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| oc exec "$( | ||
| kubectl get pod \ | ||
| -l app=curl \ | ||
| -n default \ | ||
| -o jsonpath='{.items[0].metadata.name}' | ||
| )" \ | ||
| -c curl \ | ||
| -n default -- \ | ||
| curl -sS http://productpage.bookinfo:9080/productpage | grep -o "<title>.*</title>" | ||
| ---- | ||
| + | ||
| The request will succeed because the `curl` service meets the authorization policy rules. It uses the `cluster.local/ns/default/sa/curl` principal and performs a `GET` operation, both allowed by the policy. The successful response containing the page title confirms that the waypoint proxy correctly enforces L7 authorization rules and allows valid traffic. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.