api

README

Note: this repository is modified from istio/api. Thank Istio community for the great work.

Aeraki APIs and Common Configuration Definitions

This repository defines component-level APIs and common configuration formats for the Aeraki Mesh. 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 Aeraki 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 proto-commit must be run to 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 protolock. To force these changes in, install protolock and run protolock commit --force.

You must include a note in your PR that you had to force the protolock and why.