gateway-api 0.17.1

Gateway API bindings for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

[![Docs](https://img.shields.io/badge/docs-docs.rs-ff69b4.svg)](https://docs.rs/gateway-api/)
[![crates.io](https://img.shields.io/crates/v/gateway-api.svg)](https://crates.io/crates/gateway-api)
[![License](https://img.shields.io/badge/license-mit-blue.svg)](https://raw.githubusercontent.com/kube-rs/gateway-api-rs/main/LICENSE)

> **Warning**: EXPERIMENTAL.

# Gateway API (Rust)

[Rust] bindings for [Kubernetes] [Gateway API].

> **Note**: Currently supports [Gateway API version v1.2.1][gwv]

[gwv]:https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.2.1
[Rust]:https://rust-lang.org
[Kubernetes]:https://kubernetes.io/
[Gateway API]:https://gateway-api.sigs.k8s.io/

## 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 examples.

[kube-rs Client]:https://docs.rs/kube/latest/kube/struct.Client.html
[Gateway API resources]:https://gateway-api.sigs.k8s.io/api-types/gateway/
[Controller]:https://kube.rs/controllers/intro/

## 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:

```console
$ cargo install kopium --version 0.22.5
```

After which you can run the `update.sh` script:

```console
$ ./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.

[Kopium]:https://github.com/kube-rs/kopium

## Contributions

For questions and general discussion, please use the [discussion board].

Contributions are welcome. Please create an issue describing what changes are
desired 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 contains high priority items.

[project board]:https://github.com/orgs/kube-rs/projects/3
[discussion board]:https://github.com/kube-rs/gateway-api-rs/discussions