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

Dorisをデプロイするための設定

クラスタープランニング

デフォルトのDorisClusterリソースデプロイメントでは、FEとBEイメージが最新バージョンではない可能性があり、FEとBEの両方のデフォルトレプリカ数は3に設定されています。さらに、FEのデフォルトリソース構成は6 CPUと12Giのメモリであり、BEについては8 CPUと16Giのメモリです。このセクションでは、要件に応じてこれらのデフォルト構成を変更する方法について説明します。

イメージ構成

Doris OperatorはDorisバージョンから分離されており、Dorisバージョン2.0以上のデプロイをサポートしています。

FEイメージ構成
FEイメージバージョンを指定するには、以下の構成を使用します:

spec:
feSpec:
image: ${image}

${image}を希望するイメージ名に置き換えてから、対象のDorisCluster resourceで設定を更新してください。公式のFEイメージはFE Imageで利用可能です。

BEイメージの設定
BEイメージのバージョンを指定するには、以下の設定を使用してください:

spec:
beSpec:
image: ${image}

${image}を希望するイメージ名に置き換え、その後DorisCluster resourceで設定を更新してください。公式BEイメージはBE Imageで入手できます。

Replicas設定

FE replicas設定
デフォルトのFEレプリカ数を3から5に変更するには、以下の設定を使用してください:

spec:
feSpec:
replicas: 5

ターゲットのDorisCluster resourceで設定を更新します。

BEレプリカ設定
デフォルトのFEレプリカ数を3から5に変更するには、以下の設定を使用します:

spec:
beSpec:
replicas: 5

デプロイする必要があるDorisCluster resourceの設定を更新します。

コンピューティングリソース設定

FEコンピューティングリソース設定
FEのデフォルトのコンピュートリソース設定は6 CPUと12Giのメモリです。これを8CPUと16Giに変更するには、以下の設定を使用します:

spec:
feSpec:
requests:
cpu: 8
memory: 16Gi
limits:
cpu: 8
memory: 16Gi

ターゲットのDorisCluster resourceで設定を更新します。

BEコンピューティングリソース設定
BEのデフォルトコンピューティングリソース設定は8 CPUと16Giのメモリです。16 CPUと32Giのメモリに変更するには、以下の設定を使用します:

spec:
beSpec:
requests:
cpu: 16
memory: 32Gi
limits:
cpu: 16
memory: 32Gi

ターゲットのDorisCluster resourceで設定を更新してください。

Tip

FEとBEが起動するために必要な最小リソースは4 CPUと8Giのメモリです。通常のパフォーマンステストでは、8 CPUと8Giのメモリを設定することを推奨します。

カスタム起動設定

DorisはKubernetesにおいて、設定ファイルをサービスから分離するためにConfigMapを使用します。デフォルトでは、サービスは起動パラメータ設定として、イメージ内のデフォルト設定を使用します。起動パラメータをカスタマイズするには、FE Configuration DocumentBE Configuration Documentの指示に従って特定のConfigMapを作成してください。その後、カスタマイズしたConfigMapをDorisCluster resourceがデプロイされる予定のnamespaceにデプロイしてください。

カスタムFE起動設定

Step 1: FE ConfigMapを作成してデプロイする

以下の例では、Doris FEで使用するfe-confという名前のConfigMapを定義しています:

apiVersion: v1
kind: ConfigMap
metadata:
name: fe-conf
labels:
app.kubernetes.io/component: fe
data:
fe.conf: |
CUR_DATE=`date +%Y%m%d-%H%M%S`
# Log dir
LOG_DIR = ${DORIS_HOME}/log
# For jdk 8
JAVA_OPTS="-Dfile.encoding=UTF-8 -Djavax.security.auth.useSubjectCredsOnly=false -Xss4m -Xmx8192m -XX:+UnlockExperimentalVMOptions -XX:+UseG1GC -XX:MaxGCPauseMillis=200 -XX:+PrintGCDateStamps -XX:+PrintGCDetails -XX:+PrintClassHistogramAfterFullGC -Xloggc:$LOG_DIR/log/fe.gc.log.$CUR_DATE -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=10 -XX:GCLogFileSize=50M -Dlog4j2.formatMsgNoLookups=true"

# For jdk 17, this JAVA_OPTS will be used as default JVM options
JAVA_OPTS_FOR_JDK_17="-Dfile.encoding=UTF-8 -Djavax.security.auth.useSubjectCredsOnly=false -Xmx8192m -Xms8192m -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=$LOG_DIR -Xlog:gc*,classhisto*=trace:$LOG_DIR/fe.gc.log.$CUR_DATE:time,uptime:filecount=10,filesize=50M --add-opens=java.base/java.nio=ALL-UNNAMED --add-opens java.base/jdk.internal.ref=ALL-UNNAMED --add-opens java.base/sun.nio.ch=ALL-UNNAMED"
# Set your own JAVA_HOME
# JAVA_HOME=/path/to/jdk/
##
## the lowercase properties are read by main program.
##
# store metadata, must be created before start FE.
# Default value is ${DORIS_HOME}/doris-meta
# meta_dir = ${DORIS_HOME}/doris-meta
# Default dirs to put jdbc drivers,default value is ${DORIS_HOME}/jdbc_drivers
# jdbc_drivers_dir = ${DORIS_HOME}/jdbc_drivers

http_port = 8030
rpc_port = 9020
query_port = 9030
edit_log_port = 9010
arrow_flight_sql_port = -1

# Choose one if there are more than one ip except loopback address.
# Note that there should at most one ip match this list.
# If no ip match this rule, will choose one randomly.
# use CIDR format, e.g. 10.10.10.0/24 or IP format, e.g. 10.10.10.1
# Default value is empty.
# priority_networks = 10.10.10.0/24;192.168.0.0/16

# Advanced configurations
# log_roll_size_mb = 1024
# INFO, WARN, ERROR, FATAL
syg_level = INFO
# NORMAL, BRIEF, ASYNC
syg_mode = ASYNC
# audit_log_dir = $LOG_DIR
# audit_log_modules = slow_query, query
# audit_log_roll_num = 10
# meta_delay_toleration_second = 10
# qe_max_connection = 1024
# qe_query_timeout_second = 300
# qe_slow_log_ms = 5000
enable_fqdn_mode = true

ConfigMapを使用してFEスタートアップ設定をマウントする場合、設定に対応するキーはfe.confである必要があります。ConfigMapをファイルに記述し、次のコマンドを使用してDorisClusterリソースがデプロイされている名前空間にデプロイします:

kubectl -n ${namespace} apply -f ${feConfigMapFile}.yaml

ここで、namespaceDorisClusterをデプロイするnamespaceを指し、{namespace} は DorisCluster をデプロイする namespace を指し、{feConfigMapFile} は FE 用の ConfigMap ファイルの名前です。

ステップ 2: DorisCluster リソースの更新

起動設定をマウントするために fe-conf という名前の ConfigMap を使用するには、DorisCluster resource の FE spec に以下の設定を追加してください:

spec:
feSpec:
configMapInfo:
configMapName: fe-conf
resolveKey: fe.conf

デプロイが必要なDorisClusterリソースの設定を更新してください。

Tip

起動設定にenable_fqdn_mode=trueが含まれていることを確認してください。IPモードを使用したい場合で、K8sがpod IPを再起動後も同じ状態に保つ機能を持っている場合は、設定についてissue #138を参照してください。

カスタムBE起動設定

ステップ1: BE ConfigMapの作成とデプロイ

次の例では、Doris BEで使用するbe-confという名前のConfigMapを定義しています:

apiVersion: v1
kind: ConfigMap
metadata:
name: be-conf
labels:
app.kubernetes.io/component: be
data:
be.conf: |
CUR_DATE=`date +%Y%m%d-%H%M%S`
# Log dir
LOG_DIR="${DORIS_HOME}/log/"
# For jdk 8
JAVA_OPTS="-Dfile.encoding=UTF-8 -Xmx2048m -DlogPath=$LOG_DIR/jni.log -Xloggc:$LOG_DIR/be.gc.log.$CUR_DATE -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=10 -XX:GCLogFileSize=50M -Djavax.security.auth.useSubjectCredsOnly=false -Dsun.security.krb5.debug=true -Dsun.java.command=DorisBE -XX:-CriticalJNINatives"
# For jdk 17, this JAVA_OPTS will be used as default JVM options
JAVA_OPTS_FOR_JDK_17="-Dfile.encoding=UTF-8 -Djol.skipHotspotSAAttach=true -Xmx2048m -DlogPath=$LOG_DIR/jni.log -Xlog:gc*:$LOG_DIR/be.gc.log.$CUR_DATE:time,uptime:filecount=10,filesize=50M -Djavax.security.auth.useSubjectCredsOnly=false -Dsun.security.krb5.debug=true -Dsun.java.command=DorisBE -XX:-CriticalJNINatives -XX:+IgnoreUnrecognizedVMOptions --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.nio=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens=java.base/sun.nio.ch=ALL-UNNAMED --add-opens=java.base/sun.nio.cs=ALL-UNNAMED --add-opens=java.base/sun.security.action=ALL-UNNAMED --add-opens=java.base/sun.util.calendar=ALL-UNNAMED --add-opens=java.security.jgss/sun.security.krb5=ALL-UNNAMED --add-opens=java.management/sun.management=ALL-UNNAMED -Darrow.enable_null_check_for_get=false"
# Set your own JAVA_HOME
# JAVA_HOME=/path/to/jdk/
# https://github.com/apache/doris/blob/master/docs/zh-CN/community/developer-guide/debug-tool.md#jemalloc-heap-profile
# https://jemalloc.net/jemalloc.3.html
JEMALLOC_CONF="percpu_arena:percpu,background_thread:true,metadata_thp:auto,muzzy_decay_ms:5000,dirty_decay_ms:5000,oversize_threshold:0,prof:true,prof_active:false,lg_prof_interval:-1"
JEMALLOC_PROF_PRFIX="jemalloc_heap_profile_"
# ports for admin, web, heartbeat service
be_port = 9060
webserver_port = 8040
heartbeat_service_port = 9050
brpc_port = 8060
arrow_flight_sql_port = -1
# HTTPS configures
enable_https = false
# path of certificate in PEM format.
ssl_certificate_path = "$DORIS_HOME/conf/cert.pem"
# path of private key in PEM format.
ssl_private_key_path = "$DORIS_HOME/conf/key.pem"

# Choose one if there are more than one ip except loopback address.
# Note that there should at most one ip match this list.
# If no ip match this rule, will choose one randomly.
# use CIDR format, e.g. 10.10.10.0/24 or IP format, e.g. 10.10.10.1
# Default value is empty.
# priority_networks = 10.10.10.0/24;192.168.0.0/16

# data root path, separate by ';'
# You can specify the storage type for each root path, HDD (cold data) or SSD (hot data)
# eg:
# storage_root_path = /home/disk1/doris;/home/disk2/doris;/home/disk2/doris
# storage_root_path = /home/disk1/doris,medium:SSD;/home/disk2/doris,medium:SSD;/home/disk2/doris,medium:HDD
# /home/disk2/doris,medium:HDD(default)
#
# you also can specify the properties by setting '<property>:<value>', separate by ','
# property 'medium' has a higher priority than the extension of path
#
# Default value is ${DORIS_HOME}/storage, you should create it by hand.
# storage_root_path = ${DORIS_HOME}/storage

# Default dirs to put jdbc drivers,default value is ${DORIS_HOME}/jdbc_drivers
# jdbc_drivers_dir = ${DORIS_HOME}/jdbc_drivers

# Advanced configurations
# INFO, WARNING, ERROR, FATAL
sys_log_level = INFO
# sys_log_roll_mode = SIZE-MB-1024
# sys_log_roll_num = 10
# sys_log_verbose_modules = *
# log_buffer_level = -1

# aws sdk log level
# Off = 0,
# Fatal = 1,
# Error = 2,
# Warn = 3,
# Info = 4,
# Debug = 5,
# Trace = 6
# Default to turn off aws sdk log, because aws sdk errors that need to be cared will be output through Doris logs
aws_log_level=0
## If you are not running in aws cloud, you can disable EC2 metadata
AWS_EC2_METADATA_DISABLED=true

ConfigMapを使用してBEスタートアップ設定をマウントする場合、設定に対応するキーはbe.confである必要があります。ConfigMapをファイルに書き込み、以下のコマンドを使用してDorisClusterリソースがデプロイされているnamespaceにデプロイします:

kubectl -n ${namespace} apply -f ${beConfigMapFile}.yaml

ここで、namespaceDorisClusterリソースをデプロイする必要があるnamespaceを指し、{namespace}はDorisClusterリソースをデプロイする必要があるnamespaceを指し、{beConfigMapFile}はBE用のConfigMapファイルの名前です。

ステップ 2: DorisClusterリソースの更新

起動設定のマウントにbe-confという名前のConfigMapを使用するには、DorisClusterリソースのBE specに以下の設定を追加します:

spec:
feSpec:
configMapInfo:
configMapName: be-conf
resolveKey: be.conf
Tip

コンテナ内のconfig directoryにファイルをマウントしたい場合は、startup configMapを使用してファイルをマウントしてください。config directoryは${DORIS_HOME}/confです。

複数のConfigMapsのマウント

Doris Operatorは、複数のConfigMapsをコンテナ内の異なるディレクトリにマウントすることをサポートしており、柔軟な設定管理を可能にします。

FEへの複数ConfigMapsのマウント
以下の例では、2つのConfigMaps test-fe1test-fe2を、FEコンテナ内のディレクトリ"/etc/fe/config1/"と"/etc/fe/config2"にそれぞれマウントする方法を示しています:

spec:
feSpec:
configMaps:
- configMapName: test-fe1
mountPath: /etc/fe/config1
- configMapName: test-fe2
mountPath: /etc/fe/config2

BEに複数のConfigMapをマウントする
同様に、以下の例では2つのConfigMap test-be1test-be2を、BEコンテナ内のディレクトリ"/etc/be/config1"と"/etc/be/config2"にそれぞれマウントする方法を示しています:

  spec:
beSpec:
configMaps:
- configMapName: test-be1
mountPath: /etc/be/config1
- configMapName: test-be2
mountPath: /etc/be/config2

永続ストレージ

Kubernetesは物理ストレージにデータを永続化するためにPersistent Volumesを提供しています。Kubernetesでは、Doris Operatorがデプロイが必要なDorisCluster Resourceで定義されたテンプレートに基づいて、適切なPersistentVolumesに関連付けられたPersistentVolumeClaimsを自動的に作成します。

FEの永続ストレージ

KubernetesベースのDorisデプロイメントでは、FEに対して以下のパスを永続化することが推奨されます:

  1. メタデータ: /opt/apache-doris/fe/doris-meta(FEメタデータのデフォルトストレージ設定)
  2. ログ: /opt/apache-doris/fe/log(ログの永続化が必要な場合)

FEのメタデータの永続化

デフォルトストレージ設定を使用してFEメタデータを永続化するには、DorisCluster resourceに以下の設定を追加してください:

spec:
feSpec:
persistentVolumes:
- mountPath: /opt/apache-doris/fe/doris-meta
name: meta
persistentVolumeClaimSpec:
# when use specific storageclass, the storageClassName should reConfig, example as annotation.
storageClassName: ${your_storageclass}
accessModes:
- ReadWriteOnce
resources:
# notice: if the storage size less 5G, fe will not start normal.
requests:
storage: ${storageSize}

上記の設定において、yourstorageclassは使用したいStorageClassの名前を表し、{your_storageclass}は使用したいStorageClassの名前を表し、{storageSize}は割り当てたいストレージサイズを表します。形式はquantity expressionで、例えば100Giなどです。

永続的なFEログ

クラスターに集中ログ収集システムがない場合は、DorisCluster resourceに以下の設定を追加して、FEログディレクトリを永続化します:

spec:
feSpec:
persistentVolumes:
- mountPath: /opt/apache-doris/fe/log
name: log
persistentVolumeClaimSpec:
# when use specific storageclass, the storageClassName should reConfig, example as annotation.
storageClassName: ${your_storageclass}
accessModes:
- ReadWriteOnce
resources:
# notice: if the storage size less 5G, fe will not start normal.
requests:
storage: ${storageSize}

上記の設定において、yourstorageclassは使用したいStorageClassの名前を表し、{your_storageclass}は使用したいStorageClassの名前を表し、{storageSize}は割り当てたいストレージサイズを表します。${storageSize}の形式は、K8sのquantity expression方式に従います(例:100Gi)。使用時に必要に応じて置き換えてください。

Tip

カスタマイズされた設定ファイルでmeta_dirやLOG_DIRを再設定した場合は、mountPathを再設定してください。

BEの永続ストレージ

Dorisデプロイメントのノードの場合、以下のパスを永続化することを推奨します:

  1. データストレージ:/opt/apache-doris/be/storage(BEデータのデフォルトストレージ)。
  2. ログ:/opt/apache-doris/be/log(ログの永続化が必要な場合)。

永続データ

  • デフォルトストレージ設定の使用
    デフォルトストレージ設定を使用してデータを永続化するには、DorisClusterリソースを以下の設定で更新します:

    beSpec:
    persistentVolumes:
    - mountPath: /opt/apache-doris/be/storage
    name: be-storage
    persistentVolumeClaimSpec:
    storageClassName: ${your_storageclass}
    accessModes:
    - ReadWriteOnce
    resources:
    requests:
    storage: ${storageSize}

上記の設定において、yourstorageclassは使用したいStorageClassの名前を表し、{your_storageclass}は使用したいStorageClassの名前を表し、{storageSize}は使用したいストレージサイズを表します。${storageSize}の形式は、K8sのquantity expression methodに従います。例:100Gi。使用時には必要に応じて置き換えてください。

  • BEストレージパスのカスタマイズ
    複数のディスクを活用するには、storage_root_pathを使用して複数のストレージディレクトリを設定できます。例えば、storage_root_path=/home/disk1/doris.HDD;/home/disk2/doris.SSDの場合、設定には以下を含める必要があります:

    beSpec:
    persistentVolumes:
    - mountPath: /home/disk1/doris
    name: be-storage1
    persistentVolumeClaimSpec:
    storageClassName: ${your_storageclass}
    accessModes:
    - ReadWriteOnce
    resources:
    requests:
    storage: ${storageSize}
    - mountPath: /home/disk2/doris
    name: be-storage2
    persistentVolumeClaimSpec:
    storageClassName: ${your_storageclass}
    accessModes:
    - ReadWriteOnce
    resources:
    requests:
    storage: ${storageSize}

上記の設定では、yourstorageclassは使用したいStorageClassの名前を表し、{your_storageclass}は使用したいStorageClassの名前を表し、{storageSize}は使用したいストレージサイズを表します。${storageSize}の形式は、K8sのquantity expression methodに従います(例:100Gi)。使用時に必要に応じて置き換えてください。

Persistent BEログ

デフォルト設定を使用してBEログを永続化するには、DorisClusterリソースDorisClusterリソースを以下のように更新してください:

beSpec:
persistentVolumes:
- mountPath: /opt/apache-doris/be/log
name: belog
persistentVolumeClaimSpec:
storageClassName: ${your_storageclass}
accessModes:
- ReadWriteOnce
resources:
requests:
storage: ${storageSize}

上記の設定において、yourstorageclassは使用したいStorageClassの名前を表し、{your_storageclass}は使用したいStorageClassの名前を表し、{storageSize}は使用したいストレージサイズを表します。${storageSize}の形式は、K8sのquantity expression methodに従います(例:100Gi)。使用時に必要に応じて置き換えてください。

アクセス設定

KubernetesはServiceをVIP(Virtual IP)およびロードバランサーとして使用することを提供します。Serviceには3つの外部公開モードがあります:ClusterIP、NodePort、LoadBalancerです。

ClusterIP

DorisはKubernetes上でデフォルトでClusterIPアクセスモードを提供します。ClusterIPアクセスモードは、Kubernetesクラスター内で内部IPアドレスを提供し、この内部IPを通じてサービスを公開します。ClusterIPモードでは、サービスはクラスター内でのみアクセス可能です。

ステップ1:ClusterIPを設定する

DorisはKubernetes上でデフォルトでClusterIPアクセスモードを提供します。変更を行わずにClusterIPアクセスモードを使用できます。

ステップ2:Serviceを取得する

クラスターをデプロイした後、以下のコマンドを使用してDoris Operatorによって公開されたサービスを確認できます:

kubectl -n doris get svc

返される結果は以下の通りです:

NAME                              TYPE        CLUSTER-IP    EXTERNAL-IP   PORT(S)                               AGE
doriscluster-sample-be-internal ClusterIP None <none> 9050/TCP 9m
doriscluster-sample-be-service ClusterIP 10.1.68.128 <none> 9060/TCP,8040/TCP,9050/TCP,8060/TCP 9m
doriscluster-sample-fe-internal ClusterIP None <none> 9030/TCP 14m
doriscluster-sample-fe-service ClusterIP 10.1.118.16 <none> 8030/TCP,9020/TCP,9030/TCP,9010/TCP 14m

上記の結果では、FEとBEに対して2種類のサービスがあり、それぞれ「internal」と「service」というサフィックスが付いています:

  • 「internal」サフィックスが付いたサービスは、ハートビート、データ交換、その他の操作など、Doris内での内部通信にのみ使用でき、外部使用は想定されていません。
  • 「service」サフィックスが付いたサービスは、ユーザーが使用できます。

ステップ3: コンテナ内からdorisにアクセスする

以下のコマンドを使用して、現在のKubernetesクラスター内にmysqlクライアントを含むポッドを作成できます:

kubectl run mysql-client --image=mysql:5.7 -it --rm --restart=Never --namespace=doris -- /bin/bash

クラスター内のコンテナから、外部に公開されている「service」サフィックス付きのサービス名を使用してDorisクラスターにアクセスできます。

mysql -uroot -P9030 -hdoriscluster-sample-fe-service

NodePort

Kubernetesクラスターの外部からDorisにアクセスするには、NodePortサービスタイプを使用できます。NodePortのポート割り当てには、動的割り当てと静的割り当ての2つの方法があります。

  • 動的割り当て: ポートが明示的に設定されていない場合、Kubernetesはpodが作成される際にデフォルトの範囲(30000-32767)から未使用のポートを自動的に割り当てます。
  • 静的割り当て: ポートが明示的に指定された場合、Kubernetesはそのポートが利用可能であればそのポートを割り当て、固定されることを保証します。

Dorisは外部アクセス用に以下のポートを公開しています:

Port Namedefault valuePort Description
Query Port9030MySQLプロトコル経由でDorisクラスターにアクセスするために使用
HTTP Port8030FE上のhttpサーバーポート、FE情報を表示するために使用
Web Server Port8040BE上のhttpサーバーポート、BE情報を表示するために使用

ステップ1: NodePortを設定する

FE NodePort

  • 動的割り当て:

    spec:
    feSpec:
    service:
    type: NodePort
  • 静的割り当て:

    spec:
    feSpec:
    service:
    type: NodePort
    servicePorts:
    - nodePort: 31001
    targetPort: 8030
    - nodePort: 31002
    targetPort: 9030

BE NodePort

  • 動的割り当て:

    spec:
    beSpec:
    service:
    type: NodePort
  • 静的割り当て:

      beSpec:
    service:
    type: NodePort
    servicePorts:
    - nodePort: 31006
    targetPort: 8040

Step 2: サービスの取得

クラスターをデプロイした後、以下のコマンドを使用してDoris Operatorによって公開されているサービスを確認できます:

kubectl get service

返される結果は以下の通りです:

NAME                              TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)                                                       AGE
kubernetes ClusterIP 10.152.183.1 <none> 443/TCP 169d
doriscluster-sample-fe-internal ClusterIP None <none> 9030/TCP 2d
doriscluster-sample-fe-service NodePort 10.152.183.58 <none> 8030:31041/TCP,9020:30783/TCP,9030:31545/TCP,9010:31610/TCP 2d
doriscluster-sample-be-internal ClusterIP None <none> 9050/TCP 2d
doriscluster-sample-be-service NodePort 10.152.183.244 <none> 9060:30940/TCP,8040:32713/TCP,9050:30621/TCP,8060:30926/TCP 2d

ステップ3: NodePortを使用してサービスにアクセスする

NodePort経由でDorisにアクセスするには、NodeのIPとマッピングされたポートを知る必要があります。以下のコマンドでノードのIPを取得できます:

  kubectl get nodes -owide

出力例::

NAME   STATUS   ROLES           AGE   VERSION   INTERNAL-IP     EXTERNAL-IP   OS-IMAGE          KERNEL-VERSION          CONTAINER-RUNTIME
r60 Ready control-plane 14d v1.28.2 192.168.88.60 <none> CentOS Stream 8 4.18.0-294.el8.x86_64 containerd://1.6.22
r61 Ready <none> 14d v1.28.2 192.168.88.61 <none> CentOS Stream 8 4.18.0-294.el8.x86_64 containerd://1.6.22
r62 Ready <none> 14d v1.28.2 192.168.88.62 <none> CentOS Stream 8 4.18.0-294.el8.x86_64 containerd://1.6.22
r63 Ready <none> 14d v1.28.2 192.168.88.63 <none> CentOS Stream 8 4.18.0-294.el8.x86_64 containerd://1.6.22

その後、任意のノードのIPアドレス(例:192.168.88.61、192.168.88.62、または192.168.88.63)をマップされたポートと組み合わせて使用し、Dorisにアクセスできます。例えば、ノード192.168.88.62とポート31545を使用する場合:

  mysql -h 192.168.88.62 -P 31545 -uroot

LoadBalancer

LoadBalancer serviceタイプは、通常クラウドサービスプロバイダーによって提供される追加のロードバランサーを提供します。このモードは、クラウドプラットフォームによって管理されるKubernetesクラスター上でDorisクラスターをデプロイする場合にのみ利用可能です。

ステップ1: LoadBalancerモードを設定する

FE LoadBalancer

spec:
feSpec:
service:
type: LoadBalancer

BE LoadBalancer

spec:
beSpec:
service:
type: LoadBalancer

ステップ 2: サービスの取得

クラスターをデプロイした後、以下のコマンドを使用して Doris Operator によって公開されているサービスを表示できます:

kubectl get service

返される結果は以下の通りです:

NAME                              TYPE           CLUSTER-IP       EXTERNAL-IP                                                                     PORT(S)                                                       AGE
kubernetes ClusterIP 10.152.183.1 <none> 443/TCP 169d
doriscluster-sample-fe-internal ClusterIP None <none> 9030/TCP 2d
doriscluster-sample-fe-service LoadBalancer 10.152.183.58 ac4828493dgrftb884g67wg4tb68gyut-1137856348.us-east-1.elb.amazonaws.com 8030:31041/TCP,9020:30783/TCP,9030:31545/TCP,9010:31610/TCP 2d
doriscluster-sample-be-internal ClusterIP None <none> 9050/TCP 2d
doriscluster-sample-be-service LoadBalancer 10.152.183.244 ac4828493dgrftb884g67wg4tb68gyut-1137823345.us-east-1.elb.amazonaws.com 9060:30940/TCP,8040:32713/TCP,9050:30621/TCP,8060:30926/TCP 2d

ステップ3:LoadBalancerを使用してサービスにアクセス

LoadBalancerを通じてDorisにアクセスするには、外部IP(EXTERNAL-IPフィールドで提供される)と対応するポートを使用します。例えば、mysqlコマンドを使用する場合:

mysql -h ac4828493dgrftb884g67wg4tb68gyut-1137856348.us-east-1.elb.amazonaws.com -P 31545 -uroot

管理クラスター用のユーザー名とパスワードの設定

Dorisノードの管理には、管理操作用のユーザー名とパスワードを使用してMySQLプロトコル経由でライブのFEノードに接続する必要があります。DorisはRBACに類似した権限管理メカニズムを実装しており、ユーザーはノード管理を実行するためにNode_priv権限を持つ必要があります。デフォルトでは、Doris Operatorはrootユーザーでパスワードなしモードでクラスターをデプロイします。

ユーザー名とパスワードの設定プロセスは、3つのシナリオに分けることができます:

  • クラスターデプロイ中のrootユーザーパスワードの初期化
  • rootパスワードなしデプロイメントで管理権限を持つ非rootユーザーの自動設定
  • rootパスワードなしモードでクラスターをデプロイした後のrootユーザーパスワードの設定

アクセスを保護するために、rootユーザーにパスワードを追加した後、DorisClusterリソース内でNode_Priv権限を持つユーザー名とパスワードを設定する必要があります。クラスターノード管理用のユーザー名とパスワードを設定する方法は2つあります:

  • 環境変数を使用
  • Kubernetes Secretを使用

クラスターデプロイ中のrootユーザーパスワード設定

rootユーザーのパスワードを安全に設定するために、Dorisは2段階SHA-1暗号化プロセスを使用してfe.conf内でパスワードを暗号化することをサポートしています。パスワードの設定方法は以下の通りです。

ステップ1:root暗号化パスワードの生成

2段階SHA-1暗号化を使用してrootパスワードを暗号化するには、以下の方法を使用してください:

  • Java Code:

    import org.apache.commons.codec.digest.DigestUtils;

    public static void main( String[] args ) {
    //the original password
    String a = "123456";
    String b = DigestUtils.sha1Hex(DigestUtils.sha1(a.getBytes())).toUpperCase();
    //output the 2 stage encrypted password.
    System.out.println("*"+b);
    }
  • Golangコード:

    import (
    "crypto/sha1"
    "encoding/hex"
    "fmt"
    "strings"
    )

    func main() {
    //original password
    plan := "123456"
    //the first stage encryption.
    h := sha1.New()
    h.Write([]byte(plan))
    eb := h.Sum(nil)

    //the two stage encryption.
    h.Reset()
    h.Write(eb)
    teb := h.Sum(nil)
    dst := hex.EncodeToString(teb)
    tes := strings.ToUpper(fmt.Sprintf("%s", dst))
    //output the 2 stage encrypted password.
    fmt.Println("*"+tes)
    }

設定ファイルの形式要件に従って、暗号化されたパスワードをfe.confに設定します。その後、ConfigMapを使用してKubernetesクラスターに設定を配布します。詳細はCluster Parameter Configuration Sectionを参照してください。

Step 2: DorisClusterリソースの設定

fe.confでrootパスワードを設定した後、Dorisは起動時に自動的にパスワードを最初のFEノードに適用します。他のノードがクラスターに参加するには、DorisClusterリソースでユーザー名とパスワードを指定し、Doris Operatorが自動的にノード管理を実行できるようにします。

  • 環境変数の使用

    DorisClusterリソースの".spec.adminUser.name"および".spec.adminUser.password"フィールドにユーザー名rootとパスワードを設定します。Doris Operatorは以下の設定を自動的に環境変数に変換してコンテナで使用できるようにします。コンテナ内の補助サービスは、環境変数で設定されたユーザー名とパスワードを使用して、指定されたクラスターに自身を追加します。設定形式は以下の通りです:

    spec:
    adminUser:
    name: root
    password: ${password}

ここで、${password} は root の暗号化されていないパスワードです。

  • secret の使用

    ユーザー名とパスワードを安全に管理するために、Kubernetes Basic Authentication Secret を使用できます。Secret を設定して root のユーザー名とパスワードを保存し、DorisCluster リソースでそれを参照します。 a. 必要な Secret の設定

    以下の形式に従って、必要な Basic authentication Secret を設定します:

    stringData:
    username: root
    password: ${password}

ここで、${password} は root に設定された暗号化されていないパスワードです。

b. デプロイするDorisClusterリソースを設定する

以下の形式で必要なSecretを指定するようにDorisClusterを設定します:

spec:
authSecret: ${secretName}

ここで、${secretName} は root ユーザー名とパスワードを含む Secret の名前です。

デプロイメント時の非 root 管理ユーザーとパスワードの自動作成(推奨)

セキュリティを強化するために、root ユーザーを使用するのではなく、最初のデプロイメント時に管理用の非 root ユーザーを作成することが推奨されます。この方法では、非 root ユーザーのユーザー名とパスワードが環境変数または Secret を通じて設定されます。Doris コンテナの補助サービスは、データベース内にユーザーを自動的に作成し、パスワードを設定し、必要な Node_priv 権限を付与します。デプロイメント後、Doris Operator は新しく作成された非 root ユーザー名とパスワードを使用してクラスターノードを管理します。

  • 環境変数の使用:

    非 root ユーザーを設定するには、DorisCluster リソースで環境変数を使用してユーザー名とパスワードを設定できます:

    spec:
    adminUser:
    name: ${DB_ADMIN_USER}
    password: ${DB_ADMIN_PASSWD}

ここで、DBADMINUSERは新しく作成されたユーザー名で、{DB_ADMIN_USER}は新しく作成されたユーザー名で、{DB_ADMIN_PASSWD}は新しく作成されたユーザー名に設定されたパスワードです。

  • Secretを使用する場合: ユーザー名とパスワードを安全に管理するために、基本認証用のKubernetes Secretを使用できます。 a. 必要なsecretを設定する

    stringData:
    username: ${DB_ADMIN_USER}
    password: ${DB_ADMIN_PASSWD}

ここで、DBADMINUSERは新しく作成されたユーザー名で、{DB_ADMIN_USER}は新しく作成されたユーザー名で、{DB_ADMIN_PASSWD}は新しく作成されたユーザー名に設定されたパスワードです。 次を実行してSecretをKubernetesクラスターにデプロイします:

kubectl -n ${namespace} apply -f ${secretFileName}.yaml

ここで、namespaceDorisClusterリソースをデプロイする必要があるnamespaceであり、{namespace}はDorisClusterリソースをデプロイする必要があるnamespaceであり、{secretFileName}はデプロイするSecretのファイル名です。

b. DorisClusterリソースを設定する

以下の形式に従ってDorisClusterリソースを更新してください:

spec:
authSecret: ${secretName}

ここで、${secretName}は、デプロイされたBasic認証Secretの名前です。

Tip

デプロイ後、rootパスワードを設定してください。Doris Operatorは、自動的に新しく作成されたユーザー名とパスワードを使用してノードを管理するように切り替わります。自動作成されたユーザーの削除は避けてください。

クラスターデプロイ後のrootユーザーパスワード設定

Dorisクラスターをデプロイし、rootユーザーのパスワードを設定した後、Doris Operatorがクラスターノードを自動管理できるよう、必要なNode_priv権限を持つ管理ユーザーを作成することが重要です。この目的でrootユーザーを使用することは推奨されません。代わりに、ユーザー作成と権限割り当てセクションを参照して、新しいユーザーを作成しNode_priv権限を付与してください。

ステップ1:Node_priv権限を持つユーザーを作成する

まず、MySQLプロトコルを使用してDorisデータベースに接続し、必要な権限を持つ新しいユーザーを作成します:

CREATE USER '${DB_ADMIN_USER}' IDENTIFIED BY '${DB_ADMIN_PASSWD}';
  • ${DB_ADMIN_USER}: 作成するユーザーの名前。
  • ${DB_ADMIN_PASSWD}: 新しく作成されるユーザーのパスワード。

ステップ2: 新しいユーザーにNode_priv権限を付与する

新しく作成されたユーザーにNode_priv権限を付与します:

GRANT NODE_PRIV ON *.*.* TO ${DB_ADMIN_USER};

${DB_ADMIN_USER}: 前の手順で作成したユーザー名です。
ユーザーの作成、パスワードの設定、権限の付与の詳細については、CREATE-USER セクションを参照してください。

ステップ 3: DorisCluster を設定する

  • 環境変数を使用する

    DorisCluster リソースで新しいユーザーの名前とパスワードを直接設定します:

    spec:
    adminUser:
    name: ${DB_ADMIN_USER}
    password: ${DB_ADMIN_PASSWD}

ここで、DBADMINUSERは新しく作成されたユーザー名で、{DB_ADMIN_USER}は新しく作成されたユーザー名で、{DB_ADIC_PASSWD}は新しく作成されたユーザーに設定されたパスワードです。

  • Secretの使用 ユーザー名とパスワードを安全に管理するために、Kubernetes Secretsを使用できます。 a. 必要なsecretを作成する 新しいユーザー用のBasic Authentication Secretを作成します:

    stringData:
    username: ${DB_ADMIN_USER}
    password: ${DB_ADMIN_PASSWD}

ここで、DBADMINUSERは新しく作成されたユーザー名で、{DB_ADMIN_USER}は新しく作成されたユーザー名で、{DB_ADMIN_PASSWD}は新しく作成されたユーザー名に設定されたパスワードです。
次のコマンドでSecretをKubernetesクラスターにデプロイします:

kubectl -n ${namespace} apply -f ${secretFileName}.yaml

ここで、namespaceDorisClusterリソースをデプロイする必要があるnamespaceであり、{namespace}はDorisClusterリソースをデプロイする必要があるnamespaceであり、{secretFileName}はデプロイするSecretのファイル名です。

b. DorisClusterリソースの更新
Secretがデプロイされたら、DorisClusterリソースを更新してSecretを指定します:

spec:
authSecret: ${secretName}

ここで、${secretName}は、デプロイされたBasic認証Secretの名前です。

Tip

rootパスワードの設定とデプロイ後のノード管理用の新しいユーザー名およびパスワードの設定後、既存のサービスは一度ローリング方式で再起動されます。

設定変更時の自動サービス再起動

Dorisは設定ファイルを通じて起動パラメータを指定します。ほとんどのパラメータはWebインターフェースから変更でき、即座に有効になりますが、サービス再起動が必要な特定のパラメータは、バージョン25.1.0で導入されたDoris Operatorの再起動機能により自動的に処理できるようになりました。
DorisClusterリソースでこの機能を有効にするには、以下を設定してください:

spec:
enableRestartWhenConfigChange: true

この設定が存在する場合、Doris Operatorは以下を実行します:

  1. クラスター起動設定の変更を監視します(ConfigMapを介してマウントされます。起動設定のカスタマイズを参照)。
  2. 設定が変更された際に、影響を受けるサービスを自動的に再起動します。

使用例

FEとBEのconfigmap監視と再起動をサポートします。FEの使用例を示します。

  1. DorisClusterデプロイメント仕様のサンプル:

    spec:
    enableRestartWhenConfigChange: true
    feSpec:
    image: apache/doris:fe-2.1.8
    replicas: 1
    configMapInfo:
    configMapName: fe-configmap
  2. FEサービス設定を更新します。 fe-configmap ConfigMap内のfe.confキー下の値を変更する場合(FEサービス設定を含む)、Doris Operatorは変更を適用するためにFEサービスのローリング再起動を自動的に実行します。

Kerberos認証の使用

Doris Operatorは、バージョン25.2.0以降、Kubernetes上でDoris(バージョン2.1.9、3.0.4以降)のKerberos認証をサポートしています。DorisでKerberos認証を有効にするには、krb5.confファイルkeytabファイルの両方が必要です。 Doris Operatorは、ConfigMapリソースを使用してkrb5.confファイルをマウントし、Secretリソースを使用してkeytabファイルをマウントします。Kerberos認証を有効にするワークフローは以下の通りです:

  1. krb5.confファイルを含むConfigMapを作成します:

    kubectl create -n ${namespace} configmap ${name} --from-file=krb5.conf

namespaceDorisClusterがデプロイされているネームスペースに、{namespace}をDorisClusterがデプロイされているネームスペースに、{name}をConfigMapの希望する名前に置き換えてください。 2. keytabファイルを含むSecretを作成します:

```shell
kubectl create -n ${namespace} secret generic ${name} --from-file=${xxx.keytab}
```

namespaceDorisClusterがデプロイされているnamespaceに、{namespace}をDorisClusterがデプロイされているnamespaceに、{name}をSecretの希望する名前に置き換えてください。複数のkeytabファイルをマウントする必要がある場合は、kubectl create Secret documentationを参照して、それらを単一のSecretに含めてください。 3. krb5.confを含むConfigMapとkeytabファイルを含むSecretを指定するようにDorisClusterリソースを設定します:

```yaml
spec:
kerberosInfo:
krb5ConfigMap: ${krb5ConfigMapName}
keytabSecretName: ${keytabSecretName}
keytabPath: ${keytabPath}
```

krb5ConfigMapName:krb5.confファイルを含むConfigMapの名前。{krb5ConfigMapName}: krb5.confファイルを含むConfigMapの名前。{keytabSecretName}: keytabファイルを含むSecretの名前。${keytabPath}: Secretがkeytabファイルをマウントするコンテナ内のディレクトリパス。このパスは、カタログ作成時にhadoop.kerberos.keytabで指定されるディレクトリと一致する必要があります。カタログ設定の詳細については、Hive Catalog configurationのドキュメントを参照してください。

共有ストレージの設定

バージョン25.4.0以降、Doris OperatorはReadWriteManyアクセスモードの共有ストレージを複数のコンポーネント全体のすべてのポッドにマウントすることをサポートしています。この機能を使用する前に、共有ストレージのPersistentVolumeとPersistentVolumeClaimリソースが作成されていることを確認してください。Dorisクラスタをデプロイする前に、以下に示すようにDorisClusterリソースを設定してください:

spec:
sharedPersistentVolumeClaims:
- mountPath: ${mountPath}
persistentVolumeClaimName: ${sharedPVCName}
supportComponents:
- fe
- be
  • ${mountPath} はストレージがマウントされるコンテナ内の絶対パスを指定します。
  • ${sharedPVCName} はマウントする PersistentVolumeClaim の名前を参照します。
  • supportComponents は共有ストレージが必要なコンポーネントの名前をリストアップします。上記の例では、FEとBEの両方のコンポーネントが共有ストレージをマウントします。supportComponents配列が空のままの場合、デプロイされたすべてのコンポーネントがデフォルトで共有ストレージをマウントします。
Tip

mountPath パラメータは ${DORIS_HOME} をプレフィックスとして使用できます。${DORIS_HOME} が使用される場合、FEコンテナ内では /opt/apache-doris/fe に、BEコンテナ内では /opt/apache-doris/be に解決されます。

Probe Timeoutの設定

DorisClusterは各サービスに対して2種類のprobe timeout設定を提供します:startup probe timeoutliveness probe timeout。サービスが指定されたstartup timeout期間内に開始できない場合、失敗したとみなされ、再起動されます。 サービスが指定されたliveness timeoutより長く応答しなくなった場合、対応するPodは自動的に再起動されます。

Startup Probe Timeout

  • FE Service Startup Timeout設定

    spec:
    feSpec:
    startTimeout: 3600

上記の設定では、FEサービスの起動タイムアウトを3600秒に設定します。

  • BEサービス起動タイムアウト設定

    spec:
    beSpec:
    startTimeout: 3600

Liveness Probe Timeout

  • FE Service Liveness Timeout設定

    spec:
    feSpec:
    liveTimeout: 60

上記の設定では、FE serviceのliveness timeoutを60秒に設定します。

  • BE Service Liveness Timeout設定

    spec:
    beSpec:
    liveTimeout: 60

上記の設定は、BEサービスのliveness timeoutを60秒に設定します。