-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OSDOCS-18010 [NETOSBERV] New Feature: Improving integration with GatewayAPI #106001
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
Open
gwynnemonahan
wants to merge
5
commits into
openshift:main
Choose a base branch
from
gwynnemonahan:OSDOCS-18010
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+127
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9d7b90e
OSDOCS-18010 [NETOSBERV] New Feature: Improving integration with Gate…
gwynnemonahan 4b8e082
Add concept, procedure, reference modules (Squash)
gwynnemonahan 1af5c9a
Add to topic_map (Squash)
gwynnemonahan 8a995f1
Spelling error in Reference (Squash)
gwynnemonahan a62e7b0
Errant quotation (Squash)
gwynnemonahan 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * network_observability/network-observability-gateway-api.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="network-observability-gateway-api-configure_{context}"] | ||
| = Configure Gateway API for visibility | ||
|
|
||
| [role="_abstract"] | ||
| To activate automated tracking for Gateway API resources and enable direct links to Gateway resource pages, update the `FlowCollector` configuration. | ||
|
|
||
| .Prerequisites | ||
| * Network Observability Operator is installed. | ||
| * A `GatewayClass` resource has been created. See "Getting started with the Gateway API for the Ingress Operator". | ||
| * A Gateway API-compliant controller (such as OpenShift Service Mesh 3) is managing cluster traffic. | ||
|
|
||
| .Procedure | ||
| . Edit the `FlowCollector` custom resource by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc edit flowcollector cluster | ||
| ---- | ||
|
|
||
| . Enable `NetworkEvents` enrichment to trigger automated Gateway detection: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: flows.netobserv.io/v1alpha1 | ||
| kind: FlowCollector | ||
| metadata: | ||
| name: cluster | ||
| spec: | ||
| processor: | ||
| enrich: | ||
| type: "NetworkEvents" | ||
| ---- | ||
| + | ||
| where: | ||
|
|
||
| `spec.processor.enrich.type`:: Set to `NetworkEvents` to allow network observability to automatically detect and map Gateway API resource hierarchies. | ||
|
|
||
| . Save and exit. | ||
|
|
||
| .Verification | ||
| . In the *Network Traffic* tab, locate a flow originating from your Gateway. | ||
| . Observe that the *Owner* column displays the Gateway name. | ||
| . Click the link on the Gateway object to navigate directly to its resource configuration page. |
36 changes: 36 additions & 0 deletions
36
modules/network-observability-gateway-api-metadata-reference.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,36 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * network_observability/network-observability-gateway-api.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="network-observability-gateway-api-metadata-reference_{context}"] | ||
| = Network observability Gateway API metadata reference | ||
|
|
||
| [role="_abstract"] | ||
| This reference provides technical details for Gateway API fields and configuration parameters within the Network Observability Operator. | ||
|
|
||
| .`FlowCollector` parameters | ||
| [cols="2,1,3", options="header"] | ||
| |=== | ||
| | Parameter | Type | Description | ||
| | `spec.processor.enrich.type` | ||
| | String | ||
| | Must be set to `NetworkEvents` to enable automated Gateway API tracking. | ||
| | `spec.processor.enrich.advanced.parentTrackingDepth` | ||
| | Integer | ||
| | Optional. Overrides the default automated depth detection. | ||
| |=== | ||
|
|
||
| .Gateway API metadata fields | ||
| [cols="1,3", options="header"] | ||
| |=== | ||
| | Field | Description | ||
| | `SrcK8S_OwnerType` | ||
| | The resource type of the source parent (e.g., `Gateway` or `HTTPRoute`). | ||
| | `DstK8S_OwnerType` | ||
| | The resource type of the destination parent. | ||
| | `SrcK8S_OwnerName` | ||
| | The name of the Gateway API resource originating the traffic. | ||
| | `DstK8S_OwnerName` | ||
| | The name of the Gateway API resource receiving the traffic. | ||
| |=== |
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,18 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * network_observability/network-observability-gateway-api.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id="network-observability-gateway-api-visibility_{context}"] | ||
| = Network observability automated Gateway API visibility | ||
|
|
||
| [role="_abstract"] | ||
| The Network Observability Operator provides automated traffic attribution for Gateway API resources. This integration correlates eBPF-captured flows with logical routing resources, such as `Gateways` and `HTTPRoutes`, providing a clear view of "North-South" cluster traffic. | ||
|
|
||
| With the implementation of automated parent tracking, network observability natively traverses the resource ownership hierarchy. This ensures that traffic flowing through ingress proxies (like Envoy) is automatically linked to the high-level Gateway API objects that govern it. | ||
|
|
||
| Key benefits include: | ||
|
|
||
| * Transparent proxy observability: See through the proxy layer to identify which logical route handled a specific request. | ||
| * Automatic correlation: No manual configuration of tracking depth is required for standard Gateway API implementations. | ||
| * Streamlined Troubleshooting: Identify performance bottlenecks or packet drops at the Route level rather than just the Pod level. |
23 changes: 23 additions & 0 deletions
23
observability/network_observability/network-observability-gateway-api.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,23 @@ | ||
| :_mod-docs-content-type: ASSEMBLY | ||
| [id="network-observability-gateway-api_{context}"] | ||
| = Integrate network observability with Gateway API | ||
| include::_attributes/common-attributes.adoc[] | ||
| :context: network-observability-gateway-api | ||
|
|
||
| toc::[] | ||
|
|
||
| [role="_abstract"] | ||
| Learn how to integrate the Network Observability Operator with the Gateway API. By utilizing automated parent tracking, you can gain deep visibility into proxy-managed traffic and link flows directly to Gateway resources. | ||
|
|
||
| include::modules/network-observability-gateway-api-visibility.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/network-observability-gateway-api-configure.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/network-observability-gateway-api-metadata-reference.adoc[leveloffset=+1] | ||
|
|
||
| [id="network-observability-gateway-api-additional-resource_{context}"] | ||
| == Additional resources | ||
| * link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/ingress_and_load_balancing/configuring-ingress-cluster-traffic#ingress-gateway-api[Overview of Gateway API] | ||
| * link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/ingress_and_load_balancing/configuring-ingress-cluster-traffic#nw-ingress-gateway-api-enable_ingress-gateway-api[Getting started with Gateway API for the Ingress Operator] | ||
|
|
||
| //convert to xref after builds pass |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.