Skip to content

Commit ee16b6b

Browse files
authored
Merge pull request #226 from didier-durand/patch-2
DOCS.md
2 parents 42d7b4e + 1d71970 commit ee16b6b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/DOCS.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ TODO: explain running operator locally against a cluster
5656

5757
### Run Single Instance
5858

59-
There should be always just one instance of an operator running at a time (think process). If there there would be
59+
There should be always just one instance of an operator running at a time (think process). If there would be
6060
two ore more, in general it could lead to concurrency issues. Note that we are also doing optimistic locking when we update a resource.
61-
In this way the operator is not highly available. However for operators this not necessary an issue,
61+
In this way the operator is not highly available. However for operators this is not necessarily an issue,
6262
if the operator just gets restarted after it went down.
6363

6464
### At Least Once
6565

6666
To implement controller logic, we have to override two methods: `createOrUpdateResource` and `deleteResource`.
67-
These methods are called if a resource is create/changed or marked for deletion. In most cases these methods will be
68-
called just once, but in some rare cases can happen that are called more then once. In practice this means that the
67+
These methods are called if a resource is created/changed or marked for deletion. In most cases these methods will be
68+
called just once, but in some rare cases, it can happen that they are called more then once. In practice this means that the
6969
implementation needs to be **idempotent**.
7070

7171
### Smart Scheduling
@@ -77,11 +77,11 @@ a customizable retry mechanism to deal with temporal errors.
7777

7878
When an operator is started we got events for every resource (of a type we listen to) already on the cluster. Even if the resource is not changed
7979
(We use `kubectl get ... --watch` in the background). This can be a huge amount of resources depending on your use case.
80-
So it could be a good case just have a status field on the resource which is checked, if there anything needs to be done.
80+
So it could be a good case to just have a status field on the resource which is checked, if there is anything needed to be done.
8181

8282
### Deleting a Resource
8383

8484
During deletion process we use [Kubernetes finalizers](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#finalizers
8585
"Kubernetes docs") finalizers. This is required, since it can happen that the operator is not running while the delete
8686
of resource is executed (think `oc delete`). In this case we would not catch the delete event. So we automatically add a
87-
finalizer first time we update the resource if its not there.
87+
finalizer first time we update the resource if it's not there.

0 commit comments

Comments
 (0)