Skip to content

docs: add Kubernetes deployment guide with overlays structure#219

Merged
wowo-zZ merged 6 commits intomainfrom
docs/kubernetes-deployment-guide
Apr 2, 2026
Merged

docs: add Kubernetes deployment guide with overlays structure#219
wowo-zZ merged 6 commits intomainfrom
docs/kubernetes-deployment-guide

Conversation

@XiaoSeS
Copy link
Copy Markdown
Collaborator

@XiaoSeS XiaoSeS commented Apr 2, 2026

Summary

  • Restructure k8s configs with base/overlays pattern for flexibility
  • Add overlays/with-infra for full deployment (PostgreSQL + Redis)
  • Add overlays/external for external database scenarios
  • Add comprehensive ConfigMap with bootstrap admin settings
  • Fix health check path to /actuator/health (auth issue)
  • Add SKILLHUB_API_UPSTREAM env for frontend
  • Set SESSION_COOKIE_SECURE=false for HTTP environments
  • Add Chinese and English documentation in docs/skillhub/

Changes

K8s Configuration

  • deploy/k8s/base/ - Base configuration shared by all deployments
  • deploy/k8s/overlays/with-infra/ - Full deployment with PostgreSQL + Redis
  • deploy/k8s/overlays/external/ - Use external database

Bug Fixes

  • Health check endpoint changed from /actuator/health/readiness to /actuator/health (auth required)
  • Added SKILLHUB_API_UPSTREAM environment variable for frontend
  • Set SESSION_COOKIE_SECURE=false for HTTP environments

Documentation

  • docs/skillhub/guide/kubernetes.md - Chinese documentation
  • docs/skillhub/en/guide/kubernetes.md - English documentation

Test Plan

  • Deploy with kubectl apply -k overlays/with-infra/
  • All pods running successfully
  • Frontend accessible via port-forward
  • Bootstrap admin login works

XiaoSeS added 6 commits April 2, 2026 18:14
Unify to use runtime.sh for all deployment commands, removing the
distinction between "official images" and "Aliyun mirror". The --aliyun
parameter is preserved for users in China to specify the mirror.

Changes:
- Remove runtime-github.sh references, use runtime.sh uniformly
- Default command uses GHCR images
- Add --aliyun parameter for China users
- Update README.md, README_zh.md, and docs/skillhub/ quickstart files
Merge the two documentation links into a single "Documentation" section
with clear descriptions of each:
- User Guide: skill publishing, search, CLI usage
- Developer Docs: architecture, API reference, deployment

This makes it easier for users to find the right documentation.
Merge the two documentation links into a single "Documentation" section
with clear descriptions of each:
- User Guide: skill publishing, search, CLI usage
- Developer Docs: architecture, API reference, deployment

This makes it easier for users to find the right documentation.
When starting with a custom --home directory, the generated shutdown
command now includes the same --home parameter to ensure it can find
the correct compose files.
- Restructure k8s configs with base/overlays pattern for flexibility
- Add overlays/with-infra for full deployment (PostgreSQL + Redis)
- Add overlays/external for external database scenarios
- Add comprehensive ConfigMap with bootstrap admin settings
- Fix health check path to /actuator/health (auth issue)
- Add SKILLHUB_API_UPSTREAM env for frontend
- Set SESSION_COOKIE_SECURE=false for HTTP environments
- Add Chinese and English documentation in docs/skillhub/
@wowo-zZ wowo-zZ merged commit c0f7900 into main Apr 2, 2026
3 checks passed
zhaieryuan pushed a commit to zhaieryuan/skillhub that referenced this pull request Apr 2, 2026
* main:
  docs: add Kubernetes deployment guide with overlays structure (iflytek#219)
  docs: simplify runtime script usage (iflytek#217)
  fix: add --public-url parameter for docker deployment (iflytek#216)
  chore: update .gitignore to include .codex directory (iflytek#211)
  organize .gitignore (iflytek#206)
  docs: add VitePress bilingual documentation site (iflytek#208)
zhaieryuan pushed a commit to zhaieryuan/skillhub that referenced this pull request Apr 2, 2026
* main:
  docs: add Kubernetes deployment guide with overlays structure (iflytek#219)
  docs: simplify runtime script usage (iflytek#217)
  fix: add --public-url parameter for docker deployment (iflytek#216)
  chore: update .gitignore to include .codex directory (iflytek#211)
  organize .gitignore (iflytek#206)
  docs: add VitePress bilingual documentation site (iflytek#208)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants