Skip to content

Commit 048aec5

Browse files
authored
docs: improve wording (#1528)
1 parent fe7d134 commit 048aec5

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

docs/documentation/glossary.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,21 @@ permalink: /docs/glossary
88
# Glossary
99

1010
- **Primary Resource** - the resource that represents the desired state that the controller is
11-
working
12-
to achieve. While this is often a Custom Resource, it can be also be a Kubernetes native
13-
resource (Deployment,
14-
ConfigMap,...).
15-
- **Secondary Resource** - any resource that the controller needs to manage the reach the desired state
16-
represented by the primary resource. These resources can be created, updated, deleted or simply
17-
read depending on the use case. For example, the `Deployment` controller manages `ReplicatSet`
18-
instances when trying to realize the state represented by the `Deployment`. In this scenario,
19-
the `Deployment` is the primary resource while `ReplicaSet` is one of the secondary resources
20-
managed by the `Deployment` controller.
11+
working to achieve. While this is often a Custom Resource, it can be also be a Kubernetes native
12+
resource (Deployment, ConfigMap,...).
13+
- **Secondary Resource** - any resource that the controller needs to manage the reach the desired
14+
state represented by the primary resource. These resources can be created, updated, deleted or
15+
simply read depending on the use case. For example, the `Deployment` controller manages
16+
`ReplicatSet` instances when trying to realize the state represented by the `Deployment`. In
17+
this scenario, the `Deployment` is the primary resource while `ReplicaSet` is one of the
18+
secondary resources managed by the `Deployment` controller.
2119
- **Dependent Resource** - a feature of JOSDK, to make it easier to manage secondary resources. A
2220
dependent resource represents a secondary resource with related reconciliation logic.
23-
- **Low-level API** - a reconciler implementation without using the Dependent Resource and Workflow features.
24-
Simply just implementing a logic using
25-
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)
21+
- **Low-level API** - refers to the SDK APIs that don't use any of features (such as Dependent
22+
Resources or Workflows) outside of the core
23+
- [`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)
2624
interface. See
2725
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)
28-
. See also the same logic
29-
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)
26+
. The same logic
27+
is also implemented using
28+
[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)

0 commit comments

Comments
 (0)