From 97845355f9dd30242bcb7543981cb345dab107f5 Mon Sep 17 00:00:00 2001 From: River Date: Fri, 17 Apr 2026 18:41:27 +0800 Subject: [PATCH] docs(readme): add K3s quickstart deployment section Add a K3s subsection under Kubernetes in both README.md and README_zh.md with a one-line deploy command and link to the full k3s README. --- README.md | 10 ++++++++++ README_zh.md | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.md b/README.md index 9a8f6c39..61826479 100644 --- a/README.md +++ b/README.md @@ -327,6 +327,16 @@ kubectl apply -f deploy/k8s/services.yaml kubectl apply -f deploy/k8s/ingress.yaml ``` +### K3s + +For K3s clusters, a self-contained quickstart overlay is available under [`deploy/k3s/overlays/quickstart/`](./deploy/k3s/overlays/quickstart). It includes PostgreSQL, Redis, and all SkillHub services, and is compatible with K3s' default Traefik Ingress: + +```bash +kubectl apply -k deploy/k3s/overlays/quickstart/ +``` + +See [`deploy/k3s/README_zh.md`](./deploy/k3s/README_zh.md) for full details. + ## Smoke Test A lightweight smoke test script is available at [`scripts/smoke-test.sh`](./scripts/smoke-test.sh). diff --git a/README_zh.md b/README_zh.md index 72c7eb73..ff93a4a2 100644 --- a/README_zh.md +++ b/README_zh.md @@ -203,6 +203,16 @@ kubectl apply -f deploy/k8s/ helm install skillhub ./deploy/helm ``` +### K3s 一键部署 + +针对 K3s 集群,提供了自包含的 quickstart overlay,内置 PostgreSQL、Redis 及全部服务组件,适配 K3s 默认 Traefik Ingress: + +```bash +kubectl apply -k deploy/k3s/overlays/quickstart/ +``` + +详细说明请参考 [`deploy/k3s/README_zh.md`](./deploy/k3s/README_zh.md)。 + ### 环境变量 关键配置选项: