📖 docs: add k3d hosting cluster setup and control plane section#676
📖 docs: add k3d hosting cluster setup and control plane section#676VignanNallani wants to merge 2 commits into
Conversation
…ubestellar#415) Signed-off-by: Vignan Nallani <vignanchowdarytilt@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
👋 Welcome to the KubeStellar community! 💖 Thanks and congrats 🎉 for opening your first PR here! We're excited to have you contributing. Before merge, please ensure:
📬 If you're using KubeStellar in your organization, please add your name to our Adopters list. 🙏 It really helps the project gain momentum and credibility — a small contribution back with a big impact. Resources:
A maintainer will review your PR soon. Hope you have a great time here! 🌟 ~~~~~~~~~~ 🌟 📬 If you like KubeStellar, please ⭐ star ⭐ our repo to support it! 🙏 It really helps the project gain momentum and credibility — a small contribution back with a big impact. |
|
Hi @VignanNallani. Thanks for your PR. I'm waiting for a kubestellar member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
There was a problem hiding this comment.
Pull request overview
Adds a standalone documentation page describing how to install and use KubeFlex with a k3d hosting cluster, complementing the existing k3d snippet already present in docs/users.md and resolving the request in issue #415 for a dedicated k3s/k3d control plane section.
Changes:
- New
docs/k3d.mdcovering prerequisites, k3d cluster creation with Traefik disabled and nginx ingress, andkflex initusage with--hostContainerName. - Documents supported control plane types on k3d (
k8s,vcluster,ocm,host) and known limitations. - Adds verification and cleanup steps plus references to related docs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Expected output: | ||
| NAME SYNCED READY AGE | ||
| cp1 True True 2m | ||
|
|
There was a problem hiding this comment.
Fixed — the expected output block is already wrapped in a fenced code block in the current commit.
Signed-off-by: Vignan Nallani <vignanchowdarytilt@gmail.com>
|
Hi @clubanderson — the Copilot review feedback has been addressed. Would appreciate your review when you get a chance. Happy to make any additional changes! |
|
The documentation is now maintained in a separate repository, https://github.com/kubestellar/docs |
Summary
Adds a dedicated documentation section for installing and using KubeFlex
on k3d as a hosting cluster.
Changes
docs/k3d.mdcovering:Closes #415