【Cloud Scheduler】コンテナを動かすために必要なgcloudコマンドをシェル関数化する

はじまり#

リサちゃん

あー、また強制実行しなければ・・・

135ml

シェル関数にしてしまおう。

Cloud Schedulerでコンテナを操作する#

Google Cloud Schedulerは、スケジュールに基づいてジョブを実行するサービスです。特にコンテナと組み合わせると、定期的なバッチ処理やメンテナンス作業を自動化するのに最適です。

例えば以下のようなユースケースがあります。

毎日深夜にデータベースのバックアップを取る
1時間ごとにデータを集計する
週次でレポートを生成する
特定のタイミングでコンテナを起動し、処理が終わったら停止する

Cloud Schedulerでコンテナを操作する際には、主に以下のgcloudコマンドを使用します。

gcloud scheduler jobs resume - 一時停止中のジョブを再開する
gcloud scheduler jobs run - ジョブを即時実行する
gcloud scheduler jobs pause - 実行中のジョブを一時停止する

これらのコマンドを毎回手動で入力するのは面倒ですし、ミスも発生しやすいです。そこで、これらのコマンドをシェル関数化して、より簡単かつ安全に使えるようにしましょう。

シェル関数化する利点#

gcloudコマンドをシェル関数化することで、以下のような利点があります。

コマンドの簡略化 - 長いコマンドを短い関数名で呼び出せる
パラメータのバリデーション - 必須パラメータの有無をチェックできる
エラーハンドリング - コマンド実行時のエラーを適切に処理できる
ヘルプ機能の追加 - helpオプションでコマンドの使い方を表示できる
通知機能の統合 - Discordなどに実行結果を通知できる
複数コマンドの連携 - 複数のコマンドを組み合わせた処理を1つの関数にまとめられる
スニペットとしての利用 - 今後似たような処理を作る時の見本になる

それでは、実際にシェル関数を実装していきましょう。

基本的なgcloudコマンドの紹介#

まず、Cloud Schedulerを操作する基本的なgcloudコマンドを見てみましょう。それぞれのコマンドは以下の公式ページでも確認できます。

Google Cloud Documentation

gcloud scheduler jobs resume | Google Cloud SDK | Google Cloud Documentation

docs.cloud.google.com

ジョブの再開（resume）#

1
gcloud scheduler jobs resume JOB_NAME --location=LOCATION

ジョブの即時実行（run）#

1
gcloud scheduler jobs run JOB_NAME --location=LOCATION

ジョブの一時停止（pause）#

1
gcloud scheduler jobs pause JOB_NAME --location=LOCATION

これらのコマンドは単純ですが、毎回ジョブ名やロケーションを指定する必要があります。また、エラーが発生した場合の処理も自分で書く必要があります。

シェル関数の実装#

それでは、これらのコマンドをシェル関数化していきましょう。まずは、ジョブを再開する関数から実装します。

ジョブを再開する関数#

1
function resume_gcloud_scheduler_job() {
2
  # 関数名をローカル変数に格納
3
  local func_name="${FUNCNAME[0]}"
4
  send_discord_notification "ジョブを再開するよ！"
5

6
  # 初期値
7
  local job_name=""
8
  local location=""
9

10
  # パラメータ解析
11
  if [ $# -eq 0 ]; then
12
    echo "[INFO] ${func_name}: パラメータが指定されなかったため、デフォルト設定で実行します。"
13
  fi
14

15
  local usage="[INFO] Usage: ${func_name} --job-name <JOB_NAME> --location <LOCATION>
16
  --job-name      対象のジョブ名を指定します。
17
  --location      対象のロケーションを指定します。
18

19
[INFO] Example:
20
  ${func_name} --job-name my-job --location us-central1
21
[INFO] Detail of gcloud is here: <https://cloud.google.com/sdk/gcloud/reference/scheduler/jobs/resume>
22
"
23

24
  while [ $# -gt 0 ]; do
25
    case "$1" in
26
      --help)
27
        echo "$usage"
28
        return 0
29
        ;;
30
      --job-name)
31
        shift
32
        if [ -z "$1" ]; then
33
          echo "[ERROR] ${func_name}: --job-name の引数が指定されていません。"
34
          return 1
35
        fi
36
        job_name="$1"
37
        ;;
38
      --location)
39
        shift
40
        if [ -z "$1" ]; then
41
          echo "[ERROR] ${func_name}: --location の引数が指定されていません。"
42
          return 1
43
        fi
44
        location="$1"
45
        ;;
46
      *)
47
        echo "[ERROR] ${func_name}: 不明なパラメータ '$1' です。"
48
        return 1
49
        ;;
50
    esac
51
    shift
52
  done
53

54
  # 必須パラメータのチェック
55
  if [ -z "${job_name}" ]; then
56
    echo "[ERROR] ${func_name}: --job-name は必須パラメータです。"
57
    return 1
58
  fi
59
  if [ -z "${location}" ]; then
60
    echo "[ERROR] ${func_name}: --location は必須パラメータです。"
61
    return 1
62
  fi
63

64
  # コマンド組み立て
65
  local cmd="gcloud scheduler jobs resume ${job_name} --location=${location}"
66
  echo "[INFO] ${func_name}: 実行するコマンド: ${cmd}"
67

68
  # コマンド実行とエラーハンドリング
69
  eval "${cmd}"
70
  if [ $? -ne 0 ]; then
71
    send_discord_notification_about_gcscheduler "失敗…" "ジョブを再開できなかったよ…" "red"
72
    echo "[ERROR] ${func_name}: コマンド実行中にエラーが発生しました。"
73
    return 1
74
  fi
75
  send_discord_notification_about_gcscheduler "再開したよ！" "ジョブを再開したよ！" "green"
76
  echo "[INFO] ${func_name}: Scheduler job '${job_name}' updated successfully."
77
}

この関数では、以下のような工夫をしています。

関数名の取得 - ${FUNCNAME[0]}で現在の関数名を取得し、エラーメッセージなどに使用
Discord通知 - 処理の開始と結果をDiscordに通知
パラメータ解析 - job-nameやlocationなどのパラメータを解析
ヘルプ機能 - helpオプションで使い方を表示
パラメータのバリデーション - 必須パラメータが指定されているかチェック
コマンドの組み立て - パラメータを使ってgcloudコマンドを組み立て
エラーハンドリング - コマンド実行結果をチェックし、実行完了時もしくはエラー発生時に通知

ジョブを即時実行する関数#

次に、ジョブを即時実行する関数を実装します。

1
function run_gcloud_scheduler_job() {
2
  # 関数名をローカル変数に格納
3
  local func_name="${FUNCNAME[0]}"
4
  send_discord_notification "ジョブを強制実行するよ！"
5

6
  # 初期値
7
  local job_name=""
8
  local location=""
9

10
  # パラメータ解析
11
  if [ $# -eq 0 ]; then
12
    echo "[INFO] ${func_name}: パラメータが指定されなかったため、デフォルト設定で実行します。"
13
  fi
14

15
  local usage="[INFO] Usage: ${func_name} --job-name <JOB_NAME> --location <LOCATION>
16
  --job-name      実行対象のジョブ名を指定します。
17
  --location      対象のロケーションを指定します。
18

19
[INFO] Example:
20
  ${func_name} --job-name my-job --location us-central1
21
[INFO] Detail of gcloud is here: <https://cloud.google.com/sdk/gcloud/reference/scheduler/jobs/run>
22
"
23

24
  while [ $# -gt 0 ]; do
25
    case "$1" in
26
      --help)
27
        echo "$usage"
28
        return 0
29
        ;;
30
      --job-name)
31
        shift
32
        if [ -z "$1" ]; then
33
          echo "[ERROR] ${func_name}: --job-name の引数が指定されていません。"
34
          return 1
35
        fi
36
        job_name="$1"
37
        ;;
38
      --location)
39
        shift
40
        if [ -z "$1" ]; then
41
          echo "[ERROR] ${func_name}: --location の引数が指定されていません。"
42
          return 1
43
        fi
44
        location="$1"
45
        ;;
46
      *)
47
        echo "[ERROR] ${func_name}: 不明なパラメータ '$1' です。"
48
        return 1
49
        ;;
50
    esac
51
    shift
52
  done
53

54
  # 必須パラメータのチェック
55
  if [ -z "${job_name}" ]; then
56
    echo "[ERROR] ${func_name}: --job-name は必須パラメータです。"
57
    return 1
58
  fi
59
  if [ -z "${location}" ]; then
60
    echo "[ERROR] ${func_name}: --location は必須パラメータです。"
61
    return 1
62
  fi
63

64
  # コマンド組み立て
65
  local cmd="gcloud scheduler jobs run ${job_name} --location=${location}"
66
  echo "[INFO] ${func_name}: 実行するコマンド: ${cmd}"
67

68
  # コマンド実行とエラーハンドリング
69
  eval "${cmd}"
70
  if [ $? -ne 0 ]; then
71
    send_discord_notification_about_gcscheduler "失敗…" "ジョブを強制実行できなかったよ…" "red"
72
    echo "[ERROR] ${func_name}: コマンド実行中にエラーが発生しました。"
73
    return 1
74
  fi
75
  send_discord_notification_about_gcscheduler "強制実行したよ！" "ジョブを強制実行したよ！" "green"
76
  echo "[INFO] ${func_name}: Scheduler job '${job_name}' executed successfully."
77
}

ジョブを一時停止する関数#

最後に、ジョブを一時停止する関数を実装します。

1
function pause_gcloud_scheduler_job() {
2
  # 関数名をローカル変数に格納
3
  local func_name="${FUNCNAME[0]}"
4
  send_discord_notification "ジョブを一時停止するよ！"
5

6
  # 初期値
7
  local job_name=""
8
  local location=""
9

10
  # パラメータ解析
11
  if [ $# -eq 0 ]; then
12
    echo "[INFO] ${func_name}: パラメータが指定されなかったため、デフォルト設定で実行します。"
13
  fi
14

15
  local usage="[INFO] Usage: ${func_name} --job-name <JOB_NAME> --location <LOCATION>
16
  --job-name      対象のジョブ名を指定します。
17
  --location      対象のロケーションを指定します。
18

19
[INFO] Example:
20
  ${func_name} --job-name my-job --location us-central1
21
[INFO] Detail of gcloud is here: <https://cloud.google.com/sdk/gcloud/reference/scheduler/jobs/pause>
22
"
23

24
  while [ $# -gt 0 ]; do
25
    case "$1" in
26
      --help)
27
        echo "$usage"
28
        return 0
29
        ;;
30
      --job-name)
31
        shift
32
        if [ -z "$1" ]; then
33
          echo "[ERROR] ${func_name}: --job-name の引数が指定されていません。"
34
          return 1
35
        fi
36
        job_name="$1"
37
        ;;
38
      --location)
39
        shift
40
        if [ -z "$1" ]; then
41
          echo "[ERROR] ${func_name}: --location の引数が指定されていません。"
42
          return 1
43
        fi
44
        location="$1"
45
        ;;
46
      *)
47
        echo "[ERROR] ${func_name}: 不明なパラメータ '$1' です。"
48
        return 1
49
        ;;
50
    esac
51
    shift
52
  done
53

54
  # 必須パラメータのチェック
55
  if [ -z "${job_name}" ]; then
56
    echo "[ERROR] ${func_name}: --job-name は必須パラメータです。"
57
    return 1
58
  fi
59
  if [ -z "${location}" ]; then
60
    echo "[ERROR] ${func_name}: --location は必須パラメータです。"
61
    return 1
62
  fi
63

64
  # コマンド組み立て
65
  local cmd="gcloud scheduler jobs pause ${job_name} --location=${location}"
66
  echo "[INFO] ${func_name}: 実行するコマンド: ${cmd}"
67

68
  # コマンド実行とエラーハンドリング
69
  eval "${cmd}"
70
  if [ $? -ne 0 ]; then
71
    send_discord_notification_about_gcscheduler "失敗…" "ジョブを一時停止できなかったよ…" "red"
72
    echo "[ERROR] ${func_name}: コマンド実行中にエラーが発生しました。"
73
    return 1
74
  fi
75
  send_discord_notification_about_gcscheduler "一時停止したよ！" "ジョブを一時停止したよ！" "green"
76
  echo "[INFO] ${func_name}: Scheduler job '${job_name}' paused successfully."
77
}

実際の使用例#

これらの関数を組み合わせて、実際のユースケースに応用してみましょう。以下は、テスト用コンテナを順番に起動するための関数です。

1
function setup_test_container_container_image() {
2
  resume_gcloud_scheduler_job --job-name 'setup_test_container_container_image_boot_db' --location 'us-central1'
3
  run_gcloud_scheduler_job --job-name 'setup_test_container_container_image_boot_db' --location 'us-central1'
4
  pause_gcloud_scheduler_job --job-name 'setup_test_container_container_image_boot_db' --location 'us-central1'
5
  run_gcloud_scheduler_job --job-name 'setup_test_container_container_image_job_1' --location 'us-central1'
6
  run_gcloud_scheduler_job --job-name 'setup_test_container_container_image_job_2' --location 'us-central1'
7
  run_gcloud_scheduler_job --job-name 'setup_test_container_container_image_job_3' --location 'us-central1'
8
}

この関数では、以下のような処理を行っています。

データベースコンテナを起動するジョブを再開
データベースコンテナを即時実行
データベースコンテナのジョブを一時停止（次回のスケジュール実行を防止）
ジョブ1を実行
ジョブ2を実行
ジョブ3を実行

このように、複数のジョブを順番に実行することで、コンテナ間の依存関係を考慮した起動シーケンスを実現できます。例えば、データベースコンテナが起動してから他のジョブを実行するといった順序制御が可能です。

シェル関数のエラーハンドリングとDiscord通知#

これらの関数には、エラーハンドリングとDiscord通知の機能が組み込まれています。これにより、ジョブの実行状況をリアルタイムで監視できます。

Discord通知の例#

1
send_discord_notification "ジョブを再開するよ！"

エラー発生時の通知#

1
if [ $? -ne 0 ]; then
2
  send_discord_notification_about_gcscheduler "失敗…" "ジョブを再開できなかったよ…" "red"
3
  echo "[ERROR] ${func_name}: コマンド実行中にエラーが発生しました。"
4
  return 1
5
fi

成功時の通知#

1
send_discord_notification_about_gcscheduler "再開したよ！" "ジョブを再開したよ！" "green"

これらの通知機能により、ジョブの実行状況を常に把握できるため、問題が発生した場合にも迅速に対応できます。

シェル関数のパラメータ解析#

これらの関数では、パラメータ解析にwhileループとcase文を使用しています。これにより、--job-nameや--locationなどのパラメータを柔軟に処理できます。

1
while [ $# -gt 0 ]; do
2
  case "$1" in
3
    --help)
4
      echo "$usage"
5
      return 0
6
      ;;
7
    --job-name)
8
      shift
9
      if [ -z "$1" ]; then
10
        echo "[ERROR] ${func_name}: --job-name の引数が指定されていません。"
11
        return 1
12
      fi
13
      job_name="$1"
14
      ;;
15
    --location)
16
      shift
17
      if [ -z "$1" ]; then
18
        echo "[ERROR] ${func_name}: --location の引数が指定されていません。"
19
        return 1
20
      fi
21
      location="$1"
22
      ;;
23
    *)
24
      echo "[ERROR] ${func_name}: 不明なパラメータ '$1' です。"
25
      return 1
26
      ;;
27
  esac
28
  shift
29
done

また、必須パラメータのチェックも行っています。

1
if [ -z "${job_name}" ]; then
2
  echo "[ERROR] ${func_name}: --job-name は必須パラメータです。"
3
  return 1
4
fi
5
if [ -z "${location}" ]; then
6
  echo "[ERROR] ${func_name}: --location は必須パラメータです。"
7
  return 1
8
fi

これにより、パラメータの不足や誤りを早期に検出し、エラーメッセージを表示できます。

まとめ#

今回は、Google Cloud Schedulerのジョブを操作するgcloudコマンドをシェル関数化する方法を紹介しました。シェル関数化することで、以下のようなメリットがあります。

コマンドの簡略化 - 長いコマンドを短い関数名で呼び出せる
パラメータのバリデーション - 必須パラメータの有無をチェックできる
エラーハンドリング - コマンド実行時のエラーを適切に処理できる
ヘルプ機能の追加 - helpオプションでコマンドの使い方を表示できる
通知機能の統合 - Discordなどに実行結果を通知できる
複数コマンドの連携 - 複数のコマンドを組み合わせた処理を1つの関数にまとめられる

これらの関数を使うことで、Cloud Schedulerを使ったコンテナの操作がより簡単かつ安全になります。特に、複数のコンテナを順番に起動するような複雑なシナリオでも、シンプルな関数呼び出しで実現できます。

また、これらの関数はテンプレートとして利用できるため、他のgcloudコマンドをシェル関数化する際にも参考になるでしょう。

おしまい#