Warning: EXPERIMENTAL. Not ready for production use.

Gateway API (Rust)

This project provides bindings in Rust for Kubernetes Gateway API.

Note: Currently supports Gateway API version v1.2.1

Note: The aspiration is to eventually become the "official" Gateway API bindings for Rust. However Kubernetes SIG Network has not officially endorsed it so this should be considered "unofficial" for now.

Usage

Basic usage involves using a kube-rs Client to perform operations on Gateway API resources. You can either use a basic Client to perform operations, or you can build a Controller. See the gateway-api/examples/ directory for detailed (and specific) usage examples.

Development

This project uses Kopium to automatically generate API bindings from upstream Gateway API. Make sure you install kopium locally in order to run the generator:

$ cargo install kopium --version 0.21.3

After which you can run the update.sh script:

$ ./update.sh

Check for errors and/or a non-zero exit code, but upon success you should see updates automatically generated for code in the gateway-api/src/api directory which you can then commit.

Contributions

Contributions are welcome. Please create an issue describing the contribution needed prior to creating a PR.

Please check our project board to see what work has been accepted and is in need of an owner. The next column will hold high priority items.

For discussions we prefer the discussion board.