lima-vm / lima-vm/lima

Add more Kubernetes documentation

Open
#5,378 1 comment 0 reactions 0 assignees View on GitHub
documentation kubernetes
Dominant language
Go
Stars
21.9k
Forks
957
Avg merge
2d 6h
Merged PRs (30d)
53

Description

Currently we have one section "Containers" for all of it.

But I think there is enough now to make a "Kubernetes" section?

Besides single-node and multi-node, I was also thinking of:

* How to add the new "proxy" and "mirror" parameters, for cache
#5381

* How to install the Kubernetes Dashboard (headlamp) with helm
#5289

Currently the information is a bit scattered in PRs and Discussions.

And to make the k3s/k8s/etc a little less cluttered:

[Containers](https://lima-vm.io/docs/examples/containers/)
* containerd (Default)
* Docker
* Podman
* ~~Kubernetes~~
* Apptainer

[Kubernetes](https://lima-vm.io/docs/examples/containers/kubernetes/)
* Single-node
* Multi-node
* _Cache apt/oci_
* _Dashboard_

Also since it is _also_ using containerd, by default. WDYT?

i.e. the docker and podman were quite short, but kubernetes was long

Trying to add even more information to that page would be too much?

Contributor guide

Open the contributing guide

Research direction

Start with docs/examples/containers/ and the proposed docs/examples/containers/kubernetes/ page, then review the referenced PRs #5381 and #5289 plus related Discussions. Separate Kubernetes material from the Containers section and organize single-node, multi-node, cache parameters, and Dashboard/Helm guidance as appropriate. Done means the Kubernetes content is no longer cluttering the Containers page and the proposed topics are covered.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.