gateway-api 0.14.0

Kubernetes Gateway API bindings in 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
63
64

[![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. **Not ready for production use**.

> **Note**: This library is considered "unofficial" currently. It's not ready
> for production use, and the [Kubernetes SIG Network] community hasn't
> officially endorsed it. It is a goal of this project to become "official" in
> time as the project matures.

[Kubernetes SIG Network]:https://github.com/kubernetes/community/tree/master/sig-network

# Gateway API (Rust)

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

[Gateway API] is an official [Kubernetes] API for [Layer 7] network routing.
It is the successor to the [Ingress API] but supports both ingress and service
mesh use cases. See the [Gateway API Introduction] for more details.

This project provides bindings in [Rust] for [Kubernetes] [Gateway API].

[gwv]:https://github.com/kubernetes-sigs/gateway-api/releases/tag/v1.2.0
[Gateway API]:https://gateway-api.sigs.k8s.io/
[Kubernetes]:https://kubernetes.io/
[Layer 7]:https://en.wikipedia.org/wiki/Application_layer
[Ingress API]:https://kubernetes.io/docs/concepts/services-networking/ingress/
[Gateway API Introduction]:https://gateway-api.sigs.k8s.io/#introduction
[Rust]:https://rust-lang.org

## Usage

Basic usage involves generating a [kube-rs] 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.

[kube-rs]:https://github.com/kube-rs/kube
[Gateway API resources]:https://gateway-api.sigs.k8s.io/api-types/gateway/
[Client]:https://docs.rs/kube/latest/kube/struct.Client.html
[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
```

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