You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Minor readme fixes
some old links and bad wording.
really this thing is due for a bigger overhaul, but i don't have it in me today.
Signed-off-by: clux <[email protected]>
* feature doc link
Signed-off-by: clux <[email protected]>
---------
Signed-off-by: clux <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+11-8
Original file line number
Diff line number
Diff line change
@@ -20,18 +20,19 @@ kube = { version = "0.90.0", features = ["runtime", "derive"] }
20
20
k8s-openapi = { version = "0.21.1", features = ["latest"] }
21
21
```
22
22
23
-
[Features are available](https://github.com/kube-rs/kube/blob/main/kube/Cargo.toml#L18).
23
+
See [features](https://kube.rs/features/) for a quick overview of default-enabled / opt-in functionality.
24
24
25
25
## Upgrading
26
26
27
-
Please check the [CHANGELOG](https://github.com/kube-rs/kube/blob/main/CHANGELOG.md) when upgrading.
28
-
All crates herein are versioned and [released](https://github.com/kube-rs/kube/blob/main/release.toml) together to guarantee [compatibility before 1.0](https://github.com/kube-rs/kube/issues/508).
27
+
See [kube.rs/upgrading](https://kube.rs/upgrading/).
28
+
Noteworthy changes are highlighted in [releases](https://github.com/kube-rs/kube/releases), and archived in the [changelog](https://kube.rs/changelog/).
29
29
30
30
## Usage
31
31
32
32
See the **[examples directory](https://github.com/kube-rs/kube/blob/main/examples)** for how to use any of these crates.
33
33
34
34
-**[kube API Docs](https://docs.rs/kube/)**
35
+
-**[kube.rs](https://kube.rs)**
35
36
36
37
Official examples:
37
38
@@ -42,14 +43,14 @@ For real world projects see [ADOPTERS](https://kube.rs/adopters/).
42
43
43
44
## Api
44
45
45
-
The [`Api`](https://docs.rs/kube/*/kube/struct.Api.html) is what interacts with kubernetes resources, and is generic over [`Resource`](https://docs.rs/kube/*/kube/trait.Resource.html):
46
+
The [`Api`](https://docs.rs/kube/*/kube/struct.Api.html) is what interacts with Kubernetes resources, and is generic over [`Resource`](https://docs.rs/kube/*/kube/trait.Resource.html):
println!("Got blog pod with containers: {:?}", p.spec.unwrap().containers);
52
+
letpod=pods.get("blog").await?;
53
+
println!("Got pod: {pod:?}");
53
54
54
55
letpatch=json!({"spec": {
55
56
"activeDeadlineSeconds":5
@@ -67,7 +68,7 @@ See the examples ending in `_api` examples for more detail.
67
68
68
69
Working with custom resources uses automatic code-generation via [proc_macros in kube-derive](https://docs.rs/kube/latest/kube/derive.CustomResource.html).
69
70
70
-
You need to `#[derive(CustomResource)]` and some `#[kube(attrs..)]` on a spec struct:
71
+
You need to add `#[derive(CustomResource, JsonSchema)]` and some `#[kube(attrs..)]` on a __spec__ struct:
Here `reconcile` and `error_policy` refer to functions you define. The first will be called when the root or child elements change, and the second when the `reconciler` returns an `Err`.
148
149
150
+
See the [controller guide](https://kube.rs/controllers/intro/) for how to write these.
151
+
149
152
## TLS
150
153
151
-
By default [rustls](https://github.com/ctz/rustls) is used for TLS, but `openssl` is supported. To switch, turn off `default-features`, and enable the `openssl-tls` feature:
154
+
By default [rustls](https://github.com/rustls/rustls) is used for TLS, but `openssl` is supported. To switch, turn off `default-features`, and enable the `openssl-tls` feature:
0 commit comments