API definitions for the Istio project

api

Go to file

Jacob Delgado 8b9b1b6335 update grpc-go dependency		2024-05-30 16:29:39 -06:00
.devcontainer	…
.github	…
analysis/v1alpha1	Use with latest tools image	2024-05-30 16:25:13 -06:00
annotation	…
authentication/v1alpha1	Use with latest tools image	2024-05-30 16:25:13 -06:00
common	…
common-protos	…
dictionaries	…
envoy	Use with latest tools image	2024-05-30 16:25:13 -06:00
extensions/v1alpha1	Use with latest tools image	2024-05-30 16:25:13 -06:00
kubernetes	…
label	…
licenses	…
mcp	Use with latest tools image	2024-05-30 16:25:13 -06:00
mesh/v1alpha1	Use with latest tools image	2024-05-30 16:25:13 -06:00
meta/v1alpha1	Use with latest tools image	2024-05-30 16:25:13 -06:00
networking	Use with latest tools image	2024-05-30 16:25:13 -06:00
operator/v1alpha1	Use with latest tools image	2024-05-30 16:25:13 -06:00
releaselocks	…
releasenotes	…
scripts	…
security	Use with latest tools image	2024-05-30 16:25:13 -06:00
stability	…
telemetry	Use with latest tools image	2024-05-30 16:25:13 -06:00
tests	…
type/v1beta1	Use with latest tools image	2024-05-30 16:25:13 -06:00
.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	update grpc-go dependency	2024-05-30 16:29:39 -06:00
go.sum	update grpc-go dependency	2024-05-30 16:29:39 -06:00
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.