スナップショットAPIを使用したクラスタ・バックアップ

スナップショット・ファイルを格納するためのオブジェクト・ストレージ・バケットの作成

スナップショットのリポジトリは、テナンシのObject Storageバケットです。リポジトリとして登録するObject Storageバケットがない場合は、バケットを作成する必要があります。バケットの作成方法を説明するチュートリアルについては、オブジェクト・ストレージへのデータの挿入を参照してください。

リポジトリとして登録するバケットについて、次の情報をノートにとります。この情報は、コンソールの「バケットの詳細」ページにあります。

• ネームスペース
• バケット名
• コンパートメントOCID

コンパートメントOCIDを取得するには:

1. 「バケットの詳細」ページで「コンパートメント」のリンクをクリックします。
2. 「コンパートメント情報」のOCIDの「コピー」をクリックします。

forceBucketCreation: true

IAMポリシー

スナップショット・ファイルを格納するために、テナンシのオブジェクト・ストレージ・バケットへのOpenSearchクラスタ・アクセスを提供する権限を構成する必要があります。

次のポリシーの例には、必要な権限が含まれています。

DEFINE tenancy opensearch-tenancy as <OpenSearch_Tenancy_ID>
ADMIT resource opensearch opensearchsnapshots of tenancy opensearch-tenancy to manage object-family in compartment <snapshot_bucket_compartment> where ALL {request.principal.clusterid='<cluster_OCID>', request.principal.ownertenant='<customer_tenancy_OCID>', request.principal.ownercompartment='<customer_compartment_OCID>', target.bucket.name='<snapshot_bucket_name>'}

前述のポリシーでは、指定したバケットをスナップショット・リポジトリとして登録することのみが許可されています。

<OpenSearch_Tenancy_ID>は、OpenSearchテナンシを使用したOCI検索のOCIDです。この値は、クラスタの「クラスタ詳細」ページで、「追加情報」セクションの「OpensearchテナンシOCID」フィールドで確認できます。

<customer_tenancy_OCID>は、OpenSearchクラスタを作成したテナンシのOCIDです。

<customer_compartment_OCID>は、OpenSearchクラスタが配置されているコンパートメントのOCIDです。

レジスタ操作でforceBucketCreation : trueを指定する場合は、指定したポリシーにテナンシでのバケット作成アクセスが含まれていることを確認する必要があります。そうしないと、リポジトリの登録操作は失敗します。

リポジトリ登録

スナップショットを取得する前に、次の例に示すようにリポジトリを登録する必要があります。

PUT _snapshot/<repository_name>
{
  "type": "oci",
  "settings": {
    "client": "default",
    "endpoint": "<objectstorage_endpoint>",
    "bucket": "<bucket_name>",
    "namespace": "<namespace>",
    "authType": "RESOURCE_PRINCIPAL",
    "bucket_compartment_id": "<bucket_compartment_OCID>",
    "forceBucketCreation": true
  }
}

次の表では、リポジトリの登録時に指定するパラメータについて説明します。

スナップショットの作成

リポジトリを登録したら、次の例に示すようにスナップショットを作成できます。

POST _snapshot/<repository_name>/<snapshot_name>?wait_for_completion=true

前述の例には、すべての索引とクラスタの状態が含まれます。次の例は、特定の索引およびその他の設定を含める方法を示しています。

POST _snapshot/<repository_name>/<snapshot_name>?wait_for_completion=true
{
"indices": "<index_name>,-<index_name>",
  "ignore_unavailable": true,
  "include_global_state": false
}

含める1つ以上の索引、<index_name_to_include>および除外する1つ以上の索引、-<index_name_to_exclude>を指定できます。

このAPI操作の詳細は、スナップショットの取得を参照してください。

スナップショットのリストア

スナップショットをリストアする前に、クラスタの既存のスナップショットをすべて取得できます。最初に、次の例に示すように、クラスタに登録されているすべてのリポジトリを取得します。

GET _snapshot/_all?pretty

次に、次の例に示すように、リポジトリ内のすべてのスナップショットを取得します。

GET _snapshot/<repository_name>?pretty

次の例に示すように、スナップショットを復元します。

POST _snapshot/<repository_name>/<snapshot_name>/_restore
{
     "indices": "<index_name_to_include>,-<index_name_to_exclude>",
     "ignore_unavailable": true,
     "include_global_state": false,
     "rename_pattern": "(.+)",
     "rename_replacement": "restored_$1",
     "include_aliases": true
}

含める1つ以上の索引、<index_name_to_include>および除外する1つ以上の索引、-<index_name_to_exclude>を指定できます。

このAPI操作の詳細は、スナップショットのリストアを参照してください。