From c8ba30ce422862f4519098904bad740abf469656 Mon Sep 17 00:00:00 2001 From: csviri Date: Fri, 11 Mar 2022 15:59:55 +0100 Subject: [PATCH 1/4] docs: glossary --- docs/_data/sidebar.yml | 2 ++ docs/documentation/glossary.md | 14 ++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 docs/documentation/glossary.md diff --git a/docs/_data/sidebar.yml b/docs/_data/sidebar.yml index 5bd1f2ce22..0dc51bddec 100644 --- a/docs/_data/sidebar.yml +++ b/docs/_data/sidebar.yml @@ -5,6 +5,8 @@ url: /docs/getting-started - title: How to use Samples url: /docs/using-samples + - title: Glossary + url: /docs/glossary - title: Features url: /docs/features - title: Patterns and Best Practices diff --git a/docs/documentation/glossary.md b/docs/documentation/glossary.md new file mode 100644 index 0000000000..c3765ea6fa --- /dev/null +++ b/docs/documentation/glossary.md @@ -0,0 +1,14 @@ +--- +title: Glossary +description: Glossary +layout: docs +permalink: /docs/glossary +--- + +# Glossary + +- Primary Resource - usually the custom resource (or a well known Kubernetes Resource like Ingress) the controller manages. +- Secondary Resource - is the resource managed by the operator, thus resources mainly created or updated or just read + during the reconciliation. +- Dependent Resource(s) - is a feature of JOSDK, to make it more easy to manage secondary resources. + So speaking of dependent resources refers to a secondary resource, but managed using this feature. \ No newline at end of file From 45cc00a7863ee5e2e161a88a4eecf69a94eef89e Mon Sep 17 00:00:00 2001 From: csviri Date: Fri, 11 Mar 2022 16:00:27 +0100 Subject: [PATCH 2/4] fix: format --- docs/documentation/glossary.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/documentation/glossary.md b/docs/documentation/glossary.md index c3765ea6fa..f9ade8f4f3 100644 --- a/docs/documentation/glossary.md +++ b/docs/documentation/glossary.md @@ -7,8 +7,9 @@ permalink: /docs/glossary # Glossary -- Primary Resource - usually the custom resource (or a well known Kubernetes Resource like Ingress) the controller manages. +- Primary Resource - usually the custom resource (or a well known Kubernetes Resource like Ingress) the controller + manages. - Secondary Resource - is the resource managed by the operator, thus resources mainly created or updated or just read during the reconciliation. -- Dependent Resource(s) - is a feature of JOSDK, to make it more easy to manage secondary resources. - So speaking of dependent resources refers to a secondary resource, but managed using this feature. \ No newline at end of file +- Dependent Resource(s) - is a feature of JOSDK, to make it more easy to manage secondary resources. So speaking of + dependent resources refers to a secondary resource, but managed using this feature. \ No newline at end of file From d7604895899af792315c3381021724b4d8ca6724 Mon Sep 17 00:00:00 2001 From: csviri Date: Fri, 11 Mar 2022 16:02:23 +0100 Subject: [PATCH 3/4] fix: wording --- docs/documentation/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/documentation/glossary.md b/docs/documentation/glossary.md index f9ade8f4f3..25df1b9cb4 100644 --- a/docs/documentation/glossary.md +++ b/docs/documentation/glossary.md @@ -9,7 +9,7 @@ permalink: /docs/glossary - Primary Resource - usually the custom resource (or a well known Kubernetes Resource like Ingress) the controller manages. -- Secondary Resource - is the resource managed by the operator, thus resources mainly created or updated or just read +- Secondary Resource - is the resource managed by the controller, thus resources mainly created or updated or just read during the reconciliation. - Dependent Resource(s) - is a feature of JOSDK, to make it more easy to manage secondary resources. So speaking of dependent resources refers to a secondary resource, but managed using this feature. \ No newline at end of file From d142d05d0d9ef82e15a69dd82d194ec5e0c1ff5a Mon Sep 17 00:00:00 2001 From: Chris Laprun Date: Fri, 11 Mar 2022 18:41:41 +0100 Subject: [PATCH 4/4] refactor: reword, add clarifications and example --- docs/documentation/glossary.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/documentation/glossary.md b/docs/documentation/glossary.md index 25df1b9cb4..3e48bf7efa 100644 --- a/docs/documentation/glossary.md +++ b/docs/documentation/glossary.md @@ -1,15 +1,17 @@ --- -title: Glossary -description: Glossary -layout: docs -permalink: /docs/glossary +title: Glossary description: Glossary layout: docs permalink: /docs/glossary --- # Glossary -- Primary Resource - usually the custom resource (or a well known Kubernetes Resource like Ingress) the controller - manages. -- Secondary Resource - is the resource managed by the controller, thus resources mainly created or updated or just read - during the reconciliation. -- Dependent Resource(s) - is a feature of JOSDK, to make it more easy to manage secondary resources. So speaking of - dependent resources refers to a secondary resource, but managed using this feature. \ No newline at end of file +- Primary Resource - the resource that represents the desired state that the controller is working + to achieve. While this is often a Custom Resource, this can also be a Kubernetes native resource. +- Secondary Resource - any resource that the controller needs to achieve the desired state + represented by the primary resource. These resources can be created, updated, deleted or simply + read depending on the use case. For example, the `Deployment` controller manages `ReplicatSet` + instances when trying to realize the state represented by the `Deployment`. In this scenario, + 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, aimed at making easier to manage secondary resources. A + dependent resource is therefore a secondary resource implemented using this specific JOSDK + feature. \ No newline at end of file