Skip to content

Commit ab62162

Browse files
authored
Merge pull request #78 from buraksekili/patch-2
Update stale links and typos on the intro page
2 parents 3a893db + fede241 commit ab62162

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/controllers/intro.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Writing a controller requires **three** pieces:
2929

3030
The main object is the source of truth for what the world should be like, and it takes the form of a Kubernetes object like a:
3131

32-
- [Pod](https://arnavion.github.io/k8s-openapi/v0.14.x/k8s_openapi/api/core/v1/struct.Pod.html)
33-
- [Deployment](https://arnavion.github.io/k8s-openapi/v0.14.x/k8s_openapi/api/apps/v1/struct.Deployment.html)
34-
- ..[any native Kubernetes Resource](https://arnavion.github.io/k8s-openapi/v0.14.x/k8s_openapi/trait.Resource.html#implementors)
32+
- [Pod](https://docs.rs/k8s-openapi/latest/k8s_openapi/api/core/v1/struct.Pod.html)
33+
- [Deployment](https://docs.rs/k8s-openapi/latest/k8s_openapi/api/apps/v1/struct.Deployment.html)
34+
- ..[any native Kubernetes Resource](https://docs.rs/k8s-openapi/latest/k8s_openapi/trait.Resource.html#implementors)
3535
- a partially typed or dynamically typed Kubernetes Resource
3636
- an object from [api discovery](https://docs.rs/kube/latest/kube/discovery/index.html)
3737
- a [Custom Resource](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/)
@@ -46,9 +46,9 @@ See the [[object]] document for how to use the various types.
4646

4747
## The Reconciler
4848

49-
The reconconciler is the part of the controller that ensures the world is up to date.
49+
The reconciler is the part of the controller that ensures the world is up to date.
5050

51-
It takes the form of an `async fn` taking the object along with some context, and performs the alignment between the state of world and the `object`.
51+
It takes the form of an `async fn` taking the object along with some context, and performs the alignment between the state of the world and the `object`.
5252

5353
In its simplest form, this is what a reconciler (that does nothing) looks like:
5454

@@ -81,7 +81,7 @@ The core features inside the application are:
8181

8282
The system must be **fault-tolerant**, and thus must be able to recover from **crashes**, **downtime**, and resuming even having **missed messages**.
8383

84-
Setting up a blank controller in rust satisfying these constraints is fairly simple, and can be done with minimal boilerplate (no generated files need be inlined in your project).
84+
Setting up a blank controller in rust satisfying these constraints is fairly simple, and can be done with minimal boilerplate (no generated files need to be inlined in your project).
8585

8686
See the [[application]] document for the high-level details.
8787

@@ -99,7 +99,7 @@ The terminology between **controllers** and **operators** are quite similar:
9999
100100
Which is further reworded now under their new [agglomerate banner](https://cloud.redhat.com/learn/topics/operators).
101101

102-
They key **differences** between the two is that **operators** generally a specific type of controller, sometimes more than one in a single application. To be classified as an operator, a controller would at the very least need to:
102+
The key **difference** between the two is that **operators** are generally a specific type of controller, sometimes more than one in a single application. To be classified as an operator, a controller would at the very least need to:
103103

104104
- manage custom resource definition(s)
105105
- maintain single app focus

0 commit comments

Comments
 (0)