Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.17 KB

README.md

File metadata and controls

25 lines (18 loc) · 1.17 KB
Raw

This folder stores filter config proto files for ESPv2 http filters.

Config versioning:

ESPv2 config is versioned. The current version is stored in api/VERSION file. The folder names under api/ contain version, e.g. api/envoy/v10/http/backend_auth. The proto package names contain version too, e.g. espv2.api.envoy.v10.http.common.Pattern.

Versioning Rules:

When making changes to the config proto files, make sure:

  • No breaking changes, the changes should be backward compatible,
  • If a breaking change is required, increase config version.

When making changes to Config Manager, make sure the new config is compatible with older Envoy binaries under the current API version. If it's incompatible, increase the config version.

Steps to increase config version

If a breaking change is required, use following steps to increase config version.

  • Increase api/VERSION to a newer version, e.g. from v6 to v7.
  • Rename folder name from api/envoy/v6/http to api/envoy/v10/http.
  • Replace package names from api.envoy.v6.http to api.envoy.v10.http for all proto files under folder api/.

Above steps can be achieved by running script api/scripts/update_version.sh.