Skip to content

Docs: Add glossary #1024

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.

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
Mar 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions docs/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
17 changes: 17 additions & 0 deletions docs/documentation/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Glossary description: Glossary layout: docs permalink: /docs/glossary
---

# Glossary

- 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.