gateway-api

Crates.iogateway-api
lib.rsgateway-api
version0.14.1
sourcesrc
created_at2022-11-05 15:17:34.38149
updated_at2024-12-09 12:37:16.279011
descriptionKubernetes Gateway API bindings in Rust
homepagehttps://docs.rs/crate/gateway-api/
repositoryhttps://github.com/kube-rs/gateway-api-rs
max_upload_size
id705857
size554,088
Shane Utt (shaneutt)

documentation

README

Docs crates.io License

Warning: EXPERIMENTAL. Not ready for production use.

Note: This library should be considered "unofficial". While the aspiration is to eventually become the "official" Gateway API bindings for Rust, Kubernetes SIG Network has not yet (and may never) officially endorsed it.

Gateway API (Rust)

Note: Currently supports Gateway API version v1.2.1

This project provides bindings in Rust for Kubernetes Gateway API.

Usage

Basic usage involves using a kube-rs Client to perform create, read, update and delete (CRUD) operations on Gateway API resources. You can either use a basic Client to perform CRUD 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

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.

Commit count: 121

cargo fmt