kubermatic / kubermatic/docs

Improve cluster requirements page's OS requirements

Open
#1,463 4 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

https://docs.kubermatic.com/kubermatic/v2.22/architecture/requirements/cluster-requirements/ is kind of a confusing page. It lists OS requirements for the nodes in master clusters - Why? KKP should run on any Kubernetes cluster, we do not interact with the underlying node. IMHO this should be removed.

Seed clusters are not mentioned at all, but they should. We should also point out additional resource requirements with MLA.

The user cluster requirements are also very unclear. Why give a list of OSes here? We only allow deploying with specifics OSes, but that is documented in https://docs.kubermatic.com/kubermatic/v2.22/architecture/compatibility/os-support-matrix/. This section should only link to that, at best. Giving resource requirements for user clusters is also weird, we should just mention that node sizing shouldn't be under a certain threshold. But KKP doesn't really require any specific set of resources in a user cluster, most of the deployed system components are DaemonSets.

This page should also mention KubeOne as the recommended installer IMHO.

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

Start with the cluster requirements page linked in the issue, then compare its user-cluster OS section with the OS support matrix and review the missing seed-cluster and MLA context. Trace the page source in the kubermatic/docs repository and check nearby architecture pages for the KubeOne recommendation. Done means the page accurately covers master, seed, and user-cluster requirements without duplicating the support matrix.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.