Skip to content

Commit e98b8f9

Browse files
committed
fix: spell checking
1 parent 39b6ed7 commit e98b8f9

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/documentation/features.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ other configuration options are provided to fine tune or turn off these features
1313

1414
## Controller Execution in a Nutshell
1515

16-
Controller execution is always a triggered by an event. Events typically come from the custom resource
17-
(i.e. custom resource is created, update or deleted) that the controller is watching, but also from different sources
16+
Controller execution is always triggered by an event. Events typically come from the custom resource
17+
(i.e. custom resource is created, updated or deleted) that the controller is watching, but also from different sources
1818
(see event sources). When an event is received reconciliation is executed, unless there is already a reconciliation
1919
happening for a particular custom resource. In other words it is guaranteed by the framework that no concurrent
2020
reconciliation happens for a custom resource.
@@ -23,7 +23,7 @@ After a reconciliation (
2323
i.e. [ResourceController](https://github.com/java-operator-sdk/java-operator-sdk/blob/master/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.java)
2424
called), a post-processing phase follows, where typically framework checks if:
2525

26-
- there was exception thrown during execution, if yes schedules a retry.
26+
- an exception was thrown during execution, if yes schedules a retry.
2727
- there are new events received during the controller execution, if yes schedule the execution again.
2828
- there is an instruction to re-schedule the execution for the future, if yes schedule a timer event with the specified
2929
delay.
@@ -35,29 +35,29 @@ execution.
3535
## Finalizer Support
3636

3737
[Kubernetes finalizers](https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/)
38-
makes sure that a reconciliation happens when a custom resource is instructed to be deleted. Typical case when it's
38+
make sure that a reconciliation happens when a custom resource is instructed to be deleted. Typical case when it's
3939
useful, when an operator is down (pod not running). Without a finalizer the reconciliation - thus the cleanup
4040
i.e. [`ResourceController.deleteResource(...)`](https://github.com/java-operator-sdk/java-operator-sdk/blob/master/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.java)
4141

4242
- would not happen if a custom resource is deleted.
4343

4444
Finalizers are automatically added by the framework as the first step, thus when a custom resource is created, but
45-
before the first reconciliation, custom resource is updated via a Kubernetes API call. As a results of this update, the
46-
finalizer will be present. The subsequent event will be received, what will trigger the first reconciliation.
45+
before the first reconciliation, the custom resource is updated via a Kubernetes API call. As a result of this update, the
46+
finalizer will be present. The subsequent event will be received, which will trigger the first reconciliation.
4747

4848
The finalizer that is automatically added will be also removed after the `deleteResource` is executed on the controller.
4949
However, the removal behavior can be further customized, and can be instructed to "not remove yet" - this is useful just
50-
in some specific corner cases, when there would be long waiting period for some dependent resource cleanup.
50+
in some specific corner cases, when there would be a long waiting period for some dependent resource cleanup.
5151

52-
The name of the finalizers can be specified, in case it is not a name will be generated.
52+
The name of the finalizers can be specified, in case it is not, a name will be generated.
5353

5454
This behavior can be turned off, so when configured no finalizer will be added or removed.
5555
See [`@Controller`](https://github.com/java-operator-sdk/java-operator-sdk/blob/master/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Controller.java)
5656
annotation for more details.
5757

5858
### When not to Use Finalizers?
5959

60-
Typically, automated finalizer handling should is turned off, when **all** the cleanup of the dependent resources is
60+
Typically, automated finalizer handling should be turned off, when **all** the cleanup of the dependent resources is
6161
handled by Kubernetes itself. This is handled by
6262
Kubernetes [garbage collection](https://kubernetes.io/docs/concepts/architecture/garbage-collection/#owners-dependents).
6363
Setting the owner reference and related fields are not in the scope of the SDK for now, it's up to the user to have them

0 commit comments

Comments
 (0)