search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.36k stars 14.11k forks source link

Improvement for k8s.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro/ #45619

Open warmbasket opened 3 months ago

warmbasket commented 3 months ago

You state " Each node has a Kubelet, which is an agent for managing the node and communicating with the Kubernetes control plane."

You then state "A Kubernetes cluster that handles production traffic should have a minimum of three nodes because if one node goes down, both an [etcd] member and a control plane instance are lost, and redundancy is compromised."

What is an etcd member? and how are there multiple instances of the control plane if there's only one control plane?

You then state "Minikube is a lightweight Kubernetes implementation that creates a VM on your local machine and deploys a simple cluster containing only one node."

The whole point of this page is to describe how Minikube is used to create a cluster only to find out that it can only create a single node 'cluster' if you can even call it that.

k8s-ci-robot commented 3 months ago

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
stmcginnis commented 3 months ago

It doesn't state there are multiple control planes. Just multiple nodes.

I could see a little background on etcd might be useful. Even if it's just a link to a reference stating what etcd is.

warmbasket commented 3 months ago

It states "A Kubernetes cluster that handles production traffic should have a minimum of three nodes because if one node goes down, both an [etcd] member and a control plane instance are lost, and redundancy is compromised." So wouldn't there be multiple control plane instances? Or is the single control plane lost? What's the control plane instance?

steve-hardman commented 3 months ago

Page: https://kubernetes.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro /language en

utkarsh-singh1 commented 3 months ago

You then state "Minikube is a lightweight Kubernetes implementation that creates a VM on your local machine and deploys a simple cluster containing only one node."

The whole point of this page is to describe how Minikube is used to create a cluster only to find out that it can only create a single node 'cluster' if you can even call it that.

Minikube can be used to create local kubernetes environment using different available resources/drivers (docker, virtualbox) on your machine.

utkarsh-singh1 commented 3 months ago

You can also create multinode cluster using minikube, but for simplicity it is write down for only 1 node. You can also check out minikube documentation for multinode cluster.

sftim commented 3 months ago

You can make a learning environment with more than one node, so we could fix the tutorial to not teach that the cluster is only one node.

The default is still one node.

sftim commented 3 months ago

The diagram in https://kubernetes.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro/ is unhelpful; we could make a better one.

sftim commented 3 months ago

https://k8s.io/docs/tutorials/kubernetes-basics/create-cluster/cluster-intro/ does not clearly explain the objective: help you set up a Kubernetes cluster on your own (local?) environment, so that you can use that cluster for further learning.

sftim commented 3 months ago

Kubernetes contributors: specific sub-issues about improvements, eg like the ones I commented on, are welcome.

k8s-triage-robot commented 2 weeks ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale