Skip to content

docs: add step for creating the GatewayClass#1984

Merged
TaylorMutch merged 1 commit into
NVIDIA:mainfrom
zhaohuabing:fix-ingress-gc
Jun 24, 2026
Merged

docs: add step for creating the GatewayClass#1984
TaylorMutch merged 1 commit into
NVIDIA:mainfrom
zhaohuabing:fix-ingress-gc

Conversation

@zhaohuabing

@zhaohuabing zhaohuabing commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates the Kubernetes ingress docs to add a dedicated step for creating the eg GatewayClass that the OpenShell chart references. Previously the docs implied Envoy Gateway registered the GatewayClass automatically, but EG helm chart installs only the CRDs and controller, so the GatewayClass must be created explicitly. Also bumps the Envoy Gateway Helm chart version from v1.7.2 to v1.8.1.

Related Issue

N/A — small docs fix.

Changes

  • Reworded the "Install Envoy Gateway" section to clarify that the Helm install provides the Gateway API CRDs and controller (not the GatewayClass)
  • Bumped the Envoy Gateway Helm chart version from v1.7.2 to v1.8.1
  • Added a new "Create the GatewayClass" section with a kubectl apply snippet that creates the eg GatewayClass using the gateway.envoyproxy.io/gatewayclass-controller controller

Testing

  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown

All contributors have signed the DCO ✍️ ✅
Posted by the DCO Assistant Lite bot.

@github-actions

Copy link
Copy Markdown

Thank you for your interest in contributing to OpenShell, @zhaohuabing.

This project uses a vouch system for first-time contributors. Before submitting a pull request, you need to be vouched by a maintainer.

To get vouched:

  1. Open a Vouch Request discussion.
  2. Describe what you want to change and why.
  3. Write in your own words — do not have an AI generate the request.
  4. A maintainer will comment /vouch if approved.
  5. Once vouched, open a new PR (preferred) or reopen this one after a few minutes.

See CONTRIBUTING.md for details.

@github-actions github-actions Bot closed this Jun 24, 2026
@zhaohuabing

Copy link
Copy Markdown
Contributor Author

I have read the DCO document and I hereby sign the DCO.

@TaylorMutch TaylorMutch reopened this Jun 24, 2026
@TaylorMutch

Copy link
Copy Markdown
Collaborator

/ok to test 079963d

@TaylorMutch TaylorMutch left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the fix!

@TaylorMutch

Copy link
Copy Markdown
Collaborator

Branch check failing is unrelated to your PR

@zhaohuabing

Copy link
Copy Markdown
Contributor Author

Hi @TaylorMutch thanks for the quick response and review on this PR. I really appreciate it.

@TaylorMutch TaylorMutch merged commit 62b03f0 into NVIDIA:main Jun 24, 2026
28 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants