YugabyteDBを使ってみよう（NewSQL/分散SQLデータベースよろず勉強会 #1 発表資料）

© 2022 NTT DATA Corporation
NewSQL/分散SQLデータベースよろず勉強会 #1
YugabyteDBを使ってみよう
2022/11/22
NTTデータ笠原辰仁

© 2022 NTT DATA Corporation 2
00
はじめに

自己紹介
• 笠原辰仁 (@kasa_zip)
• 長年PostgreSQLの検証や周辺ツールの開発、サポートなどに従事
• 最近はNewSQLや分散データベースに属するOSSプロダクトの調査や検証、
適用領域の見極めなど
• 本日は、まだあまり馴染みのない分散データベースのOSSプロダクトであるYugabyteDBの概
観や利用方法を紹介
• 手軽さや使い方のイメージを持ってもらい、最初の一手の助けになりたい
• 本資料は公開しますので、細かい部分はそちらで確認いただけます
• 本日と同様の内容を(やや丁寧な形で)11/26(土)のOSC 福岡でもお話します！

本日のアジェンダ
1.YugabyteDBの概要とアーキテクチャ
2.YugabyteDBの導入と操作
3.YSQLによるDBへの処理
4.YugabyteDBの管理
【注意】
本日紹介するYugabyteDBでは、機能追加や変更が活発に行われているため、本日の講演内容と最新版のプロダクトとの
齟齬が出やすいことが想定されます。参考として公式のオンラインマニュアルのリンクも添えていますので、試行の際に躓く場合は
マニュアルを参考してください。
本資料の説明には2022年11月上旬での最新版であるYugabyteDBのバージョン2.15(2.15.2)を利用しています。

01
YugabyteDBの概要とアーキテクチャ

YugabyteDBの概要
Yugabyte社が中心に開発しているOSSプロダクト。PostgreSQL/Cassandraとの互換性があり、
高い可用性とスケーラビリティを持つ分散データベース。
YugabyteDB
開発主体 Yugabyte 社 ( https://www.yugabyte.com/ )
開発体制 Github上での開発。JIRAも併用。 ( https://github.com/yugabyte/yugabyte-db )
開発言語 DB本体は主に C/C++ (PostgreSQLのコードを流用している部分はC)
ユーティリティやCLIはPython
製品形態 YugabyteDB Core ：YugabyteDB本体
YugabyteDB Anyware ：YugabyteDBのセルフマネージド用のユーティリティ群
YugabyteDB Managed ： YugabyteDBのマネージドサービス
ライセンス Apache License 2.0とPolyform Free Trial License 1.0.0の2つのライセンス形態がある。
Polyformライセンスは主にYugabyteDB Anywareに関するコード部分となる。(ソースツリーの managed
ディレクトリ以下の部分。バイナリには-managedのサフィックスを含む)
( https://docs.yugabyte.com/preview/legal/#licenses )

YugabyteDBのアーキテクチャ
ユーザデータの配置先・ユーザ・権限などのメタデータを管理する「YB-Master」と、
ユーザデータを保持するとともに、ユーザリクエストを処理する「YB-Tserver」の2つのコンポーネントから構成される。
複数のYB-MasterとYB-Tserverで構成されるクラスタをYugabyteDBクラスタ(Universe)と呼ぶ。
YugabyteDBクラスタ (Universe)
YugabyteDBノード#1
YB-Master
YB-Tserver
YB-Master
YB-Tserver
YB-Master
YB-Tserver
YB-Masterはクラスタ全体の
メタデータ管理を担当
YB-Tserverはクエリ処理や
ユーザデータの保管を担当

YB-Masterサーバ
YB-Masterサーバ(以降Masterと呼称)はDDLの実行やデータ配置などの管理を行う。
Masterは複数ノードで構成され、１台のLeaderと複数のFollowerから成る。
メタデータはDocDB(RocksDBの改良版となるKVS)に格納され、Raftを用いてLeaderの選出や冗長化を実施。
Leader役のノードダウン時にはFollowerがLeaderに昇格し処理を継続する。
YB-Master
(Follower)
YB-Tserver
YB-Master
(Leader)
YB-Tserver
YB-Master
(Follower)
YB-Tserver
DocDB DocDB DocDB
クラスタのメタデータの変更を
伴う処理(テーブル作成や
データ配置の変更など)は
Leaderで実施され、
その結果がFollowerに
伝搬される。

YB-Tserverサーバ
YB-Tserverサーバ(以降Tserverと呼称)はユーザからのYSQL(PostgreSQL互換のIF)と
YCQL(Cassandra互換のIF)を受け付け処理を行う。また、Masterのメタデータを元に
ユーザーデータの読み書きを実施。データはTablet(後述)という単位で分割され複数のTserverに
均等に分散される。これによりTserverのノード増減に伴うスケーラビリティを実現している。
YB-Master
YB-Tserver
YB-Master
YB-Master
YSQL YCQL
DocDB
YB-Tserver
YSQL YCQL
DocDB
YB-Tserver
YSQL YCQL
DocDB
クエリ処理やそれに伴うデータ
の読み書きを行う。
ユーザはすべてのTserverへ
処理を行うことができる。

Tablet
ユーザデータ(テーブルとインデックス)はTabletと呼ばれる単位で分割され、
各TserverのDocDBへ分散配置(シャーディング)される。Tabletは１台のLeaderと
複数(replication factorで変動)のFollowerから成る。
基本的にユーザからの読み書きリクエストはLeaderのTabletに対して実行される。
Masterと同じく、ユーザデータもRaftによりLeader選出と冗長化が行われている。
Tablet1 Tablet1 Tablet1
Tablet2
Tablet2 Tablet2
Tablet3
Tablet3 Tablet3
YB-Tserver YB-Tserver YB-Tserver ユーザからは一つのテーブル
に見えるが内部的に複数の
Tabletに分割される。
分割はHash or Rangeが
選択可能。
分割数や配置は基本的に
自動で決定・実施。

Tabletの分割について
Tabletの分割は自動で行われるほか、テーブル作成時に予め分割しておくことも可能。
分割はHashかRangeとなるが、主キーやインデックスの定義方法で決まることになる。
Range SplitのテーブルにHash Splitのインデックス定義なども可能。
-- 主キーをASC/DESC付きでソートしたものを定義した場合はRange Splitとなる
yugabyte=# CREATE TABLE r_t1 (c1 int, c2 text, primary key (c1 ASC));
CREATE TABLE
-- 主キーのデフォルト(ASCなどを付与しない)定義ではHash Splitとなる
yugabyte=# CREATE TABLE h_t1 (c1 int, c2 text, primary key (c1));
CREATE TABLE
-- インデックスも同様のルール。なおRange Splitの場合は作成時にSplitの境界値を指定できる
yugabyte=# CREATE INDEX r_t1_idx ON r_t1 (c2 ASC) SPLIT AT VALUES((1000),(2000));
CREATE INDEX
-- Hash Splitの場合は作成時に分割数を指定できる
yugabyte=# CREATE INDEX h_t1_idx ON h_t1 (c2) SPLIT INTO 4 TABLETS;
CREATE INDEX

02
YugabyteDBの導入と操作

YugabyteDBの動作環境とインストール
YugabyteDBは以下の環境で利用可能。
詳しくは https://docs.yugabyte.com/preview/quick-start/
OSのバージョンバイナリ Docker 備考
CentOS 7以降 ○ ○ RockyLinux8でもとりあえ動作
Ubuntu 16.04以降 ○ ○
Mac 10.12以降 ○ ○
Windows -- - ○
必要なハードスペック
• https://docs.yugabyte.com/preview/deploy/checklist/
• CPUは最低2core, 推奨は16core以上
• メモリは最低2GB, 推奨は32GB以上
• CPUとメモリはあるだけ良い・・
• ストレージはSSD等の高速なもの推奨
• YugabyteDBではJBODのような複数ディスク構成も扱いやすい (RAIDやLLVMでまとめなくても良い)
• サイズ要求は明示的にないが、触ってみる程度ならば最低限1GB程度あれば動く (できれば20GBくらいあると良い)

YugabyteDBの動作環境とインストール
インストールに際しては、以下のソフトウェアを事前に導入しておく。
• Python3
• 後にも出てくるYugbyteDBのCLIやユーティリティの多くがPythonを利用しているため
• wget もしくは curl
• これはバイナリのダウンロードのため
その他のポイント
• 複数ノードでクラスタを構成する場合は、NTP/Chronyでノード間の時刻同期をしておく
• デフォルトの設定では250 msec以上の時刻差があるとWARNING、6秒以上でFATALのエラーとなる
• システム設定でいくつかの設定を引き上げておくと良い
• 簡易動作確認程度ならば問題ないが、比較的多めのファイルやスレッドを扱うためnofile (ulimit –n)、
nproc (ulimit –u)は公式ドキュメントの推奨程度にしておく
• https://docs.yugabyte.com/preview/deploy/manual-deployment/system-config/

YugabyteDBのインストール
YugabyteDBのインストール方法にはいくつかあるが、
ここでは公式に公開しているバイナリを入手する方法を紹介。
最新版の資材は https://docs.yugabyte.com/preview/quick-start/linux/#download-yugabytedb を参照。
以下はyugabyteユーザを追加し、python3を入手後、alternativesコマンドでpythonコマンドがpython3を向くように設定
した後、実際のインストールへ移るコマンド例。
(yugabyteユーザの作成は任意で、別のユーザ名でも可。python3もインストール済みならスキップ可)
# useradd yugabyte
# yum install -y python3
# alternatives --set python /usr/bin/python3
# yum install -y wget
# su - yugabyte
$ wget https://downloads.yugabyte.com/releases/2.15.2.1/yugabyte-2.15.2.1-b1-linux-x86_64.tar.gz
$ tar zxvf yugabyte-2.15.2.1-b1-linux-x86_64.tar.gz
$ cd yugabyte-2.15.1.0
$ ./bin/post_install.sh
以上で終わり。資材の格納先は任意なのでダウンロード/解凍後に好きなディレクトへ移しても問題ない。
なお yugabyte-xxx.tar.gzは約300MB、展開後は約1.1GB程度のサイズとなる。

YugabyteDBのインストール
前述のコマンドにより $HOME/yugabyte-2.15.2.1 に必要資材が格納される。
操作に必要な実行ファイルは
$HOME/yugabyte-2.15.2.1/bin
と
$HOME/yugabyte-2.15.2.1/postgres/bin
にあるため、PATH に上記を通しておくと良い。
$ cat .bashrc
YUGA_INSTALL=/home/yugabyte/yugabyte-2.15.2.1
export PATH=$PATH:$YUGA_INSTALL/bin:$YUGA_INSTALL/postgres/bin

YugabyteDBの起動と停止
YugabyteDBの起動は基本的にMasterサーバ(YB-Master)の起動を行い、それからTabletサーバ(YB-Tserver)を起動する
手順となる。起動と停止(初期化含む)には以下のコマンドを利用可能。
説明備考/注意
yb-master YB-Masterの起動用コマンド。
yb-tserver YB-Tserverの起動用コマンド。
yugabyted yb-masterとyb-tserverをラップし、簡易的にクラ
スタの設定や起動/停止を行うコマンド。動作確
認や開発、試験時の利用を想定。
商用利用は非推奨。複数ノードでのクラスタ
構成などをサポート。
yb-ctl yb-masterとyb-tserverをラップし、簡易的にクラ
スタの設定や起動/停止を行うコマンド。動作確
認や開発、試験時の利用を想定。
商用利用は非推奨。シングルノードのみでの
クラスタ構成などをサポート。yb-ctlコマンドで
生成したデータディレクトリはyb-ctlでのみ再
利用可。
クラスタ構成を組んでの起動などはやや煩雑なコマンドとなるため、利便用のコマンドとしてyugabytedとyb-ctlが用意されている。
従来はyb-ctlが主に用いられてきたようだが、最近はyugabytedの機能拡充が目立つ。
簡易的な動作確認であれば、構築されるクラスタの機能としては変わらないためどちらを選んでも良い。
本資料ではyugabytedコマンドを利用した実例で解説を進める。

YugabyteDBの起動
yugabytedコマンドを利用する場合、以下のように「yugabyted start」とするだけで起動できる。
$ yugabyted start
Starting yugabyted...
? System checks
? YugabyteDB Started
? WARNING: Cluster started in an insecure mode without authentication and encryption enabled. For non-
production use only, not to be used without firewalls blocking the internet traffic.
+----------------------------------------------------------------------------------------------------------+
| yugabyted |
+----------------------------------------------------------------------------------------------------------+
| Status : Running. |
| Replication Factor : 1 |
| Web console : http://127.0.0.1:7000 |
| JDBC : jdbc:postgresql://127.0.0.1:5433/yugabyte?user=yugabyte&password=yugabyte |
| YSQL : bin/ysqlsh -U yugabyte -d yugabyte |
| YCQL : bin/ycqlsh -u cassandra |
| Data Dir : /home/yugabyte/var/data |
| Log Dir : /home/yugabyte/var/logs |
| Universe UUID : e8bffde5-b7e1-4837-83b8-15c0d6008d0b |
+----------------------------------------------------------------------------------------------------------+
? YugabyteDB started successfully! To load a sample dataset, try 'yugabyted demo'.
? Join us on Slack at https://www.yugabyte.com/slack
? Claim your free t-shirt at https://www.yugabyte.com/community-rewards/

YugabyteDBの起動
YugabyteDBを起動すると以下のプロセスが立ち上がる。
yugabyte 6411 0.0 0.0 470544 17560 ? Sl 10:27 0:00 python /home/yugabyte/yugabyte-2.15.2.1/bin/yugabyted start
yugabyte 6423 1.7 0.3 649900 127504 ? Sl 10:27 0:04 /home/yugabyte/yugabyte-2.15.2.1/bin/yb-master (略
yugabyte 6504 0.3 0.1 1055384 57748 ? Sl 10:27 0:00 /home/yugabyte/yugabyte-2.15.2.1/bin/yb-tserver (略
yugabyte 6672 0.0 0.2 291664 64508 ? S 10:27 0:00 /home/yugabyte/yugabyte-2.15.2.1/postgres/bin/postgres (略
yugabyte 6696 0.0 0.0 133392 17548 ? Ss 10:27 0:00 postgres: logger
yugabyte 6698 0.0 0.0 308056 26272 ? Ssl 10:27 0:00 postgres: YSQL webserver
yugabyte 6700 0.0 0.0 291664 18452 ? Ss 10:27 0:00 postgres: checkpointer
yugabyte 6701 0.0 0.0 135512 17508 ? Ss 10:27 0:00 postgres: stats collector
yugabytedとyb-master、yb-tserverの他、PostgreSQL(とPostgreSQLのバックグラウンドプロセス)が稼働する。
PostgreSQLはTserverが内部的に起動/停止するためユーザが直接管理する必要はない。

YugabyteDBのデータディレクトリ
YugabyteDBを起動する際、指定されたデータディレクトリ(yb-master、yb-tserverコマンドの--fs_data_dirsオプションで指
定)が空もしくは存在しない場合、自動でディレクトリが作成され各種の初期データが作成される。
yugabytedコマンドを利用する場合、デフォルトでは実施ユーザのHOMEディレクトリ配下に「var」ディレクトリが生成され、その
配下に各種データが格納される。以下はyugabytedコマンドで生成されるデータディレクトリ。
var/
|-- conf < -- yugabytedコマンドの起動オプション(デフォルト含む)として使用されたパラメータの設定ファイル
|-- data
| |-- pg_data < -- Tserverで稼働するPostgreSQLのデータファイル
| `-- yb-data < -- Master、およびTserverのデータファイル
`-- logs
|-- master < -- Masterのログディレクトリへのリンク
`-- tserver < -- Tserverのログディレクトリへのリンク
ログディレクトリ配下にはいくつかログが生成される。直下にあるmaster.errやtserver.errは各サービスの起動ログ。
yugabyted.logはyugabytedが発行しているコマンドログ。起動が上手くいかない場合はこれらを見ると良い。

YugabyteDBのMasterとTserverそれぞれで扱う実データは基本的にDocDBに格納される。DocDBはTabletの単位でイン
スタンスが作成されるため、Tabletの数だけDocDB用のディレクトリが存在する。
また、内部的にノード間はProtocol Bufferを利用してデータのやり取り(read/write, replication, consensusなど)がされ
るため、そのデータのメタデータもデータディレクトリに格納される。
var/data/yb-data/
|-- master
| |-- consensus-meta < -- Tablet毎のRaftコンセンサスのメタデータ
| |-- data < -- Tablet毎のDocDB(RocksDB)の実データ
| |-- logs < -- ログファイル
| |-- tablet-meta < -- Tablet毎のメタデータ
| `-- wals < -- Tablet毎のWAL(Write Ahead Log)
`-- tserver < -- 以下はTservertのデータだが区分けはMasterと同様
|-- consensus-meta
|-- data
|-- logs
|-- tablet-meta
`-- wals

「var/data/yb-data/tserver/data/」配下には、YugabyteDBのTserverのユーザデータ(ユーザが作成したテーブルなど)
が格納される。以下のように「rocksdb」ディレクトリの下に「table-<UUID>」ディレクトリがテーブルとインデックス(主キーは除く)
の数だけ作成され、その下に「tablet-<UUID>」のディレクトリが作成される。
var/data/yb-data/tserver/data/
`-- rocksdb
|-- table-000033e8000030008000000000004008 < -- Table(3つのTabletを持つ)のディレクトリ
| |-- tablet-39ae7e99082e4e2483d9909131a67155 < -- Tabletのデータ
| |-- tablet-39ae7e99082e4e2483d9909131a67155.intents < -- 同名Tabletのロックなどのデータ
| |-- tablet-39ae7e99082e4e2483d9909131a67155.snapshots < -- 同名Tabletのスナップショットデータ
| |-- tablet-3c47e9b44d25408f9765231ba6fedbc7
| |-- tablet-3c47e9b44d25408f9765231ba6fedbc7.intents
| |-- tablet-3c47e9b44d25408f9765231ba6fedbc7.snapshots
| |-- tablet-ce93f09488d94b109f09f05e434470ff
| |-- tablet-ce93f09488d94b109f09f05e434470ff.intents
| `-- tablet-ce93f09488d94b109f09f05e434470ff.snapshots
|-- table-000033e8000030008000000000004003
(略)

yugabytedが利用するポート
YugabyteDBは処理の受付や後述するメトリクス情報のエンドポイント用に以下のポートを利用する。
ユーザはこれらにアクセスして処理をリクエストしたり情報を参照したりできる。
(なお他にYEDIS用のポートもあるが、YEDISは廃止予定のため省いている)
ポート番号用途備考
5433 TserverでのYSQLのリクエスト
9042 TserverでのYCQLのリクエスト
7000 MasterのWeb UIとメトリクス用 Web UIはブラウザでアクセスする。
メトリクスはPrometheusで収集するためのもの
だが、jsonフォーマット出力を行うエンドポイント
も備えている。
9000 TserverのWeb UIとメトリクス用
13000 TserverでのYSQLのメトリクス用
12000 TserverでのYCQLのメトリクス用
7100 MasterのRPC処理用ユーザは直接利用しない。
9100 TserverのRPC処理用
https://docs.yugabyte.com/preview/reference/configuration/default-ports/

YugabyteDBの停止
yugabytedコマンドを利用する場合、以下のように「yugabyted stop」とするだけで起動できる。
$ yugabyted stop
Stopped yugabyted using config /home/yugabyte/var/conf/yugabyted.conf.
もし、同じデータディレクトリで再度起動したい場合は「yugabyted start」とすれば良い。
なお、使い捨てのデータディレクトリである場合(停止後にデータなどを破棄しても良い)、
「yugabyted destroy」とすることで停止と共にデータディレクトリの破棄も行う。ただし「var/conf」のみ残る。
$ yugabyted destroy
Stopped yugabyted using config /home/yugabyte/var/conf/yugabyted.conf.
Deleted logs at /home/yugabyte/var/logs.
Deleted data at /home/yugabyte/var/data.
Deleted conf file at /home/yugabyte/var/conf/yugabyted.conf..

yugabytedによる起動時のオプションについて
yugabytedコマンドはいくつかのオプションを取ることができる。
以下は多用するため抑えておくと良い。特に複数のYugabyteDBを起動してクラスタを組む場合には必須となる。
オプション用途
--listen 起動するMasterとTserverのListenアドレスの指定。複数のMasterとTserverでクラスタを組む場合は
明示しておくと良い。
--base_dir 起動するMasterとTserverのデータディレクトリの指定。
--join 複数のMasterとTserverでクラスタ構成を組む際のジョインする既存Masterのアドレス
--master_flags Master用のパラメータ指定。カンマ区切りでname=valueを複数指定可能。
--tserver_flags Tserver用のパラメータ指定。カンマ区切りでname=valueを複数指定可能。
-- 以下は1台のローカルマシン上で3つのMasterとTserverを起動しクラスタを組む例
$ yugabyted start --base_dir=/home/yugabyte/ydata/node1 --listen=127.0.0.1
$ yugabyted start --base_dir=/home/yugabyte/ydata/node2 --listen=127.0.0.2 --join=127.0.0.1
$ yugabyted start --base_dir=/home/yugabyte/ydata/node3 --listen=127.0.0.3 --join=127.0.0.1

yugabytedコマンドのその他ポイント
• yugabytedで3つ以上のMaster/Tserverを起動し—joinオプションでクラスタを構成すると、
自動的にreplication factorを3に設定し、冗長構成としてくれる
• ただしMasterは4つ以上の構成にしない(Tserverは4台上の追加がされる)
• Masterを4つ以上とするクラスタを構成する場合は手動でyb-masterを起動しクラスタに参加させる必要がある
• Tserverを4つ以上に増やしていってもreplication factorは3から変更されない
• replication factorを変更する場合は別途tserver_flagsオプションで変更する必要がある
• master_flagsやtserver_flagsオプションの指定は非常に長くなりやすく、かつクォート/ダブルクォートの指定が(正しい文法で
あっても)一部のケースでエラーで弾かれることがある。
• 以下のようにconfファイルを作成し、--tserver_flags=flagfile=/path/to/conf_fileという方法を取ると良い。
$ cat /tmp/tserver_flg.conf
--yb_enable_read_committed_isolation=true
--ysql_beta_features=true
--ysql_pg_conf_csv=password_encryption=scram-sha-256
--ysql_hba_conf_csv=host all kasa 127.0.0.1/32 scram-sha-256,host all all 0.0.0.0/0 trust,host all all ::0/0 trust
$ yugabyted start --tserver_flags=flagfile=/tmp/tserver_flg.conf

YugabyteDBを使ってみよう（NewSQL/分散SQLデータベースよろず勉強会 #1 発表資料）

More Related Content

What's hot (20)

Similar to YugabyteDBを使ってみよう（NewSQL/分散SQLデータベースよろず勉強会 #1 発表資料） (20)

More from NTT DATA Technology & Innovation (20)

YugabyteDBを使ってみよう（NewSQL/分散SQLデータベースよろず勉強会 #1 発表資料）