
Jira Service Management のサンドボックスをためしてみた
こんにちは。たかやまです。
Jira Service Management(JSM)のサンドボックス機能があることはご存知ですか?
JSMで検証する際にサイトをもう一つ作成して検証するのは手間とお金がかかりますよね
そんな時に便利なのがサンドボックス機能です。
今回は実際にサンドボックス機能をためしてみたのでご紹介します。
さきにまとめ
- JSMのサンドボックス機能はPremium/Enterpriseプランで利用可能(追加料金なし)
- 本番環境のデータを簡単にコピーして安全にテスト・検証が可能
- 自動化ルール、アセット、Operations機能などはコピーされないため別途設定が必要です
- Premiumプランでは1つのサンドボックスのみで、ConfluenceとJSMは同時利用不可
- 28日間非アクティブでオフライン状態となり、30日後に完全削除される点に注意
サンドボックス機能概要
サンドボックスとは、本番環境に適用する前に変更を実験・テストできる隔離された環境になります。サンドボックスは本番環境のレプリカのように機能し、本番環境のデータのコピーして利用することができます。
サンドボックス機能は、Premium / Enterpriseプランで提供される機能で、追加料金はかかりません。
※Standardプランでは利用できません
主なユースケースは以下の通りです。
- 本番環境の前にサンドボックス環境で新機能を検証し、エンドユーザーへの影響を事前に確認する
- 本番環境の前にサンドボックス環境で新しい自動化設定や利用中スキームのカスタマイズを行い、実運用に影響がないかを検証する
- サンドボックス環境のみに新しいアプリをインストールし、トライアル期間にアプリの評価をする
プランベースのサンドボックス機能
Sandboxの機能はプランごとに異なります。
各プランでのサンドボックス機能の違いは以下の通りです。
機能項目 | Premium | Enterprise |
---|---|---|
サンドボックス数 | 1つのサンドボックス | 最大10つのサンドボックス |
Multiple Sandboxes機能 | 利用不可 | 利用可能 |
マルチ環境テスト | 単一環境のみ | 複数環境対応 (Dev/Staging/UAT等) |
用途別サンドボックス分離 | 1つの環境ですべてのテストを実施 | 用途別に環境分離可能 ・マーケットプレイスアプリテスト用 ・新機能テスト用 ・マイグレーション用 |
複数アプリの統合管理 | 制限あり※1 (例:ConfluenceとJSMのどちらか一方のみ) |
複数アプリを共通サンドボックスサイトで統合 |
参考:サンドボックスとは? | Atlassian サポート
※1 : サンドボックス環境は、Jira Service ManagementとConfluenceの両方を利用している場合、どちらか一方のサンドボックス環境しか作成できません。
Premiumプランでは1つのサンドボックス環境のみ作成可能ですが、これは組織全体での制限となります。
そのため、Jira Service ManagementとConfluenceの両方を利用している場合、どちらか一方のサンドボックス環境しか作成できません。
例えば、JSMのサンドボックスを作成した場合、Confluenceのサンドボックスは作成できません。
複数の製品でサンドボックス環境を同時に利用したい場合は、Enterpriseプランへのアップグレードが必要になります。
制約事項
サンドボックス機能を利用する際の重要な制約事項があります:
本番環境複製機能の制約事項
サンドボックス機能の本番環境複製機能ですが、すべての機能がコピーされるわけではないという重要な制約があります。
一例ですが、私が検証したい以下の機能はコピーされませんでした。
- 自動化ルール
- Operations、Syncs(Opsgenie搭載のJira Service Management機能)
- アセット
詳細については、Atlassianの公式ドキュメントで確認できます。
また、現時点でサンドボックス → 本番への逆輸入する機能は提供されていないため、手動でのインポート対応が必要になります。
オフライン状態と削除について
サンドボックス環境は、一定期間操作が行われないとオフライン状態に移行し、最終的に削除される仕組みになっています。
オフライン状態になる条件は以下の通りです。
- サンドボックスまたはサンドボックス サイト全体を削除した場合
- サンドボックスが 28 日間非アクティブになっている場合
削除タイミングとしては以下の通りです。
- オフライン状態に移行後、30日で完全削除される
- オフライン状態から30日以内であれば復元可能
継続的にサンドボックスを利用する場合は、JSMの自動化ルールで定期的にチケット操作を行う仕組みを作ると良さそうですね。
やってみる
サンドボックス環境の作成
以下のURLにアクセスし、対象のサイト内の「製品」→ 「サンドボックス」からサンドボックス機能を有効化します。
デフォルトは、元のサイト名のサフィックスに-sandbox
が付きます。
問題なければ作成します。
作成が開始されると先ほどの画面に戻ります。作成が完了するとメールが届くのでそちらを待ちます。
作成が完了すると、Sandbox created
という件名で以下のメールは届きます。
サンドボックスが完了すると、以下のような状態になります。
まだこの状態ではデータはコピーはされていません。
以下の作業を「本番データをコピー」ボタンを押して行います。
「本番データをコピー」ボタンをクリックすると、コピーするデータの選択画面が表示されます。
ここではすべてのプロジェクトを選択します。
コピーしたいデータを選択して「コピーを開始」ボタンをクリックします。ここでは、プロジェクト、ユーザー、グループなどの主要なデータを選択できます。
コピー処理が開始されると、進行状況が表示されます。データ量によって時間がかかる場合がありますので、しばらく待ちます。
完了するとSandbox data copy complete
という件名でメールが届きます。
コピーが完了すると、サンドボックス環境に本番環境のデータが反映されます。これで、本番環境と同じ状態でテストや検証作業を行うことができるようになります。
環境確認
プロジェクト
サンドボックス環境を確認してみます。
プロジェクトのデータがコピーされていることが確認できます。
プロジェクトごとのチケットもコピーされていることが確認できますね。
チーム
チームのメンバーはそのままコピーされています。
一方でチームで利用するオペレーションズの機能などはコピーされていないようです。
アセット
アセットもデフォルトのスキーマのみで本番のデータはコピーされていないですね
自動化ルール
自動化ルールもコピーされていないですね
自動化ルールについては、公式の方で以下のコピーの推奨方法が提供されています。
最後に
今回はJira Service Management(JSM)のサンドボックス機能を実際に試してみました。
サンドボックス機能は本番環境に影響を与えることなく、新機能の検証や自動化ルールのテスト、アプリの評価などを安全に行える便利な機能です。
特に、本番環境のデータを簡単にコピーできる点はいいですね
ただし、自動化ルールやアセット、Operations機能などはコピーされないため、これらの機能を検証したい場合は別途設定が必要になります。
自動化ルールについては、公式の方でエクスポート/インポートの方法が提供されているので、そちらを利用すると良さそうです。
アセットやOperations機能については、効率的な設定方法があれば、 別途ご紹介したいと思います。
JSMの運用改善や新機能の導入を検討されている方は、ぜひサンドボックス機能を活用してみてください。
このブログがどなたかの参考になれば幸いです。
以上、たかやま(@nyan_kotaroo)でした。