API definitions for the Istio project
api
Go to file
Whitney Griffith 2b0bfde445
Networking APIs graduation to v1 (#3111)
* bump networking apis to v1

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

* set storageVersion as v1beta1

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

* Add release notes

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

* Update release notes

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

* make gen

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

* Remove ProxyConfig v1

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

* update release notes

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

* Remove update notes

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>

---------

Signed-off-by: whitneygriffith <whitney.griffith16@gmail.com>
2024-03-15 10:52:50 -07:00
.devcontainer
.github
analysis/v1alpha1
annotation
authentication/v1alpha1
common
common-protos
dictionaries
envoy
extensions/v1alpha1
kubernetes
label
licenses
mcp
mesh/v1alpha1
meta/v1alpha1
networking
operator/v1alpha1
releaselocks
releasenotes
scripts
security
stability
telemetry/v1alpha1
tests
type/v1beta1
.gitattributes
.gitignore
BUGS-AND-FEATURE-REQUESTS.md
CODEOWNERS
CONTRIBUTING.md
GUIDELINES.md
LICENSE
Makefile
Makefile.core.mk
Makefile.overrides.mk
README.md
SUPPORT.md
buf.gen-golang.yaml
buf.gen-noncrd.yaml
buf.gen.yaml
buf.yaml
clean.sh
gen.sh
github.com
go.mod
go.sum
google
header.go.txt
istio.io
k8s.io

README.md

Istio APIs and Common Configuration Definitions

This repository defines component-level APIs and common configuration formats for the Istio platform. These definitions are specified using the protobuf syntax.

This repository depends only on the tools repository for tools used during build. This repository will not depend on any other repositories. Except for tools, all other Istio repositories can take a dependency on the api repository.

API Guidelines

When making changes to the protos in this repository, your changes must comply with the API guidelines.

Updating

After the protobuf definitions are updated, the corresponding *pb.go, _pb2.py, *.json and Kubernetes Custom Resource Definition files must be generated by running make gen and submitted as part of the same PR as the updated definitions. Also make gen will update the proto.lock file with new changes.

Backwards Incompatible Changes

If a PR tries to make backwards incompatible changes, it will be blocked by buf breaking. If there are legitimate reasons to make these breaking changes forever, the configuration in buf.yaml can be changed. If it is a one-off case, the PR can be force approved skipping the test.