Kuvel
概述
Kuvel,一个用于 Velocity 的服务发现插件。它将自动发现 Minecraft 服务器并在 Velocity 中注册/注销它们。
功能
- 监控 Kubernetes 集群中的 Minecraft Pod,并在 Velocity 中自动注册/注销它们
- 创建负载均衡服务器,并将尝试加入的玩家分配到已链接的服务器。
- 使用 Redis 在多个 Velocity 实例之间同步服务器名称
安装
插件可从 Releases 下载。下载 Kuvel.jar 并将其安装到 Velocity 的 plugins 目录中。配置文件需要进行如下所示的初始设置。
# 用于服务器发现的 Kubernetes 命名空间。
namespace: ""
# 用于服务器标签或注解键的前缀。
label-key-prefix: "kuvel.azisaba.net"
# 在使用多个 Velocity 实例的负载均衡环境中,需要通过 Redis 进行服务器名称同步。
redis:
group-name: "develop"
connection:
hostname: "redis"
port: 6379
# username 是可选的。如果启用了身份验证,可以在此处使用它。否则可以留空或 null。
username: "default"
# password 是可选的。如果启用了身份验证,可以在此处使用它。否则可以留空或 null。
password: "password"
# label-selectors 用于过滤要注册的 Pods 和 ReplicaSets。
label-selectors:
- "kuvel.azisaba.net/enable-server-discovery=true"
或者,您可以使用环境变量来配置 Kuvel。这些环境变量将覆盖 config.yml,分别为 KUVEL_NAMESPACE、KUVEL_LABEL_KEY_PREFIX、KUVEL_REDIS_GROUPNAME、
KUVEL_REDIS_CONNECTION_HOSTNAME、KUVEL_REDIS_CONNECTION_PORT、KUVEL_REDIS_CONNECTION_USERNAME 和
KUVEL_REDIS_CONNECTION_PASSWORD。
为了让 Kuvel 监控服务器,您必须向 Kubernetes 请求权限。对于 Velocity Pod,请允许对 Pods
和 ReplicaSets 执行 get/list/watch 操作。
apiVersion: v1
kind: ServiceAccount
metadata:
name: velocity-account
namespace: default
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: velocity-clusterrolebiding
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: view
subjects:
- kind: ServiceAccount
name: velocity-account
namespace: default
# 将 ServiceAccount 应用到 Velocity pod
apiVersion: apps/v1
kind: ...
# ...
spec:
serviceAccountName: velocity-account
# ...
在 Minecraft 服务器上启用服务发现
为了告诉 Kuvel 该 Pod 是一个 Minecraft 服务器,请使用 Kubernetes 标签服务。
标签键和值在配置文件中指定。默认情况下,标签键为
kuvel.azisaba.net/enable-server-discovery,值为 true。
以下标签还用于其他一些功能。
| 标签名称 |
值 |
| kuvel.azisaba.net/preferred-server-name |
您希望与 Velocity 注册的服务器名称 |
| kuvel.azisaba.net/initial-server |
true / false |
| kuvel.azisaba.net/disable-name-suffix |
true / false |
如果需要超过 63 个字符的服务器名称,可以使用 kuvel.azisaba.net/preferred-server-name 注解代替标签。
如果在 Pod 上设置了 kuvel.azisaba.net/disable-name-suffix=true,Kuvel 将按照 preferred-server-name 的确切内容注册服务器名称(不带 -1 后缀)。如果检测到多个副本,Kuvel 会记录错误并跳过额外的 Pod。此标签仅适用于单副本 Pod。
Pod
apiVersion: v1
kind: Pod
metadata:
name: test-server
labels:
kuvel.azisaba.net/enable-server-discovery: "true" # Kuvel 检测 Minecraft 服务器所必需。取决于您的配置。
kuvel.azisaba.net/preferred-server-name: "test-server" # Kuvel 命名服务器所必需
# kuvel.azisaba.net/initial-server: "true" # 如果您想将此服务器设为初始服务器,请取消注释此行。
# kuvel.azisaba.net/disable-name-suffix: "true" # 使用确切的偏好名称(无 -1 后缀);仅限单副本。
spec:
containers:
- name: test-server
image: itzg/minecraft-server:java8
ports:
- containerPort: 25565
Deployment
apiVersion: apps/v1
kind: Deployment
metadata:
name: test-server-deployment
spec:
replicas: 2
selector:
matchLabels:
app: test-server-deployment
template:
metadata:
labels:
app: test-server-deployment
kuvel.azisaba.net/enable-server-discovery: "true" # Kuvel 检测 Minecraft 服务器所必需。取决于您的配置。
kuvel.azisaba.net/preferred-server-name: "test-server" # Kuvel 命名服务器所必需
# kuvel.azisaba.net/initial-server: "true" # 如果您想将此服务器设为初始服务器,请取消注释此行。
spec:
containers:
- name: test-server
image: itzg/minecraft-server:java8
ports:
- containerPort: 25565
在这两种情况下,服务器都将以 test-server 的名称注册。
但是,如果有两个或更多同名的服务器,将在服务器名称后分配一个数字。例如,如果有两个名为 test-server 的 Pod,其中一个将是 test-server,另一个将是 test-server-1。
负载均衡
对于可并行处理的服务器(如大厅服务器),有时希望尽可能均匀地分配玩家数量。这时 Kuvel 的负载均衡功能就派上用场了。
apiVersion: apps/v1
kind: Deployment
metadata:
name: lobby-deployment
labels:
kuvel.azisaba.net/enable-server-discovery: "true"
kuvel.azisaba.net/preferred-server-name: "lobby"
# kuvel.azisaba.net/initial-server: "true" # Uncomment this line if you want to make this load balancer server the initial server.
spec:
replicas: 3
selector:
matchLabels:
app: lobby-deployment
template:
metadata:
labels:
app: lobby-deployment
kuvel.azisaba.net/enable-server-discovery: "true"
kuvel.azisaba.net/preferred-server-name: "lobby"
# kuvel.azisaba.net/initial-server: "true" # Uncomment this line if you want to make this server the initial server.
spec:
containers:
- name: lobby
image: itzg/minecraft-server:java8
ports:
- containerPort: 25565
通过为 Deployment 添加标签,可以激活 Kuvel 的负载均衡功能。Kuvel 的负载均衡器具备以下特性:
- 将尝试加入负载均衡服务器的玩家随机分配到 ReplicaSet 下的各个 Pod 中。
- 与 Kubernetes ReplicaSet 同步,自动注册/注销转发目标。
利用此功能,当执行 /server lobby 命令时,可以实现连接到 lobby-1、lobby-2 或 lobby-3 中的随机一个。
在多 Velocity 环境中同步服务器名称
在 Kubernetes 集群中,Pod 几乎可以在同一时间创建,这可能导致不同的 Velocity 服务器拥有不同的注册名称。这在并行的 Velocity 环境中可能引发严重问题。Kuvel 提供基于 Redis 的名称同步功能以避免此类问题。Kuvel 使用键名以 kuvel: 开头的键。
在 1.x 版本中,此功能是可选的;但从 2.0.0 版本开始,该设置默认启用。
许可证
GNU General Public License v3.0
Kuvel
Overview
Kuvel, A service discovery plugin for Velocity. It will automatically discover Minecraft servers and
register/unregister them within Velocity.
Features
- Monitor Minecraft pods in a Kubernetes cluster and automatically register/unregister them within
Velocity
- Create a LoadBalancer server and distribute players trying to join to the linked servers.
- Synchronize server names across multiple Velocity instances using Redis
Installing
The Plugin can be downloaded
from Releases. Download Kuvel.jar and
install it into Velocity plugins directory. The config file requires initial setup as seen below.
# The kubernetes namespace to use for the server discovery.
namespace: ""
# The prefix to use for the keys of the server labels or annotations.
label-key-prefix: "kuvel.azisaba.net"
# Server name synchronization by Redis is required in load-balanced environments using multiple Velocity instances.
redis:
group-name: "develop"
connection:
hostname: "redis"
port: 6379
# username is optional. if you have authentication enabled, you can use it here. Otherwise you can leave it blank or null.
username: "default"
# password is optional. if you have authentication enabled, you can use it here. Otherwise you can leave it blank or null.
password: "password"
# label-selectors are used to filter Pods and ReplicaSets to be registered.
label-selectors:
- "kuvel.azisaba.net/enable-server-discovery=true"
Alternatively you can use environment variables to configure Kuvel. The environment variable will override
the config.yml and are KUVEL_NAMESPACE, KUVEL_LABEL_KEY_PREFIX, KUVEL_REDIS_GROUPNAME,
KUVEL_REDIS_CONNECTION_HOSTNAME, KUVEL_REDIS_CONNECTION_PORT, KUVEL_REDIS_CONNECTION_USERNAME, and
KUVEL_REDIS_CONNECTION_PASSWORD.
In order for Kuvel to monitor the server, you must request permission from Kubernetes. For Velocity pods, please allow get/list/watch to Pods
and ReplicaSets.
apiVersion: v1
kind: ServiceAccount
metadata:
name: velocity-account
namespace: default
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: velocity-clusterrolebiding
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: view
subjects:
- kind: ServiceAccount
name: velocity-account
namespace: default
# Apply ServiceAccount to the Velocity pod
apiVersion: apps/v1
kind: ...
# ...
spec:
serviceAccountName: velocity-account
# ...
Enable Service Discovery on the Minecraft Servers
To tell Kuvel that the pod is a Minecraft server, use the Kubernetes label service.
The label keys and values are specified in the config file. By default, the label key
is kuvel.azisaba.net/enable-server-discovery and the value is true.
The following labels are also used for some other features.
| Label Name |
Value |
| kuvel.azisaba.net/preferred-server-name |
Name of the server you wish to register with Velocity |
| kuvel.azisaba.net/initial-server |
true / false |
| kuvel.azisaba.net/disable-name-suffix |
true / false |
If server names longer than 63 characters are desired, the kuvel.azisaba.net/preferred-server-name annotation can be used instead of the label.
If kuvel.azisaba.net/disable-name-suffix=true is set on a Pod, Kuvel will register the server name exactly as preferred-server-name (no -1 suffix). If multiple replicas are detected, Kuvel logs an error and skips the extra pods. This label is intended for single-replica Pods only.
Pod
apiVersion: v1
kind: Pod
metadata:
name: test-server
labels:
kuvel.azisaba.net/enable-server-discovery: "true" # Required for Kuvel to detect Minecraft servers. Depends on your config.
kuvel.azisaba.net/preferred-server-name: "test-server" # Required for Kuvel to name the server
# kuvel.azisaba.net/initial-server: "true" # Uncomment this line if you want to make this server the initial server.
# kuvel.azisaba.net/disable-name-suffix: "true" # Use the exact preferred name (no -1 suffix); single replica only.
spec:
containers:
- name: test-server
image: itzg/minecraft-server:java8
ports:
- containerPort: 25565
Deployment
apiVersion: apps/v1
kind: Deployment
metadata:
name: test-server-deployment
spec:
replicas: 2
selector:
matchLabels:
app: test-server-deployment
template:
metadata:
labels:
app: test-server-deployment
kuvel.azisaba.net/enable-server-discovery: "true" # Required for Kuvel to detect Minecraft servers. Depends on your config.
kuvel.azisaba.net/preferred-server-name: "test-server" # Required for Kuvel to name the server
# kuvel.azisaba.net/initial-server: "true" # Uncomment this line if you want to make this server the initial server.
spec:
containers:
- name: test-server
image: itzg/minecraft-server:java8
ports:
- containerPort: 25565
In both cases, the server is registered under the name test-server.
However, if there are two or more servers with the same name, a number will be assigned after the server name. For example, if there are two pods with the server name test-server, one will be test-server and the other will be test-server-1.
Load Balancer
On parallelizable servers such as Lobby servers, it is sometimes desirable to distribute the number of players as evenly as possible. This is where Kuvel's LoadBalancer feature comes in handy.
apiVersion: apps/v1
kind: Deployment
metadata:
name: lobby-deployment
labels:
kuvel.azisaba.net/enable-server-discovery: "true"
kuvel.azisaba.net/preferred-server-name: "lobby"
# kuvel.azisaba.net/initial-server: "true" # Uncomment this line if you want to make this load balancer server the initial server.
spec:
replicas: 3
selector:
matchLabels:
app: lobby-deployment
template:
metadata:
labels:
app: lobby-deployment
kuvel.azisaba.net/enable-server-discovery: "true"
kuvel.azisaba.net/preferred-server-name: "lobby"
# kuvel.azisaba.net/initial-server: "true" # Uncomment this line if you want to make this server the initial server.
spec:
containers:
- name: lobby
image: itzg/minecraft-server:java8
ports:
- containerPort: 25565
By applying a Label to a Deployment, Kuvel's LoadBalancer feature can be activated. Kuvel's LoadBalancer has the following features.
- Distribute players who try to join the Load Balancer server randomly to the pods under ReplicaSet.
- Synchronize with Kubernetes ReplicaSet and automatically register/unregister forwarding destinations.
Using this, you can implement a mechanism to randomly connect to lobby-1, lobby-2, or lobby-3 when /server lobby is invoked.
Synchronize Server Names in Multi Velocity Environments
In a Kubernetes cluster, pods can be created at almost the same time, and this can cause different
Velocity servers to have different registration names. This can cause fatal issues in a parallel
Velocity environment. Kuvel provides name synchronization using Redis to avoid this
issue. Kuvel uses keys whose key name begins with kuvel:.
On 1.x, this feature was optional, but from 2.0.0, this setting is enabled by default.
License
GNU General Public License v3.0
评论 0
登录后参与评分
还没有评论,来抢沙发吧