toms.log: Minecraftのサーバー構築

モチベーションは興味本位.

Minecraftがやりたくなったので, サーバーを構築した. 
もちろんソロでプレイする場合はサーバー必要ないし, マルチだとしても先人の知恵を使えば簡単に構築できる. が独自で構築することにした.

[<img alt="" border="0" data-original-height="296" data-original-width="889" width="460px" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhu3o4s2tOHNFJcGwsUuopFoxFErgaR8GhMxNTTTqcoKkIGda6gWI4J213BV6Jwxf2lgyflKdgaal-bUUJEdnVcvRz6QCiJt7pMgN60nMFlQwDTDuzDMc6NSNZ6i8P95cZ9MdAp8F5bS0aVkS8Tvarq0ZOUjaJ7h1qSM1aX-udRZEKQWNrAG7KFuKr2Gw/s1600/minecraft-server.png"/>](https://github.com/toms74209200/minecraft-server)

## サーバー構築

サーバー用の実行JARはSpigotMC[[1](#spigotmc)] にした. まあこれはModとか入れるなら安定. サーバー本体は Docker image に固めてKubernetes(k8s)上で構築することにした. プラットフォームにはGoogle Cloud Platform(GCP)を利用した. Docker image に固めたのは, 構築しやすくするためで特にサーバーを起動したり落としたりすることが多いので正解. k8s上に構築したのはただの趣味. ふつうはAWSならばEC2やGCPの場合は Compute Engine を使うことが多いと思われる. また Docker image を利用するにしてもサーバーは１台しか使わないので Amazon ECS とかで十分なはず. IaCするうえで「Terraform使うくらいならk8sでいいか」くらいの気持ち. 仕事でもないなら自分の好きなようにやるのが一番. ちなみに2023年4月現在は課金アカウント1つにつき1クラスターまで無料で使える[[2](#gcp_k8s_pricing)]（こんなのに貴重な1枠を使っていいのか）.

### Kubernetes での構築

Minecraftサーバーを構築するには, Minecraftそのものを動かすサーバー本体のほかにサーバーデータを記録するための永続化ディスク（とはいえEC2のようなVMそのものであれば勝手に永続化ディスクがついてくるので意識する必要がない場合もある）と外部から接続できるようにするためのロードバランサーが必要になる. これらはすべてKubernatesの構成ファイルとして表現できる. とても良い. 詳しくは後述するが, 特にロードバランサーを作ったり削除したりができてとても良い.

Google Kubernetes Engine にはフルマネージドの標準モードのほかにAutopilotモードがある. 今回はAutopilotモードを使用した. インフラ周りで考えることが少ないので楽.

### Docker image

Minecraftサーバーとして利用できる Docker image として有名なのは itzg/minecraft-server[[3](#itzg_docker_image)] があるが, せっかくなので自分でイメージを作成した. SpigotMCではサーバーとなるJARを事前にビルドする必要がある. DockerなのでJARをビルドするレイヤーとサーバーとしてJARを実行するレイヤーを用意することにした. マイナーバージョンアップ程度であれば `dcoker build` 時に `ARG` を変更するだけで対応できそうだ. JARのランタイムイメージはビルドで使ったイメージと同じものでも構わないが distroless[[4](#distroless)] を使うことにした. イメージサイズも小さくなるし, 構成もシンプルなので最適だと思う.

[`Dockerfile`](https://github.com/toms74209200/minecraft-server/blob/master/docker/Dockerfile)

```dockerfile
ARG SPIGOT_VERSION=1.19.3

FROM openjdk:17.0.2-slim-bullseye AS build-spigotmc

ARG SPIGOT_VERSION

WORKDIR /usr/local/bin
RUN apt-get update && apt-get install -y \
    wget \
    git
RUN wget https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar \
    && java -jar BuildTools.jar --rev ${SPIGOT_VERSION} \
    && mv spigot-${SPIGOT_VERSION}.jar server.jar
RUN echo eula=true > eula.txt

FROM gcr.io/distroless/java17-debian11

COPY --from=build-spigotmc /usr/local/bin/server.jar /usr/local/bin/server.jar
COPY --from=build-spigotmc /usr/local/bin/eula.txt /usr/local/bin/eula.txt
WORKDIR /usr/local/bin
CMD ["-Xmx2048M", "-Xms1024M", "-jar", "/usr/local/bin/server.jar", "nogui"]
```

Minecraftの設定は `server.properties` で設定することになるが, 今のところ特に設定していない. 必要になったらk8sから入れることになるだろう.

### 永続化ディスク

サーバーのワールドデータは `world/` ディレクトリのファイルとして保存されているため, コンテナで運用するためには別途永続化ディスクを用意しなければならない. 一応10GB用意したが, 今のところ1GBも使っていない.

### コンテナの設定

ゲームサーバーにありがちだがMinecraftのサーバーはスケールアウトができずスケールアップするしかない. 前述のとおりk8sはAutopilotモードで利用しているがAutopilotのデフォルトだとCPUとメモリが足りないのでここは自前で設定しなければならない.1vCPUより小さくすると描画がもたつくようだ（Autopilotではデフォルトが 0.5）.

Cloud Monitoring からも確認できる.

### 監視

デフォルトでコンテナの標準出力からログが出力されるため, 特に何もしなくてもログ出力される. しかも Cloud Logging のログレベルにそのまま反映される. ユーザーのログイン情報もログに出力されるので, 比較的簡単に管理できそうだ.

特になにもしなくても Cloud Logging にログが記録されている.

## 運用

### ロードバランサー金がかかる

k8sそのものは料金がかからないが, k8sから Cloud Load Balancing を使うと料金がかかる（Cloud Run にしておけばよかったんじゃ…）. そのため使わない間は少なくともロードバランサーを削除しておかなければならない. またロードバランサーを作りなおすたびにIPアドレスは変更される. IPアドレスの確認が面倒であれば固定IPにするかDDNSにする必要があるだろう. 今回はここまでの対応はせずにIPアドレスを常に確認することにした.

k8sを使っているためロードバランサーの作成・削除は kubectl を使えばよい. これを Web API でラップしてやればあとは外からAPIを叩くだけでよくなる. 簡単に Web API を構築するには Cloud Functions を使うのが最も簡単だ. しかし Cloud Functions からは kubectl を使うことはできない. なので直接コンテナを利用できるサービスを使う必要がある.

このためにGCPから Kubernetes Python Client[[5](#k8s-client)] を利用するイメージを作った.

[<img alt="" border="0" data-original-height="296" data-original-width="889" width="460px"  src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEj0IOCp-LZigrMNLzJRu23FHiWzTK0KpEEooqq2_Gix38MOCizNMEKqFx6Mv94B1I9etc68t3WDV4JZzwKdFs5REDBHo9YZfGG97ofXYCDecD8K4wfsPz_s7xB2jNinE1kqgD1YM575Q3PIRkcv3q_9mFKagrS0qpNc3-Nga-4rmrqhsSDc5Dzttv13CA/s1600/python-gcloud-k8s-client.png"/>](https://github.com/toms74209200/python-gcloud-k8s-client)

これをもとにロードバランサーを作成・削除するイメージを用意した. GitHubのリリースからロードバランサーを構成するYAMLファイルを取得して kubectl を実行すればロードバランサーを作成できる. ロードバランサーを削除するには名前さえわかっていればよい.

これからさらに Web API のインターフェースを用意してやれば外部から叩くことができるようになる. が, 今回は Web API にはせずに Cloud Run jobs で実行するだけにした. Cloud Run jobs はジョブを作成しておけばGCPコンソール上から実行ボタンを押すだけで実行することができる. 今のところはこれでも問題ない. 外から叩くことができるようにしたければ, イメージごと Web API サービスにしてやるか, Cloud Functions から今ある Cloud Run jobs をトリガしてやればよいだろう.

---

勢いでk8sを使ってMinecraftサーバーを構築してみたが, やはり引っかかるところが多くて大変だった. ただMinecraftが遊びたいだけなら, せいぜい Cloud Run を使っておけばよさそうだ. しかしサーバーの構成管理が容易だし腐ることはないので, とりあえずk8sを選んでおくというのもありかもしれない（責任は取らない).

## 参考

[1]<a name="spigotmc"></a> [SpigotMC - High Performance Minecraft](https://www.spigotmc.org/)

[2]<a name="gcp_k8s_pricing"></a> [クラスタ管理手数料と無料枠 | 料金  |  Google Kubernetes Engine（GKE）  |  Google Cloud](https://cloud.google.com/kubernetes-engine/pricing?hl=ja#cluster_management_fee_and_free_tier)

[3]<a name="itzg_docker_image"></a>  [itzg/minecraft-server - Docker Image | Docker Hub](https://hub.docker.com/r/itzg/minecraft-server)

[4]<a name="distroless"></a> [GoogleContainerTools/distroless: 🥑 Language focused docker images, minus the operating system.](https://github.com/GoogleContainerTools/distroless)

[5]<a name="k8s-client"></a> [kubernetes-client/python: Official Python client library for kubernetes](https://github.com/kubernetes-client/python)

toms.log

2023/05/05

Minecraftのサーバー構築

0 件のコメント:

コメントを投稿

人気の投稿