qumine/ingress-controller

QuMine - Ingress

!GitHub Release !GitHub Workflow https://godoc.org/github.com/qumine/QuMine-Ingress?status.svg](https://godoc.org/github.com/qumine/qumine-Ingress) https://goreportcard.com/badge/github.com/qumine/qumine-Ingress](https://goreportcard.com/report/github.com/qumine/qumine-Ingress)

镜像概述和主要用途

QuMine - Ingress是一个Kubernetes入口控制器，专门用于基于请求的主机名路由Minecraft连接。它允许在Kubernetes集群中运行多个Minecraft服务器，并通过主机名区分不同的服务实例，实现连接的精准路由。

核心功能和特性

• 基于主机名的路由：根据Minecraft客户端请求的主机名将连接路由到相应的后端服务
• Kubernetes原生集成：通过服务注解实现后端服务自动发现
• 可配置参数：支持自定义监听地址、端口及API配置
• 轻量级设计：使用Go语言开发，资源占用低，性能高效
• 调试支持：提供调试日志级别，便于问题排查

使用场景和适用范围

适用于在Kubernetes集群中部署多个Minecraft服务器实例的场景，特别是需要通过不同主机名区分不同游戏服务器（如生存服、创造服、测试服等）的情况。适合游戏服务提供商、社区服务器管理员以及需要管理多Minecraft实例的团队使用。

使用方法和配置说明

Kubernetes环境

HELM Charts

HELM Charts可在以下地址获取：https://github.com/qumine/charts

Ingress部署

Ingress应作为DaemonSet在所有面向外部的节点上运行。

默认情况下，Ingress无需自定义即可正常运行，如需调整行为，可通过设置以下参数进行配置：

  -api-host string
        REST API监听地址 (默认 "0.0.0.0")
  -api-port int
        REST API监听端口 (默认 8080)
  -debug
        启用调试日志级别
  -help
        显示帮助信息
  -host string
        服务器监听地址 (默认 "0.0.0.0")
  -kube-config string
        kube配置文件路径
  -port int
        服务器监听端口 (默认 25565)
  -version
        显示当前版本

上游服务配置

要使服务被Ingress发现，需要为服务添加ingress.qumine.io/hostname注解。可选地，可以设置ingress.qumine.io/portname注解来指定Minecraft连接使用的端口。

服务配置示例：

yaml
apiVersion: v1
kind: Service
metadata:
  name: example
  annotations:
    ingress.qumine.io/hostname: "example"  # 必需：指定主机名
    ingress.qumine.io/portname: "minecraft"  # 可选：指定端口名称
spec:
  ports:
  - port: 25565
    name: minecraft  # 需与portname注解匹配
  selector:
    app: example

非Kubernetes环境

即将在近期提供

开发

本地执行快照发布

bash
docker run -it --rm \
  -v ${PWD}:/build -w /build \
  -v /var/run/docker.sock:/var/run/docker.sock \
  goreleaser/goreleaser \
  release --snapshot --rm-dist