Skip to content

📖 docs: add k3d hosting cluster setup and control plane section#676

Open
VignanNallani wants to merge 2 commits into
kubestellar:mainfrom
VignanNallani:docs/k3s-k3d-control-plane
Open

📖 docs: add k3d hosting cluster setup and control plane section#676
VignanNallani wants to merge 2 commits into
kubestellar:mainfrom
VignanNallani:docs/k3s-k3d-control-plane

Conversation

@VignanNallani

Copy link
Copy Markdown

Summary

Adds a dedicated documentation section for installing and using KubeFlex
on k3d as a hosting cluster.

Changes

  • New file docs/k3d.md covering:
    • When to use k3d with KubeFlex
    • Prerequisites and k3d installation
    • Step-by-step cluster setup with nginx ingress
    • Creating control planes on k3d
    • Capabilities table and known limitations
    • Cleanup and references

Closes #415

…ubestellar#415)

Signed-off-by: Vignan Nallani <vignanchowdarytilt@gmail.com>
Copilot AI review requested due to automatic review settings May 15, 2026 10:18
@kubestellar-prow kubestellar-prow Bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label May 15, 2026
@kubestellar-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign clubanderson for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@github-actions

Copy link
Copy Markdown

👋 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:

  • DCO Sign-off — All commits signed with git commit -s (DCO)
  • PR Title — Starts with an emoji: ✨ feature | 🐛 bug fix | 📖 docs | 🌱 infra/tests | ⚠️ breaking

📬 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.

@kubestellar-prow

Copy link
Copy Markdown
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions 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.

@kubestellar-prow kubestellar-prow Bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 15, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md covering prerequisites, k3d cluster creation with Traefik disabled and nginx ingress, and kflex init usage 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.

Comment thread docs/k3d.md
Comment on lines +127 to +130
Expected output:
NAME SYNCED READY AGE
cp1 True True 2m

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed — the expected output block is already wrapped in a fenced code block in the current commit.

@VignanNallani VignanNallani changed the title docs: add k3d hosting cluster setup and control plane section 📖 docs: add k3d hosting cluster setup and control plane section May 15, 2026
Signed-off-by: Vignan Nallani <vignanchowdarytilt@gmail.com>
@VignanNallani

Copy link
Copy Markdown
Author

Hi @clubanderson — the Copilot review feedback has been addressed. Would appreciate your review when you get a chance. Happy to make any additional changes!

@MikeSpreitzer

Copy link
Copy Markdown
Contributor

The documentation is now maintained in a separate repository, https://github.com/kubestellar/docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

task: create k3s/k3d control plane section

3 participants