OSDOCS-13509: add assembly, topic map, and concept #92976
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@jldohmann: This pull request references OSDOCS-13509 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/M
|
🤖 Thu May 15 20:53:35 - Prow CI generated the docs preview: |
|
@jldohmann: This pull request references OSDOCS-13509 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@jldohmann: This pull request references OSDOCS-13509 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@jldohmann: This pull request references OSDOCS-13509 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
LGTM, thanks. |
|
@jldohmann: This pull request references OSDOCS-13509 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
jldohmann
force-pushed
the
OSDOCS-13509
branch
3 times, most recently
from
ae1cd3d to
0fd11d0
Compare
openshift-ci
bot
added
size/L
jldohmann
force-pushed
the
OSDOCS-13509
branch
2 times, most recently
from
7840bd1 to
ee58552
Compare
|
@candita @Miciah is this Gateway API docs PR something either of you can take a look at and provide feedback on? i'm sure there's plenty that needs to be corrected with SME input 😅 this docs PR covers the linked JIRA issues over:
|
|
/assign |
openshift-merge-robot
added
the
needs-rebase
|
|
||
| The project is an effort to provide a standardized, vender-neutral, ecosystem by using a portable API with broad community support. By integrating Gateway API functionality into the Ingress Operator, it enables a networking solution that aligns with existing community and upstream development efforts. | ||
|
|
||
| The Gateway API extends the functionality of the Ingress Operator to handle more granular cluster traffic and routing configurations. These capabilities let you define custom resource definitions (CRDs) using one of Gateway APIs resources. For {product-title} clusters, these resources include: |
There was a problem hiding this comment.
What is meant by "these capabilities"? And why they let us "define CRDs"? The CRDs are defined by the upstream community. We use them "as is" in the cluster ingress operator and enable users to use these apis by creating instances of these custom resources.
There was a problem hiding this comment.
"these capabilities" here is just a way to reference the aforementioned "extends the functionality of the Ingress Operator", is that not right?
ive updated the rest of the paragraph to try and be more clear
| Gateway:: This resource describes how traffic can be translated to services within the cluster. For example, a specific load balancer configuration. | ||
| GatewayClass:: This resource defines a set of Gateways that share a common configuration and behavior. For example, two separate GatewayClasses might be created to distinguish Gateways used for public or private applications. | ||
| HTTPRoute:: This resource specifies routing behavior of of HTTP requests from a Gateway to a service, and is especially useful for multiplexing HTTP or terminated HTTPS connections. | ||
|
|
There was a problem hiding this comment.
There is also GRPCRoute and ReferenceGrant which the cluster ingress operator creates in the cluster.
There was a problem hiding this comment.
thanks, ive updated the definition list to include these
There was a problem hiding this comment.
This resource is created by the Ingress Operator for the cluster.
All of these CRDs are created by the ingress operator. I don't know whether it's worth mentioning this for some (or maybe even for all of them). It seems to me that the idea here is to present what the CRD is for.
| rules: | ||
| - backendRefs: | ||
| - name: sales-db | ||
| ¦ port: 8080 |
There was a problem hiding this comment.
seems to be an indentation artifact when editing yaml, it doesn't show up in the published version though
There was a problem hiding this comment.
I can see it in the preview:
There was a problem hiding this comment.
it is present in the preview yeah
There was a problem hiding this comment.
the preview is not really reflective style-wise to the d.r.c. published documentation. even with d.o.c, the preview contained some artifacts that get stripped out during the publishing process
openshift-merge-robot
removed
the
needs-rebase
|
@jldohmann: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
| [id="nw-ingress-gateway-api-implementation_{context}"] | ||
| = {product-title}'s Gateway API implementation |
There was a problem hiding this comment.
This chapter only mentions the CRD management part of the implementation. Do we want to hightlight the fact that OSSM (OpenShift Service Mesh) operator will be installed behind the scene? And how to trigger this installation (GatewayClass example)?
There was a problem hiding this comment.
its a good question, i wonder that myself. @ahardin-rh what do you think?
Version(s): 4.19
Issue:
Link to docs preview: https://92976--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/configuring_ingress_cluster_traffic/ingress-gateway-api.html
QE review:
Additional information: