Confluence
Confluence コネクタを使用すると、Confluence に対して挿入、削除、更新、読み取りのオペレーションを実行できます。
始める前に
Confluence コネクタを使用する前に、次の作業を行います。
- Google Cloud プロジェクトで次の操作を行います。
- ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。
- 次のサービスを有効にします。
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。
コネクタを構成する
コネクタを構成するには、データソース(バックエンド システム)への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [+ 新規作成] をクリックして [接続の作成] ページを開きます。
- [ロケーション] セクションで、接続のロケーションを選択します。
- リージョン: プルダウン リストからロケーションを選択します
サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
- [NEXT] をクリックします。
- リージョン: プルダウン リストからロケーションを選択します
- [接続の詳細] セクションで、次の操作を行います。
- コネクタ: 使用可能なコネクタのプルダウン リストから [Confluence] を選択します。
- コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
- [接続名] フィールドに、接続インスタンスの名前を入力します。
接続名は次の条件を満たす必要があります。
- 接続名には英字、数字、ハイフンを使用できます。
- 文字は小文字のみを使用できます。
- 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
- 接続名は 49 文字以内で指定してください。
- 必要に応じて、接続インスタンスの [説明] を入力します。
- 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
- サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
- 必要に応じて、[アーカイブ済みのスペースを含める] を選択して、アーカイブ済みのスペースのコンテンツを結果に含めます。デフォルト値は false です。
- 必要に応じて、検索するスペースキーを入力して、その特定のスペースのコンテンツのみを表示します。
- 必要に応じて、接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
ノードは、トランザクションを処理する接続の単位(またはレプリカ)です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され(可用性を高めるため)、最大ノード数は 50 に設定されます。
- 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
- [NEXT] をクリックします。
- [宛先] セクションに、接続するリモートホスト(バックエンド システム)の詳細を入力します。
- 宛先の種類: 宛先の種類を選択します。
- リストから [ホストアドレス] を選択し、宛先のホスト名または IP アドレスを指定します。
- バックエンド システムへのプライベート接続を確立する場合は、リストからエンドポイント アタッチメントを選択し、次にエンドポイント アタッチメントリストから必要なエンドポイント アタッチメントを選択します。
セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォール ルールを構成します。
他の宛先を入力するには、[+ 宛先を追加] をクリックします。
- [NEXT] をクリックします。
- 宛先の種類: 宛先の種類を選択します。
-
[認証] セクションで、認証の詳細を入力します。
- [認証タイプ] を選択し、関連する詳細を入力します。
Confluence コネクタでサポートされる認証タイプは次のとおりです。
- 基本
- APIToken
- OAuth2.0
- [NEXT] をクリックします。
これらの認証タイプの構成方法については、認証を構成するをご覧ください。
- [認証タイプ] を選択し、関連する詳細を入力します。
- Review: 接続と認証の詳細を確認します。
- [作成] をクリックします。
認証を構成する
使用する認証に基づいて詳細を入力します。
-
ベーシック
- ユーザー名: 認証に使用される Confluence ユーザー アカウント。
- パスワード: アカウントに関連付けられたパスワード。
-
APIToken
- ユーザー名: API トークンの作成に使用した Confluence のユーザー名。
- API トークン: ユーザー名のパスワードは API トークンです。Confluence ユーザー名に関連付けられた API トークンを含む Secret Manager のシークレットを選択します。
-
OAuth 2.0 - 認証コード
- クライアント ID: 外部アプリケーションによって提供されるクライアント ID。
- スコープ: 権限スコープ。
offline_access
スコープは、Confluence コネクタで使用する必要があります。Confluence スコープの詳細については、Confluence スコープをご覧ください。 - クライアント シークレット: Secret Manager のシークレットを選択します。 この認証を構成する前に、Secret Manager のシークレットを作成しておく必要があります。
- シークレットのバージョン: クライアント シークレットの Secret Manager シークレットのバージョン。
Authorization code
認証タイプの場合は、接続を作成した後、認証を構成するためにいくつかの追加手順を行う必要があります。詳しくは、接続作成後の追加手順をご覧ください。
接続作成後の追加手順
認証に OAuth 2.0 - Authorization code
を選択した場合は、接続の作成後に次の追加の手順を行う必要があります。
- 接続ページで、新しく作成された接続を見つけます。
新しいコネクタの [ステータス] は [承認が必要] になります。
- [承認が必要] をクリックします。
これにより、[承認の編集] ペインが表示されます。
- [リダイレクト URI] の値を外部アプリケーションにコピーします。
- 認可の詳細を確認します。
- [Authorize(承認)] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。
認証コードの再認可
Authorization code
認証タイプを使用しているユーザーが、Confluence アプリケーションの構成を変更した場合は、Confluence 接続を再認可する必要があります。接続を再認可するには、次の手順を行います。
- [接続] ページで必要な接続をクリックします。
これにより、[接続の詳細] ページが開きます。
- [編集] をクリックして、接続の詳細を編集します。
- [認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。
必要に応じて必要な変更を加えます。
- [保存] をクリックします。接続の詳細ページに移動します。
- [認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
- [Authorize(承認)] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。
システムの上限
Confluence コネクタは、ノードごとに 1 秒あたり 28 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます(可用性を高めるため)。
Integration Connectors に適用される上限の詳細については、上限をご覧ください。
統合で Confluence 接続を使用する
接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、Connectors タスクを介して統合で使用できます。
- Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
- Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
エンティティ、オペレーション、アクション
すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。
- エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、
Entities
リストは空になります。 - オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは
Operations
リストに含まれません。 - アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、
Actions
リストが空になります。
アクション
Confluence コネクタには、DownloadAttachment や UploadAttachment などのアクションが用意されています。アクションの構成方法については、アクションの例をご覧ください。
アクションの例
このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。
例 - 添付ファイルをダウンロードする
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DownloadAttachment
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "AttachmentId": "xyz" }
エンティティ オペレーションの例
例 - すべてのリクエストを一覧表示する
この例では、Requests
エンティティ内のすべてのリクエストを一覧表示します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
リストから [リクエスト] を選択します。- [
LIST
] オペレーションを選択してから、[完了] をクリックします。
例 - 特定のアカウント ID からユーザーを取得する
この例では、Users
エンティティから AccoundId が 6035864ce2020c0070b5285b のユーザーを取得します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUsers
を選択します。- [
LIST
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで [filterClause] をクリックしてから、[デフォルト値] フィールドに「
AccountId=6035864ce2020c0070b5285b
」と入力します。ここで、
AccountId
はUsers
エンティティの主キー値です。
例 - ページを一覧表示する
この例では、Pages
エンティティのページを一覧表示します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPages
を選択します。- [
LIST
] オペレーションを選択してから、[完了] をクリックします。
例 - ページを取得する
この例では、Pages
エンティティからページレコードを取得します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPages
を選択します。- [
GET
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに
123
を入力します。ここで、
123
はリソースPages
エンティティ固有識別子です。
例 - ページを作成する
この例では、Pages
エンティティにページレコードを作成します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPages
を選択します。- [
CREATE
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "SpaceId": "12345", "Status": "Current", "Title": "FROM XYZ", "Storage": "XYZ1234" }
Example - Update Pages
This example updates a page record in the Pages
entity.
- In the
Configure connector task
dialog, clickEntities
. - Select
Pages
from theEntity
list. - Select the
UPDATE
operation, and then click Done. - In the Task Input section of the Connectors task, click
connectorInputPayload
and then enter a value similar to the following in theDefault Value
field:{ "Title": "Update abc" }
- [コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに
12345
を入力します。
統合が成功すると、コネクタタスクの connectorOutputPayload
フィールドに update オペレーションのレスポンスが返されます。
{ "Id": 1234 }
例 - ページを削除する
この例では、Pages
エンティティからページを削除します。
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPages
を選択します。- [
DELETE
] オペレーションを選択してから、[完了] をクリックします。 - [コネクタタスクの [タスク入力] セクションの [entityId] をクリックし、[デフォルト値] フィールドに
123
を入力します。または、エンティティに複合主キーがある場合、entityId を指定する代わりに、filterClause を設定できます。例:
Id='123'
Terraform を使用して接続を作成する
Terraform リソースを使用して、新しい接続を作成できます。Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。
接続作成用の Terraform テンプレートのサンプルを表示するには、サンプル テンプレートをご覧ください。
Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
proxy_enabled | BOOLEAN | False | 接続用のプロキシ サーバーを構成するには、このチェックボックスをオンにします。 |
proxy_auth_scheme | ENUM | False | ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。 |
proxy_user | STRING | False | ProxyServer プロキシへの認証に使用されるユーザー名です。 |
proxy_password | SECRET | False | ProxyServer プロキシの認証に使用されるパスワード。 |
proxy_ssltype | ENUM | False | ProxyServer プロキシへの接続時に使用する SSL のタイプです。サポートされている値は AUTO、ALWAYS、NEVER、TUNNEL です。 |
Google Cloud コミュニティの助けを借りる
Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。次のステップ
- 接続を一時停止して再開する方法を確認する。
- コネクタの使用状況をモニタリングする方法を確認する。
- コネクタログを表示する方法を確認する。