Openflow Connector for Jira Cloud を設定する

注釈

コネクタには、 コネクタ利用規約 が適用されます。

このトピックでは、 Openflow Connector for Jira Cloud を設定する手順について説明します。

前提条件

  1. Openflow Connector for Jira Cloud について を確認してください。

  2. Openflowを設定した ことを確認します。

認証情報を取得する

Jira Cloud管理者として、Atlassianアカウントで以下のタスクを実行します。

  1. API トークンページ に移動します。

  2. Create API token with scopes を選択します。

  3. Create an API token ダイアログボックスで、 API トークンに説明的な名前を指定し、 API トークンの有効期限を選択します。1日から365日までの範囲になります。

  4. Api token app Jira を選択します。

  5. jiraスコープの read:jira-work および read:jira-user を選択します。

  6. Create token を選択します。

  7. Copy your API token ダイアログボックスで、 Copy を選択して、生成した API トークンをコピーし、そのトークンをコネクタパラメーターに貼り付けるか、安全に保存します。

  8. Close を選択してダイアログボックスを閉じます。

Snowflakeアカウントを設定する

Snowflakeアカウント管理者として、以下のタスクを実行します。

  1. 新しいロールを作成するか、既存のロールを使用します。

  2. タイプを SERVICE として、新しいSnowflakeサービスユーザーを作成します。

  3. Snowflakeサービスユーザーに、前の手順で作成したロールを付与します。

  4. ステップ2のSnowflake SERVICE ユーザーを key-pair auth で構成します。

  5. Snowflakeではこの手順を強く推奨します。Openflowがサポートするシークレットマネージャ(AWS、Azure、Hashicorpなど)を構成し、公開キーと秘密キーを秘密ストアに格納します。

    注釈

    何らかの理由でシークレットマネージャを使用したくない場合は、組織のセキュリティポリシーに従って、キーペア認証に使用する公開キーと秘密キーファイルを保護する責任があります。

    1. シークレットマネージャを構成したら、その認証方法を決定します。AWS 上では、Openflowに関連付けられた EC2 インスタンスロールが推奨されます。こうすることで、他の秘密を永続化する必要がなくなるからです。

    2. Openflowで、右上のハンバーガーメニューから、このシークレットマネージャに関連付けられたParameter Providerを構成します。 Controller Settings » Parameter Provider に移動し、パラメーターの値をフェッチします。

    3. この時点で、すべての認証情報を関連するパラメーターパスで参照することができるため、機密性の高い値をOpenflow内で永続化する必要はありません。

  6. 他のSnowflakeユーザーが、コネクタによって取り込まれた生の取り込みドキュメントやとテーブルへのアクセスを必要とする場合は(Snowflakeでのカスタム処理のためなど)、それらのユーザーにステップ1で作成したロールを付与します。

  7. 取り込んだデータを格納するコネクタ用に、Snowflakeでデータベースとスキーマを作成します。最初のステップで作成したロールに以下の データベース権限 を付与します。

    CREATE DATABASE jira_destination_db;
    CREATE SCHEMA jira_destination_db.jira_destination_schema;
    GRANT USAGE ON DATABASE jira_destination_db TO ROLE <jira_connector_role>;
    GRANT USAGE ON SCHEMA jira_destination_db.jira_destination_schema TO ROLE <jira_connector_role>;
    GRANT CREATE TABLE ON SCHEMA jira_destination_db.jira_destination_schema TO ROLE <jira_connector_role>;
    
    Copy
  8. コネクタで使用するウェアハウスを作成するか、既存のウェアハウスを使用します。まずは最小のウェアハウスサイズから始め、複製するテーブルの数や転送するデータ量に応じて異なるサイズを試してみてください。テーブル数が大きい場合は、通常、ウェアハウスのサイズを大きくするよりも、 マルチクラスターウェアハウス を使用した方がスケーリングが向上します。

  9. コネクタで使用するロールを持つユーザーが、ウェアハウスを使用するために必要な権限を持っていることを確認します。権限がない場合は、ロールに必要な権限を付与してください。

    CREATE WAREHOUSE jira_connector_warehouse WITH WAREHOUSE_SIZE = 'X-Small';
    GRANT USAGE ON WAREHOUSE jira_connector_warehouse TO ROLE <jira_connector_role>;
    
    Copy

コネクタを設定する

データエンジニアとして、以下のタスクを実行してコネクタをインストールおよび構成します。

コネクタをインストールする

  1. Openflowの概要ページに移動します。 Featured connectors セクションで、 View more connectors を選択します。

  2. Openflowのコネクタページでコネクタを探し、 Add to runtime を選択します。

  3. Select runtime ダイアログで、 Available runtimes ドロップダウンリストからランタイムを選択します。

  4. Add を選択します。

    注釈

    コネクタをインストールする前に、コネクタが取り込んだデータを格納するためのデータベースとスキーマをSnowflakeで作成したことを確認します。

  5. Snowflakeアカウント認証情報でデプロイメントを認証し、Snowflakeアカウントへのランタイムアプリケーションのアクセスを許可するよう求められたられたら、 Allow を選択します。コネクタのインストールプロセスは数分で完了します。

  6. Snowflakeアカウント認証情報でランタイムを認証します。

コネクタプロセスグループが追加されたOpenflowキャンバスが表示されます。

コネクタを構成する

  1. インポートしたプロセスグループを右クリックし、 Parameters を選択します。

  2. フローパラメーター の説明に従って、必要なパラメーター値を入力します。

フローパラメーター

このセクションでは、以下のパラメーターコンテキストに基づいて構成できるフローパラメーターについて説明します。

Jira Cloudソースパラメーター

パラメーター

説明

認証方法

Jira Cloud API の認証方法。デフォルト値: BASIC

Jira Eメール

Atlassianアカウントのメールアドレス。認証方法が BASIC の場合のみ表示されます。

Jira API トークン

Atlassianアカウントの API アクセストークン。認証方法が BASIC の場合のみ表示されます。

環境 URL

URL からAtlassian Jira環境へ

Jira Cloud宛先パラメーター

パラメーター

説明

宛先データベース

データが永続化されるデータベース。既にSnowflakeに存在している必要があります。

宛先スキーマ

データが永続化されるスキーマ。既にSnowflakeに存在している必要があります。

Snowflakeアカウント識別子

データが永続化されるSnowflakeアカウント名(形式: [organization-name]- [account-name])。

Snowflake認証ストラテジー

Snowflakeへの認証のストラテジー。可能な値: SPCS でフローを実行している場合は SNOWFLAKE_SESSION_TOKEN、秘密キーを使用してアクセスを設定する場合は KEY_PAIR

Snowflake秘密キー

認証に使用される RSA 秘密キー。RSA キーは、 PKCS8 標準に従って書式設定され、標準的な PEM ヘッダーとフッターを持つ必要があります。Snowflake秘密キーファイルまたはSnowflake秘密キーのいずれかを定義する必要があることに注意してください。

Snowflake秘密キーファイル

Snowflakeへの認証に使用される RSA 秘密キーを含むファイル。 PKCS8 標準に従って書式設定され、標準的な PEM ヘッダーとフッターを持ちます。ヘッダー行は -----BEGIN PRIVATE で始まります。 Reference asset チェックボックスを選択し、秘密キーファイルをアップロードします。

Snowflake秘密キーパスワード

Snowflake秘密キーファイルに関連付けられたパスワード

Snowflakeロール

クエリ実行時に使用されるSnowflakeロール

Snowflakeのユーザー名

Snowflakeインスタンスへの接続に使用するユーザー名

Snowflakeウェアハウス

クエリの実行に使用されるSnowflakeウェアハウス

Jira Cloud取り込みパラメーター

パラメーター

説明

検索タイプ

実行する検索のタイプ。可能な値の SIMPLE および JQL のいずれかです。デフォルト値: SIMPLE

JQL クエリ

JQL クエリ。これは、検索タイプが JQL の場合にのみ使用してください。

プロジェクト名

プロジェクト名、プロジェクトキー、またはプロジェクト ID によって、特定のプロジェクトに属する課題を検索できます。これは、検索タイプが SIMPLE の場合にのみ使用してください。

ステータスカテゴリ

ステータスカテゴリフィルターによる簡易検索。これは、検索タイプが SIMPLE の場合にのみ使用してください。値の例は次のようになります: DoneIn ProgressTo Do

更新後

指定した日時以降に更新された課題をフィルターします。これは、検索タイプが SIMPLE の場合にのみ使用してください。2023-10-01のように、yyyy-MM-dd形式でなければなりません。

作成後

指定した日時以降に作成された課題をフィルターします。これは、検索タイプが SIMPLE の場合にのみ使用してください。2023-10-01のように、yyyy-MM-dd形式でなければなりません。

課題フィールド

各課題に対して返されるフィールドのリストで、フィールドのサブセットを取得するために使用します。このパラメーターはコンマ区切りリストを受け入れます。デフォルト値: all

最大ページサイズ

ページごとに返す項目の最大数。デフォルト値: 200

フローを実行する

  1. プレーンを右クリックし、 Enable all Controller Services を選択します。

  2. インポートしたプロセスグループを右クリックし、 Start を選択します。コネクタがデータの取り込みを開始します。

課題のクエリの条件を変更する必要がある場合、または取り込みを最初からやり直す場合は、以下の手順を実行して宛先テーブルのデータに一貫性があることを確認します。

  1. FetchJiraIssues プロセッサーを右クリックして停止します。

  2. FetchJiraIssues プロセッサーを右クリックし、 View State を選択します。

  3. State ダイアログボックスで、 Clear State を選択します。このアクションはプロセッサーの状態をクリアし、すべての課題を再度フェッチできるようにします。

  4. オプション: 課題のクエリの条件を変更する場合は、インポートしたプロセスグループを右クリックし、 Parameters を選択します。必要に応じてパラメーターを更新します。

  5. オプション: 宛先テーブル名を変更したい場合は、インポートしたプロセスグループを右クリックし、 Parameters を選択します。宛先テーブル パラメーターを更新します。

  6. FetchJiraIssues プロセッサーを右クリックし、 Start を選択します。コネクタがデータの取り込みを開始します。