Jira Cloud

Jira Cloud コネクタを使用すると、データベースとしてモデル化された Jira データに対して、挿入、削除、更新、読み取りオペレーションを実行できます。

サポート対象のバージョン

Jira Cloud コネクタは、JIRA Cloud REST API のバージョン 2 と 3 を使用します。これらは内部で管理されるため、追加の構成は必要ありません。

始める前に

Jira Cloud コネクタを使用する前に、次の作業を行います。

Google Cloud プロジェクトで次の操作を行います。
- コネクタを構成するユーザーに 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 プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [NEXT] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [Jira Cloud] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
  - イベントサブスクリプションをサポートするコネクタの場合、接続名の先頭に接頭辞「goog」は使用できません。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. イベントサブスクリプションの接続を使用するには、[イベントサブスクリプションを有効にする] を選択します。これを選択すると、次のオプションが表示されます。
  - エンティティとアクションを使用したイベントサブスクリプションを有効にする: このオプションを選択すると、イベントサブスクリプションとコネクタオペレーション（エンティティとアクション）の両方に対して接続が使用されます。
  - イベントサブスクリプションのみを有効にする: イベントサブスクリプションに対してのみ接続を使用するには、このオプションを選択します。このオプションを選択した場合は、[次へ] をクリックして、イベントサブスクリプションを構成します。
8. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
9. プロキシを使用: このチェックボックスを選択して、接続用のプロキシサーバーを構成し、次の値を構成します。
10. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
11. [NEXT] をクリックします。
[宛先] セクションに、接続するリモートホスト（バックエンドシステム）の詳細を入力します。
1. Destination Type: 宛先の種類を選択します。
  - ホストアドレス: 宛先のホスト名または IP アドレスを指定します。
    注: ホスト名を指定する場合は、プロトコル（HTTP または HTTPS）とともに URL を指定する必要があります。
    
    バックエンドへのプライベート接続を確立する場合は、次のようにします。
    - PSC サービスアタッチメントを作成します。
    - エンドポイントアタッチメントを作成し、続いて [Host address] フィールドにあるエンドポイントアタッチメントの詳細を入力します。
  他の宛先を入力するには、[+ 宛先を追加] をクリックします。
2. [NEXT] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  Jira Cloud 接続でサポートされる認証タイプは、次のとおりです。
  - ユーザー名とパスワードを指定する
2. [NEXT] をクリックします。
イベントサブスクリプションを有効にしている場合は、接続作成ページに [イベントサブスクリプションの詳細] セクションが表示されます。イベントサブスクリプションの詳細の構成方法については、イベントサブスクリプションを構成するをご覧ください。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

イベントサブスクリプションを構成する

イベントサブスクリプションを有効にしている場合は、[イベントサブスクリプションの詳細] セクションに次の値を入力します。

[宛先の種類] を選択します。
- ホストアドレス: [ホスト] フィールドにバックエンドシステムの登録 URL を入力します。
認証の詳細を入力します。
1. ユーザー名: ユーザー名を入力します。
2. API トークン: API トークンを含む Secret Manager の Secret を選択します。
3. Secret のバージョン: Secret のバージョンを選択します。
バックエンドアプリケーションと接続間を安全に接続するには、[プライベート接続を有効にする] を選択します。このオプションを選択した場合は、接続の作成後に追加の構成手順を実行する必要があります。詳細については、イベントサブスクリプションのプライベート接続をご覧ください。
デッドレター構成を入力します。デッドレターを構成すると、指定された Pub/Sub トピックに未処理のイベントが書き込まれます。次の詳細情報を入力します。
1. デッドレタープロジェクト ID: デッドレター Pub/Sub トピックを構成した Google Cloud プロジェクト ID。
2. デッドレタートピック: 未処理イベントの詳細を書き込む Pub/Sub トピック。
プロキシを使用してバックエンドに接続する場合（イベントサブスクリプションの場合）は、次の詳細を入力します。

Proxy SSL Type: プロキシサーバーへの接続時に使用する SSL タイプ。次のいずれかの認証タイプを選択します。
- 常に: イベントサブスクリプションの接続は常に SSL 対応です。
- なし: イベントサブスクリプションの接続は SSL に対応していません。
Proxy Auth Scheme: プロキシサーバーで認証する認証タイプを選択します。次の認証タイプがサポートされています。
- 基本: 基本的な HTTP 認証。
Proxy User: プロキシサーバーでの認証に使用されるユーザー名を入力します。
Proxy Password: ユーザーのパスワードの Secret Manager シークレットを選択します。
Secret のバージョン: Secret のバージョンを選択します。
[Proxy Server] セクションで、プロキシサーバーの詳細を入力します。
1. [+ 宛先を追加] をクリックし、[宛先タイプ] を [ホストアドレス] として選択します。
2. プロキシサーバーのホスト名または IP アドレスと、プロキシサーバーのポート番号を入力します。

認証を構成する

使用する認証に基づいて詳細を入力します。

ユーザー名とパスワード
- ユーザー名: 接続に使用する Jira Cloud ユーザー名。
- API トークン: ユーザー名のパスワードが API トークンになります。Jira Cloud ユーザー名に関連付けられた API トークンを含む Secret Manager の Secret を選択します。
OAuth 2.0 - 認証コード

クライアント ID: 外部アプリケーションによって提供されるクライアント ID。
スコープ: 権限スコープ。 offline_access スコープは、Jira Cloud コネクタで使用する必要があります。スコープの仕組みと Jira Cloud で利用可能なすべてのスコープを確認するには、スコープをご覧ください。
クライアントシークレット: Secret Manager のシークレットを選択します。この認証を構成する前に、Secret Manager のシークレットを作成しておく必要があります。
シークレットのバージョン: クライアントシークレットの Secret Manager シークレットのバージョン。

Authorization code 認証タイプの場合は、接続を作成した後、認証を構成するためにいくつかの追加手順を行う必要があります。詳しくは、接続作成後の追加手順をご覧ください。

注: Authorization code 認証タイプを使用しているユーザーが、Jira Cloud アプリケーションの構成を変更した場合は、Jira Cloud 接続を再認可する必要があります。再認可する方法については、認証コードの再認可をご覧ください。

接続作成後の追加手順

認証に OAuth 2.0 - Authorization code を選択した場合は、接続の作成後に次の追加の手順を行う必要があります。

接続ページで、新しく作成された接続を見つけます。
新しいコネクタの [ステータス] は [承認が必要] になります。
[承認が必要] をクリックします。
これにより、[承認の編集] ペインが表示されます。
[リダイレクト URI] の値を外部アプリケーションにコピーします。
認可の詳細を確認します。
[Authorize（承認）] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

認証コードの再認可

Authorization code 認証タイプを使用しているユーザーが、Jira Cloud アプリケーションの構成を変更した場合は、Jira Cloud 接続を再認可する必要があります。接続を再認可するには、次の手順を行います。

[接続] ページで必要な接続をクリックします。
これにより、[接続の詳細] ページが開きます。
[編集] をクリックして、接続の詳細を編集します。
[認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。
必要に応じて必要な変更を加えます。
[保存] をクリックします。接続の詳細ページに移動します。
[認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
[Authorize（承認）] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがいずれかのエンティティオペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。
アクション: コネクタインターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

Jira Cloud コネクタは、ノードごとに 1 秒あたり最大 10 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてthrottlesされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

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 です。

統合で Jira Cloud 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。