メインコンテンツまでスキップ

コンパイルとデプロイメント

1. 概要

本ドキュメントでは、ストレージ・コンピュート分離モデルにおけるDorisのコンパイルとデプロイメントプロセスについて詳述し、統合型ストレージ・コンピュートモデルとの違い、特に新たに追加されたMeta Service (MS) モジュールのコンパイル、設定、管理について説明します。

2. バイナリの取得

2.1 直接ダウンロード

コンパイル済みバイナリ(全てのDorisモジュールを含む)はDoris Download Pageから取得できます(バージョン3.0.2以上を選択)。

2.2 コンパイル出力(オプション)

コードベースで提供されるbuild.shスクリプトを使用してコンパイルします。新しいMSモジュールは--cloudパラメータでコンパイルされます。

sh build.sh --fe --be --cloud 

コンパイル後、outputディレクトリに新しいmsディレクトリが追加されます:

output
├── be
├── fe
└── ms
├── bin
├── conf
└── lib

3. Meta Service デプロイメント

3.1 設定

./conf/doris_cloud.conf ファイルでは、主に以下の2つのパラメータを変更する必要があります:

  1. brpc_listen_port: Meta Service のリスニングポート、デフォルトは 5000 です。
  2. fdb_cluster: FoundationDB クラスタの接続情報で、FoundationDB をデプロイする際に取得できます。(Doris が提供する fdb_ctl.sh を使用してデプロイする場合、この値は $FDB_HOME/conf/fdb.cluster ファイルで確認できます。)

設定例:

brpc_listen_port = 5000
fdb_cluster = xxx:yyy@127.0.0.1:4500

注意: fdb_clusterの値は、FoundationDBデプロイメントマシン上の/etc/foundationdb/fdb.clusterファイルの内容と一致する必要があります。(Dorisが提供するfdb_ctl.shをデプロイメントに使用している場合、この値は$FDB_HOME/conf/fdb.clusterファイルで確認できます。)

例: ファイルの最後の行が、doris_cloud.confのfdb_clusterフィールドに入力する値です

cat /etc/foundationdb/fdb.cluster

# DO NOT EDIT!
# This file is auto-generated, it is not to be edited by hand.
cloud_ssb:A83c8Y1S3ZbqHLL4P4HHNTTw0A83CuHj@127.0.0.1:4500

3.2 開始と停止

環境要件

JAVA_HOME環境変数がOpenJDK 17を正しく指すように設定されていることを確認し、msディレクトリに移動してください。

開始コマンド

export JAVA_HOME=${path_to_jdk_17}
bin/start.sh --daemon
LIBHDFS3_CONF=
starts doris_cloud with args: --meta-service
wait and check doris_cloud start successfully
successfully started brpc listening on port=5000 time_elapsed_ms=11
doris_cloud start successfully

スタートアップスクリプトは、スタートアップが成功したことを示すために0の値を返します。そうでなければ、スタートアップは失敗します。

備考

3.0.4では、スタートアップスクリプトはより多くの情報を出力します:

2024-12-26 15:31:53 start with args: --meta-service
wait and check MetaService and Recycler start successfully
process working directory: "/mnt/disk1/doris/ms"
pid=1666015 written to file=./bin/doris_cloud.pid
version:{doris-3.0.4-release} code_version:{commit=fd44740fadabebfedb5da201d7ce427a5dd47c44 time=2025-01-16 18:53:00 +0800} build_info: ...

MetaService has been started successfully
successfully started service listening on port=5000 time_elapsed_ms=19

停止コマンド

bin/stop.sh

本番環境では、Meta Serviceの総数が最低3つになるようにしてください。

4. データリサイクル機能の独立デプロイ(オプション)

備考

Meta Service自体にはメタデータ管理とリサイクル機能があり、これらは独立してデプロイできます。独立してデプロイしたい場合は、このセクションを参照してください。

準備作業

  1. 新しい作業ディレクトリを作成します(例:recycler)。

  2. msディレクトリの内容を新しいディレクトリにコピーします:

    cp -r ms recycler

設定

新しいディレクトリの設定ファイルでBRPCリスニングポートbrpc_listen_portfdb_clusterの値を変更します。

データリサイクル機能の開始

export JAVA_HOME=${path_to_jdk_17}
bin/start.sh --recycler --daemon

Start Only Metadata Operation Function

export JAVA_HOME=${path_to_jdk_17}
bin/start.sh --meta-service --daemon

5. FEとBEの起動プロセス

このセクションでは、分離されたストレージ・コンピュート アーキテクチャにおいてFE(Frontend)とBE(Backend)を起動する手順について詳しく説明します。

5.1 起動順序

  1. MASTERロールを持つ最初のFEインスタンスを起動する。
  2. 他のFEとBEインスタンスをクラスタに追加する。
  3. 最初のStorage Vaultを追加する。

5.2 MASTERロールのFEを起動する

5.2.1 fe.confを設定する

fe.confファイルでは、以下のキーパラメータを設定する必要があります:

  1. deploy_mode

    • 説明:Dorisの起動モードを指定します。
    • 形式:cloudは分離されたストレージ・コンピュート モードを示し、その他は統合されたストレージ・コンピュート モードを示します。
    • 例:cloud
  2. cluster_id

    • 説明:分離されたストレージ・コンピュート アーキテクチャにおけるクラスタの一意識別子。各クラスタは競合を避けるために異なるcluster_idを持つ必要があります。

    • 形式:整数(int型)。

    • 例:ランダムなcluster_idは以下のshellコマンドを使用して生成できます。

      echo $(($((RANDOM << 15)) | $RANDOM))
注意
 **各クラスターは競合を避けるため、異なるcluster_idを持つ必要があります**
:::

3. meta_service_endpoint

  • 説明: Meta Serviceのアドレスとポート。
  • 形式: IPアドレス:ポート番号
  • 例: 127.0.0.1:5000、複数のmeta serviceをカンマ区切りで設定できます。

5.2.2 FEの開始

開始コマンドの例:

bin/start_fe.sh --daemon

最初のFEプロセスはクラスターを初期化し、FOLLOWERロールで動作します。MySQLクライアントを使用してFEに接続し、show frontendsを使用して最近開始されたFEがマスターであることを確認してください。

5.3 その他のFEノードの追加

その他のノードも設定ファイルを変更し、上記の手順に従って開始する必要があります。MySQLクライアントを使用してMASTERロールを持つFEに接続し、以下のSQLコマンドを使用して追加のFEノードを追加してください:

ALTER SYSTEM ADD FOLLOWER "host:port";

host:portをFEノードの実際のアドレスとeditlogポートに置き換えてください。詳細については、ADD FOLLOWERおよびADD OBSERVERを参照してください。

本番環境では、最初のFEを含むFOLLOWERロールのFrontend(FE)ノードの総数が奇数になるようにしてください。一般的に、3つのFOLLOWERで十分です。OBSERVERロールのFrontendノードは任意の数にできます。

5.4 BEノードの追加

クラスターにBackendノードを追加するには、各Backendに対して以下の手順を実行してください:

5.4.1 be.confの設定

be.confファイルで、以下のキーパラメータを設定する必要があります:

  1. deploy_mode

    • 説明:Dorisの起動モードを指定します。
    • 形式:cloudは分離ストレージ・コンピュートモードを示します。その他は統合ストレージ・コンピュートモードを示します。
    • 例:cloud
  2. file_cache_path

    • 説明:ファイルキャッシュに使用するディスクパスとその他のパラメータで、配列として表現され、各ディスクに対して1つのエントリがあります。pathはディスクパスを指定し、total_sizeはキャッシュのサイズを制限します。-1または0はディスク領域全体を使用します。
    • 形式:[{"path":"/path/to/file_cache","total_size":21474836480},{"path":"/path/to/file_cache2","total_size":21474836480}]
    • 例:[{"path":"/path/to/file_cache","total_size":21474836480},{"path":"/path/to/file_cache2","total_size":21474836480}]
    • デフォルト:[{"path":"${DORIS_HOME}/file_cache"}]

5.4.1 BEの開始と追加

  1. Backendを開始:

    以下のコマンドを使用してBackendを開始します:

    bin/start_be.sh --daemon
  2. Backendをクラスターに追加する:

    MySQLクライアントを使用して任意のFrontendに接続し、以下を実行する:

    ALTER SYSTEM ADD BACKEND "<ip>:<heartbeat_service_port>" [PROPERTIES properties];

<ip> を新しい Backend の IP アドレスに、<heartbeat_service_port> を設定されたハートビートサービスポート(デフォルトは 9050)に置き換えてください。

PROPERTIES を使用して BE のコンピューティンググループを設定できます。

より詳細な使用方法については、ADD BACKEND および REMOVE BACKEND を参照してください。

  1. Backend ステータスの確認:

    Backend ログファイル(be.log)をチェックして、正常に開始され、クラスターに参加したことを確認してください。

    次の SQL コマンドを使用して Backend ステータスを確認することもできます:

    SHOW BACKENDS;

これにより、クラスター内のすべてのBackendsとその現在のステータスが表示されます。

6. Storage Vaultの作成

Storage VaultはDorisの分離されたストレージとコンピューティングアーキテクチャにおける重要なコンポーネントです。これらはデータを格納するための共有ストレージレイヤーを表します。HDFSまたはS3互換オブジェクトストレージを使用して1つまたは複数のStorage Vaultを作成できます。1つのStorage VaultをデフォルトのStorage Vaultとして設定でき、システムテーブルおよび指定されたStorage Vaultを持たないテーブルは、このデフォルトのStorage Vaultに格納されます。デフォルトのStorage Vaultは削除できません。DorisクラスターにStorage Vaultを作成する方法は以下の通りです:

6.1 HDFS Storage Vaultの作成

SQLを使用してStorage Vaultを作成するには、MySQLクライアントを使用してDorisクラスターに接続します。

CREATE STORAGE VAULT IF NOT EXISTS hdfs_vault
PROPERTIES (
"type"="hdfs",
"fs.defaultFS"="hdfs://127.0.0.1:8020"
);

6.2 S3 Storage Vault の作成

S3互換オブジェクトストレージを使用してStorage Vaultを作成するには、以下の手順に従ってください:

  1. MySQLクライアントを使用してDorisクラスターに接続します。

  2. 以下のSQLコマンドを実行してS3 Storage Vaultを作成します:

CREATE STORAGE VAULT IF NOT EXISTS s3_vault
PROPERTIES (
"type"="S3",
"s3.endpoint"="s3.us-east-1.amazonaws.com",
"s3.access_key" = "ak",
"s3.secret_key" = "sk",
"s3.region" = "us-east-1",
"s3.root.path" = "ssb_sf1_p2_s3",
"s3.bucket" = "doris-build-1308700295",
"provider" = "S3"
);

他のオブジェクトストレージ上にStorage Vaultを作成するには、Create Storage Vaultを参照してください。

6.3 デフォルトStorage Vaultの設定

以下のSQL文を使用してデフォルトのStorage Vaultを設定します。

SET <storage_vault_name> AS DEFAULT STORAGE VAULT

7. 注意事項

  • メタデータ操作用のMeta Serviceプロセスのみを、FEとBEのmeta_service_endpointターゲットとして設定する必要があります。
  • データリサイクル機能プロセスはmeta_service_endpointターゲットとして設定しないでください。