docs: update podman guide - #1650
Open
DaniD3v wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation on using k3d with podman.
The previous documentation was confusing and did simply not work.
This is reflected by the open github issues of non-working podman configs.
TODO:
Open Questions:
Should I re-add the section on remote podman?
The main reason the old docs were unreadable to me is due to the
DOCKER_HOSTandDOCKER_SOCKclutter. If I have some very basic experience with podman/docker I will know to set those variables as they are not tooling specific. Moreover theDOCKER_SOCKvariable is not even used.MacOS section
I also think the MacOS section should be reduced. The guide clearly explains how to set delegate cpuset for systemd users so mac users should be able to follow along. Users that want to use k3d have probably already setup podman and a general setup guide is out of scope.
I cannot verify changes to the macOS section tho, so I left them untouched for now.
--default-networkfor creating registriesI understand the necessity regarding extra config for rootless kubelet and cgroup v2 delegation but I think this should simply use the podman network per default if it is detected. Also why is the
--default-networkparameter only there for theregistry createsubcommand but not for the options incluster create.#1605 seems to be about this, too
Backport?
Since its only docs related this PR should be back-ported.
The changes were tested on the latest stable version anyway.
Some of these open questions are not specific to this PR. I can open separate issues for them so that this can get merged quickly.
Clarification on whether cgroup v1 is supported?
There is an open issue because cgroup v1 doesn't work.
I personally can't test that but we should specify whether it is even supported or not?
#1439
Podman/ at least rootless docker should have first-class support
K3d is clearly more useful when running without root. Why not make it the default/ at least officially supported.
For dev rootless is simply superior:
no sudo for
kubectl(the config gets merged into root when usingsudo k3d cluster create)you can run something like
tiltwith k3d and properly.devs that don't have root access can use k3d.
Close
Please close your resolved issues!
Open issues also serve as documentation the fact that there's so many open ones makes the situation even worse.