docs(setup): add guide for using custom upstream Envoy images#844
Open
mihir-dixit2k27 wants to merge 1 commit into
Open
docs(setup): add guide for using custom upstream Envoy images#844mihir-dixit2k27 wants to merge 1 commit into
mihir-dixit2k27 wants to merge 1 commit into
Conversation
mihir-dixit2k27
force-pushed
the
docs/upstream-envoy-image-guide
branch
from
1044eec to
909d0a7
Compare
Add a new page under setup/customize/ (main) and setup/ (latest) explaining how to build a custom envoy-wrapper image on top of any upstream Envoy release and configure kgateway to use it. Covers: - Why plain upstream Envoy images do not work (Dynamic Modules ABI) - The envoy-wrapper-docker make target and ENVOY_IMAGE / IMAGE_REGISTRY / VERSION variables - The spec.kube.envoyContainer.image CRD field path in GatewayParameters - Patch-vs-minor ABI compatibility constraints - Cluster-wide default via gatewayClassParametersRefs Helm value Also adds card entries to the relevant _index.md files so the page appears in the section navigation. Closes kgateway-dev/kgateway#14193 Signed-off-by: Mihir Dixit <dixitmihir1@gmail.com>
mihir-dixit2k27
force-pushed
the
docs/upstream-envoy-image-guide
branch
from
909d0a7 to
7faa9bb
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Adds a user-facing guide for building and using a custom
envoy-wrapperimagebased on any upstream Envoy release, so users can apply Envoy CVE fixes orpatch updates without waiting for an official kgateway release.Motivation: Closes a docs gap from #14193. The capability already shipsin v2.3 (
make envoy-wrapper-docker,GatewayParameters.spec.kube.envoyContainer),but was never documented for end users.What changed:
assets/docs/pages/setup/customize/envoy-image.md- the full guide, covering:envoyinitand thelibrust_module.soDynamic Module), Envoy ABI compatibility rules (patch bumps safe, minor bumps require an SDK pin change), and step-by-step instructions to build, push, and wire in a custom image viaGatewayParametersandGateway. Also covers the cluster-wide default viagatewayClassParametersRefs.content/docs/envoy/main/setup/customize/envoy-image.mdandcontent/docs/envoy/latest/setup/envoy-image.md, following the reuse-shortcode pattern used throughout the site._index.mdfiles so the page shows up insection nav under both versions.Fixes kgateway-dev/kgateway#14193
Change Type
/kind documentation
Changelog