Skip to content
BranchesTags

Repository files navigation

New API Helm Chart

Helm Kubernetes License

一个用于部署 New-API 服务的 Helm Chart，支持高可用性部署。

📋 功能特性

  • ✅ 高可用架构: 支持 Master/Slave 模式部署
  • ✅ 智能负载均衡: 自动选择器和智能流量分发
  • ✅ 自动外部访问: 未启用 Ingress 时自动启用 NodePort
  • ✅ 内置数据库: 集成 MySQL StatefulSet
  • ✅ 缓存支持: 集成 Redis 缓存
  • ✅ 自动扩缩容: 支持 HPA (Horizontal Pod Autoscaler)
  • ✅ 持久化存储: 支持数据持久化
  • ✅ 安全配置: 自动生成密钥和安全配置
  • ✅ 监控集成: 支持 Prometheus 监控
  • ✅ 网络策略: 支持 Kubernetes NetworkPolicy
  • ✅ 备份机制: 支持定时备份

🚀 快速开始

前置要求

  • Kubernetes 1.19+
  • Helm 3.0+
  • 至少 2GB 可用内存
  • 至少 10GB 可用存储空间

使用 OCI 仓库安装 (推荐)

我们使用 OCI (Open Container Initiative) 格式通过 GitHub Container Registry 分发 Helm Chart，这种方式比传统的 Helm 仓库更高效，不需要下载整个仓库索引。

# 配置认证 (参考 GitHub 文档进行安全配置)
# https://docs.github.com/cn/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry

# 直接安装最新版本
helm install my-new-api oci://ghcr.io/seongminhwan/helm-charts/new-api

# 安装特定版本
helm install my-new-api oci://ghcr.io/seongminhwan/helm-charts/new-api --version 1.0.0

# 使用自定义配置
helm install my-new-api oci://ghcr.io/seongminhwan/helm-charts/new-api -f custom-values.yaml

传统方式安装 (不推荐)

如果您使用的 Helm 版本低于 3.8.0，可以使用传统方式，但此方式将被逐步淘汰：

# 添加仓库 (请替换为实际的GitHub Pages地址)
helm repo add new-api https://seongminhwan.github.io/new-api-helm/

# 更新仓库索引
helm repo update

# 安装
helm install my-new-api new-api/new-api

# 或者使用自定义配置
helm install my-new-api new-api/new-api -f custom-values.yaml

访问服务

# 获取服务访问地址
kubectl get svc my-new-api

# 如果启用了 Ingress
kubectl get ingress my-new-api

# 如果未启用 Ingress，服务会自动使用 NodePort (默认端口 30080)
kubectl get nodes -o wide
# 然后访问 http://<node-ip>:30080

注意: 当 ingress.enabled: false 时，Chart 会自动将主服务从 ClusterIP 转换为 NodePort 类型，确保可以从集群外部访问。

⚙️ 配置说明

基本配置

# values.yaml
newapi:
  master:
    enabled: true
    replicaCount: 1
  slave:
    enabled: false
    replicaCount: 2

mysql:
  enabled: true
  auth:
    database: "newapi"
    username: "newapi"

redis:
  enabled: true
  auth:
    enabled: true

高可用配置

# 启用高可用模式
newapi:
  master:
    enabled: true
    replicaCount: 2
  slave:
    enabled: true
    replicaCount: 3

# 服务配置 - 智能负载均衡
service:
  type: ClusterIP        # 当 ingress.enabled: false 时自动转换为 NodePort
  port: 80
  targetPort: 3000
  nodePort: 30080        # 自动 NodePort 时使用的端口

# Ingress 配置
ingress:
  enabled: false         # 设为 false 时自动启用 NodePort 外部访问

# 启用自动扩缩容
autoscaling:
  enabled: true
  minReplicas: 2
  maxReplicas: 10
  targetCPUUtilizationPercentage: 70

智能负载均衡说明:

  • 主服务 (new-api) 会根据启用的组件智能选择后端
  • 当 master 和 slave 都启用时，主服务优先选择 slave 进行负载均衡
  • 专用服务 (new-api-master, new-api-slave) 提供直接访问特定组件的能力

外部数据库配置

# 使用外部 MySQL
mysql:
  enabled: false
  external:
    host: "mysql.example.com"
    port: 3306
    username: "newapi"
    password: "your-password"
    database: "newapi"

# 使用外部 Redis
redis:
  enabled: false
  external:
    host: "redis.example.com"
    port: 6379
    password: "your-redis-password"
    database: 0

服务配置

# 服务类型和负载均衡配置
service:
  type: ClusterIP          # 服务类型: ClusterIP, NodePort, LoadBalancer
  port: 80                 # 服务端口
  targetPort: 3000         # 目标端口
  nodePort: 30080          # NodePort端口 (当自动启用NodePort时使用)
  
  # 负载均衡器配置 (当type为LoadBalancer时)
  loadBalancer:
    enabled: false
    annotations: {}

# Ingress配置
ingress:
  enabled: false           # 是否启用Ingress
  className: ""
  hosts:
    - host: new-api.local
      paths:
        - path: /
          pathType: Prefix

智能负载均衡特性

Chart 提供智能负载均衡功能：

  1. 智能服务选择器：

    • 当只启用 slave 时，主服务自动选择 slave 组件
    • 当只启用 master 时，主服务自动选择 master 组件
    • 当两者都启用时，主服务优先选择 slave 组件进行负载均衡

  2. 自动 NodePort 启用：

    • 当 ingress.enabled: false 且 service.type: ClusterIP 时
    • 主服务自动转换为 NodePort 类型，提供外部访问能力
    • 默认使用端口 30080，可通过 service.nodePort 自定义

  3. 多层服务架构：

    • new-api: 主服务，提供智能负载均衡和外部访问
    • new-api-master: 专用 master 服务，用于内部直接访问
    • new-api-slave: 专用 slave 服务，用于内部直接访问

🔧 高级配置

持久化存储

newapi:
  master:
    persistence:
      enabled: true
      size: 10Gi
      storageClass: "fast-ssd"

Ingress 配置

ingress:
  enabled: true
  className: "nginx"
  annotations:
    cert-manager.io/cluster-issuer: "letsencrypt-prod"
  hosts:
    - host: api.example.com
      paths:
        - path: /
          pathType: Prefix
  tls:
    - secretName: new-api-tls
      hosts:
        - api.example.com

监控配置

monitoring:
  serviceMonitor:
    enabled: true
    namespace: monitoring
    labels:
      release: prometheus

📊 监控和日志

Prometheus 监控

Chart 支持 ServiceMonitor 资源，可以与 Prometheus Operator 集成：

monitoring:
  serviceMonitor:
    enabled: true
    interval: 30s
    path: /metrics

日志收集

logging:
  level: "info"
  format: "json"
  output: "stdout"

🔐 安全配置

密钥管理

Chart 会自动生成以下密钥：

  • SESSION_SECRET: 32位随机字符串
  • CRYPTO_SECRET: 32位随机字符串
  • MySQL 密码: 16位随机字符串
  • Redis 密码: 16位随机字符串

也可以手动指定：

config:
  session:
    secret: "your-session-secret"
  crypto:
    secret: "your-crypto-secret"

网络策略

networkPolicy:
  enabled: true
  ingress:
    - from:
        - namespaceSelector:
            matchLabels:
              name: ingress-nginx

🛠️ 运维操作

升级

# 升级到新版本
helm upgrade my-new-api new-api/new-api

# 查看升级历史
helm history my-new-api

# 回滚到上一个版本
helm rollback my-new-api

备份

Chart 支持定时备份功能：

backup:
  enabled: true
  schedule: "0 2 * * *"  # 每天凌晨2点
  retention: 7  # 保留7天

故障排除

# 查看 Pod 状态
kubectl get pods -l app.kubernetes.io/name=new-api

# 查看日志
kubectl logs -l app.kubernetes.io/name=new-api -f

# 查看配置
kubectl get configmap my-new-api-config -o yaml
kubectl get secret my-new-api-secrets -o yaml

📚 完整配置参考

查看 values.yaml 文件获取所有可配置参数的详细说明。

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

🔗 相关链接

📞 支持

如果您在使用过程中遇到问题，请：

  1. 查看 故障排除 部分
  2. 搜索现有的 Issues
  3. 创建新的 Issue 描述您的问题

⭐ 如果这个项目对您有帮助，请给我们一个 Star！

About

一个用于部署 [New-API](https://github.com/Calcium-Ion/new-api) 服务的 Helm Chart，支持高可用性部署。

Resources

Readme
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages