[ERROR] Failed to execute goal org.wildfly.plugins:wildfly-maven-plugin:5.0.0.Final:start-jar (default-cli) on project wildfly-maven-plugin-bootable-jar-example: Bootable JAR file '/path/to/target/server-bootable.jar' doesn't exist. -> [Help 1]

通常はjava -jarコマンドで起動することが多いと思うので、参考までに。

ちなみに、wildfly:start-jarゴールはこちらのページには載っていますが

WildFly Maven Plugin – Plugin Documentation

なぜかこちらのページには載っていません…。

WildFly Maven Plugin – WildFly Maven Plugin (wildfly-maven-plugin)

では、簡単に試してみましょう。

環境

今回の環境はこちら。

$ java --version
openjdk 21.0.2 2024-01-16
OpenJDK Runtime Environment (build 21.0.2+13-Ubuntu-122.04.1)
OpenJDK 64-Bit Server VM (build 21.0.2+13-Ubuntu-122.04.1, mixed mode, sharing)


$ mvn --version
Apache Maven 3.9.6 (bc0240f3c744dd6b6ec2920b3cd08dcc295161ae)
Maven home: $HOME/.sdkman/candidates/maven/current
Java version: 21.0.2, vendor: Private Build, runtime: /usr/lib/jvm/java-21-openjdk-amd64
Default locale: ja_JP, platform encoding: UTF-8
OS name: "linux", version: "5.15.0-105-generic", arch: "amd64", family: "unix"

アプリケーションを作成する

それでは、簡単なサンプルアプリケーションを作成します。Jakarta RESTful Web Services（JAX-RS）を使うだけのものにしましょう。

Maven依存関係など。

    <properties>
        <maven.compiler.release>21</maven.compiler.release>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>jakarta.platform</groupId>
            <artifactId>jakarta.jakartaee-web-api</artifactId>
            <version>10.0.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

    <build>
        <finalName>ROOT</finalName>
        <plugins>
            <plugin>
                <groupId>org.wildfly.plugins</groupId>
                <artifactId>wildfly-maven-plugin</artifactId>
                <version>5.0.0.Final</version>

                <!-- 後で -->
            </plugin>
        </plugins>
    </build>
</project>

packagingはwarです。

JAX-RSの有効化。

src/main/java/org/littlewings/wildfly/RestApplication.java

package org.littlewings.wildfly;

import jakarta.ws.rs.ApplicationPath;
import jakarta.ws.rs.core.Application;

@ApplicationPath("")
public class RestApplication extends Application {
}

リソースクラス。

src/main/java/org/littlewings/wildfly/HelloResource.java

package org.littlewings.wildfly;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("hello")
public class HelloResource {
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String message() {
        return "Hello World!!";
    }
}

これで準備は完了です。

WildFly Maven PluginでBootable JARを作成する

では、WildFly Maven PluginでBootable JARを作成します。

まずは以下で設定。

            <plugin>
                <groupId>org.wildfly.plugins</groupId>
                <artifactId>wildfly-maven-plugin</artifactId>
                <version>5.0.0.Final</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>package</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <!-- wildfly:dev も使うなら、finalNameで指定した方がよさそう -->
                    <!-- <runtime-name>ROOT.war</runtime-name> -->
                    <bootable-jar>true</bootable-jar>
                        <feature-pack>
                            <location>wildfly@maven(org.jboss.universe:community-universe)#32.0.0.Final</location>
                        </feature-pack>
                    </feature-packs>
                </configuration>
            </plugin>

packageゴール実行時にwildfly:packageゴールが動作するように設定。

                <executions>
                    <execution>
                        <goals>
                            <goal>package</goal>
                        </goals>
                    </execution>
                </executions>

いきなり脱線しますが、Bootable JAR作成時（というかプロビジョニング時）のデプロイ名をruntime-nameで変えられるのですが

                    <!-- wildfly:dev も使うなら、finalNameで指定した方がよさそう -->
                    <!-- <runtime-name>ROOT.war</runtime-name> -->

コメントで書いているように、この設定はwildfly:devは追従しないのでどちらも同じコンテキストパスにしたいのならfinalNameで
設定する方が無難でしょう。

    <build>
        <finalName>ROOT</finalName>

パッケージングします。

$ mvn package

できました。デフォルトのファイル名はserver-bootable.jarです。

[INFO] Bootable JAR packaging DONE. To run the server: java -jar /path/to/target/server-bootable.jar

起動してみます。

$ java -jar target/server-bootable.jar

確認。

$ curl localhost:8080/hello
Hello World!!

OKですね。

ところで、Bootable JARのサイズが237MBとけっこうなサイズです…。

$ ll -h target/server-bootable.jar
-rw-rw-r-- 1 xxxxx xxxxx 237M  4月 28 19:34 target/server-bootable.jar

WildFly Glowを使うと必要なWildFlyモジュールを選んでくれるようですが、今回は自分で指定します。

こうしました。

                <configuration>
                    <bootable-jar>true</bootable-jar>
                    <feature-packs>
                        <feature-pack>
                            <location>wildfly@maven(org.jboss.universe:community-universe)#32.0.0.Final</location>
                        </feature-pack>
                    </feature-packs>
                    <layers>
                        <layer>jaxrs-server</layer>
                    </layers>
                </configuration>

すでにプロビジョニング済みのディレクトリがあると再度作成してくれないので、1度mvn cleanしておきます。

$ mvn clean

もしくは以下の設定を追加すると、wildfly:package時に1度プロビジョニング済みのディレクトリを削除して実行してくれるようになります。

                    <overwrite-provisioned-server>true</overwrite-provisioned-server>

パッケージング。

$ mvn package

だいぶ小さくなりましたね。

$ ll -h target/server-bootable.jar
-rw-rw-r-- 1 xxxxx xxxxx 111M  4月 28 19:40 target/server-bootable.jar

最後はbootable-jar-nameを指定してBootable JARファイル名を変更してみます。

                <configuration>
                    <!-- wildfly:dev も使うなら、finalNameで指定した方がよさそう -->
                    <!-- <runtime-name>ROOT.war</runtime-name> -->
                    <bootable-jar>true</bootable-jar>
                    <!-- 指定しない場合は server-bootable.jar になる -->
                    <bootable-jar-name>${project.artifactId}-${project.version}-bootable.jar</bootable-jar-name>
                    <overwrite-provisioned-server>true</overwrite-provisioned-server>
                    <feature-packs>
                        <feature-pack>
                            <location>wildfly@maven(org.jboss.universe:community-universe)#32.0.0.Final</location>
                        </feature-pack>
                    </feature-packs>
                    <layers>
                        <layer>jaxrs-server</layer>
                    </layers>
                </configuration>

これでパッケージングすると、指定のファイル名でBootable JARを作成してくれます。

[INFO] Bootable JAR packaging DONE. To run the server: java -jar /path/to/target/artifact-name-0.0.1-SNAPSHOT-bootable.jar

なお、完全に蛇足ですがWildFly JAR Maven Pluginと違ってjboss-maven-distが使えないので、開発時にJARファイルをもっと小さく
することはできなさそうです…。

今回はこんなところで。

おわりに

WildFly Maven PluginでBootable JARを作成できるようになったということで、少し試してみました。

そのうちWildFly Glowも組み合わせて使ってみたいと思いますが、それはまたそのうちということで。

2024-04-28

Ubuntu Linux 22.04 LTSに、MySQL互換の分散データベースTiDBをインストールして（ローカルでクラスターを立ち上げて）みる

TiDB

これは、なにをしたくて書いたもの？

MySQL互換の分散データベースであるTiDBを少し試してみたいなと思いまして。

TiDB: The Advanced Distributed SQL Database

今回は、あまりなにも考えずにUbuntu Linux 22.04 LTSにインストールしてみます。

TiDB

TiDBは、PingCAPが開発しているオープンソースでMySQL互換のデータベースです。

TiDB: The Advanced Distributed SQL Database

GitHub リポジトリーはこちら。

GitHub - pingcap/tidb: TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics. Try AI-powered Chat2Query free at : https://tidbcloud.com/free-trial

TiDBのトップページを見ると、以下を特徴にしているようです。

水平方向のスケーリング
高可用性
- 自動フェイルオーバーとセルフヒーリング
強い一貫性
- 分散データに対するグローバルなトランザクション
ワークロードの混在
MySQL互換
マルチクラウド
オープンソース
堅牢なセキュリティ

提供形態としては、以下の3つがあります。

セルフホスティング
- TiDB: The Advanced Distributed SQL Database
DBaaS（フルマネージド）
- TiDB Dedicated: A More Scalable MySQL Alternative
サーバーレス
- Serverless Database - TiDB Serverless: Auto Scale, Start Free

自分は、基本的にはセルフホスティングで扱います。

ドキュメントはこちら。

TiDB Introduction | PingCAP Docs

環境

今回の環境は、こちら。Ubuntu Linux 22.04 LTSです。

$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 22.04.4 LTS
Release:        22.04
Codename:       jammy


$ uname -srvmpio
Linux 5.15.0-105-generic #115-Ubuntu SMP Mon Apr 15 09:52:04 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux

TiDBをインストールする

まずは対応OSを見てみます。

Software and Hardware Recommendations / OS and platform requirements

基本的にはRed Hat Enterprise Linux互換のOSが推奨みたいですね。

Ubuntu Linuxでも動作することは書かれていますが、エンタープライズレベルの運用品質は保証しないそうです。

その後に続く必要リソースはまったく足りないのですが、まあ気にせずに今回は進めてみます。

こちらを見て進めればよさそうです。

Quick Start Guide for the TiDB Database Platform | PingCAP Docs

まずはTiUpというツールをインストールします。

$ curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

インストールが終わると、こんな表示が出ます。

Successfully set mirror to https://tiup-mirrors.pingcap.com
Detected shell: bash
Shell profile:  /home/xxxxx/.bashrc
/home/vagrant/.bashrc has been modified to add tiup to PATH
open a new terminal or source /home/xxxxx/.bashrc to use it
Installed path: /home/xxxxx/.tiup/bin/tiup
===============================================
Have a try:     tiup playground
===============================================

シェルを新しく立ち上げるか、.bashrcを読み込めばtiupコマンドが使えるようになります。

$ . .bashrc

バージョン確認。

$ tiup --version
1.15.0 v1.15.0-nightly-8
Go Version: go1.21.9
Git Ref: master
GitHash: 2c38be765363cf699104a3f234513460d155add2

ローカルでTiDB、TiKV、PD、TiFlashのインスタンスをひとつずつ起動します。
※これらの構成要素についてはまた後に調べましょう

$ tiup playground

tiup playgroundはローカルでクラスターを立ち上げるコマンドのようです。なので、インストールというよりはQuickStart的に
ローカルでクラスターを起動するというのが今回やっていることですね。

今回は、TiDB 8.0.0のインストールを始めました。

Note: Version constraint  is resolved to v8.0.0. If you'd like to use other versions:

起動すると、こんな表示が出ます。

🎉 TiDB Playground Cluster is started, enjoy!

Connect TiDB:    mysql --comments --host 127.0.0.1 --port 4000 -u root
TiDB Dashboard:  http://127.0.0.1:2379/dashboard
Grafana:         http://127.0.0.1:3000

ダッシュボード、Grafanaもついているようです。

接続もtiupコマンドで行うようです。

$ tiup client

初回はダウンロードが行われます。

プロンプトはこんな感じでした。

my:root@127.0.0.1:4000=>

バージョンを確認してみます。

my:root@127.0.0.1:4000=> select version();
     version()
--------------------
 8.0.11-TiDB-v8.0.0
(1 row)

データベースを作成してみます。

my:root@127.0.0.1:4000=> create database my_database;
CREATE DATABASE


my:root@127.0.0.1:4000=> use my_database;

テーブルを作成してデータの登録、取得の確認。

my:root@127.0.0.1:4000=> create table t1(c1 varchar(20));
CREATE TABLE
my:root@127.0.0.1:4000=> insert into t1(c1) values('Hello World');
INSERT 1
my:root@127.0.0.1:4000=> select * from t1;
     c1
-------------
 Hello World
(1 row)

MySQLのクライアントツールでもアクセスできるみたいなので、インストールしておきましょう。

$ curl -LO https://dev.mysql.com/get/mysql-apt-config_0.8.29-1_all.deb
$ sudo dpkg -i mysql-apt-config_0.8.29-1_all.deb
$ sudo apt update
$ sudo apt install mysql-shell mysql-client

なんとなく、通常のMySQLクライアントとMySQL Shellの両方をインストールしておきました。

接続。rootのパスワードは空です。

$ mysqlsh root:@localhost:4000 --sql

データベースを切り替えて、先ほど登録したテーブルとデータを確認。

 MySQL  localhost:4000 ssl  SQL > use my_database;
Default schema set to `my_database`.
Fetching global names, object names from `my_database` for auto-completion... Press ^C to stop.
 MySQL  localhost:4000 ssl  my_database  SQL > select * from t1;
+-------------+
| c1          |
+-------------+
| Hello World |
+-------------+
1 row in set (0.0029 sec)

OKですね。

ここで、tiup playgroundコマンドをCtrl-cで止めます。

ところで、現時点の安定版は7.5のようなのですが、8.0.0をインストールしていましたね。この差はなんなのでしょうか？
バージョンについては、こちらに記載があります。

TiDB Versioning | PingCAP Docs

こちらのページを見ると、どうやら8.0は開発マイルストーンリリース（DMR）のようです。

では、今度は7.5をインストールしてみることにします。

1度すべてのコンポーネントを削除。

$ tiup uninstall --all
Uninstalled all components successfully!

tiup listで現在のコンポーネントのバージョンを確認。すべてのコンポーネントのバージョンを確認すると遅いので、TiDBに絞って
確認しました。

$ tiup list tidb

7.5系の最新バージョンは7.5.1のようなので、こちらを指定することにします。

$ tiup playground v7.5.1

ちなみに、TiDBの各コンポーネントはデフォルトでローカルにのみバインドするようなので、必要であれば以下のほうに--hostオプションを
指定します。

$ tiup playground v7.5.1 --host 0.0.0.0

--hostオプションだけではなく、--db.hostなど細かく指定できるようなのでそちらはtiup playground --helpで確認しましょう。

ちなみに、今回--host 0.0.0.0付きで実行したらこんな感じになりました。

🎉 TiDB Playground Cluster is started, enjoy!

Connect TiDB:    mysql --comments --host 192.168.121.182 --port 4000 -u root
TiDB Dashboard:  http://192.168.121.182:2379/dashboard
Grafana:         http://0.0.0.0:3000

見た感じ特定のIPアドレスにバインドされているように見えますが、実際にはすべてのネットワークインターフェースに対して
バインドされています。

接続して

$ tiup client

バージョン確認。

my:root@192.168.121.182:4000=> select version();
     version()
--------------------
 8.0.11-TiDB-v7.5.1
(1 row)

7.5.1なのですが、これを見て気づきましたが8.0.11というのはベースのMySQLのバージョンでしょうね。

最後にダッシュボードとGrafanaにログインして終わりにしましょう。

ダッシュボードは、http://[host]:2379/dashboardにアクセスします。デフォルトのユーザー名はroot、パスワードは空です。

Grafanaは、http://[host]:3000にアクセスします。デフォルトのユーザー名とパスワードは、両方ともadminです。
ログインすると、すぐにパスワードの変更を求められますけど。

最初はなにがあるかわかりにくいですが、トップフォルダーにアクセスするとテスト用のクラスターを認識していることがわかります。
展開するとこんな感じです。

作成されているダッシュボード。

ちなみに、コンソールには出力されていませんでしたがhttp://[host]:9090/でPrometheusのダッシュボードにもアクセスできます。

こちらは認証不要です。

今回はこんなところでしょうか。

おわりに

MySQL互換の分散データベースであるTiDBを、Ubuntu Linux 22.04 LTS上でローカルにクラスターを起動してみました。

導入自体はTiUpで簡単にできるのですが、リソース少なめの環境で試していたら全然立ち上がらなくて苦労しました…。
まあ、そういう環境で使うものじゃないですよね…。

手持ちの環境がちょっと貧弱なのであまり使いこなせない気はしますが、少しずつ見ていけたらいいかなと思います。

CLOVER🍀

That was when it all began.

WildFly Maven PluginでBootable JARを作成する

これは、なにをしたくて書いたもの？

WildFly Maven PluginでBootable JARを作成する

環境

アプリケーションを作成する

WildFly Maven PluginでBootable JARを作成する

おわりに

Ubuntu Linux 22.04 LTSに、MySQL互換の分散データベースTiDBをインストールして（ローカルでクラスターを立ち上げて）みる

これは、なにをしたくて書いたもの？

TiDB

環境

TiDBをインストールする

おわりに