Skip to content

docs: fixes and improvements #839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 17, 2022
Merged

docs: fixes and improvements #839

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
24aa6f9
docs: fixes and improvements
csviri Jan 17, 2022
5bf8a52
fix: wording
csviri Jan 17, 2022
4a14a79
docs: additional chapters, code snippets
csviri Jan 17, 2022
ae7f48e
fix: format
csviri Jan 17, 2022
0e518c5
fix: event sources improvements
csviri Jan 17, 2022
e44995b
docs: add faq
csviri Jan 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/documentation/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ layout: docs
permalink: /docs/faq
---

## Q: How can I access events?
### Q: How can I access the events which triggered the Reconciliation?
In the v1.* version events were exposed to `Reconciler` (in v1 called `ResourceController`). This
included events (Create, Update) of the custom resource, but also events produced by Event Sources. After
long discussions also with developers of golang version (controller-runtime), we decided to remove access to
Expand Down
6 changes: 3 additions & 3 deletions docs/documentation/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ in some specific corner cases, when there would be a long waiting period for som
The name of the finalizers can be specified, in case it is not, a name will be generated.

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

### When not to Use Finalizers?
Expand All @@ -66,7 +66,7 @@ When automatic finalizer handling is turned off, the `Reconciler.cleanup(...)` m
case when a delete event received. So it does not make sense to implement this method and turn off finalizer at the same
time.

## The `reconcile` and `cleanup` Methods of `Reconciler`
## The `reconcile` and `cleanup` Methods of [`Reconciler`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Reconciler.java)

The lifecycle of a custom resource can be clearly separated to two phases from a perspective of an operator. When a
custom resource is created or update, or on the other hand when the custom resource is deleted - or rather marked for
Expand All @@ -79,7 +79,7 @@ method, unless the custom resource is

If there is **no finalizer** in place (see Finalizer Support section), the `cleanup` method is **not called**.

### Using `UpdateControl` and `DeleteControl`
### Using [`UpdateControl`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/UpdateControl.java) and [`DeleteControl`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/DeleteControl.java)

These two classes are used to control the outcome or the desired behavior after the reconciliation.

Expand Down