[アップデート] AWS Well-Architected Tool と Jira を同期してワークロードのアセスメント状況を Jira プロジェクトで管理できるようになりました

2024.04.18

いわさです。

AWS Well-Architected Tool を使うと、AWS Well-Archited フレームワークに基づいたアセスメントをマネジメントコンソール上で実行したり管理したり、あるいは改善が必要な項目を Trusted Advisor に連携したりすることができます。非常に良いコンセプトのツールだと思っています。

そんな AWS Well-Architected Tool が先日アップデートされまして、Jira と連携できるようになったそうです。

Jira は Atlassian 社が提供する SaaS で、プロジェクト管理・チケット管理などの用途で広く使われているサービスです。

AWS Well-Arhitected Tool と Jira が同期・連携できるとはいったいどういうことなのか、ドキュメントを見ただけだと全くわかりませんでした。
本日は実際に AWS Well-Architected Tool と Jira を連携し使い勝手を確認してみたので紹介します。

流れとしては、まず Well-Architected Tool と Jira の接続設定を行います。
その後、Jira プロジェクトキーを指定することで、ワークロードと Jira を同期できるようになります。
双方向の同期が可能ですが、手動同期と自動同期があります。

接続設定

Jira へのアプリのセットアップ

まず、AWS Well-Architected Tool コンソールの設定メニューにアクセスしましょう。
次のように「Jira アカウントの同期」という設定グループが追加されていることが確認出来ます。

デフォルトでは接続されておらず、明示的にセットアップが必要です。
画面の説明書きに記載がありますが、前提として当然ながら連携先の Jira アカウントが必要となります。
そのうえで、Jira マーケットプレイスから「AWS Well-Architected Tool Connector for Jira」アプリを Jira のワークスペースへインストールすることで統合設定を開始できるようになります。

上記の「Jira マーケットプレイスのアプリに移動」ボタンを押すと、ATLASSIAN マーケットプレイスへ移動します。
知らなかったのですが、このマーケットプレイスでは既に AWS によるアプリがいくつか提供されているようですね。
今回のアップデートに併せて次の「AWS Well-Architected Tool Connector for Jira」が追加されています。

このアプリは無料で利用が出来ます。
こちらを選択して「Get it now」を押します。
どうやらまだ 1 人しかインストールしていないようですね。

「Add to Jira」ダイアログでも「Get it now」を押します。

アプリのインストールが完了しました。
Jira Software のアプリ管理画面でインストール済みアプリとして確認することができるようになります。

しかし、Well-Architected Tool コンソールを見てみると、まだ Jira アプリ接続ステータスは「未設定」です。
そりゃそうだという感じですね。まだアカウントなどの権限設定何もやってませんし。

Jira から AWS Well-Architected Tool にアクセスするための設定を行います。
Jira 側のアプリタブから、インストール済みの「AWS Well-Architected Tool Connector for Jira」を開き「Get started」を押下します。

AWS Well-Architected Tool 構成画面が表示されるので「Connect a new AWS account」ボタンを押します。

AWS アカウントの接続構成画面が表示されます。
ここで IAM ユーザーのアクセスキーとシークレットを登録する方式のようです。

接続先の AWS アカウント上で IAM ユーザーを作成しアクセスキーを発行します。
必要な IAM ポリシーについてなのですが、本日時点で公式ドキュメントには明記されていないように思えました。

今回は AdministratorAccess マネージドポリシーを使っています。
その後該当 IAM ユーザーのアクセスアナライザーを確認してみたところ、AWS Well-Architected Tool にアクセスはしているようですが、アクションを抽出することが出来ませんでした。必要なポリシーがわかったら追記したいと思います。

アクセスキー、シークレット、リージョンを指定します。

ここまで行うことで Well-Architected Tool 上でも Jira アプリとの接続ステータスが「設定済み」となりました。

同期

接続の設定が出来たので、AWS Well-Architected Tool と Jira の間で「同期」を行ってみたいと思います。
これを行うと、要は Jira 上でも Well-Architected Tool の設問状態の確認や更新ができるようになります。

同期するプロジェクトを設定

ただし、同期するためにはそのワークロードがどの Jira プロジェクトへ同期を行うのか指定が必要です。
今回は次のようなカンバンプロジェクトを作成しました。
「HOG」がプロジェクトキーになります。

これを Well-Architected Tool のワークロードで指定しましょう。
ワークロードのプロパティを開きます。

「Jira」の項目を編集し、「アカウントレベルの設定を上書き」をチェックします。
今回の機能はアカウント全体の設定も可能なのですが、ワークロードごとに個別の設定を行うことも可能です。
今回は個別設定を試してみたいと思います。

同期設定には、同期しない・手動同期・自動同期からモードを選択することが出来ます。
まずは手動同期を行ってみたいと思います。
併せて、同期先の Jira プロジェクトキーを指定します。今回試していませんがプロジェクトキーを指定しなかった場合は新しいプロジェクトが作成されるようです。

手動同期

まず、今回のアップデートにおける「同期」ですが双方向の同期機能となっています。
Well-Architected Tool 上で変更した内容が Jira プロジェクトへ同期されますし、Jira プロジェクトで変更した内容は Well-Architected Tool 上に同期されます。

手動同期ですが、これは Well-Architected のコンソール上に次のように「Jira と同期する」ボタンが表示されるので、同期したいタイミングで押す感じです。

同期ボタンを押すと、同期したいレンズと、同期する質問を選択する形となっています。

同期後、次のように Jira のカンバン上に Well-Architected Tool 上で回答した設問のチケットが作成されました。
まず、何も回答していない設問は Jira 上にチケットが作成されませんでした。
一つ以上回答した設問は、選択肢それぞれがチケット作成されました。チケットには設問番号・設問名のラベルが割り当てられています。
そして、設問の中で回答したもの(あるいは未回答の理由を明記したもの)については Jira の完了リストに設定され、未回答のものは進行中リストに設定されました。

ひとつ注意点がありまして、本機能を使って連携したJira 上のチケット内容は全て英語となっていました。
AWS マネジメントコンソールや Jira 側の言語が日本語でも英語で設定されます。
本日時点で本機能の利用にあたっては英語が前提となりそうなので覚えておきましょう。

また、バックログリストにはストーリーも作成されています。
これは Well-Architected Tool の設問上でも確認することができます。リンクも設定されています。

Well-Architected Tool 側で更新してみる

設問を追加で更新してどのように Jira 側へ同期されるのかを確認してみます。
ここではまだ未回答の OPS 5 に回答したいと思います。

次のように 2 つ選択し、メモ欄に適当な文言を入れてみました。

その後同期を行ってみると、次のように選択した選択肢は完了リストに移動されていました。

未回答の選択肢は進行中リストに残っています。

なので、選択しない項目についても「このワークロードに該当しないベストプラクティスをマークする」へ該当しない理由を設定してやる必要がありますね。

ちなみに、設問のメモについては Jira 側ではストーリーに入力されるようです。

ただし、次のように文字化けしていました。日本語入力は問題が起きるようですね。
このあたりはフィードバックしたいですね。Well-Architected 周りは日本語を使いたいという要望が多いと思います。

Jira プロジェクト側で更新してみる

先ほどは Well-Architected Tool 側で更新した内容を Jira へ同期しました。
今度は逆のパターンを試してみましょう。Jira で更新してから同期ボタンを押してみます。

ここでは先程の OPS 5 の進行中の選択肢を完了に移動してみました。

その後 Well-Architected Tool 上で同期ボタンを押すと、対象の選択肢が回答済みの状態に更新されることが確認出来ました。なるほどー。

自動同期

自動同期は、これまで手動で行っていた Well-Architected Tool 上の手動ボタンの押下操作を行わなくても双方向で同期を勝手に行ってくれるものです。
同期操作結構面倒なので、基本的に自動同期でも良いんじゃないのかと思ってます。

自動同期を有効化した上で、OPS 6 に回答してみます。

Well-Architected Tool 更新後、Jira 上へ自動反映されていることが確認出来ました。

また、ここから一部の回答済みチケットを進行中リストに戻してみましょう。

Well-Architected Tool 側に戻って確認してみると、選択状態が解除されていることが確認出来ました。
双方向に自動で同期されていますね。

さいごに

本日は AWS Well-Architected Tool と Jira を同期してワークロードのアセスメント状況を Jira プロジェクトで管理できるようになったので確認してみました。

これはカンバンで管理するのがちょっと難しいかもと思いました。どういう使い方を想定したら良いのだろうか・・・。 設問に対してチケット管理したことがなくて、その結果の改善項目をチケット管理することならよくあるのだが。
良い使い方ご存知の方、メッセージください。

あと、本日時点では日本語には対応出来ていなさそうだったので、そのあたりは今後のアップデートに期待したいところですね。