Get Involved on Envoy Gateway

Roadmap

Mon, 01 Jan 0001 00:00:00 +0000

This document serves as a high-level reference for Envoy Gateway users and contributors to understand the direction of the project.

Contributing to the Roadmap

To add a feature to the roadmap, create an issue or join a community meeting to discuss your use case. If your feature is accepted, a maintainer will assign your issue to a release milestone and update this document accordingly.
To help with an existing roadmap item, comment on or assign yourself to the associated issue.
If a roadmap item doesn’t have an issue, create one, assign yourself to the issue, and reference this document. A maintainer will submit a pull request to add the feature to the roadmap. Note: The feature should be discussed in an issue or a community meeting before implementing it.

If you don’t know where to start contributing, help is needed to reduce technical, automation, and documentation debt. Look for issues with the help wanted label to get started.

Developer Guide

Mon, 01 Jan 0001 00:00:00 +0000

Envoy Gateway is built using a make-based build system. Our CI is based on Github Actions using workflows.

Prerequisites

go

Version: 1.24
Installation Guide: https://go.dev/doc/install

make

Recommended Version: 4.0 or later
Installation Guide: https://www.gnu.org/software/make

docker

Optional when you want to build a Docker image or run make inside Docker.
Recommended Version: 20.10.16
Installation Guide: https://docs.docker.com/engine/install

python3

Need a python3 program
Must have a functioning venv module; this is part of the standard library, but some distributions (such as Debian and Ubuntu) replace it with a stub and require you to install a python3-venv package separately.

Quickstart

Run make help to see all the available targets to build, test and run Envoy Gateway. Below are the other make directives

Contributing

Mon, 01 Jan 0001 00:00:00 +0000

We welcome contributions from the community. Please carefully review the project goals and following guidelines to streamline your contributions.

Communication

Before starting work on a major feature, please contact us via GitHub or Slack. We will ensure no one else is working on it and ask you to open a GitHub issue.
A “major feature” is defined as any change that is > 100 LOC altered (not including tests), or changes any user-facing behavior. We will use the GitHub issue to discuss the feature and come to agreement. This is to prevent your time being wasted, as well as ours. The GitHub review process for major features is also important so that affiliations with commit access can come to agreement on the design. If it’s appropriate to write a design document, the document must be hosted either in the GitHub issue, or linked to from the issue and hosted in a world-readable location.
Small patches and bug fixes don’t need prior communication.

Inclusivity

The Envoy Gateway community has an explicit goal to be inclusive to all. As such, all PRs must adhere to the following guidelines for all code, APIs, and documentation:

Adopters

Mon, 01 Jan 0001 00:00:00 +0000

Join the Envoy Gateway Adopters List

Envoy Gateway is a sub-project of Envoy, a graduated CNCF project under the Cloud Native Computing Foundation (CNCF), which is a part of the Linux Foundation, a 501(c)(6) nonprofit organization.

Why Add Your Logo?

As Envoy Gateway gains momentum as the preferred API gateway within the CNCF ecosystem, your company’s support helps drive its adoption and success. By joining the Envoy Gateway Adopters List, you:

Code of Conduct

Mon, 01 Jan 0001 00:00:00 +0000

Envoy Gateway follows the CNCF Code of Conduct.

Enterprise Support

Mon, 01 Jan 0001 00:00:00 +0000

Enterprise Support for Envoy Gateway

Envoy Gateway is a sub-project of Envoy, a graduated CNCF project under the Cloud Native Computing Foundation (CNCF), which is a part of the Linux Foundation, a 501(c)(6) nonprofit organization.

Professional Support & Services

While Envoy Gateway is open source and free to use, many organizations benefit from professional support, training, and consulting services to accelerate adoption and ensure production success.

Why Choose Enterprise Support?

🛡️ Production Assurance – Get expert guidance for mission-critical deployments with guaranteed response times and SLAs
🚀 Faster Implementation – Leverage professional services to accelerate your API gateway rollout and avoid common pitfalls
📚 Training & Best Practices – Access comprehensive training programs and learn proven deployment patterns from experts
🔧 Custom Solutions – Get help with complex integrations, custom policies, and advanced use cases

Maintainers

Mon, 01 Jan 0001 00:00:00 +0000

The following maintainers, listed in alphabetical order, own everything

@arkodg
@cnvergence
@guydc
@jukie
@kkk777-7
@rudrakhp
@shawnh2
@Xunzhuo
@zhaohuabing
@zirain

Emeritus Maintainers

@alexgervais
@Alice-Lilith
@danehans
@LukeShu
@qicz
@skriss
@youngnick

Open Source Ecosystem

Mon, 01 Jan 0001 00:00:00 +0000

Envoy Gateway OSS Ecosystem 🌐

Envoy Gateway powers modern API gateway solutions while embracing the collaborative spirit of open source. This section highlights projects that extend, integrate with, or leverage Envoy Gateway’s capabilities.

Why Add Your Project?

By listing your open source project here, you help:

🌱 Boost Visibility - Showcase how your project interacts with Envoy Gateway to thousands of cloud-native developers
🤝 Encourage Collaboration - Attract contributors and foster interoperability within the ecosystem

Release Process

Mon, 01 Jan 0001 00:00:00 +0000

This document guides maintainers through the process of creating an Envoy Gateway release.

Release Candidate

The following steps should be used for creating a release candidate.

Prerequisites

Permissions to push to the Envoy Gateway repository.

Set environment variables for use in subsequent steps:

export MAJOR_VERSION=0
export MINOR_VERSION=3
export RELEASE_CANDIDATE_NUMBER=1
export GITHUB_REMOTE=origin

Clone the repo, checkout the main branch, ensure it’s up-to-date, and your local branch is clean.

Working on Envoy Gateway Docs

Mon, 01 Jan 0001 00:00:00 +0000

The documentation for the Envoy Gateway lives in the site/content/en directory. Any individual document can be written using Markdown.

Documentation Structure

We supported the versioned Docs now, the directory name under docs represents the version of docs. The root of the latest site is in site/content/en/latest. This is probably where to start if you’re trying to understand how things fit together.

Note that the new contents should be added to site/content/en/latest and will be cut off at the next release. The contents under site/content/en/v0.5.0 are auto-generated, and usually do not need to make changes to them, unless if you find the current release pages have some incorrect contents. If so, you should send a PR to update contents both of site/content/en/latest and site/content/en/v0.5.0.