kubermatic / kubermatic/docs

Architecture diagram marginalia are mixed/mingled

Open
#1,121 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

lifecycle/frozen
Dominant language
SCSS
Stars
19
Forks
117
Avg merge
13h 29m
Merged PRs (30d)
13

Description

In continuation of #1114, it appears that the sentence

Operator Infrastructure with a Master Cluster and two dedicated Seed Clusters

which appears in both images, should only be valid for the second.

The first image also suggests there's an independent seed cluster for the User Clusters, which appears wrong. The gray box "Independent of each other" could also combine the area below the "Master Cluster/Seed Cluster" box and the "User-Cluster-1 NS / User-Cluster-2 NS" box. This way "Independent of each other" would mean "sitting in the same Kubernetes cluster" and allowed to understand the two approaches better.

This is especially useful, if future users of the CE need to evaluate how to lay out their infrastructure, esp. in terms of #1120.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read #1114 and compare the first and second architecture images referenced here. Update the diagrams so the quoted Operator Infrastructure sentence appears only in the second, remove the implied independent seed cluster for User Clusters, and clarify the gray “Independent of each other” grouping. Done when the diagrams clearly communicate the two infrastructure approaches for evaluating CE layouts.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation, infrastructure
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.