重要

このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

配置ルール

注記：
このドキュメントでは、Placement Driver (PD) で配置ルールを手動で指定する方法を紹介します。現在はSQL の配置ルール使用が推奨されています。これにより、テーブルとパーティションの配置をより便利に構成できます。

v5.0 で導入された配置ルールは、PD がさまざまなタイプのデータに対応するスケジュールを生成するようにガイドするレプリカルールシステムです。さまざまなスケジューリングルールを組み合わせることで、レプリカの数、storage場所、ホストの種類、 Raft選出に参加するかどうか、 Raftリーダーとして機能するかどうかなど、任意の連続データ範囲の属性を細かく制御できます。

配置ルール機能は、TiDB の v5.0 以降のバージョンではデフォルトで有効になっています。無効にするには、配置ルールを無効にするを参照してください。

ルールシステム

ルールシステム全体の構成は、複数のルールで構成されます。各ルールでは、レプリカの数、 Raftの役割、配置場所、このルールが適用されるキー範囲などの属性を指定できます。PD がスケジュールを実行するときは、まず、リージョンのキー範囲に従ってルールシステム内のリージョンに対応するルールを見つけ、次に、リージョンのレプリカの配布がルールに準拠するように対応するスケジュールを生成します。

複数のルールのキー範囲には重複部分がある場合があり、これはリージョンが複数のルールに一致する可能性があることを意味します。この場合、PD はルールの属性に従って、ルールが互いに上書きされるか、同時に有効になるかを決定します。複数のルールが同時に有効になる場合、PD はルールの一致のためにルールの積み重ね順序に従って順番にスケジュールを生成します。

さらに、異なるソースからのルールを互いに分離するという要件を満たすために、これらのルールをより柔軟な方法で編成できます。そのため、「グループ」の概念が導入されました。通常、ユーザーは異なるソースに応じてルールを異なるグループに配置できます。

Placement rules overview

ルールフィールド

次の表は、ルール内の各フィールドの意味を示しています。

フィールド名	タイプと制限	説明
`GroupID`	`string`	ルールのソースを示すグループ ID。
`ID`	`string`	グループ内のルールの一意の ID。
`Index`	`int`	グループ内のルールの積み重ね順序。
`Override`	`true` / `false`	より小さいインデックスを持つルールを（グループ内で）上書きするかどうか。
`StartKey`	`string` 、16進数形式	範囲の開始キーに適用されます。
`EndKey`	`string` 、16進数形式	範囲の終了キーに適用されます。
`Role`	`string`	投票者/リーダー/フォロワー/学習者などのレプリカロール。
`Count`	`int` 、正の整数	レプリカの数。
`LabelConstraint`	`[]Constraint`	ラベルに基づいてノードをフィルタリングします。
`LocationLabels`	`[]string`	物理的な分離に使用されます。
`IsolationLevel`	`string`	最小物理的分離レベルを設定するために使用

LabelConstraint 、 in 、 notIn 、 exists 、 notExists 4 つのプリミティブに基づいてラベルをフィルタリングする Kubernetes の機能に似ています。これら 4 つのプリミティブの意味は次のとおりです。

in : 指定されたキーのラベル値が指定されたリストに含まれます。
notIn : 指定されたキーのラベル値は指定されたリストに含まれていません。
exists : 指定されたラベルキーが含まれます。
notExists : 指定されたラベルキーは含まれません。

LocationLabelsの意味と機能は、v4.0 より前のバージョンと同じです。たとえば、 [zone,rack,host]デプロイして 3 層トポロジを定義した場合、クラスターには複数のゾーン (アベイラビリティーゾーン) があり、各ゾーンには複数のラックがあり、各ラックには複数のホストがあります。スケジュールを実行すると、PD は最初にリージョンのピアを異なるゾーンに配置しようとします。この試行が失敗した場合 (レプリカが 3 つあるがゾーンが合計で 2 つしかない場合など)、PD はこれらのレプリカを異なるラックに配置することを保証します。ラックの数が分離を保証するのに十分でない場合、PD はホストレベルの分離を試みます。

IsolationLevelの意味と機能については、クラスタトポロジ構成で詳しく説明します。たとえば、 LocationLabelsで 3 層トポロジを定義する[zone,rack,host]をデプロイし、 IsolationLevelをzoneに設定した場合、PD は、スケジュール時に各リージョンのすべてのピアが異なるゾーンに配置されるように保証します。 IsolationLevelの最小分離レベル制限を満たすことができない場合 (たとえば、3 つのレプリカが構成されているが、合計で 2 つのデータゾーンしかない場合)、PD はこの制限を満たすために補おうとしません。デフォルト値IsolationLevelは空の文字列で、無効であることを意味します。

ルールグループのフィールド

次の表は、ルールグループ内の各フィールドの説明を示しています。

フィールド名	タイプと制限	説明
`ID`	`string`	ルールのソースを示すグループ ID。
`Index`	`int`	異なるグループの積み重ね順序。
`Override`	`true` / `false`	より小さいインデックスを持つグループをオーバーライドするかどうか。

ルールを設定する

このセクションの操作はpd-ctlに基づいており、操作に関連するコマンドは HTTP API 経由の呼び出しもサポートしています。

配置ルールを有効にする

配置ルール機能は、TiDB の v5.0 以降のバージョンではデフォルトで有効になっています。無効にするには、配置ルールを無効にするを参照してください。無効にした後でこの機能を有効にするには、クラスターを初期化する前に PD 構成ファイルを次のように変更します。

[replication]
enable-placement-rules = true

このように、PD はクラスターが正常にブートストラップされた後にこの機能を有効にし、 max-replicas 、 location-labels 、およびisolation-level構成に従って対応するルールを生成します。

{
  "group_id": "pd",
  "id": "default",
  "start_key": "",
  "end_key": "",
  "role": "voter",
  "count": 3,
  "location_labels": ["zone", "rack", "host"],
  "isolation_level": ""
}

ブートストラップされたクラスターの場合、pd-ctl を使用して配置ルールを動的に有効にすることもできます。

pd-ctl config placement-rules enable

PD は、 max-replicas 、 location-labels 、およびisolation-level構成に基づいてデフォルトのルールも生成します。

注記：
配置ルールが有効になっていて、複数のルールが存在する場合、以前に構成されたmax-replicas 、 location-labels 、およびisolation-level有効になりません。レプリカポリシーを調整するには、配置ルールに関連するインターフェイスを使用します。
配置ルールが有効になっていて、デフォルトルールが 1 つだけ存在する場合、 max-replicas 、またはisolation-level location-labelsが変更されると、TiDB はこのデフォルトルールを自動的に更新します。

配置ルールを無効にする

pd-ctl を使用して配置ルール機能を無効にし、以前のスケジュール戦略に切り替えることができます。

pd-ctl config placement-rules disable

注記：
配置ルールを無効にすると、PD は元のmax-replicas 、 location-labels 、およびisolation-level構成を使用します。ルールを変更しても (配置ルールが有効になっている場合)、これら 3 つの構成はリアルタイムで更新されません。また、設定されているすべてのルールは PD に残り、次に配置ルールを有効にしたときに使用されます。

pd-ctlを使用してルールを設定する

注記：
ルールの変更は、PD のスケジュールにリアルタイムで影響します。ルールの設定が不適切だと、レプリカの数が少なくなり、システムの高可用性に影響する可能性があります。

pd-ctl は、システム内のルールを表示するために次のメソッドの使用をサポートしており、出力は JSON 形式のルールまたはルールリストです。

すべてのルールのリストを表示するには:
```
pd-ctl config placement-rules show
```
PD グループ内のすべてのルールのリストを表示するには:
```
pd-ctl config placement-rules show --group=pd
```
グループ内の特定の ID のルールを表示するには:
```
pd-ctl config placement-rules show --group=pd --id=default
```
リージョンに一致するルールリストを表示するには:
```
pd-ctl config placement-rules show --region=2
```
上記の例では、 2リージョンID です。

ルールの追加と編集は似ています。対応するルールをファイルに書き込み、 saveコマンドを使用してルールを PD に保存する必要があります。

cat > rules.json <<EOF
[
    {
        "group_id": "pd",
        "id": "rule1",
        "role": "voter",
        "count": 3,
        "location_labels": ["zone", "rack", "host"]
    },
    {
        "group_id": "pd",
        "id": "rule2",
        "role": "voter",
        "count": 2,
        "location_labels": ["zone", "rack", "host"]
    }
]
EOF
pd-ctl config placement save --in=rules.json

上記の操作により、 rule1とrule2 PD に書き込まれます。同じGroupID + IDを持つルールがシステム内にすでに存在する場合、このルールは上書きされます。

ルールを削除するには、ルールのcount 0に設定するだけで、同じGroupID + IDを持つルールが削除されます。次のコマンドは、 pd / rule2ルールを削除します。

cat > rules.json <<EOF
[
    {
        "group_id": "pd",
        "id": "rule2"
    }
]
EOF
pd-ctl config placement save --in=rules.json

pd-ctlを使用してルールグループを構成する

すべてのルールグループのリストを表示するには:
```
pd-ctl config placement-rules rule-group show
```
特定の ID のルールグループを表示するには:
```
pd-ctl config placement-rules rule-group show pd
```
ルールグループのindexとoverrideの属性を設定するには:
```
pd-ctl config placement-rules rule-group set pd 100 true
```
ルールグループの構成を削除するには (グループ内にルールがある場合は、デフォルトのグループ構成を使用します)。
```
pd-ctl config placement-rules rule-group delete pd
```

pd-ctl を使用してグループとグループ内のルールを一括更新する

ルールグループとグループ内のすべてのルールを同時に表示および変更するには、サブコマンドrule-bundleを実行します。

このサブコマンドでは、 get {group_id}使用してグループを照会し、出力結果にはルールグループとグループのルールがネストされた形式で表示されます。

pd-ctl config placement-rules rule-bundle get pd

上記のコマンドの出力:

{
  "group_id": "pd",
  "group_index": 0,
  "group_override": false,
  "rules": [
    {
      "group_id": "pd",
      "id": "default",
      "start_key": "",
      "end_key": "",
      "role": "voter",
      "count": 3
    }
  ]
}

出力をファイルに書き込むには、 rule-bundle getサブコマンドに--out引数を追加します。これは、後続の変更や保存に便利です。

pd-ctl config placement-rules rule-bundle get pd --out="group.json"

変更が完了したら、 rule-bundle setサブコマンドを使用して、ファイル内の設定を PDサーバーに保存できます。 pd-ctlを使用してルールを設定するで説明したsaveコマンドとは異なり、このコマンドはサーバー側でこのグループのすべてのルールを置き換えます。

pd-ctl config placement-rules rule-bundle set pd --in="group.json"

pd-ctlを使用してすべての設定を表示および変更します

pd-ctl を使用してすべての設定を表示および変更することもできます。そのためには、すべての設定をファイルに保存し、設定ファイルを編集してから、そのファイルを PDサーバーに保存して以前の設定を上書きします。この操作でもrule-bundleサブコマンドが使用されます。

たとえば、すべての設定をrules.jsonファイルに保存するには、次のコマンドを実行します。

pd-ctl config placement-rules rule-bundle load --out="rules.json"

ファイルを編集した後、次のコマンドを実行して設定を PDサーバーに保存します。

pd-ctl config placement-rules rule-bundle save --in="rules.json"

メタデータまたは特定のテーブルに特別な構成が必要な場合は、 keyrangeコマンド in tidb-ctlを実行して関連キーをクエリできます。コマンドの最後に--encode追加することを忘れないでください。

tidb-ctl keyrange --database test --table ttt --encode

global ranges:
  meta: (6d00000000000000f8, 6e00000000000000f8)
  table: (7400000000000000f8, 7500000000000000f8)
table ttt ranges: (NOTE: key range might be changed after DDL)
  table: (7480000000000000ff2d00000000000000f8, 7480000000000000ff2e00000000000000f8)
  table indexes: (7480000000000000ff2d5f690000000000fa, 7480000000000000ff2d5f720000000000fa)
    index c2: (7480000000000000ff2d5f698000000000ff0000010000000000fa, 7480000000000000ff2d5f698000000000ff0000020000000000fa)
    index c3: (7480000000000000ff2d5f698000000000ff0000020000000000fa, 7480000000000000ff2d5f698000000000ff0000030000000000fa)
    index c4: (7480000000000000ff2d5f698000000000ff0000030000000000fa, 7480000000000000ff2d5f698000000000ff0000040000000000fa)
  table rows: (7480000000000000ff2d5f720000000000fa, 7480000000000000ff2e00000000000000f8)

注記：
DDL やその他の操作によってテーブル ID が変更される可能性があるため、対応するルールも同時に更新する必要があります。

一般的な使用シナリオ

このセクションでは、配置ルールの一般的な使用シナリオを紹介します。

シナリオ 1: 通常のテーブルに 3 つのレプリカを使用し、メタデータに 5 つのレプリカを使用して、クラスタの耐障害性を向上させる

キー範囲をメタデータの範囲に制限するルールを追加し、 countの値を5に設定するだけです。このルールの例を次に示します。

{
  "group_id": "pd",
  "id": "meta",
  "index": 1,
  "override": true,
  "start_key": "6d00000000000000f8",
  "end_key": "6e00000000000000f8",
  "role": "voter",
  "count": 5,
  "location_labels": ["zone", "rack", "host"]
}

シナリオ2: 3つのデータセンターに5つのレプリカを2:2:1の割合で配置し、Leaderは3番目のデータセンターに存在しないようにします。

3 つのルールを作成します。レプリカの数をそれぞれ2 、 2 、 1に設定します。各ルールで、レプリカを対応するデータセンターlabel_constraintsまでに制限します。また、Leaderを必要としないデータセンターのroleをfollowerに変更します。

[
    {
        "group_id": "pd",
        "id": "zone1",
        "start_key": "",
        "end_key": "",
        "role": "voter",
        "count": 2,
        "label_constraints": [
            {"key": "zone", "op": "in", "values": ["zone1"]}
        ],
        "location_labels": ["rack", "host"]
    },
    {
        "group_id": "pd",
        "id": "zone2",
        "start_key": "",
        "end_key": "",
        "role": "voter",
        "count": 2,
        "label_constraints": [
            {"key": "zone", "op": "in", "values": ["zone2"]}
        ],
        "location_labels": ["rack", "host"]
    },
    {
        "group_id": "pd",
        "id": "zone3",
        "start_key": "",
        "end_key": "",
        "role": "follower",
        "count": 1,
        "label_constraints": [
            {"key": "zone", "op": "in", "values": ["zone3"]}
        ],
        "location_labels": ["rack", "host"]
    }
]

シナリオ3: テーブルに2つのTiFlashレプリカを追加する

テーブルの行キーに別のルールを追加し、 countを2に制限します。 label_constraintsを使用して、レプリカがengine = tiflashのノードで生成されるようにします。このルールがシステム内の他のソースのルールと重複または競合しないようにするために、ここでは別のgroup_idが使用されていることに注意してください。

{
  "group_id": "tiflash",
  "id": "learner-replica-table-ttt",
  "start_key": "7480000000000000ff2d5f720000000000fa",
  "end_key": "7480000000000000ff2e00000000000000f8",
  "role": "learner",
  "count": 2,
  "label_constraints": [
    {"key": "engine", "op": "in", "values": ["tiflash"]}
  ],
  "location_labels": ["host"]
}

シナリオ4: 高性能ディスクを備えた北京ノードのテーブルに2つのフォロワーレプリカを追加する

次の例は、より複雑なlabel_constraints構成を示しています。このルールでは、レプリカはbj1またはbj2マシンルームに配置する必要があり、ディスクタイプはnvmeである必要があります。

{
  "group_id": "follower-read",
  "id": "follower-read-table-ttt",
  "start_key": "7480000000000000ff2d00000000000000f8",
  "end_key": "7480000000000000ff2e00000000000000f8",
  "role": "follower",
  "count": 2,
  "label_constraints": [
    {"key": "zone", "op": "in", "values": ["bj1", "bj2"]},
    {"key": "disk", "op": "in", "values": ["nvme"]}
  ],
  "location_labels": ["host"]
}

シナリオ5: SSDディスクを備えたノードにテーブルを移行する

シナリオ 3 とは異なり、このシナリオは既存の構成に基づいて新しいレプリカを追加するのではなく、データ範囲の他の構成を強制的に上書きします。したがって、既存のルールを上書きするには、十分に大きいindex値を指定し、ルールグループ構成でoverrideからtrueに設定する必要があります。

ルール：

{
  "group_id": "ssd-override",
  "id": "ssd-table-45",
  "start_key": "7480000000000000ff2d5f720000000000fa",
  "end_key": "7480000000000000ff2e00000000000000f8",
  "role": "voter",
  "count": 3,
  "label_constraints": [
    {"key": "disk", "op": "in", "values": ["ssd"]}
  ],
  "location_labels": ["rack", "host"]
}

ルールグループ:

{
  "id": "ssd-override",
  "index": 1024,
  "override": true,
}