Docs for Gateway API #1813

nelljerram · 2024-12-13T17:47:05Z

Product Version(s):

Issue:

Link to docs preview:

SME review:

An SME has approved this change.

DOCS review:

A member of the docs team has approved this change.

Additional information:

Merge checklist:

Deploy preview inspected wherever changes were made
Build completed successfully
Test have passed

netlify · 2024-12-13T17:47:24Z

❌ Deploy Preview for tigera failed. Why did it fail? →

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`e057c7f`
🔍 Latest deploy log	https://app.netlify.com/sites/tigera/deploys/67630600e8581e0008f0da07

netlify · 2024-12-13T17:47:25Z

✅ Deploy Preview for calico-docs-preview-next ready!

Name	Link
🔨 Latest commit	`e057c7f`
🔍 Latest deploy log	https://app.netlify.com/sites/calico-docs-preview-next/deploys/67630600cea35a0009636da9
😎 Deploy Preview	https://deploy-preview-1813--calico-docs-preview-next.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 30 Accessibility: 90 Best Practices: 83 SEO: 92 PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

rene-dekker · 2024-12-13T18:05:53Z

calico-enterprise/networking/gateway-api.mdx

+Shortly after this you will see that Gateway API resources are now available:
+
+```bash
+kubectl api-resources | grep gateway.networking.k8s.io


Should we be relying on the new tigerastatus instead?

At this point I'm more interested in showing that the CRDs have been installed. But certainly we could mention the "gatewayapi" tigerastatus object as well - would you like me to add that?

I think tigerastatus is a more useful thing to use. If it succeeds, then we know CRDs are installed. If not, it provides you useful troubleshooting information.

rene-dekker · 2024-12-13T18:06:40Z

calico-enterprise/networking/gateway-api.mdx

+
+### Use the Gateway API
+
+Now you can use the Gateway API in any way that the API supports.  When configuring a Gateway resource, be sure to specify `gatewayClassName: tigera-gateway-class`.


Should we be calling it tigera-gateway? -class is redundant.

We could do. But in this case I think the -class is helpful, on balance. There are so many things that are called "gateway": the API, the controller, the Gateway objects, and the GatewayClass. So here I think it's helpful to be more explicit.

We don't add suffixes to any resource we create in the operator, like storage classes, deployments, services, ... I think we should be consistent in naming things.

rene-dekker · 2024-12-13T18:07:07Z

calico-enterprise/networking/gateway-api.mdx

+- Once that pod is running, install `curl` in it:
+
+```bash
+kubectl exec -it test-client -- apt-get -y update


Should we combine the lines and remote -it?

I don't see a need to do that. I agree it's slightly annoying that everyone puts -it everywhere even when not needed, but it does no harm. (And I remember cases where -i is surprisingly needed. Not sure if this could be one of those.)

I'm confident that these don't need it.

I think we should use https://hub.docker.com/r/alpine/curl image for this page to avoid apt update and installing curl.

-- update --
Never mind, I see you need jq

rene-dekker · 2024-12-13T18:12:57Z

calico-enterprise/networking/gateway-api.mdx

+
+### Gateway API
+
+The Gateway API is an official Kubernetes API for advanced routing to services in a cluster.  To read about its use cases, structure and design, please see [the official docs](https://gateway-api.sigs.k8s.io/).


Should we specify which (minimum) gateway api version(s) we support? I imagine that there may be conflicts with api versions, for example the grant is at v1beta1 now.

Thanks, I've added a table to show this.

rene-dekker · 2024-12-13T18:13:49Z

calico-enterprise/networking/gateway-api.mdx

+
+- The output confirms that the request was handled by the echo server in namespace `ns1`:
+
+```


Is this supposed to be empty? Maybe if we expect an empty output, we can put it in text, rather than an empty code block? (I'm not even sure something will be rendered, the deploy preview didn't build unfortunately.)

Sorry, this was work-in-progress. It's filled in now.

rene-dekker · 2024-12-13T18:17:33Z

calico-enterprise/networking/gateway-api.mdx

+
+- The output confirms that the request was handled by the echo server in namespace `ns2`:
+
+```


Is this supposed to be empty as well?

Sorry, this was work-in-progress. It's filled in now.

peterkellydev · 2024-12-17T16:41:55Z

calico-enterprise/networking/gateway-api.mdx

+
+| Resource         | Versions          |
+| ---------------- | ----------------- |
+| BackendLBPolicy  | v1alpha2          |


I was going to ask if we should state a specific version of the gateway API we support and not document alpha and beta versions, so the list would just be

Gateway, GatewayClass, HTTPRoute and GRPCRoute to start. Which are v1.

But I guess we support all of the beta and alpha too via EnvoyGateway so there's no reason not to document that really, I can't think of any

peterkellydev

LGTM.

This naming and sidebar etc is fine while PM still decides on the naming.

I can see the sidebar being "Ingress Gateway" potentially (and positioned directly above / below "Egress Gateway" but we are waiting on PM to decide on what this feature is going to be called.

Because I now realize that this is intentionally a release time process, not dev time. This reverts commit 1b9c8be.

gantony · 2024-12-19T09:30:40Z

calico-enterprise/networking/gateway-api.mdx

+- Once that pod is running, install `curl` in it:
+
+  ```bash
+  kubectl exec -it test-client -- apt-get -y update
+  kubectl exec -it test-client -- apt-get -y install curl
+  ```


Could use an image that already has curl installed. I typically use wbitt/network-multitool for that kind of stuff (not sure if there are better alternatives).

ctauchen · 2024-12-20T16:53:25Z

Merging this now with plans to make improvements as discussed in coming weeks. Thanks for this, @nelljerram!

Docs for Gateway API

5cbbbe5

nelljerram requested a review from a team as a code owner December 13, 2024 17:47

rene-dekker reviewed Dec 13, 2024

View reviewed changes

nelljerram added 7 commits December 16, 2024 11:06

List exact Gateway API resources and versions that we provide

c4686e9

Be less verbose

13d812b

Add more detail into the sample scenario

9c6e6d1

Add "tech preview" note and remove "Which gives"

a88dc77

More detail, checking if I can indent code blocks

6b567bb

Indenting works, so apply it everywhere

0a27762

Complete and refine per testing

b0eb090

peterkellydev reviewed Dec 17, 2024

View reviewed changes

peterkellydev approved these changes Dec 17, 2024

View reviewed changes

nelljerram added 2 commits December 18, 2024 11:59

Regenerate operator API docs

1b9c8be

Revert "Regenerate operator API docs"

e057c7f

Because I now realize that this is intentionally a release time process, not dev time. This reverts commit 1b9c8be.

gantony reviewed Dec 19, 2024

View reviewed changes

ctauchen merged commit 65378fe into tigera:main Dec 20, 2024
6 of 10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs for Gateway API #1813

Docs for Gateway API #1813

nelljerram commented Dec 13, 2024

netlify bot commented Dec 13, 2024 •

edited

Loading

netlify bot commented Dec 13, 2024 •

edited

Loading

rene-dekker Dec 13, 2024

nelljerram Dec 17, 2024

rene-dekker Dec 17, 2024

rene-dekker Dec 13, 2024

nelljerram Dec 17, 2024

rene-dekker Dec 17, 2024

rene-dekker Dec 13, 2024

nelljerram Dec 17, 2024

rene-dekker Dec 17, 2024

rene-dekker Dec 17, 2024 •

edited

Loading

rene-dekker Dec 13, 2024

nelljerram Dec 16, 2024

rene-dekker Dec 13, 2024

nelljerram Dec 17, 2024

rene-dekker Dec 13, 2024

nelljerram Dec 17, 2024

peterkellydev Dec 17, 2024

peterkellydev left a comment •

edited

Loading

gantony Dec 19, 2024

ctauchen commented Dec 20, 2024


		### Use the Gateway API

		Now you can use the Gateway API in any way that the API supports. When configuring a Gateway resource, be sure to specify `gatewayClassName: tigera-gateway-class`.


		### Gateway API

		The Gateway API is an official Kubernetes API for advanced routing to services in a cluster. To read about its use cases, structure and design, please see [the official docs](https://gateway-api.sigs.k8s.io/).


		- The output confirms that the request was handled by the echo server in namespace `ns1`:

		```

Docs for Gateway API #1813

Docs for Gateway API #1813

Conversation

nelljerram commented Dec 13, 2024

netlify bot commented Dec 13, 2024 • edited Loading

❌ Deploy Preview for tigera failed. Why did it fail? →

netlify bot commented Dec 13, 2024 • edited Loading

✅ Deploy Preview for calico-docs-preview-next ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rene-dekker Dec 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peterkellydev left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ctauchen commented Dec 20, 2024

netlify bot commented Dec 13, 2024 •

edited

Loading

netlify bot commented Dec 13, 2024 •

edited

Loading

rene-dekker Dec 17, 2024 •

edited

Loading

peterkellydev left a comment •

edited

Loading