The initial interaction for many users with a project often begins with its "Quick Start" guide. Ensuring this guide is of high quality and up-to-date is crucial. Currently, the community offers several quick start methods, including a one-click setup script (hack/local-up-karmada.sh), installation tools such as Helm, karmadactl, and the operator, alongside learning tutorials on Killercoda.
Although the community's CI effectively maintains these installation methods, it lacks support for different operating systems, notably macOS. Furthermore, some Killercoda tutorials are outdated and do not reflect the latest features and best practices. This project aims to ease the entry barrier for new users by enhancing the quick start process, ensuring cross-platform compatibility, and updating educational content.
This is a lfx project, ref upstream community issue: karmada-io/community#170 (comment)
tasks:
Task1: macOS parity for hack/local-up-karmada.sh on both Apple Silicon and Intel.
Issue:
PRs:
##### Task2: A minimal GitHub Actions smoke workflow on macOS that verifies install + basic control-plane/member-cluster bring-up
Task3: Revise existing outdated scenarios on Killercoda and develop valuable new scenarios to guide users through current features
- [ ] Extracting common functions from various scenarios to reduce code duplication.
The initial interaction for many users with a project often begins with its "Quick Start" guide. Ensuring this guide is of high quality and up-to-date is crucial. Currently, the community offers several quick start methods, including a one-click setup script (hack/local-up-karmada.sh), installation tools such as Helm, karmadactl, and the operator, alongside learning tutorials on Killercoda.
Although the community's CI effectively maintains these installation methods, it lacks support for different operating systems, notably macOS. Furthermore, some Killercoda tutorials are outdated and do not reflect the latest features and best practices. This project aims to ease the entry barrier for new users by enhancing the quick start process, ensuring cross-platform compatibility, and updating educational content.
This is a lfx project, ref upstream community issue: karmada-io/community#170 (comment)
tasks:
Task1: macOS parity for
hack/local-up-karmada.shon both Apple Silicon and Intel.Issue:
util::wait_nodes_taint_disappearcontaining timeout from hack/util.sh #7284PRs:
util::wait_nodes_taint_disappearcontaining timeout #7285)##### Task2: A minimal GitHub Actions smoke workflow on macOS that verifies install + basic control-plane/member-cluster bring-upTask3: Revise existing outdated scenarios on Killercoda and develop valuable new scenarios to guide users through current features
- [ ] Extracting common functions from various scenarios to reduce code duplication.