Skip to content

docs: add low level api to glossary #1523

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 4 commits into from
Oct 6, 2022
Merged

docs: add low level api to glossary #1523

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
541ff20
docs: add low level api to glossary
csviri Oct 5, 2022
1a5c4a5
improvement
csviri Oct 5, 2022
aaad233
wording
csviri Oct 5, 2022
affc610
improvement
csviri Oct 5, 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
9 changes: 8 additions & 1 deletion docs/documentation/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,11 @@ permalink: /docs/glossary
the `Deployment` is the primary resource while `ReplicaSet` is one of the secondary resources
managed by the `Deployment` controller.
- **Dependent Resource** - a feature of JOSDK, to make it easier to manage secondary resources. A
dependent resource represents a secondary resource with related reconciliation logic.
dependent resource represents a secondary resource with related reconciliation logic.
- **Low-level API** - a reconciler implementation without using the Dependent Resource and Workflow features.
Simply just implementing a logic using
the [`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)
interface. See
the [WebPage sample](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java)
. See also the same logic
implemented using [Dependent Resource and Workflows](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageManagedDependentsReconciler.java)