-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Description
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:
- [Enhancement] Automate macOS IP detection in local-up script #7257
- hack/deploy-k8s-metrics-server.sh: wget not available on macOS by default, causing Quick Start failure #7273
- cleanup: remove unused function
util::wait_nodes_taint_disappearcontaining timeout from hack/util.sh #7284 - hack/setup-dev-base.sh: Add macOS pre-flight validation for Docker daemon and resources #7280
- hack/update-estimator-protobuf.sh: sed -r flag incompatible with macOS BSD sed #7278
PRs:
- hack/util.sh: auto-detect macOS host IP instead of interactive prompt(hack/util.sh: auto-detect macOS host IP instead of interactive prompt #7267)
- fix: add curl fallback in deploy-k8s-metrics-server.sh for macOS compute(fix: add curl fallback in deploy-k8s-metrics-server.sh for macOS comp… #7274)
- cleanup(hack/util.sh): remove unused function util::wait_nodes_taint_disappear containing timeout(cleanup(hack/util.sh): remove unused function
util::wait_nodes_taint_disappearcontaining timeout #7285) - hack/setup-dev-base.sh: Add Docker daemon and resource pre-flight validation(hack/setup-dev-base.sh: Add Docker daemon and resource pre-flight validation #7281)
- fix: use sed -E instead of sed -r for macOS BSD sed compatibility(fix: use sed -E instead of sed -r for macOS BSD sed compatibility #7279)
Task2: A minimal GitHub Actions smoke workflow on macOS that verifies install + basic control-plane/member-cluster bring-up
TBD
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.
- Updating the course information of existing scenarios by correcting outdated content and optimizing the material to enhance learning outcomes.
- Adding new scenario-A tutorial on FHPA usage.
- Adding new scenario-An application-level failover guide.
- Adding new scenario-Multi-component workload scheduling (support for workloads common in AI and big data).
Metadata
Metadata
Assignees
Labels
Type
Projects
Status