Tableau Server のバックアップ取得をスケジュール実行する

tsm maintenance backup -f ts_saturday_backup -sr weekly -st 12:00 -sd 6 -sn weekly-saturday-backup

tsm maintenance backup -f tableau-server-data -sr daily -st 17:00 -sn daily-backup

$ tsm maintenance backup -f tableau-server-data -sr daily -st 17:00 -sn daily-backup
スケジュール ID が 1 の daily スケジュールを作成しました。次は 2024/12/06 17:00 に実行されます。

$ tsm schedules list
スケジュール ID: 1
        名前: daily-backup
        タイプ: GenerateBackupJob
        状態: アクティブ
        次の実行時刻: 2024/12/06 17:00
        繰り返しのタイプ: DAILY、17:00

$ ls /opt/tableau/tableau_backups/backups
2024.12.06.17.00-tableau-server-data.tsbak 

$ tsm schedules list
スケジュール ID: 1
        名前: daily-backup
        タイプ: GenerateBackupJob
        状態: アクティブ
        次の実行時刻: 2024/12/07 17:00
        繰り返しのタイプ: DAILY、17:00

tsm schedules update -si <scheduleID> -st <time_to_run> -sr <recurrence_frequency>

tsm schedules update -si 1 -sr daily -st 18:00

$ tsm schedules list
スケジュール ID: 1
        名前: daily-backup
        タイプ: GenerateBackupJob
        状態: アクティブ
        次の実行時刻: 2024/12/06 18:00
        繰り返しのタイプ: DAILY、18:00

tsm schedules suspend -si 1

$ tsm schedules list
スケジュール ID: 1
        名前: daily-backup
        タイプ: GenerateBackupJob
        状態: 一時停止
        繰り返しのタイプ: DAILY、18:00

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "sns:Publish"
            ],
            "Resource": "arn:aws:sns:us-east-1:<アカウントID>:yasuhara-test-topic"
        }
    ]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service": [
                    "ssm.amazonaws.com"
                ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

{
  "DocumentName": "AWS-RunShellScript",
  "Parameters": {
    "commands": [
      "DATE=$(date +%Y-%m-%d)",
      "TIME=$(date +%H-%M-%S)",
      "su - ec2-user -c \"tsm settings export -f /opt/tableau/tableau_backups/setting_exports/output_file-$DATE-$TIME.json\"",
      "aws s3 cp /opt/tableau/tableau_backups/setting_exports/ s3://<バケット名>/setting/$DATE/ --recursive",      
      "aws s3 cp /opt/tableau/tableau_backups/backups/ s3://<バケット名>/maintenance-backup/$DATE/ --recursive"     
    ]
  },
  "Targets": [
    {
       "Key": "InstanceIds",
       "Values": [
          "<コマンドの実行対象となるEC2インスタンスのID>"
       ]
    }
 ],
  "MaxConcurrency": "1",
  "MaxErrors": "0",
  "TimeoutSeconds": 300,
   "NotificationConfig": {
    "NotificationArn": "arn:aws:sns:us-east-1:<アカウントID>:yasuhara-test-topic",
    "NotificationEvents": [
       "Failed",
       "Success"
    ],
    "NotificationType": "Command"
 },
 "ServiceRoleArn": "arn:aws:iam::<アカウントID>:role/yasuhara-sns-test-role",
 "OutputS3BucketName": "<バケット名>",
 "OutputS3KeyPrefix": "ssm-runcommand/"
}

{
	"Version": "2012-10-17",
	"Statement": [
		{
			"Effect": "Allow",
			"Action": "ssm:SendCommand",
			"Resource": [
				"arn:aws:ssm:*:*:document/AWS-RunShellScript",
				"arn:aws:ec2:us-east-1:<アカウントID>:instance/<EC2インスタンスのID>"
			]
		},
		{
			"Effect": "Allow",
			"Action": "iam:PassRole",
			"Resource": "arn:aws:iam::<アカウントID>:role/yasuhara-sns-test-role"
		}
	]
}

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service": "scheduler.amazonaws.com"
            },
            "Action": "sts:AssumeRole"
        }
    ]
}

sudo mkdir /opt/tableau/backup_scripts

$ tree /opt/tableau -d -L 2
/opt/tableau
├── backup_scripts
├── data
│   ├── config
│   ├── data
│   ├── logs
│   └── temp
├── tableau_backups
│   ├── backups
│   └── setting_exports
├── tableau_driver
│   └── jdbc
└── tableau_server
    ├── manifests
    └── packages

sudo touch /opt/tableau/backup_scripts/tableau_backup.sh

$ sudo ls /opt/tableau/backup_scripts
tableau_backup.sh

sudo vi /opt/tableau/backup_scripts/tableau_backup.sh

#!/bin/bash
set -xu

# 現在の日付と時刻を取得
DATE=$(date +%Y-%m-%d)
TIME=$(date +%H-%M-%S)

# 変数を定義
backup_dir="/opt/tableau/tableau_backups/backups/"                # バックアップファイル保存ディレクトリ
settings_export_dir="/opt/tableau/tableau_backups/setting_exports/" # 設定エクスポート保存ディレクトリ
s3_bucket="<バケット名>"                                          # S3 バケット名
s3_backup_path="maintenance-backup/${DATE}/"                     # S3 バックアップ保存先パス
s3_settings_path="setting/${DATE}/"                              # S3 設定保存先パス
file_extension="*.tsbak"                                         # 対象とするバックアップファイルの拡張子
settings_file="output_file-${DATE}-${TIME}.json"                 # 設定エクスポートファイル名
current_time() {
    date '+%Y-%m-%d %H:%M:%S'
}

# 構成およびトポロジデータをエクスポート
echo "$(current_time) Exporting Tableau settings..."
su - ec2-user -c "tsm settings export -f ${settings_export_dir}${settings_file}"
if [ $? -ne 0 ]; then
    echo "$(current_time) Error: Failed to export Tableau settings." >&2
    exit 1
fi
echo "$(current_time) Successfully exported Tableau settings to ${settings_export_dir}${settings_file}"

# 構成およびトポロジデータをS3に配置
echo "$(current_time) Uploading Tableau settings export to S3..."
aws s3 cp "$settings_export_dir" "s3://$s3_bucket/$s3_settings_path" --recursive
if [ $? -ne 0 ]; then
    echo "$(current_time) Error: Failed to upload Tableau settings to S3." >&2
    exit 1
fi
echo "$(current_time) Successfully uploaded Tableau settings to s3://$s3_bucket/$s3_settings_path"

# Tableau Serverで管理されるデータ（.tsbak）が存在するか確認
echo "$(current_time) Checking for $file_extension files in $backup_dir..."
found_files=$(find "$backup_dir" -type f -name "$file_extension")
if [ -z "$found_files" ]; then
    echo "$(current_time) Error: No $file_extension files found in $backup_dir. Exiting." >&2
    exit 1
fi

# 見つかったファイルをログに出力する
echo "$(current_time) Found the following $file_extension files:"
echo "$found_files"

# Tableau Serverで管理されるデータ（.tsbak）をS3に配置
echo "$(current_time) Uploading all $file_extension files in $backup_dir to S3..."
aws s3 cp "$backup_dir" "s3://$s3_bucket/$s3_backup_path" --recursive --exclude "*" --include "$file_extension"
if [ $? -ne 0 ]; then
    echo "$(current_time) Error: Failed to upload $file_extension files to S3." >&2
    exit 1
fi
echo "$(current_time) Successfully uploaded $file_extension files to s3://$s3_bucket/$s3_backup_path"

sudo chmod +x /opt/tableau/backup_scripts/tableau_backup.sh

{
  "DocumentName": "AWS-RunShellScript",
  "Parameters": {
    "commands": [
      "sudo /opt/tableau/backup_scripts/tableau_backup.sh"     
    ]
  },
  "Targets": [
    {
       "Key": "InstanceIds",
       "Values": [
          "<コマンドの実行対象となるEC2インスタンスのID>"
       ]
    }
 ],
  "MaxConcurrency": "1",
  "MaxErrors": "0",
  "TimeoutSeconds": 300,
   "NotificationConfig": {
    "NotificationArn": "arn:aws:sns:us-east-1:<アカウントID>:yasuhara-test-topic",
    "NotificationEvents": [
       "Failed",
       "Success"
    ],
    "NotificationType": "Command"
 },
 "ServiceRoleArn": "arn:aws:iam::<アカウントID>:role/yasuhara-sns-test-role",
 "OutputS3BucketName": "<バケット名>",
 "OutputS3KeyPrefix": "ssm-runcommand/"
}

$ sudo rm /opt/tableau/tableau_backups/backups/*
$ sudo rm /opt/tableau/tableau_backups/setting_exports/*
$ ls /opt/tableau/tableau_backups/*
/opt/tableau/tableau_backups/backups:

/opt/tableau/tableau_backups/setting_exports:

$ ls /opt/tableau/tableau_backups/*
/opt/tableau/tableau_backups/backups:

/opt/tableau/tableau_backups/setting_exports:
output_file-2024-12-07-15-30-45.json

++ date +%Y-%m-%d
+ DATE=2024-12-07
++ date +%H-%M-%S
+ TIME=15-30-45
+ backup_dir=/opt/tableau/tableau_backups/backups/
+ settings_export_dir=/opt/tableau/tableau_backups/setting_exports/
+ s3_bucket=<S3バケット名>
+ s3_backup_path=maintenance-backup/2024-12-07/
+ s3_settings_path=setting/2024-12-07/
+ file_extension='*.tsbak'
+ settings_file=output_file-2024-12-07-15-30-45.json
++ current_time
++ date '+%Y-%m-%d %H:%M:%S'
+ echo '2024-12-07 15:30:45 Exporting Tableau settings...'
+ su - ec2-user -c 'tsm settings export -f /opt/tableau/tableau_backups/setting_exports/output_file-2024-12-07-15-30-45.json'
+ '[' 0 -ne 0 ']'
++ current_time
++ date '+%Y-%m-%d %H:%M:%S'
+ echo '2024-12-07 15:30:48 Successfully exported Tableau settings to /opt/tableau/tableau_backups/setting_exports/output_file-2024-12-07-15-30-45.json'
++ current_time
++ date '+%Y-%m-%d %H:%M:%S'
+ echo '2024-12-07 15:30:48 Uploading Tableau settings export to S3...'
+ aws s3 cp /opt/tableau/tableau_backups/setting_exports/ s3://<S3バケット名>/setting/2024-12-07/ --recursive
+ '[' 0 -ne 0 ']'
++ current_time
++ date '+%Y-%m-%d %H:%M:%S'
+ echo '2024-12-07 15:30:49 Successfully uploaded Tableau settings to s3://<S3バケット名>/setting/2024-12-07/'
++ current_time
++ date '+%Y-%m-%d %H:%M:%S'
+ echo '2024-12-07 15:30:49 Checking for *.tsbak files in /opt/tableau/tableau_backups/backups/...'
++ find /opt/tableau/tableau_backups/backups/ -type f -name '*.tsbak'
+ found_files=
+ '[' -z '' ']'
++ current_time
++ date '+%Y-%m-%d %H:%M:%S'
+ echo '2024-12-07 15:30:49 Error: No *.tsbak files found in /opt/tableau/tableau_backups/backups/. Exiting.'
2024-12-07 15:30:49 Error: No *.tsbak files found in /opt/tableau/tableau_backups/backups/. Exiting.
+ exit 1
failed to run commands: exit status 1