Skip to content

docs: provide K8s deploy #8585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

wayne-cheng
Copy link

Alist 也需要在云计算领域推广,毕竟 K8s 已经相当流行了。

提供在 K8s 集群中安装 alist 的方式。将 Helm Chart 包文件维护在项目根路径的 helm 目录下。

后续建议官方发布一个 Alist 的 Helm Chart 仓库地址,用户就可以直接使用 helm 命令拉取,而不用从源码仓库中找部署清单了。

Copy link

Walkthrough

此PR为Alist项目提供了在Kubernetes集群中部署的支持,使用Helm Chart进行安装和管理。Helm Chart文件被添加到项目的helm目录中,包含了必要的模板和配置文件。

Changes

文件 概要
helm/alist/Chart.yaml 添加了Helm Chart的基本信息配置。
helm/alist/README.md 新增文件,提供了Helm Chart的使用说明,包括安装步骤和配置参数。
helm/alist/templates/_helpers.tpl 新增文件,包含Helm模板的辅助函数定义。
helm/alist/templates/alist-deployment.yaml 添加了Kubernetes Deployment模板文件。
helm/alist/templates/alist-persistentvolumeclaim.yaml 添加了Kubernetes PersistentVolumeClaim模板文件。
helm/alist/templates/alist-service.yaml 添加了Kubernetes Service模板文件。
helm/alist/values.yaml 添加了默认的Helm Chart配置文件。
🪧 Tips For further assistance, please describe your question in the comments and @petercat-assistant to start a conversation with me.

@@ -0,0 +1,10 @@
name: alist

Choose a reason for hiding this comment

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

Ensure that the version and appVersion fields are specified in the Chart.yaml file to maintain compatibility and clarity for users.

@xrgzs
Copy link
Contributor

xrgzs commented May 26, 2025

感谢 @wayne-cheng 的贡献想法!对 K8s 部署 Alist 的重要性表示认同,但个人认为:

  1. 主仓库应专注于核心代码,部署配置可能会让仓库变得臃肿
  2. 您提交的 Chart 配置中存在版本号硬编码等问题,且没有集成 CI/CD
  3. 可以先在社区维护一个成熟的 alist-helm 仓库,经过充分测试后再考虑官方支持
  4. Alist 在社区具有一定知名度,一般 K8s 云平台会提供 Alist 的模板
  5. 您可以在 https://github.com/AlistGo/docs 中提供自行使用 K8s 部署的指南

再次感谢你的贡献!如果您愿意帮忙完善部署文档,个人表示很欢迎。

@wayne-cheng
Copy link
Author

@xrgzs 我已经调试成功了,并乐意完善相关 K8s 部署文档,不过文档里总得引用一个合适的 helm 包下载地址,我希望它是官方的。虽然有不少开源项目是在其主代码维护的helm包,但我个人也更倾向于使用单独的代码仓库去管理。这样做还可以把项目设置成 Github Pages ,并对外提供可 github.io 域名访问的 Helm Chart 链接。你可以在 AlistGo 下面创建一个 alist-helm 仓库吗?

@xrgzs
Copy link
Contributor

xrgzs commented May 27, 2025

你可以在 AlistGo 下面创建一个 alist-helm 仓库吗?

我没有权限,你可以 @ 一下 xhofe。

@wayne-cheng
Copy link
Author

  1. Alist 在社区具有一定知名度,一般 K8s 云平台会提供 Alist 的模板

这些平台厂商提供的部署模板,只能在他们的平台上跑起来(依赖了其定制的 K8s CRD 资源)。可以参考,但不够中立和普适性。我们需要能直接在原生 K8s 集群上就能运行 alist!

@wayne-cheng
Copy link
Author

@xhofe 可以建一个alist-helm 仓库吗?

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