Comments (9)
Hmm, I've used this page several times to walk through spinning up a cluster successfully. Are there specific sections or flows that you find lacking? You mention a couple general concepts, but this still kind of reads as "this should be better!!"
from website.
from website.
What we have now could split into two explanations:
- what's involved, generally, in cluster setup
- how kubeadm fits into that story
- a tutorial-like page about how to set up a multi node cluster with a stacked etc, 3 × n control plane nodes, m worker nodes
- you would need to pick your own container runtime and network plugin, so one of the subtasks is to prepare for the work by picking something
- we should also explain how to check that your cluster is happy and healthy
- a “what's next” for this page should help you find separate advice about deploying optional but common add-ons, such as the metrics server
The tutorial I'm imagining is a largely manual walkthrough. There is third party documentation from the ecosystem but we don't document that, as (so far as I know) all of these tools are either aimed as local Kubernetes development, or are not part of Kubernetes.
from website.
/language en
/sig cluster-lifecycle
/frozen
We should do this
/retitle "Creating a cluster with kubeadm—there should be a simple, straightforward quickstart”
Even if we try hard, it won't be simple and straightforward, but we can do more than we have.
from website.
Someone has taken weeks I'm betting to write this documentation and that person is clearly a master of kubeadm.
I think this might be the work of more than one contributor, not the product of a single expert.
from website.
To move this work forward, a contributor can:
- look at the page
- identify actionable subtasks to help reshape the existing content
- file a new separate issue for some or all of those actionable subtasks
from website.
@sftim okay here are the tasks:
- rename
Creating a cluster with kubeadm
toCluster Creation Deep Dive
to make it clear that the document is going to cover various considerations and configuration options. - create a quickstart document called
Cluster Creation Quickstart
and then use thekubeadm
cli STDOUT in it:
│ KUBEADM │
│ Easily bootstrap a secure Kubernetes cluster │
│ Please give us feedback at: │
│ https://github.com/kubernetes/kubeadm/issues │
Example usage:
Create a two-machine cluster with one control-plane node
(which controls the cluster), and one worker node
(where your workloads, like Pods and Deployments run).
│ On the first machine: │
│ control-plane# kubeadm init │
│ On the second machine: │
│ worker# kubeadm join <arguments-returned-from-init> │
You can then repeat the second step on as many other machines as you like.
The quickstart document, unlike the original document, should:
- assume people are using yum/dnf or apt server os's
- assume people have a container runtime installed
- simply link to installing a cri plugin
- not diverge into various potential kubeadm cli switch options in an attempt to be a catchall that covers the myriad potential pre-existing OS or cluster states folks may be coming in
- state at the top of the doc "if you are coming to this page with anything but a fresh install see the deep dive document"
- list some basic remediation commands for various errors (yes I know there is a troubleshooting doc, it does not need to overtake that)
- be 80% commands and 20% words
If you want to see an excellent example of a similarly complicated tool that has a legitimate quickstart that I was able to follow and complete in a matter of minutes look no further than Calico:
https://docs.tigera.io/calico/latest/getting-started/kubernetes/quickstart
from website.
To move this work forward, a contributor can:
- look at the page
- identify actionable subtasks to help reshape the existing content - see #45309 (comment) for a hint
- file a new separate issue for some or all of those actionable subtasks
from website.
/triage accepted
from website.
Related Issues (20)
- [hi] Localize concepts/Workloads page HOT 5
- [es] Translate - `docs/tasks/debug/debug-cluster/audit` into Spanish - Update HOT 1
- There is a typo in the Chinese documentation. HOT 2
- Freeze k/website for Kubernetes v1.31 release HOT 7
- [hi] Localize concepts/Storage page HOT 5
- [hi] Localize concepts/Security page HOT 5
- Rad54s kubernetes HOT 4
- Document the best practices when implementing mutating webhook HOT 3
- 污点和容忍度 HOT 3
- [ja] Translate content/en/blog/_posts/2024-08-07-sig-api-machinery-spotlight.md into Japanese HOT 3
- [ja] Translate content/en/blog/_posts/2024-08-12-feature-gates_client-go.md into Japanese HOT 1
- My host HOT 4
- [ja] Translate content/en/blog/_posts/2024-08-13-Kubernetes-v1-31-Release.md into Japanese HOT 2
- Document alpha API kind ResourceSlice HOT 2
- 从私有仓库拉取镜像 HOT 3
- Due to the prow source code was moved, there is invalid link for prow plugins. HOT 5
- [ja] Translate content/en/blog/_posts/2024-08-22-Fine-grained-SupplementalGroups-control into Japanese HOT 1
- Statement "A Pod is considered ready when all of its containers are ready." is incomplete / wrong / misleading HOT 1
- Kubernetes API reference 1.31 missing HOT 10
- Deprecation warning banner missing in v1.30 documentation website HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from website.