Add glossary entries for commonly used terms #947
Conversation
Signed-off-by: Jillian <jillian.maroket@suse.com>
Signed-off-by: Jillian <jillian.maroket@suse.com>
|
Signed-off-by: Jillian <jillian.maroket@suse.com>
jillian-maroket
requested review from
Vicente-Cheng and
starbops
and removed request for
akashraj4261 and
dariavladykina
starbops
left a comment
starbops
left a comment
There was a problem hiding this comment.
Thanks for the PR. Please check the comments below.
docs/getting-started/glossary.md
Outdated
| Group of integrated Kubernetes worker machines that run in VMs on top of a Harvester cluster. | ||
| Group of integrated Kubernetes worker machines that run in virtual machines on top of a Harvester cluster. |
There was a problem hiding this comment.
I can be wrong about this, but the term Kubernetes "worker" machines sounds like it only applies to the "worker-role" nodes, which is not true. Is there a better term describing it?
There was a problem hiding this comment.
@starbops Thank you for reviewing. The definitions for guest cluster and guest node were based on details provided by @m-ildefons and @tserong in PR #539 . PTAL at their comments.
There was a problem hiding this comment.
I agree with what @starbops mentioned.
Can we rewrite as below?
Group of integrated Kubernetes nodes that run in virtual machines on top of a Harvester cluster.
WDYT?
docs/getting-started/glossary.md
Outdated
| ## **guest node** / **guest cluster node** | ||
|
|
||
| Kubernetes worker VM that uses guest cluster resources to run container workloads. | ||
| Kubernetes worker virtual machine that uses guest cluster resources to run container workloads. |
There was a problem hiding this comment.
I kinda get confused by this statement. I suppose this sentence tries to convey that "those virtual machines, as guest nodes, use/occupy the underlying Harvester cluster resources to run container workloads on the guest cluster".
There was a problem hiding this comment.
How about
Virtual machine for the Kubernetes nodes that uses guest cluster resources to run container workloads?
There was a problem hiding this comment.
In general, the statement of "running container workloads" naturally implies using the cluster's resources. What makes this term, "guest node/guest cluster node", worth explaining is the word "guest", so we should try to elaborate on that.
I'm not a pro at wording, but I suppose this should be something like the following:
Guest (cluster) nodes are virtual machines running on the underlying Harvester cluster that comprise the guest cluster.
There was a problem hiding this comment.
@starbops @Vicente-Cheng Please clarify:
- guest cluster: Group of integrated Kubernetes nodes that run in virtual machines on top of a Harvester cluster.
- guest nodes: Virtual machines running on the underlying Harvester cluster that comprise the guest cluster.
Isn't a guest node part of a guest cluster? If so, a guest node (virtual machine) is running in another virtual machine that is running on top of the Harvester cluster?
|
@ihcsim Please review the term definitions. Thank you. |
Signed-off-by: Jillian <jillian.maroket@suse.com>
4 participants
The Localization team is planning to translate the SUSE Virtualization doc, so I was asked to provide definitions for an initial set of terms. Due to task scheduling constraints, I decided to split the terms into two sets.
Set 1 (covered in this PR):
Set 2: