Skip to content

Update Helm install command for Envoy Gateway #7637

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.

Sign up for GitHub

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
scraly wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Helm install command for Envoy Gateway #7637

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/content/en/latest/tasks/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ so the `Gateway` resource has an Address associated with it. We recommend using
Install the Gateway API CRDs and Envoy Gateway:

```shell
helm install eg oci://docker.io/envoyproxy/gateway-helm --version {{< helm-version >}} -n envoy-gateway-system --create-namespace
helm install eg oci://docker.io/envoyproxy/gateway-helm -n envoy-gateway-system --create-namespace
Copy link
Contributor

@jukie jukie Dec 1, 2025

Choose a reason for hiding this comment

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

I don't think we need this. When navigating to versioned install docs you get an actual version vs v0.0.0-latest, e.g. https://gateway.envoyproxy.io/v1.6/install/install-helm/#install-with-helm.

Copy link
Author

@scraly scraly Dec 1, 2025

Choose a reason for hiding this comment

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

As n user I don't want to install 0.0.0-latest but instead the latest version, 1.6 for example

Copy link
Contributor

@jukie jukie Dec 1, 2025

Choose a reason for hiding this comment

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

So then shouldn't the user navigate to the v1.6 docs pages? Perhaps for the latest version docs we can instead use the latest version (e.g. 1.6) instead but we shouldn't just remove this flag entirely.

Copy link
Contributor

@jukie jukie Dec 1, 2025

Choose a reason for hiding this comment

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

I'm certainly not an expert on UX but just sharing that the current setup will already facilitate what you mention if you navigate to the versioned docs page instead of "latest".

Copy link
Author

@scraly scraly Dec 1, 2025

Choose a reason for hiding this comment

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

Just to understand correctly, so for you it's normal to ask the user to install the v0.0.0-latest instead of the latest version?

Copy link
Contributor

@arkodg arkodg Dec 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

yeah this is by design @scraly
if a user has intentionally navigated from https://gateway.envoyproxy.io to https://gateway.envoyproxy.io/latest/ they are attempting to access unreleased bleeding edge content, there's even a banner on this page

Notice:
This is the "latest" release of Envoy Gateway, which contains the most recent commits from the main branch.
This release might not be stable.
Please refer to the [/docs](https://gateway.envoyproxy.io/docs) documentation for the most current information.

Copy link
Contributor

@jukie jukie Dec 1, 2025

Choose a reason for hiding this comment

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

I'm saying that a user can get the behavior you're seeking by navigating to the versioned docs pages such as https://gateway.envoyproxy.io/v1.6/install/install-helm/#install-with-helm and it doesn't seem irregular that the /latest versioned docs would use something like v0.0.0-latest.
I'm open to a discussion of whether the /latest docs pages (e.g. https://gateway.envoyproxy.io/latest/install/install-helm/#install-with-helm) should also default to the most recent version (e.g. currently v1.6) but I think your change here would break the versioned docs pages in future releases so instead of removing should map helm-version for latest to the most recent version.

Copy link
Contributor

@jukie jukie Dec 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

CC @envoyproxy/gateway-maintainers should the /latest docs pages use v0.0.0-latest or the most recent release (e.g. currently v1.6) for general docs and install steps?

As for some examples:

  • Istio omits the version flag entirely so if a user navigates to an older release version and runs the setup guide they would instead be installing the most recent release version. This seems like a poor UX to me.
  • Karpenter maps latest to the most recent release version and then has a separate "preview" docs version page which is equivalent to EG's current "latest".

Personally, the karpenter model makes most sense to me and may fix understandable confusion for users like @scraly who logically think latest will map to the most recent release version.

Edit: missed Arko's comment and didn't realize we had the existing banner. That seems reasonable as well and should be sufficient here.

Copy link
Member

@cnvergence cnvergence Dec 2, 2025

Choose a reason for hiding this comment

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

I'm fine with setting it to the latest release, as only for helm install.
But if it is described with the notice, I think we can keep the old style, we could improve it by setting something like preview, git tag instead of v0.0.0-latest.

```

Wait for Envoy Gateway to become available:
Expand Down