It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

プログラミングなしでJira CloudとConfluence Cloudのサイトバックアップを自動化する

今回は追加の費用負担なくアドオンアプリ Automation for Jira (A4J) で Atlassian Cloud の Jira, Confluence でバックアップを自動取得する方法を紹介します。

 

■ (0) 要件

後述の手順はバックアップのみ実行してファイルのダウンロードは行わない割り切った方針になっています。ついては管理者がバックアップを何も行っていない状況からの第一歩としてご検討いただけますとさいわいです。バックアップファイルを手元に残したい場合は Atlassian Cloud 製品のバックアップ取得を自動化するには にて紹介されているbashスクリプトを使ったバックアップ自動化をご検討ください。

 

■ (1) 下準備

バックアップ実行のリクエストを送信するにあたって必要となる認証情報を用意して、アドオンアプリをサイトにインストールします。

  1. サイト管理者のアカウントにて API token を発行する
  2. オンラインツール Base64 Encode などで "$EMAIL_ADDRESS:$API_TOKEN" の形式をエンコードする
    • 例: base64encode.png
    • ターミナルを使いたい場合は後述の (1-2) を参考のこと
  3. サイトに Automation for Jira をインストールする

 

(1-2) 認証情報のエンコーディング

$ echo -n "site-admin@example.com:SAMPLE2019" | base64
c2l0ZS1hZG1pbkBleGFtcGxlLmNvbTpTQU1QTEUyMDE5

 

■ (2) Confluence向けサイトバックアップのルールを作成する

どちらからでも差し支えありませんが、ここでは Confluence Cloud から設定します。

  1. スケジュールを設定する
    • Cron expression にて (2-1) を指定する。
    • When rule executes... には "simply run the conditions and actions without providing issues" を選択する。
    • schedule-cron.png
  2. アクション Send web request を追加する
    • Webhook URLhttps://<サイト名>.atlassian.net/wiki/rest/obm/1.0/runbackup
    • Headers:
      • Authorization: Basic <(1-2) で出力した認証情報>
    • Webhook body: (2-2)
    • action-webhook.png
  3. アクション Log action を追加する
    • 成功時のレスポンスボディを audit log に出力するよう Log message に {{webhookResponse.body}} を指定する。
  4. 名前をつけて設定を保存して Run rule で試運転を行う
    • A4J の Audit log にて実行ログを確認できる。 
    • audit-log.png
  5. バックアップファイルが完成していることを確認する
    • このファイルは7日間保存されるため、ユーザーの操作などによりデータを喪失してしまった場合にダウンロードして復旧に利用できる。
    • confluence-backup.png

 

(2-1) Cron expression

方針: バックアップは最低48時間間隔を開けなければならないので、余裕を見て3日に1回の実行とする。また メンテナンス時間 はサービス利用ができなくなるため 19:00 (UTC) を指定する。

0 0 19 */3 * ? 

(2-2) Webhook body

{"cbAttachments":"true" }

 

■ (3) Jira向けサイトバックアップのルールを作成する

ほとんど Confluence と同じなので差分のみを記載します。

  1. スケジュールを設定するのは同じ
  2. アクション Send web request を追加する
    1. Webhook URLhttps://<サイト名>.atlassian.net/rest/backup/1/export/runbackup
    2. Webhook body: (3-1)
  3. 残りの手順は同じ
    • バックアップファイル: jira-backup.png

 

(3-1) Webhook body

{"cbAttachments":"true", "exportToCloud":"true"}

 

■ (4) 制約事項

今回のアプローチには、いくつか留意点があります。

  • 無償の A4J Lite ではルールの実行が300回までに制限されているので、他のルールで枠を使い切ってしまった場合はバックアップが走らなくなります。
  • ファイルを手元にダウンロードしていないので、保存期間の7日間を過ぎてしまった場合はバックアップが失われます。
  • 誤った操作などによりデータを喪失してしまった後にバックアップが行われてしまった場合、データを喪失した状態のバックアップが取得されてしまいます。

 

2 comments

Very detailed post, nice work @i05 

i05 Atlassian Team Jan 15, 2020

Comment

Log in or Sign up to comment
Community showcase
Published in Jira

Keep your team in the loop with Team @mentions in Jira Software!

Hi everyone! My name is Jenny, a Product Manager at Atlassian. After launching Team @mentions in Confluence, we heard a lot of positive feedback from customers that they love how easy it is to @men...

564 views 6 18
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you