Skip to content

Commit 3275edd

Browse files
committed
fix incorrect link for k8s-openapi crate
Signed-off-by: Burak Sekili <[email protected]>
1 parent 3a893db commit 3275edd

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/controllers/object.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ We will outline how they interact with controllers and the basics of how to set
1414

1515
## Typed Resource
1616

17-
This is the most common, and simplest case. Your source of truth is an existing [Kubernetes object found in the openapi spec](https://arnavion.github.io/k8s-openapi/v0.14.x/k8s_openapi/trait.Resource.html#implementors).
17+
This is the most common, and simplest case. Your source of truth is an existing [Kubernetes object found in the openapi spec](https://docs.rs/k8s-openapi/latest/k8s_openapi/trait.Resource.html#implementors).
1818

1919
To use a typed Kubernetes resource as a source of truth in a [Controller], import it from [k8s-openapi], and create an [Api] from it, then pass it to the [Controller].
2020

@@ -110,7 +110,7 @@ Here, a separate `crdgen` bin entry would install your custom resource using `ca
110110

111111
!!! warning "CRD Installation"
112112

113-
Be careful with installing CRDs inside a controller at starup. It is customary to provide a generated yaml file so consumers can install a CRD out of band to better support [gitops](https://fluxcd.io/flux/components/helm/helmreleases/#crds) and [helm](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/). See [[security#crd-access]].
113+
Be careful with installing CRDs inside a controller at startup. It is customary to provide a generated yaml file so consumers can install a CRD out of band to better support [gitops](https://fluxcd.io/flux/components/helm/helmreleases/#crds) and [helm](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/). See [[security#crd-access]].
114114

115115
### Imported Custom Resource
116116

@@ -198,7 +198,7 @@ Untyped resources are using [DynamicObject]; an umbrella container for arbitrary
198198

199199
The [DynamicObject] consists of **just the unavoidable properties** like `apiVersion`, `kind`, and `metadata`, whereas the entire spec is loaded onto an arbitrary [serde_json::Value] via [flattening].
200200

201-
The benefits you get is that:
201+
The benefits you get are that:
202202

203203
- you avoid having to write out fields manually
204204
- you **can** achieve tolerance against multiple versions of your object
@@ -270,7 +270,7 @@ This is functionally similar way to deriving `CustomResource` on an incomplete s
270270

271271
!!! warning "Partial or dynamic typing always needs additional type information"
272272

273-
All usage of `DynamicObject` or `Object` require the use of alternate constructors for multiple interfaces such as [Api] and [Controller]. These constructors have an additional `_with` suffix to carry an associated type for the [Resource] trait.
273+
All usage of `DynamicObject` or `Object` requires the use of alternate constructors for multiple interfaces such as [Api] and [Controller]. These constructors have an additional `_with` suffix to carry an associated type for the [Resource] trait.
274274

275275
## Summary
276276

0 commit comments

Comments
 (0)