Confluence と Jira の連携

はじめに

このページでは、Confluence と Jira を同時に利用する場合のおすすめの運用方法をご紹介します。

ご注意ください

ここで紹介している手順を実行するには、Confluence と Jira のそれぞれについて管理者権限が必要です。

Confluence で行う手順は「(青い星)  以下の手順は Confluence で実施します。 」、Jira で行う手順は「(赤い星)  以下の手順は Jira で実施します。 」と表記しています。

ご参考

このドキュメントでは、データベースとして PostgreSQL を使用しています。別のデータベースをご使用の場合は、適宜読み替えてください。

ユーザー管理の一元化

Confluence と Jira を連携して利用するときに、ユーザー管理を Jira にまとめることができます。
これにより、以下のメリットがあります。

  • Confluence と Jira のそれぞれに同じユーザーやグループを作る必要がなくなります。
  • ユーザーやグループの二重管理の手間を省き、登録漏れ、削除漏れなどの作業ミスを防ぐことができます。
  • Confluence 側から Jira に登録されたユーザーやグループに対して各種権限を設定できます。
  • ユーザーは、Confluence と Jira で共通のユーザー名とパスワードを使用できます。

設定手順

Confluence と Jira を連携させるには、以下の二通りの方法があります。

(1) セットアップウィザードで連携させるすでに Jira をお使いの環境に、追加で Confluence をインストールするときにおすすめの方法です。
(2) 設定画面から連携させるあとから Jira をインストールしたとき、または既存の Jira と Confluence を連携させるときの方法です。

設定する前の準備

連携の設定は Confluence 側から行います。はじめに、設定で使用する連携先の Jira のベース URL を確認しておきます。

(赤い星)  以下の手順は Jira で実施します。

Jira の設定を確認する

Jira の画面を開き、右上にある歯車アイコンから管理画面を開きます。管理画面では「システム」の「一般設定」を開きます。
画面に表示される「ベース URL」の内容を控えておいてください。

(1) セットアップウィザードで連携させる方法

すでに Jira をお使いの環境に Confluence を追加でインストールするときに利用できる方法です。
こちらの手順を参考に Confluence をインストールしたあと、セットアップウィザードで連携設定を行います。

(青い星)  以下の手順は Confluence で実施します。

1. Confluence セットアップウィザードの開始

Confluence をインストールしサービスを開始したあとで、Webブラウザから 「http://Confluenceサーバー:8090/wiki/」 にアクセスします。

画面右上のドロップダウンリストから「日本語」をクリックします。


画面が日本語に切り替わります。「プロダクション版のインストール」を選択し、「次へ」をクリックします。


Confluence のみインストールする場合は、そのまま「次へ」をクリックします。

同時に Confluence Questions 等のアプリをインストールしたい場合は、該当の項目を選択し「次へ」をクリックします。


弊社からメール送付されたライセンスキーをコピー&ペーストして 「次へ」をクリックします。


Confluence のデータを格納するためのデータベースを選択します。
商用環境の場合は「ご自分のデータベース」を選択して外部データベースと接続します。 「次へ」をクリックします。

内蔵 (評価用またはデモ用) を選択した場合にインストールされる H2 データベースは、商用環境ではサポートされていません。


データベース接続パラメータの例 

項目

データベースタイプ

PostgreSQL

設定タイプシンプル

ホスト名

127.0.0.1

ポート

5432

データベース

confluence (データベース作成時に指定したデータベース名)

ユーザー名

confluence (データベース作成時に指定したユーザー名)

パスワード

(データベース作成時に指定したパスワード)


指定できたら「テスト接続」をクリックします。 無事接続されたら「次へ」をクリックします。
データベースをセットアップするため、少し時間がかかることがあります。


以下のいずれかを選択し、それぞれのボタンをクリックしてください。今回は、「空のサイト」を選択します。

  • サンプル サイト …… サンプルのサイトで、素敵なサイトですが、英語となります。一度これを選択して、後からスペースを消すこともできます。
  • 空のサイト …… 空の Confluence ができます。通常はこちらを選択するのがお勧めです。
  • バックアップから復元 …… Confluence のバックアップでデータを復元する場合に選択します。


ユーザ管理方法を選択します。今回は Jira でユーザー管理を行いたいので「Jira に接続」ボタンをクリックします。

ご参考

Confluence 内蔵のユーザーディレクトリでユーザー管理を行うとき、または LDAP サーバー、Crowd サーバーを使ってユーザー管理を行う計画があるときは、「Confluence のユーザーとグループの管理」ボタンをクリックします。Crowd サーバーでユーザー管理を行う方法については、こちらのドキュメントを参考にしてください。


ユーザー管理を行なっている Jira に接続するための情報を設定します。
Jira サーバーの場所 の「Jira ベース URL」には、設定する前の準備として控えておいた Jira のベース URL を入力します。
Jira 管理者 ログイン の「ユーザー名」と「パスワード」には、管理者権限を持つユーザーのユーザー名とパスワードを入力します。 
入力できたら「次へ」ボタンをクリックしてください。 


入力したベース URL とユーザー名、パスワードを使用し、Jira からユーザーとグループの情報を読み込みます。Jira に設定されているユーザーとグループの数によっては、作業に時間がかかることがありますので、しばらくお待ちください。

正常終了すると「ローカル管理者アカウントを作成しました。」というメッセージが表示されます。
メッセージを確認したら「次へ」ボタンをクリックします。 


以下の画面が表示されたらセットアップウィザードは完了です。
すぐに Confluence を起動するときは、「開始」のボタンをクリックします。 

以降は、通常のインストール手順に従って作業します。ここからは、Confluence のインストール手順書の「Confluence の日本語化」をご覧ください。
また、管理者ユーザーのユーザー名とパスワードは、Jira の管理者ユーザーと同じものを使ってください。

(2) インストール後に連携させる方法

 すでに Confluence が稼働している環境に Jira をインストールしたとき、または連携していない Confluence と Jira が存在しているときに、連携させる手順を紹介します。

1.Jira 側の設定

最初に Jira 側で Confluence からの接続を受け付けるための設定を行います。

(赤い星)  以下の手順は Jira で実施します。

アプリケーションの構成画面を開く

Jira の管理画面を開き、「ユーザー管理」の「Jira ユーザーサーバー」を選択します。

「その他のアプリケーションの構成」画面が表示されるので、画面右上の「アプリケーションの追加」をクリックします。

「アプリケーションの追加」画面が表示されるので、接続もととなるアプリケーション (今回の場合は Confluence ) が使用する識別情報を指定します。

  • 「アプリケーション名」は、Confluence から Jira に接続するときに利用するIDになります。他のアプリケーションと区別できる名前を指定してください。
  • 「パスワード」は「アプリケーション名」と組み合わせて接続時の確認に使用します。
  • 「IP アドレス」には接続もとサーバーの IP アドレス (ポート番号は不要) を入力してください。

指定できたら「保存」ボタンをクリックします。


「その他のアプリケーションの構成」画面に戻ります。画面上部に「アプリケーション ~を作成しました」というメッセージが表示され、リストにアプリケーションが追加されていることを確認してください。

2.Confluence 側の設定

次に、Confluence から Jira に接続するための設定を行います。

(青い星)  以下の手順は Confluence で実施します。

ユーザーディレクトリを追加する

Confluence の管理画面を開き、「ユーザー&セキュリティ」の「ユーザーディレクトリ」を選択します。

「ユーザーディレクトリ」画面が開きます。ユーザーディレクトリとは、ユーザーを認証するために使用するデータベースです。Confluence は、既定では内部ユーザーディレクトリ (Confluence Internal Directory) を使用してユーザー認証を行います。
今回はユーザー管理を一元化するため、Jira のユーザーディレクトリを使ってユーザー認証できるように設定します。
リストの下に表示されている「ディレクトリの追加」ボタンをクリックします。


吹き出しが表示され、ドロップダウンリストでディレクトリタイプが選択できるようになります (ブラウザによっては、ドロップダウンリストの右側が切れて表示されることがあります) 。
選択肢から「Atlassian JIRA」を選び「次へ」ボタンをクリックします。 


「Atlassian JIRA サーバーを設定する」画面が表示されます。
画面の上の方にある「サーバーの設定」欄の各項目を入力します。

名前接続先のサーバーを識別するための名前です。接続先がわかるような名前をつけることをおすすめします。
サーバー URL

接続先のサーバーのURLです。接続先が Jira の場合は、管理画面の「一般設定」に表示されている「ベース URL」を入力します。

アプリケーション名Jira 側の設定でアプリケーションの追加時に指定したアプリケーション名を入力します。
アプリケーションのパスワードJira 側の設定でアプリケーションの追加時に指定したパスワードを入力します。

入力できたら、画面の下の方にある「設定のテスト」ボタンをクリックして、サーバーに接続できるかテストします。


テストが成功すると、「接続テストに成功しました。」というメッセージが表示され、「保存およびテスト」ボタンが使用できるようになります。
メッセージを確認したら「保存およびテスト」ボタンをクリックして設定を保存します。 

ユーザー情報を同期する

「ユーザーディレクトリ」画面に戻ります。リストに新しいディレクトリが追加されていることを確認してください。Jira はタイプ「Atlassian Crowd」として登録されます。
ディレクトリを追加した直後は、まだ Confluence と Jira の同期が取れていません。「同期」リンクをクリックして情報を同期させます。登録されているユーザーやグループが多い場合、同期には時間がかかることがあります。


同期を始めると、以下のように「同期中...」と表示されます。


同期が完了すると、以下のように同期完了時刻と所要時間、 正常終了メッセージが表示されます。

以上で連携のための設定は終了です。

3.Jira で管理されているグループ、ユーザーの権限設定

連携設定を行った直後は、Jira に登録されているユーザーには Confluence の操作権限は与えられていません。以下の手順を参考に権限設定を行なってください。

(青い星)  以下の手順は Confluence で実施します。

既定のスペース権限を設定する

まず「既定のスペース権限」を設定します。これは、新しいスペースが作成されたときにデフォルトの設定値として使用される権限のことです。
Confluence の管理画面で「ユーザー&セキュリティ」の「スペース権限」をクリックします。「既定のスペース権限」画面が表示されるので「権限の編集」ボタンをクリックします。 


権限の編集画面が表示されます。リスト下側の「Grant browse permission to」テキストボックスに Jira に登録されているグループ名を入力します。
「追加」ボタンの左側にある虫めがねアイコンをクリックすると、グループの検索画面を使用することもできます。 入力できたら、「追加」ボタンをクリックします。


下の画面のように、リストに Jira のグループが追加され表示権限のみが与えられた状態になります。その他の権限を付けたいときは、与えたい権限にチェックをいれてください。
設定できたら「保存」ボタンをクリックします。


指定した内容で登録されたことを確認してください。 

グローバル権限を設定する

スペースの作成権限などのグローバル権限は、Confluence 管理画面にある「ユーザー&セキュリティ」の「グローバル権限」で指定できます。画面の使い方は「既定のスペース権限」と同じです。

ただし、こちらの画面では個々のユーザーに対しても権限を設定できます。ここではグループに対して権限を設定する手順を紹介します。

リスト下側の「Grant browse permission to」テキストボックスに Jira に登録されているグループ名を入力します。「追加」ボタンの左側にある虫めがねアイコンをクリックすると、グループの検索画面を使用することもできます。 入力できたら、「追加」ボタンをクリックします。 


リストに Jira のグループが追加されるので、チェックボックスを操作して与えたい権限を指定します。
設定できたら「すべて保存」ボタンをクリックします。


指定した内容で登録されたことを確認してください。 

以上で権限の設定は終了です。

動作確認

連携設定が終わったら、Confluence でテストを行います。

(青い星)  以下の手順は Confluence で実施します。

Jira のユーザーでログインできるか確認する

まず、Jira の管理者ユーザーで Confluence にログインできることを確認します。Confluence のログイン画面で Jira 管理者ユーザーのユーザー名とパスワードを入力し、ログインできれば動作は正常です。その他のユーザーでもログインできるか試してみてください。

ログインできたら、Confluence に登録されている情報が参照できるか確認します。権限設定で割り当てた操作が実行できるかも試してみます。

ログインできない

Confluence 管理画面にある「ユーザー&セキュリティ」の「ユーザーディレクトリ」を開き、Jira のディレクトリが追加されていること、同期が完了していることを確認してください。

ページが表示できない、編集できない

Confluence 管理画面から「ユーザー&セキュリティ」の「グローバル権限」「スペース権限」を開き、適切な権限が設定されていることを確認してください。

Jira のユーザー情報にアクセスできるか確認する

次に、Confluence から Jira のユーザー情報にアクセスできることを確認します。

画面右上の歯車アイコンから Confluence 管理画面を開きます。

「ユーザー & セキュリティ」の「ユーザーディレクトリ」をクリックします。

ユーザーディレクトリの管理画面が開きます。
ディレクトリ名のリストに設定した Jira のディレクトリが表示されていることを確認し、操作欄の「テスト」をクリックします。 


接続テスト用の画面が表示されます。
ユーザー名とパスワードには、Jira 管理者ユーザーのユーザー名とパスワードを入力してください。
入力できたら「設定のテスト」 ボタンをクリックします。 


各テストが自動的に実行され、結果が表示されます。すべて「成功しました」と表示されていることを確認してください。
確認できたら「ディレクトリ一覧に戻る」のリンクをクリックしてテスト画面を終了します。

アプリケーションリンクで情報を参照

Confluence と Jiraにアプリケーションリンクを設定することで、Jira のプロジェクトと Confluence のスペースを関連付け、お互いの情報を参照できるようになります。

例えば、以下のようなことができるようになります。

  • Confluence のページに Jira の課題へのリンクを作成できます。
  • Jira の課題へのリンクに表示される情報は、課題のステータス変更にあわせて更新されます。
  • Jira の課題に Confluence のページへのリンクを作成できます。

ご注意ください

アプリケーションリンクで情報を参照できるように設定するときは、ユーザー管理の一元化も設定しておくことをおすすめします。
リンク先に移動するときのユーザー名とパスワードの入力を省略できます。

ご参考

ユーザー管理の一元化をしていないときは、このあと説明するアプリケーションリンクの設定手順の手順3で「サーバーは異なるユーザーまたはユーザー名の集合を持っています。」を選択してください。

設定手順

アプリケーションリンクを設定するには、Jira と Confluence の双方で設定を行う必要があります。

Confluence 側の設定

(青い星)  以下の手順は Confluence で実施します。

アプリケーションリンク画面を開く

まず Confluence 側の設定を行います。
Confluence の管理画面を開き、「管理」の「アプリケーションリンク」をクリックします。

アプリケーションリンクの設定画面が表示されます。最初はリンクが設定されていないので、「どのアプリにもリンクしていません」というメッセージが表示されています。
Jira とのリンクを追加するため、入力欄に Jira のベース URL を入力し、「新しいリンクを作成」ボタンをクリックします。


Link applications の確認ダイアログが表示されます。
Jira とユーザの同期を行っているので、「サーバーには、同じセットのユーザーとユーザー名があります。」のチェックボックスを有効にし、「続行」ボタンをクリックします。


Jira の画面へ遷移し、同様に確認のダイアログが表示されます。
問題がないことを確認し、「続行」ボタンをクリックします。


アプリケーションリンクの設定画面に戻り、いまリンクを設定した Jira サーバーの情報がリストに表示されていることを確認します。

リモート API を利用できるように設定する

続いて、Confluence に外部サーバーからアクセスできるようにするための設定を行います。
Confluence の管理画面から「詳細設定」を開き、 「リモートAPI(XML-RPC & SOAP)」のチェックがオンになっているか確認します。
チェックがオフのときは「編集」ボタンをクリックして設定を変更します。 チェックがオンのときは、変更する必要はありません。


ここまでで Confluence 側の設定は終了です。

リンクの作成方法

ここまでの設定を使って、Jira と Confluence の間でリンクを作成する方法をご紹介します。

(1) Jira 課題から Confluence のページへリンクを作成する

まず Jira の課題から Confluence のページにリンクを作成する手順を説明します。課題に関連する情報を Confluence にまとめている場合などに利用できます。

リンクの作成

(赤い星)  以下の手順は Jira で実施します。

リンクを作成したい課題を開き、「その他」から「リンク」をクリックします。

リンク先を指定するダイアログボックスが表示されます。
ダイアログボックスの左側で「Confluence ページ」を選択すると、右側にリンク先のページを指定するための「ページ URL」テキストボックスが表示されます。リンク先ページのURLがわかっているときは、直接 URL を入力してください。URL がわからないときは、「ページの検索」リンクを使ってページのタイトルから検索することができます。
リンク先の指定ができたら、「リンク」ボタンをクリックします。

「Confluenceページ」が表示されないときは

アプリケーションリンクの設定が正しく行われているか確認してください。


課題の画面に戻ると、「課題リンク」セクションに Wiki Page として指定した Confluence のページへのリンクが表示されています。 

リンクの動作確認

作成したリンクをクリックすると、Confluence のページが表示されます。

また、ページの画面上部には Jira 課題とのリンクが表示されます。

リンク先を表示するときにログイン画面が表示される

ユーザー管理の一元化を正しく設定できているか確認してください。

(2) Confluence のページから Jira 課題へリンクを作成する

次に Confluence のページから Jira 課題へリンクを作成する手順を説明します。URL ベースのリンクとは異なり、課題の要約やステータスがリアルタイムに反映されます。

リンクの作成

(青い星) 以下の手順は Confluence で実施します。

Jira へのリンクを作成したいページを開き、「挿入」メニューの「Jira課題/フィルタ」を選択します。

「Jira課題」が表示されないときは

アプリケーションリンクの設定が正しく行われているか確認してください。


Jira 課題の挿入ダイアログボックスが表示されます。リンクしたい課題を検索、選択し、「挿入」ボタンをクリックします。
このダイアログボックスでは、新しい課題を作ったり、検索結果の課題を表示することができます。


ページに課題へのリンクが挿入されます。


ページを公開すると、課題のリンクと情報が表示されるようになります。

リンクの動作確認

課題番号のリンクをクリックすると Jira の課題が表示されます。

リンク先を表示するときにログイン画面が表示される

ユーザー管理の一元化を正しく設定できているか確認してください。

リックソフト株式会社 は、日本でトップレベルのAtlassian Platinum Solution Partnerです。
大規模ユーザーへの対応実績が認められたEnterpriseの認定をうけ、高度なトレーニング要件をクリアし、小規模から大規模のお客様まで対応可能な実績を示したパートナー企業です。


Copyright © Ricksoft Co., Ltd. プライバシーポリシー お問い合わせ