アプリ プロファイルの作成と構成
このページでは、Bigtable インスタンスのアプリケーション プロファイル(アプリ プロファイル)の作成方法と管理方法について説明します。また、カスタムアプリ プロファイルを使用して Bigtable に接続する方法も説明します。
このページを読む前に、アプリ プロファイルとその機能について理解する必要があります。特に、標準アプリ プロファイル(標準コンピューティングを使用するように構成されたアプリ プロファイル)と Data Boost アプリ プロファイル(Data Boost サーバーレス コンピューティングを使用して高スループットの読み取りジョブを実行するアプリ プロファイル)の違いを理解しておいてください。Data Boost と、プロビジョニングされたクラスタノードを使用するコンピューティングとの違いについては、Data Boost の概要をご覧ください。
標準アプリ プロファイルを使用してレプリケーションを構成する場合は、Bigtable レプリケーションの概要も知っておく必要があります。また、レプリケーション設定の例を確認し、ユースケースに最適な設定を判断する必要もあります。
必要なロール
アプリ プロファイルの作成、構成、削除に必要な権限を取得するには、インスタンスに対する Bigtable 管理者(roles/bigtable.admin
)IAM ロールの付与を管理者に依頼してください。
ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
アプリ プロファイルを作成する
インスタンスごとに、多数のカスタムアプリ プロファイルを作成できます。カスタムアプリ プロファイルを使用すると、各アプリケーション、またはアプリケーション内の各ファンクションがインスタンスとどのようにインタラクションするかを制御できます。たとえば、バッチ アプリケーション用のアプリ プロファイルで 1 つのクラスタへのトラフィックを分離できます。また、別のアプリ プロファイルを使用して他のアプリケーションの高可用性を実現することもできます。
標準アプリ プロファイルを作成する
標準アプリ プロファイルを作成する手順は次のとおりです。
コンソール
Google Cloud コンソールで Bigtable インスタンスのリストを開きます。
アプリ プロファイルを作成するインスタンスをクリックします。
左側のペインで [アプリケーション プロファイル] をクリックします。
[アプリケーション プロファイルを作成] をクリックします。
[標準] を選択します。
[次へ] をクリックします。
アプリケーション プロファイル ID を入力します。
アプリケーション プロファイル ID は、アプリ プロファイルの永続的な識別子です。アプリケーションが Bigtable に接続すると、この ID が生成されます。
アプリ プロファイルの説明を入力します。
[クラスタ ルーティング] で、単一クラスタのルーティングまたは複数クラスタのルーティングを選択します。詳細
[単一クラスタ] を選択した場合:
プルダウンを使用して、リクエストのルーティング先となるクラスタを選択します。
単一行のトランザクションを有効にする必要がある場合は、[単一行のトランザクションを許可] チェックボックスをオンにします。
[複数クラスタ] を選択した場合:
- インスタンス内の任意のクラスタにリクエストをルーティングするには、[クラスタ グループ] プルダウンで [任意のクラスタ] を選択します。
- リクエストのルーティングをインスタンス内の一部のクラスタのみに制限するには(クラスタ グループ ルーティング)、ルーティング グループに含める各クラスタのチェックボックスをオンにして、[OK] をクリックします。
[作成] をクリックして、アプリ プロファイルを作成します。
Bigtable に接続するためのアプリケーションのコードを更新して、新しいアプリ プロファイルを使用するよう設定します。
gcloud
インスタンス ID がわからない場合は、
bigtable instances list
コマンドを使用して、プロジェクトのインスタンスのリストを表示します。gcloud bigtable instances list
bigtable app-profiles create
コマンドを使用して、アプリ プロファイルを作成します。gcloud bigtable app-profiles create APP_PROFILE_ID \ --instance=INSTANCE_ID \ [--description=DESCRIPTION] \ [--force] \ [--route-any] \ [--restrict-to=CLUSTER_ID_1, CLUSTER_ID_2...] [--route-to=CLUSTER_ID] \ [--transactional-writes] \ [--priority=PRIORITY]
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。
コマンドには、以下の任意のフラグを指定できます。
--description=DESCRIPTION
: アプリ プロファイルの詳細な説明。--force
: 問題や他のアプリ プロファイルとの競合の可能性についての警告を無視します。--route-any
: 複数クラスタのルーティングを有効にして、使用可能な任意のクラスタにリクエストをルーティングできるようにします。このフラグを
--route-to
フラグや--transactional-writes
フラグと組み合わせることはできません。--restrict-to=CLUSTER_ID_1, CLUSTER_ID_2...
: リクエストのルーティング先となるクラスタのリスト。このオプションは、インスタンス内の一部のクラスタのみにリクエストをルーティングする場合に使用します。このフラグを
--route-to
フラグや--transactional-writes
フラグと組み合わせることはできません。--route-to=CLUSTER_ID
: すべてのリクエストのルーティング先となるクラスタ ID。このフラグにより、単一クラスタのルーティングが有効になります。このフラグを
--route-any
フラグと組み合わせることはできません。--transactional-writes
: アプリ プロファイルで単一行のトランザクションを有効にします。このフラグを
--route-any
フラグや--restrict-to
フラグと組み合わせることはできません。--priority=PRIORITY
: アプリ プロファイルが使用する優先度。指定できる値はPRIORITY_HIGH
、PRIORITY_MEDIUM
、PRIORITY_LOW
です。
Bigtable に接続するためのアプリケーションのコードを更新して、新しいアプリ プロファイルを使用するよう設定します。
Data Boost アプリ プロファイルを作成する
Data Boost アプリ プロファイル(Data Boost サーバーレス コンピューティングを使用するアプリ プロファイル)を作成するには、次の操作を行います。ワークロードが Data Boost と互換性があることを確認するには、制限事項を確認してください。
コンソール
Google Cloud コンソールで Bigtable インスタンスのリストを開きます。
アプリ プロファイルを作成するインスタンスをクリックします。
左側のペインで [アプリケーション プロファイル] をクリックします。
[アプリケーション プロファイルを作成] をクリックします。
[Data Boost] を選択します。
[次へ] をクリックします。
アプリケーション プロファイル ID を入力します。
アプリケーション プロファイル ID は、アプリ プロファイルの永続的な識別子です。アプリケーションが Bigtable に接続すると、この ID が生成されます。
アプリ プロファイルの説明を入力します。
[クラスタ ルーティング] で、リクエストのルーティング先となるクラスタを選択します。
[Create app profile] をクリックして、アプリ プロファイルを作成します。
Bigtable に接続するためのアプリケーションのコードを更新して、新しいアプリ プロファイルを使用するよう設定します。
gcloud
インスタンス ID がわからない場合は、
bigtable instances list
コマンドを使用して、プロジェクトのインスタンスのリストを表示します。gcloud bigtable instances list
gcloud beta bigtable app-profiles create
コマンドを使用して、アプリ プロファイルを作成します。gcloud bigtable app-profiles create APP_PROFILE_ID \ --instance=INSTANCE_ID \ --data-boost \ --data-boost-compute-billing-owner=HOST_PAYS \ --route-to=CLUSTER_ID
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。CLUSTER_ID
: すべてのリクエストのルーティング先となるクラスタ ID。このフラグにより、単一クラスタのルーティングが有効になります。
カスタム アプリ プロファイルに接続する
カスタム アプリ プロファイルを作成したら、Bigtable と接続するときにアプリがアプリ プロファイルを使用するようにコードを更新できます。
以下の例では、アプリが Bigtable クライアントを作成してインスタンスに接続するときにアプリ プロファイルを指定する方法を説明します。[APP_PROFILE_ID]
は、適切な値で置き換えます。
C#
var client = BigtableClient.Create(appProfileId: "[APP_PROFILE_ID]");
Go
clientConf := bigtable.ClientConfig{AppProfile:"[APP_PROFILE_ID]"}
client, err = bigtable.NewClientWithConfig(ctx, project, instance, clientConf)
HBase Java
// If using BigtableOptions directly:
optionsBuilder.setAppProfileId("[APP_PROFILE_ID]");
// If using BigtableOptionsFactory:
configuration.set(BigtableOptionsFactory.APP_PROFILE_ID_KEY, "[APP_PROFILE_ID]");
// If using system properties, set "google.bigtable.app_profile.id" to
// "[APP_PROFILE_ID]"
// If using CloudBigtableIO for Cloud Dataflow:
config.withConfiguration(BigtableOptionsFactory.APP_PROFILE_ID_KEY,
"[APP_PROFILE_ID]");
Node.js
const bigtable = new Bigtable({appProfileId: '[APP_PROFILE_ID]'});
Python
from google.cloud import bigtable
client = bigtable.Client(project=project_id)
instance = client.instance(instance_id)
table = bigtable.table.Table(table_id, instance, '[APP_PROFILE_ID]')
アプリ プロファイルを更新する
インスタンスのアプリ プロファイルの表示とそれらの設定の更新は、いつでも可能です。更新により動作の予期しない変動が発生する可能性がある場合は、警告が生成されます。
アプリ プロファイルを標準から Data Boost、または Data Boost から標準に更新する方法については、アプリ プロファイルを変換するをご覧ください。
標準アプリ プロファイルを更新する
標準アプリ プロファイルを更新する手順は次のとおりです。
コンソール
Google Cloud コンソールで Bigtable インスタンスのリストを開きます。
[アプリケーション プロファイル] 列で、表示または更新するアプリ プロファイルをクリックします。
編集するアプリ プロファイルが表示されない場合は、インスタンス名をクリックしてから左側のペインで [アプリケーション プロファイル] をクリックすると、完全なリストを表示できます。
必要に応じて設定を更新してから [保存] をクリックします。保存せずに終了する場合は [キャンセル] をクリックします。
gcloud
インスタンス ID がわからない場合は、
bigtable instances list
コマンドを使用して、プロジェクトのインスタンスのリストを表示します。gcloud bigtable instances list
アプリ プロファイルの ID がわからない場合は、
bigtable app-profiles list
コマンドを使用して、インスタンスのアプリ プロファイルのリストを表示します。gcloud bigtable app-profiles list --instance=INSTANCE_ID
INSTANCE_ID
はインスタンスの永続的な識別子に置き換えます。(省略可)
bigtable app-profiles describe
コマンドを使用して、アプリ プロファイルの設定を確認します。gcloud bigtable app-profiles describe APP_PROFILE_ID \ --instance=INSTANCE_ID
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。
bigtable app-profiles update
コマンドを使用して、アプリ プロファイルの設定を更新します。gcloud bigtable app-profiles update APP_PROFILE_ID \ --instance=INSTANCE_ID \ [--description=DESCRIPTION] \ [--force] \ [--route-any] \ [--restrict-to=CLUSTER_ID_1, CLUSTER_ID_2...] [--route-to=CLUSTER_ID] \ [--transactional-writes]
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。
コマンドには、以下の任意のフラグを指定できます。
--description=DESCRIPTION
: アプリ プロファイルの詳細な説明。--force
: 問題や他のアプリ プロファイルとの競合の可能性についての警告を無視します。--route-any
: 複数クラスタのルーティングを有効にして、使用可能な任意のクラスタにリクエストをルーティングできるようにします。このフラグを
--route-to
フラグや--transactional-writes
フラグと組み合わせることはできません。--restrict-to=CLUSTER_ID_1, CLUSTER_ID_2...
: リクエストのルーティング先となるクラスタのリスト。このオプションは、インスタンス内の一部のクラスタのみにリクエストをルーティングする場合に使用します。このフラグを
--route-to
フラグや--transactional-writes
フラグと組み合わせることはできません。--route-to=CLUSTER_ID
: すべてのリクエストのルーティング先となるクラスタ ID。このフラグにより、単一クラスタのルーティングが有効になります。このフラグを
--route-any
フラグと組み合わせることはできません。--transactional-writes
: アプリ プロファイルで単一行のトランザクションを有効にします。このフラグを
--route-any
フラグと組み合わせることはできません。--priority=PRIORITY
: アプリ プロファイルが使用する優先度。指定できる値はPRIORITY_HIGH
、PRIORITY_MEDIUM
、PRIORITY_LOW
です。
Data Boost アプリ プロファイルを更新する
Data Boost アプリ プロファイルが読み取るクラスタを更新する手順は次のとおりです。
コンソール
Google Cloud コンソールで Bigtable インスタンスのリストを開きます。
[アプリケーション プロファイル] 列で、表示または更新するアプリ プロファイルをクリックします。
編集するアプリ プロファイルが表示されない場合は、インスタンス名をクリックしてから左側のペインで [アプリケーション プロファイル] をクリックすると、完全なリストを表示できます。
トラフィックを転送する新しいクラスタを選択し、[保存] をクリックします。
gcloud
インスタンス ID がわからない場合は、
bigtable instances list
コマンドを使用して、プロジェクトのインスタンスのリストを表示します。gcloud bigtable instances list
アプリ プロファイルの ID がわからない場合は、
bigtable app-profiles list
コマンドを使用して、インスタンスのアプリ プロファイルのリストを表示します。gcloud bigtable app-profiles list --instance=INSTANCE_ID
INSTANCE_ID
はインスタンスの永続的な識別子に置き換えます。(省略可)
bigtable app-profiles describe
コマンドを使用して、アプリ プロファイルの設定を確認します。gcloud bigtable app-profiles describe APP_PROFILE_ID \ --instance=INSTANCE_ID
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。
gcloud beta bigtable app-profiles update
コマンドを使用して、アプリ プロファイルの設定を更新します。gcloud beta bigtable app-profiles update APP_PROFILE_ID \ --instance=INSTANCE_ID \ --route-to=CLUSTER_ID
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。CLUSTER_ID
: 読み取る新しいクラスタの ID
アプリ プロファイルを変換する
標準のアプリ プロファイルを Data Boost アプリ プロファイルに変換することも、Data Boost アプリ プロファイルを標準のアプリ プロファイルに変換することもできます。アプリ プロファイルを変換する前に、アプリ プロファイルの変更のガイダンスを確認してください。
Standard から Data Boost に変換する
アプリ プロファイルを標準(コンピューティング用にプロビジョニングされたノード)から Data Boost サーバーレス コンピューティングに更新する前に、Data Boost の適格性に関する指標を確認します。また、Data Boost の制限事項にも注意してください。
コンソール
Google Cloud コンソールで Bigtable インスタンスのリストを開きます。
[アプリケーション プロファイル] 列で、更新するアプリ プロファイルをクリックします。
編集するアプリ プロファイルが表示されない場合は、インスタンス名をクリックしてから左側のペインで [アプリケーション プロファイル] をクリックすると、完全なリストを表示できます。
[Data Boost] を選択します。
リクエストのルーティング先となるクラスタを選択します。
[保存] をクリックします。
gcloud
インスタンス ID がわからない場合は、
bigtable instances list
コマンドを使用して、プロジェクトのインスタンスのリストを表示します。gcloud bigtable instances list
アプリ プロファイルの ID がわからない場合は、
bigtable app-profiles list
コマンドを使用して、インスタンスのアプリ プロファイルのリストを表示します。gcloud bigtable app-profiles list --instance=INSTANCE_ID
INSTANCE_ID
はインスタンスの永続的な識別子に置き換えます。(省略可)
bigtable app-profiles describe
コマンドを使用して、アプリ プロファイルの設定を確認します。gcloud bigtable app-profiles describe APP_PROFILE_ID \ --instance=INSTANCE_ID
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。
gcloud beta bigtable app-profiles update
コマンドを使用して、アプリ プロファイルを標準から Data Boost に変換します。gcloud bigtable app-profiles update APP_PROFILE_ID \ --instance=INSTANCE_ID \ --data-boost \ --data-boost-compute-billing-owner=HOST_PAYS \ --route-to=CLUSTER_ID
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。CLUSTER_ID
: すべてのリクエストのルーティング先となるクラスタ ID。このフラグにより、単一クラスタのルーティングが有効になります。
Data Boost から標準に変換する
アプリ プロファイルを Data Boost(サーバーレス コンピューティング)から標準(コンピューティング用のプロビジョニングされたノード)に変更する手順は次のとおりです。
コンソール
Google Cloud コンソールで Bigtable インスタンスのリストを開きます。
[アプリケーション プロファイル] 列で、更新するアプリ プロファイルをクリックします。
編集するアプリ プロファイルが表示されない場合は、インスタンス名をクリックしてから左側のペインで [アプリケーション プロファイル] をクリックすると、完全なリストを表示できます。
[標準] を選択します。
[次へ] をクリックします。
省略可: アプリ プロファイルの説明を編集します。
[クラスタ ルーティング] で、単一クラスタのルーティングまたは複数クラスタのルーティングを選択します。詳細
[単一クラスタ] を選択した場合:
プルダウンを使用して、リクエストのルーティング先となるクラスタを選択します。
単一行のトランザクションを有効にする必要がある場合は、[単一行のトランザクションを許可] チェックボックスをオンにします。
[複数クラスタ] を選択した場合:
- インスタンス内の任意のクラスタにリクエストをルーティングするには、[クラスタ グループ] プルダウンで [任意のクラスタ] を選択します。
- リクエストのルーティングをインスタンス内の一部のクラスタのみに制限するには(クラスタ グループ ルーティング)、ルーティング グループに含める各クラスタのチェックボックスをオンにして、[OK] をクリックします。
[保存] をクリックします。
gcloud
インスタンス ID がわからない場合は、
bigtable instances list
コマンドを使用して、プロジェクトのインスタンスのリストを表示します。gcloud bigtable instances list
アプリ プロファイルの ID がわからない場合は、
bigtable app-profiles list
コマンドを使用して、インスタンスのアプリ プロファイルのリストを表示します。gcloud bigtable app-profiles list --instance=INSTANCE_ID
INSTANCE_ID
はインスタンスの永続的な識別子に置き換えます。(省略可)
bigtable app-profiles describe
コマンドを使用して、アプリ プロファイルの設定を確認します。gcloud bigtable app-profiles describe APP_PROFILE_ID \ --instance=INSTANCE_ID
gcloud beta bigtable app-profiles update
コマンドを使用して、アプリ プロファイルを変換します。gcloud bigtable app-profiles update APP_PROFILE_ID \ --instance=INSTANCE_ID \ --standard \ [--route-any] \ [--restrict-to=CLUSTER_ID_1, CLUSTER_ID_2...] [--route-to=CLUSTER_ID] \ [--transactional-writes]
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。
コマンドには、以下の任意のフラグを指定できます。
--route-any
: 複数クラスタのルーティングを有効にして、使用可能な任意のクラスタにリクエストをルーティングできるようにします。このフラグを
--route-to
フラグや--transactional-writes
フラグと組み合わせることはできません。--restrict-to=CLUSTER_ID_1, CLUSTER_ID_2...
: リクエストのルーティング先となるクラスタのリスト。このオプションは、インスタンス内の一部のクラスタのみにリクエストをルーティングする場合に使用します。このフラグを
--route-to
フラグや--transactional-writes
フラグと組み合わせることはできません。--route-to=CLUSTER_ID
: すべてのリクエストのルーティング先となるクラスタ ID。このフラグにより、単一クラスタのルーティングが有効になります。このフラグを
--route-any
フラグと組み合わせることはできません。--transactional-writes
: アプリ プロファイルで単一行のトランザクションを有効にします。このフラグを
--route-any
フラグや--restrict-to
フラグと組み合わせることはできません。
アプリ プロファイルを削除する
インスタンスのカスタムアプリ プロファイルは削除できますが、デフォルトのアプリ プロファイルは削除できません。
カスタムアプリ プロファイルを削除するには:
コンソール
Google Cloud コンソールで Bigtable インスタンスのリストを開きます。
削除するアプリ プロファイルがあるインスタンスをクリックします。
左側のペインで [アプリケーション プロファイル] をクリックします。
その他の操作メニュー
を開き、[アプリケーション プロファイルを削除] をクリックします。確認ダイアログが表示されます。確認ダイアログの手順に沿って、[削除] をクリックします。
gcloud
インスタンス ID がわからない場合は、
bigtable instances list
コマンドを使用して、プロジェクトのインスタンスのリストを表示します。gcloud bigtable instances list
アプリ プロファイルの ID がわからない場合は、
bigtable app-profiles list
コマンドを使用して、インスタンスのアプリ プロファイルのリストを表示します。gcloud bigtable app-profiles list --instance=INSTANCE_ID
INSTANCE_ID
はインスタンスの永続的な識別子に置き換えます。bigtable app-profiles delete
コマンドを使用して、アプリ プロファイルを削除します。gcloud bigtable app-profiles delete APP_PROFILE_ID \ --instance=INSTANCE_ID \ [--force]
次のフィールドを入力します。
APP_PROFILE_ID
: アプリ プロファイルの永続的な識別子。INSTANCE_ID
: インスタンスの永続的な識別子。
コマンドには、以下の任意のフラグを指定できます。
--force
: 問題や他のアプリ プロファイルとの競合の可能性についての警告を無視します。