接続レジストリの管理
項目一覧
各ストリーム プロセシング インスタンスは、ストリーミング データ ソースまたは シンクへの構成済みのすべての接続を 接続レジストリ に保存します。 このページの手順では、Atlas Stream Processing 接続の作成と構成について説明します。
前提条件
接続を作成および構成するには、次のものが必要です。
Atlas プロジェクト
接続レジストリを管理するための
Project Stream Processing Owner
{2Atlas userProject Owner
または ロールを持つ注意
Project Owner
ロールでは、データベース配置の作成、プロジェクト アクセスとプロジェクト設定の管理、IP アクセス リスト エントリの管理などを行うことができます。Project Stream Processing Owner
ロールにより、ストリーム プロセシング インスタンスの表示、作成、削除、編集などの Atlas Stream Processing アクションや、接続レジストリ内の接続の表示、追加、変更、削除などの Atlas Stream Processing アクションが可能になります。2 つのロールの違いの詳細については、「プロジェクト ロール」を参照してください。
Atlas クラスター
接続レジストリでの接続の表示
Atlas Stream Processing インスタンスへの接続を表示するには:
Atlas CLI を使用して指定した 1 つのストリーム プロセシング インスタンスからのすべての接続を一覧表示するには、次のコマンドを実行します。
atlas streams connections list [options]
Atlas CLI を使用して指定した 1 つのストリーム プロセシング接続の詳細を返すには、次のコマンドを実行します。
atlas streams connections describe <streamConnectionName> [options]
前のコマンドの構文とパラメータの詳細については、Atlas CLI ドキュメントの Atlas Streams 接続リストとAtlas Streams 接続の説明 を参照してください。
Atlas Atlasで、プロジェクトの {0 ページにGoします。GoStream Processing
まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。
まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。
サイドバーで、 Services見出しの下のStream Processingをクリックします。
Atlas Stream Processingページが表示されます。
Atlas Administration API は、接続レジストリ内の 1 つまたはすべての接続を取得するためのさまざまなエンドポイントを提供します。
mongosh
を使用して利用可能なすべての接続を一覧表示するには、 sp.listConnections()
メソッドを使用します。 ストリーム プロセシング インスタンスの接続レジストリ内の各接続を説明するドキュメントのリストが返されます。 構文は次のとおりです。
sp.listConnections()
接続レジストリへの接続の追加
Atlas Stream Processing は次の接続タイプをサポートしています。
各タイプには異なる構成要件があります。
Apache Kafka 接続の追加
重要
Atlas Stream Processing の VPC ピアリングは現在プライベートプレビュー段階です。 詳しくは、アカウント チームにお問い合わせください。
Atlas Stream Processing インスタンスに Kafka 接続を追加するには、次の手順に従います。
Atlas CLI を使用して、指定したストリーム プロセシング インスタンスの 1 つの接続を作成するには、次のコマンドを実行します。
atlas streams connections create [connectionName] [options]
コマンド構文とパラメーターの詳細については、 Atlas CLIドキュメントの「 Atlas streams connection create 」を参照してください。
Atlas CLI を使用してストリーム プロセシング インスタンスを作成する場合は、新しい接続のパラメーターを定義するための.json
構成ファイルを提供する必要があります。 このファイルの形式は、定義する接続のタイプによって異なります。
Apache Kafka の場合 接続には、次の構文を持つ構成ファイルを指定します。
{ "name": "<name>", "type": "Kafka", "bootstrapServers": "<address:port>, ...", "security": { "protocol": "<protocol>" }, "authentication": { "mechanism": "<auth-mechanism>", "username": "<username>", "password": "<password>" } }
AtlasGoStream ProcessingAtlas で、プロジェクトの ページにGoします。
まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。
まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。
サイドバーで、 Services見出しの下のStream Processingをクリックします。
Atlas Stream Processingページが表示されます。
新しい接続を追加します。
Kafka接続を選択します。
Connection Nameを指定します。 各接続名は、ストリーム プロセシング インスタンス内で一意である必要があります。 これは、Atlas Stream Processing の集計で接続を参照するために使用される名前です。
Network Accessタイプを選択します。 Atlas Stream Processing はPublic IPまたはVPC Peering接続をサポートしています。
[ Public IP ] ボタンをクリックします。 このネットワーク アクセス タイプでは、それ以上の設定は必要ありません。
VPC Peeringボタンをクリックします。
Enable VPC Peering をオンに切り替えます。Atlas Stream Processing は、構成された接続から適切な VPC ピアリング接続を自動的に選択します。
VPCピアリング接続がない場合は、「Atlas ネットワークピアリング接続の設定」を参照してください。
1 つ以上の ブートストラップ サーバー の IP アドレスを指定 Apache Kafka 用 システム参照してください。
ドロップダウン メニューからSecurity Protocol Method ] を選択します。
Atlas Stream Processing は
SASL_PLAINTEXT
またはSASL_SSL
をサポートしています。SASL_PLAINTEXT
は VPC ピアリングと互換性がありません。 VPC ピアリングを使用するには、SASL_SSL
メソッドを選択する必要があります。ドロップダウン メニューからSASL Mechanism ] を選択します。
Atlas Stream Processing は以下をサポートします。
PLAIN
SCRAM-SHA-256
SCRAM-SHA-512
認証にはUsernameを指定します。
認証用パスワードを入力します。
[Add connection] をクリックします。
ドロップダウン メニューからSASL Mechanism ] を選択します。
Atlas Stream Processing は以下をサポートします。
PLAIN
SCRAM-SHA-256
SCRAM-SHA-512
Uploadをクリックして をアップロードしますCertificate Authority PEM file
認証にはUsernameを指定します。
認証用パスワードを入力します。
[Add connection] をクリックします。
Atlas Administration API は、接続レジストリに接続を追加するためのエンドポイントを提供します。
重要
Apache Kafka などの外部接続を追加した後 クラスターが接続レジストリに追加されている場合は、その外部接続用のアクセス リストに Atlas IP アドレスを追加する必要があります。詳細については、 「 Atlas Control Plane へのアクセスまたは Atlas Control Plane からのアクセス許可 」を参照してください。
Atlas 接続の追加
重要
Atlas Stream Processing の VPC ピアリングは現在プライベートプレビュー段階です。 詳しくは、アカウント チームにお問い合わせください。
Atlas データベース接続をストリーム プロセシング インスタンスに追加するには、次の手順に従います。
Atlas CLI を使用して、指定したストリーム プロセシング インスタンスの 1 つの接続を作成するには、次のコマンドを実行します。
atlas streams connections create [connectionName] [options]
コマンド構文とパラメーターの詳細については、 Atlas CLIドキュメントの「 Atlas streams connection create 」を参照してください。
Atlas CLI を使用してストリーム プロセシング インスタンスを作成する場合は、新しい接続のパラメーターを定義するための.json
構成ファイルを提供する必要があります。 このファイルの形式は、定義する接続のタイプによって異なります。
Atlas データベース接続には、次の構文を含む構成ファイルを提供します。
{ "name": "<name>", "type": "Cluster", "clusterName": "<clusterName>" }
AtlasGoStream ProcessingAtlas で、プロジェクトの ページにGoします。
まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。
まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。
サイドバーで、 Services見出しの下のStream Processingをクリックします。
Atlas Stream Processingページが表示されます。
新しい接続を追加します。
Atlas変更ストリームへの新しい接続を作成するには
Atlas Database接続を選択します。
Connection Nameを指定します。 各接続名は、ストリーム プロセシング インスタンス内で一意である必要があります。 これは、Atlas Stream Processing の集計で接続を参照するために使用される名前です。
ドロップダウン メニューからAtlas Cluster ] を選択します。 Atlas Stream Processing は専用階層クラスターでのみ利用できます。
[Add connection] をクリックします。
Atlas Administration API は、接続レジストリに接続を追加するためのエンドポイントを提供します。
接続レジストリからの接続の変更
接続レジストリから接続を変更するには、次の手順に従います。
Atlas CLI を使用して指定したストリーム プロセシング インスタンスの 1 つの接続の詳細を変更するには、次のコマンドを実行します。
atlas streams connections update <connectionName> [options]
コマンド構文とパラメータの詳細については、Atlas CLI ドキュメントの Atlas Streams 接続の更新を参照してください。
AtlasGoStream ProcessingAtlas で、プロジェクトの ページにGoします。
まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。
まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。
サイドバーで、 Services見出しの下のStream Processingをクリックします。
Atlas Stream Processingページが表示されます。
Atlas Administration API は、ストリーム プロセシング インスタンスを編集するためのエンドポイントを提供します。
接続レジストリからの接続の削除
接続レジストリから接続を削除するには、次の手順に従います。
Atlas CLI を使用して指定したストリーム プロセシング インスタンスから 1 つの接続を削除するには、次のコマンドを実行します。
atlas streams connections delete <connectionName> [options]
コマンド構文とパラメータの詳細については、 Atlas CLIドキュメントの「 Atlas connection delete 」を参照してください。
AtlasGoStream ProcessingAtlas で、プロジェクトの ページにGoします。
まだ表示されていない場合は、プロジェクトを含む組織をナビゲーション バーの Organizations メニューで選択します。
まだ表示されていない場合は、ナビゲーション バーの Projects メニューからプロジェクトを選択します。
サイドバーで、 Services見出しの下のStream Processingをクリックします。
Atlas Stream Processingページが表示されます。
Atlas Administration API は、ストリーム プロセシング インスタンスを編集するためのエンドポイントを提供します。
プライベートリンク接続を一覧表示する
Atlas Administration APIは、指定されたプロジェクト内の Atlas Stream Processing 用に構成されたすべての Private Link 接続を表示するためのエンドポイントを提供します。
1 つのプライベート リンク接続を表示
Atlas Administration APIは、指定されたプロジェクト内の Atlas Stream Processing 用に構成された 1 つの Private Link 接続の詳細を表示するためのエンドポイントを提供します。
プライベートリンク接続の作成
Atlas Stream Processing は現在、 AWSでホストされているAzureと Confluent クラスターへの Private Link 接続の作成をサポートしています。
Atlas Stream Processingプロジェクトで使用する Private Link 接続 を作成するには、次の手順に従います。
重要
Confluent クラスターを構成します。
Atlasプロジェクトからの着信接続を受け入れるように Confluent クラスターを構成する必要があります。
重要
Confluent はAWSからの着信接続のみを受け入れます。 Confluent Private Link 接続を使用するには、ストリーム処理インスタンスをAWSでホストする必要があります。
グループとリージョンの Atlas Administration APIエンドポイントの Return Account IDとVPC IDを呼び出します。
awsAccountId
の値に注目してください。これは後の手順で必要になります。Confluent アカウントで、接続するクラスターに移動します。クラスター ネットワーク インターフェースで、クラスター ネットワークの詳細に移動します。
Confluent専有クラスターの場合は、選択した名前を指定します。 AWSアカウント番号には、前述の
awsAccountId
フィールドの値を指定します。注意
この手順は、Confluent サーバーレス クラスターでは必要ありません。
クラウドプロバイダーへの接続をリクエストします。
Atlas Administration APIは、Atlas Stream Processing 用に構成された Private Link 接続をリクエストするためのエンドポイントを提供します。
AWS Private Link 接続の場合、次のキーと値のペアを設定する必要があります。
キー | 値 |
---|---|
| Confluent クラスターの VPC Endpoint service name 。 |
| Confluent クラスター上のブートストラップサーバーの完全修飾ドメイン名。 |
| クラスターがサブドメインを使用しない場合は、これを空の配列 |
これらの値は、Confluent クラスターのネットワークの詳細で確認できます。
次の例のコマンドは、Confluent クラスターへの接続をリクエストし、一般的な応答を示しています。
curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/privateLinkConnections' \ --digest \ --user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \ --header 'Content-Type: application/json' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --data '{ "vendor": "Confluent", "provider": "AWS", "region": "us_east_1", "serviceEndpointId": "com.amazonaws.vpce.us-east-1.vpce-svc-93da685022ee702a9", "dnsDomain": "sample.us-east-1.aws.confluent.cloud", "dnsSubDomain: [ "use1-az1.sample.us-east-1.aws.confluent.cloud", "use1-az2.sample.us-east-1.aws.confluent.cloud", "use1-az4.sample.us-east-1.aws.confluent.cloud" ] }'
{"_id":"6aa12e7ccd660d4b2380b1c1","dnsDomain":"sample.us-east-1.aws.confluent.cloud.","vendor":"Confluent","provider":"AWS","region":"us_east_1","serviceEndpointId":"com.amazonaws.vpce.us-east-1.vpce-svc-93da685022ee702a9"}
リクエストを送信した後、レスポンス本文の _id
フィールドの値に注意します。これは後の手順で必要になります。
Confluent にインターフェイスエンドポイントIDを指定します。
注意
この手順は、Confluent サーバーレス クラスターにのみ適用されます。
すべてのプライベートリンク接続を返す エンドポイントを呼び出します。interfaceEndpointId
の値に注目してください。
Confluent アカウントで、接続するクラスターに移動します。クラスター ネットワーク インターフェースで、クラスター ネットワークの詳細に移動します。アクセス ポイント インターフェイスに移動し、新しい アクセス点を追加します。 Confluent からインターフェイスエンドポイントの入力を求められたら、以前にメモした interfaceEndpointId
の値を指定します。
Atlas 側の接続を作成します。
キー | 値 |
---|---|
| クラウドプロバイダーのKafkaブートストラップサーバーのIPアドレス。 |
|
|
|
|
| Confluent APIキーに関連付けられたパスワード |
| Confluent APIキーに関連付けられたユーザー名 |
|
|
|
|
|
|
必要に応じて、他のすべての値を設定します。
次の例のコマンドは、Atlas でApache Kafka接続を作成します。
curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/spinstance/connections' \ --digest \ --user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \ --header 'Content-Type: application/json' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --data '{ "name": "confluent_demo", "bootstrapServers": "slr-ntgrbn.sample.us-east-1.aws.confluent.cloud:9092", "security": { "protocol": "SASL_SSL" }, "authentication": { "mechanism": "PLAIN", "password": "apiSecretDemo", "username": "apiUserDemo" }, "type": "Kafka", "networking": { "access": { "type": "PRIVATE_LINK", "connectionId": "38972b0cbe9c2aa40a30a246" } } }'
クラウドプロバイダーへの接続をリクエストします。
Atlas Administration APIは、Atlas Stream Processing 用に構成された Private Link 接続をリクエストするためのエンドポイントを提供します。
Azure Private Link 接続の場合は、次のキーと値のペアを設定する必要があります。
キー | 値 |
---|---|
| |
|
curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/privateLinkConnections' \ --digest \ --user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \ --header 'Content-Type: application/json' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --data '{ "provider": "AZURE", "region": "US_EAST_2", "serviceEndpointId": "/subscriptions/b82d6aa0-0b0a-ffa3-7c22-e167dc44f5b0/resourceGroups/asp/providers/Microsoft.EventHub/namespaces/sample", "dnsDomain": "sample.servicebus.windows.net" }'
{"_id":"6aa12e7ccd660d4b2380b1c1","dnsDomain":"sample.servicebus.windows.net","provider":"AZURE","region":"US_EAST_2","serviceEndpointId":"/subscriptions/b82d6aa0-0b0a-ffa3-7c22-e167dc44f5b0/resourceGroups/asp/providers/Microsoft.EventHub/namespaces/sample"}
リクエストを送信した後、レスポンス本文の _id
フィールドの値に注意します。これは後の手順で必要になります。
クラウドプロバイダーのアカウント内で要求された接続を受け入れます。
Azureへの Private Link 接続には、 Event Hub ネットワーク ページに移動し、Private endpoint connections タブを選択します。接続のテーブルで、新しくリクエストされた接続を識別し、承認します。
Atlas 側の接続を作成します。
キー | 値 |
---|---|
| クラウドプロバイダーのKafkaブートストラップサーバーのIPアドレス。 |
|
|
|
|
| |
|
|
|
|
|
|
|
|
必要に応じて、他のすべての値を設定します。
次の例のコマンドは、Atlas でApache Kafka接続を作成します。
curl --location 'https://cloud.mongodb.com/api/atlas/v2/groups/8358217d3abb5c76c3434648/streams/spinstance/connections' \ --digest \ --user "slrntglrbn:933fb118-ac62-4991-db05-ee67a3481fde" \ --header 'Content-Type: application/json' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --data '{ "name": "eventhubpl33333", "bootstrapServers": "sample.servicebus.windows.net:9093", "security": { "protocol": "SASL_SSL" }, "authentication": { "mechanism": "PLAIN", "password": "Endpoint=sb://sample.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=Irlo3OoRkc27T3ZoGOlbhEOqXQRXzb12+Q2hNXm0lc=", "username": "$ConnectionString" }, "type": "Kafka", "networking": { "access": { "type": "PRIVATE_LINK", "connectionId": "38972b0cbe9c2aa40a30a246" } } }'
プライベート リンク接続の削除
Atlas Administration APIは、指定されたプロジェクト内で Atlas Stream Processing 用に構成された Private Link 接続を削除するためのエンドポイントを提供します。