バックアップストレージ

スナップショットデータをGCSにバックアップする

tiup br backup full --pd "${PD_IP}:2379" \
--storage "gcs://external/backup-20220915?credentials-file=${credentials-file-path}"

GCSからスナップショットデータを復元する

tiup br restore full --pd "${PD_IP}:2379" \
--storage "gcs://external/backup-20220915?credentials-file=${credentials-file-path}"

スナップショット データを Azure Blob Storage にバックアップする

tiup br backup full -u "${PD_IP}:2379" \
--storage "azure://external/backup-20220915?account-name=${account-name}&account-key=${account-key}"

Azure Blob Storage のスナップショット バックアップ データからtestデータベースを復元します。

tiup br restore db --db test -u "${PD_IP}:2379" \
--storage "azure://external/backup-20220915account-name=${account-name}&account-key=${account-key}"

GCSへのアクセスに使用するアカウントは、アクセスキーを指定することで設定できます。1 パラメータcredentials-file指定した場合、指定されたcredentials-fileを使用して認証が行われます。URIでキーを指定する以外にも、以下の方法がサポートされています。

• BRは環境変数$GOOGLE_APPLICATION_CREDENTIALSで指定されたパスのファイルを読み取ります。
• BRはファイル~/.config/gcloud/application_default_credentials.jsonを読み取ります。
• BR は、クラスターが GCE または GAE で実行されているときに、メタデータサーバーから資格情報を取得します。

• 方法1: 共有アクセス署名を指定する

  URIにaccount-nameとsas-token指定した場合、指定されたアカウント名と共有アクセス署名（SAS）トークンを使用して認証が行われます。SASトークンには&という文字が含まれていることに注意してください。これをURIに追加する前に、 %26としてエンコードする必要があります。パーセントエンコードを使用して、 sas-token全体を直接エンコードすることもできます。

• 方法2: アクセスキーを指定する

  URIにaccount-nameとaccount-key指定すると、指定されたアカウント名とアカウントキーを用いて認証が行われます。URIでキーを指定する方法に加え、 BRは環境変数$AZURE_STORAGE_KEYからキーを読み取ることもできます。

• 方法3: バックアップと復元にAzure ADを使用する

  BRが実行されているノードで環境変数$AZURE_CLIENT_ID $AZURE_TENANT_IDおよび$AZURE_CLIENT_SECRETを設定します。

  • TiUPを使用してクラスターを起動すると、TiKV は systemd サービスを使用します。次の例は、TiKV の上記の 3 つの環境変数を設定する方法を示しています。

    注記：

    この方法を使用する場合は、手順 3 で TiKV を再起動する必要があります。クラスターを再起動できない場合は、 「方法 1: バックアップと復元のアクセス キーを指定する」を使用します。

    1. このノードの TiKV ポートが24000 、つまり systemd サービスの名前がtikv-24000であるとします。

       systemctl edit tikv-24000
       

    2. TiKV 構成ファイルを編集して、次の 3 つの環境変数を構成します。

       [Service]
       Environment="AZURE_CLIENT_ID=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
       Environment="AZURE_TENANT_ID=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
       Environment="AZURE_CLIENT_SECRET=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
       

    3. 設定を再読み込みし、TiKV を再起動します。

       systemctl daemon-reload
       systemctl restart tikv-24000
       

  • コマンドラインで起動した TiKV およびBRの Azure AD 情報を構成するには、次のコマンドを実行して、オペレーティング環境で環境変数$AZURE_CLIENT_ID $AZURE_TENANT_IDおよび$AZURE_CLIENT_SECRETが構成されているかどうかを確認するだけです。

    echo $AZURE_CLIENT_ID
    echo $AZURE_TENANT_ID
    echo $AZURE_CLIENT_SECRET
    

  • BRを使用してデータを Azure Blob Storage にバックアップします。

    tiup br backup full -u "${PD_IP}:2379" \
    --storage "azure://external/backup-20220915?account-name=${account-name}"
    

• 方法4: AzureマネージドIDを使用する

  v8.5.5 以降では、TiDB クラスターとBRが Azure 仮想マシン (VM) または Azure Kubernetes Service (AKS) 環境で実行されており、Azure マネージド ID がノードに割り当てられている場合は、認証に Azure マネージド ID を使用できます。

  この方法を使用する前に、 Azureポータル内のターゲットstorageアカウントにアクセスするためのアクセス許可 ( Storage Blob Data Contributorなど) が対応するマネージド ID に付与されていることを確認してください。

  • システム割り当てマネージド ID :

    システム割り当てマネージド ID を使用する場合、Azure 関連の環境変数を構成する必要はありません。BRBRコマンドを直接実行できます。

    tiup br backup full -u "${PD_IP}:2379" \
    --storage "azure://external/backup-20220915?account-name=${account-name}"
    

    注記：

    ランタイム環境で環境変数AZURE_CLIENT_ID 、 AZURE_TENANT_ID 、 AZURE_CLIENT_SECRET設定されていないことを確認してください。設定されていない場合、Azure SDK が他の認証方法を優先し、マネージド ID が有効にならない可能性があります。

  • ユーザー割り当てマネージド ID :

    ユーザー割り当てマネージドIDを使用する場合は、TiKVとBRのランタイム環境で環境変数AZURE_CLIENT_IDを設定し、その値をマネージドIDのクライアントIDに設定してから、 BRバックアップコマンドを実行する必要があります。詳細な手順は次のとおりです。

    1. TiUPで起動するときに TiKV のクライアント ID を設定します。

       次の手順では、TiKV ポート24000と systemd サービス名tikv-24000例として使用します。

       1. 次のコマンドを実行して、systemd サービス エディターを開きます。

          systemctl edit tikv-24000
          

       2. AZURE_CLIENT_ID環境変数をマネージド ID クライアント ID に設定します。

          [Service]
          Environment="AZURE_CLIENT_ID=<your-client-id>"
          

       3. systemd 構成を再ロードし、TiKV を再起動します。

          systemctl daemon-reload
          systemctl restart tikv-24000
          

    2. BRのAZURE_CLIENT_ID環境変数を設定します。

       export AZURE_CLIENT_ID="<your-client-id>"
       

    3. 次のBRコマンドを使用して、データを Azure Blob Storage にバックアップします。

       tiup br backup full -u "${PD_IP}:2379" \
       --storage "azure://external/backup-20220915?account-name=${account-name}"