Skip to content

Commit a89832e

Browse files
authored
Docs: Add glossary (#1024)
1 parent 13a6c83 commit a89832e

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/_data/sidebar.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
url: /docs/getting-started
66
- title: How to use Samples
77
url: /docs/using-samples
8+
- title: Glossary
9+
url: /docs/glossary
810
- title: Features
911
url: /docs/features
1012
- title: Patterns and Best Practices

docs/documentation/glossary.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Glossary description: Glossary layout: docs permalink: /docs/glossary
3+
---
4+
5+
# Glossary
6+
7+
- Primary Resource - the resource that represents the desired state that the controller is working
8+
to achieve. While this is often a Custom Resource, this can also be a Kubernetes native resource.
9+
- Secondary Resource - any resource that the controller needs to achieve the desired state
10+
represented by the primary resource. These resources can be created, updated, deleted or simply
11+
read depending on the use case. For example, the `Deployment` controller manages `ReplicatSet`
12+
instances when trying to realize the state represented by the `Deployment`. In this scenario,
13+
the `Deployment` is the primary resource while `ReplicaSet` is one of the secondary resources
14+
managed by the `Deployment` controller.
15+
- Dependent Resource - a feature of JOSDK, aimed at making easier to manage secondary resources. A
16+
dependent resource is therefore a secondary resource implemented using this specific JOSDK
17+
feature.

0 commit comments

Comments
 (0)