【Google Compute Engine】SSH接続できるDebian VMを構築するシェル関数を作る

1
#!/bin/bash -x
2
#
3
# Startup script to install Chrome remote desktop and a desktop environment.
4
#
5
# See environmental variables at then end of the script for configuration
6
#
7

8
function send_discord_notification() {
9
  # --helpオプションの確認
10
  if [ "$1" == "--help" ] || [ "$1" == "-h" ]; then
11
    cat <<EOF
12
Usage: ${FUNCNAME[0]} <通知テキスト> <Embedのテキスト> <Embedのフッターテキスト> <EmbedのアイコンのURL> <Embedの色> [DISCORD_WEBHOOK_URL]
13

14
Parameters:
15
  通知テキスト           : 通知内容のテキスト
16
  Embedのテキスト        : Embedメッセージの内容
17
  Embedのフッターテキスト : Embedフッターに表示するテキスト
18
  EmbedのアイコンのURL   : Embedフッターに表示するアイコンのURL
19
  Embedの色             : Embedの色（10進数の数値または以下の文字列指定が可能）
20
  DISCORD_WEBHOOK_URL    : (任意) DiscordのWebhook URL。省略した場合は環境変数DISCORD_WEBHOOK_URLを使用します。
21

22
Color Samples:
23
  green     : 4569935   (0x45BB4F)
24
  red       : 16711680  (0xFF0000)
25
  sky_blue  : 52479     (0x00CCFF)
26
  orange    : 14177041  (0xD85311)
27
  white     : 16777215  (0xFFFFFF)
28
  blue      : 39423     (0x0099FF)
29
  yellow    : 16770560  (0xFFE600)
30
  pink      : 16711833  (0xFF0099)
31
  purple    : 10494192  (0xA020F0)
32
  gray_blue : 9212588   (0x8C92AC)
33
  black     : 3355443   (0x333333)
34

35
Examples:
36
  # Using environment variable DISCORD_WEBHOOK_URL (5 arguments)
37
  ${FUNCNAME[0]} "通知テキスト" "Embedのテキスト" "Embedのフッターテキスト" "https://example.com/footer_icon.png" green
38

39
  # Explicitly specifying DISCORD_WEBHOOK_URL as the last argument (6 arguments)
40
  ${FUNCNAME[0]} "通知テキスト" "Embedのテキスト" "Embedのフッターテキスト" "https://example.com/footer_icon.png" red "https://discord.com/api/webhooks/your_webhook_id/your_webhook_token"
41
EOF
42
    return 0
43
  fi
44

45
  local message embed_text embed_footer_text embed_icon_url embed_color webhook_url
46

47
  # Embedなし
48
  # 引数の個数チェック
49
  if [ "$#" -eq 1 ]; then
50
    message="$1"
51
    webhook_url="${DISCORD_WEBHOOK_URL}"
52
    # JSONペイロードの作成
53
    local payload=$(cat <<EOF
54
{
55
  "content": "$message"
56
}
57
EOF
58
    )
59
    # curlでDiscordのWebhookにPOSTリクエストを送信
60
    curl -H "Content-Type: application/json" \
61
      -X POST \
62
      -d "$payload" \
63
      "$webhook_url"
64
    return 0
65
  fi
66

67
  # Embedあり
68
  # 引数の個数チェック
69
  if [ "$#" -eq 5 ]; then
70
    message="$1"
71
    embed_text="$2"
72
    embed_footer_text="$3"
73
    embed_icon_url="$4"
74
    embed_color="$5"
75
    webhook_url="${DISCORD_WEBHOOK_URL}"
76
  elif [ "$#" -eq 6 ]; then
77
    message="$1"
78
    embed_text="$2"
79
    embed_footer_text="$3"
80
    embed_icon_url="$4"
81
    embed_color="$5"
82
    webhook_url="$6"
83
  else
84
    echo "Error: 引数の数が正しくありません。"
85
    cat <<EOF
86
Usage: ${FUNCNAME[0]} <通知テキスト> <Embedのテキスト> <Embedのフッターテキスト> <EmbedのアイコンのURL> <Embedの色> [DISCORD_WEBHOOK_URL];
87
EOF
88
    return 1
89
  fi
90

91
  # いずれかの引数が空文字だった場合のエラーハンドリング
92
  if [ -z "$message" ] || [ -z "$embed_text" ] || [ -z "$embed_icon_url" ] || [ -z "$embed_color" ] || [ -z "$webhook_url" ]; then
93
    echo "Error: 引数に空文字が含まれています。"
94
    cat <<EOF
95
Usage: ${FUNCNAME[0]} <通知テキスト> <Embedのテキスト> <Embedのフッターテキスト> <EmbedのアイコンのURL> <Embedの色> [DISCORD_WEBHOOK_URL];
96
EOF
97
    return 1
98
  fi
99

100
  # Embedの色が文字列の場合、対応する10進数の値に変換
101
  case "$embed_color" in
102
    green)
103
      embed_color=4569935
104
      ;;
105
    red)
106
      embed_color=16711680
107
      ;;
108
    sky_blue)
109
      embed_color=52479
110
      ;;
111
    orange)
112
      embed_color=14177041
113
      ;;
114
    white)
115
      embed_color=16777215
116
      ;;
117
    blue)
118
      embed_color=39423
119
      ;;
120
    yellow)
121
      embed_color=16770560
122
      ;;
123
    pink)
124
      embed_color=16711833
125
      ;;
126
    purple)
127
      embed_color=10494192
128
      ;;
129
    gray_blue)
130
      embed_color=9212588
131
      ;;
132
    black)
133
      embed_color=3355443
134
      ;;
135
    *)
136
      # 数値が直接入力されているものとみなす
137
      ;;
138
  esac
139

140
  # JSONペイロードの作成
141
  local payload=$(cat <<EOF
142
{
143
  "content": "$message",
144
  "embeds": [
145
    {
146
      "description": "$embed_text",
147
      "color": $embed_color,
148
      "timestamp": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")",
149
      "footer": {
150
          "text": "$embed_footer_text",
151
          "icon_url": "$embed_icon_url"
152
      }
153
    }
154
  ]
155
}
156
EOF
157
  )
158

159
  # curlでDiscordのWebhookにPOSTリクエストを送信
160
  curl -H "Content-Type: application/json" \
161
    -X POST \
162
    -d "$payload" \
163
    "$webhook_url"
164
}
165

166
function send_discord_notification_about_gce() {
167
  # 第一引数以降のパラメータは send_discord_notification と同じ順序
168
  # 通知テキストに [GCE] プレフィックスを追加する例
169
  local message="$1"
170
  local embed_text="$2"
171
  local embed_color="$3"
172
  local embed_footer_text="GoogleComputeEngine"
173
  local embed_icon_url=$GCE_ICON_URL
174
  local webhook_url=$DISCORD_WEBHOOK_URL
175

176
  # webhook_url が空でないかチェックし、あれば最後の引数として渡す
177
  if [ -n "$webhook_url" ]; then
178
    send_discord_notification "$message" "$embed_text" "$embed_footer_text" "$embed_icon_url" "$embed_color" "$webhook_url"
179
  else
180
    send_discord_notification "$message" "$embed_text" "$embed_footer_text" "$embed_icon_url" "$embed_color"
181
  fi
182
}
183

184
function set_env_var_from_custom_metadata() {
185
  local key=$1
186
  local MY_CUSTOM_VALUE=$(curl -s -H "Metadata-Flavor: Google" \
187
    http://metadata.google.internal/computeMetadata/v1/instance/attributes/$key)
188
  export $key="$MY_CUSTOM_VALUE"
189
}
190

191
function install_chrome_remote_desktop() {
192
  curl https://dl.google.com/linux/linux_signing_key.pub \
193
    | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/chrome-remote-desktop.gpg
194
  echo "deb [arch=amd64] https://dl.google.com/linux/chrome-remote-desktop/deb stable main" \
195
    | sudo tee /etc/apt/sources.list.d/chrome-remote-desktop.list
196
  sudo apt-get update
197
  sudo DEBIAN_FRONTEND=noninteractive \
198
    apt-get install --assume-yes chrome-remote-desktop
199
  echo "[INFO] Setup for Chrome Remote Desktop completed successfully."
200
}
201

202
function install_xfce_desktop_env() {
203
  # Xfce デスクトップ環境の導入
204
  sudo DEBIAN_FRONTEND=noninteractive \
205
    apt install --assume-yes xfce4 desktop-base dbus-x11 xscreensaver
206
  # Xfce デスクトップ環境をデフォルトへ設定
207
  sudo bash -c 'echo "exec /etc/X11/Xsession /usr/bin/xfce4-session" > /etc/chrome-remote-desktop-session'
208
  # Chrome ブラウザをインストール
209
  curl -L -o google-chrome-stable_current_amd64.deb \
210
  https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
211
  sudo apt install --assume-yes --fix-broken ./google-chrome-stable_current_amd64.deb
212
  # Color Manager を停止
213
  sudo systemctl stop colord
214
  sudo systemctl disable colord
215
  echo "[INFO] Setup for Xfce (X Windows System Desktop Environment) completed successfully."
216
}
217

218
function install_desktop_env_with_xfce() {
219
  install_chrome_remote_desktop
220
  install_xfce_desktop_env
221
}
222

223
function install_lxqt_desktop_env() {
224
  # LXQt デスクトップ環境の導入
225
  sudo DEBIAN_FRONTEND=noninteractive \
226
    apt install --assume-yes lxqt dbus-x11
227
  # LXQt デスクトップ環境をデフォルトへ設定
228
  echo "exec startlxqt" > /etc/chrome-remote-desktop-session
229
  # Chrome ブラウザをインストール
230
  curl -L -o google-chrome-stable_current_amd64.deb \
231
    https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
232
  sudo apt install --assume-yes --fix-broken ./google-chrome-stable_current_amd64.deb
233
  # Color Manager を停止
234
  sudo systemctl stop colord 2>/dev/null
235
  sudo systemctl disable colord 2>/dev/null
236
  echo "[INFO] Setup for LXQt (X Windows System Desktop Environment) completed successfully."
237
}
238

239
function install_desktop_env_with_lxqt() {
240
  install_chrome_remote_desktop
241
  install_lxqt_desktop_env
242
}
243

244
function download_and_install { # args URL FILENAME
245
  if [[ -e "$2" ]] ; then
246
    echo "cannot download $1 to $2 - file exists"
247
    return 1;
248
  fi
249
  curl -L -o "$2" "$1" && \
250
    apt-get install --assume-yes --fix-broken "$2" && \
251
    rm "$2"
252
}
253

254
function is_installed {  # args PACKAGE_NAME
255
  dpkg-query --list "$1" | grep -q "^ii" 2>/dev/null
256
  return $?
257
}
258

259
function install_japanese_locale() {
260
  # install japanese locale
261
  sudo apt -y install locales
262
  sudo localectl set-locale LANG=ja_JP.UTF-8 LANGUAGE="ja_JP:ja"
263
  source /etc/default/locale
264
  echo $LANG
265

266
  # install japanese locale for desktop
267
  sudo apt -y install task-japanese-desktop
268
}
269

270
function setup_japanese_timezone() {
271
  sudo chmod 777 /etc/timezone
272
  sudo rm /etc/localtime
273
  echo Asia/Tokyo > /etc/timezone
274
  sudo chmod 644 /etc/timezone
275
  sudo dpkg-reconfigure -f noninteractive tzdata
276
}
277

278
function install_japanese_input_method() {
279
  # install input methods
280
  sudo apt update
281
  sudo apt install fcitx5-mozc -y
282

283
  touch ~/.profile
284
  inserting=$(cat <<EOF
285
while true; do
286
  dbus-update-activation-environment --systemd DBUS_SESSION_BUS_ADDRESS DISPLAY XAUTHORITY 2> /dev/null && break
287
done
288

289
export GTK_IM_MODULE=fcitx
290
export QT_IM_MODULE=fcitx
291
export XMODIFIERS="@im=fcitx"
292
if [ $SHLVL = 1 ] ; then
293
  (fcitx5 --disable=wayland -d --verbose '*'=0 &)
294
  xset -r 49  > /dev/null 2>&1
295
fi
296
EOF
297
  )
298
  echo $inserting >> ~/.profile
299

300
  im-config -n fcitx5
301
}
302

303
function setup_dev_resources() {
304
  # Setup development resources
305
  # local home_dir="$DEV_HOME"
306
  sudo apt update
307
  sudo apt install git -y
308
}
309

310
function setup_vscode() {
311
  # Install VSCode
312
  wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > packages.microsoft.gpg
313
  sudo install -D -o root -g root -m 644 packages.microsoft.gpg /etc/apt/keyrings/packages.microsoft.gpg
314
  sudo sh -c 'echo "deb [arch=amd64,arm64,armhf signed-by=/etc/apt/keyrings/packages.microsoft.gpg] https://packages.microsoft.com/repos/code stable main" > /etc/apt/sources.list.d/vscode.list'
315
  rm -f packages.microsoft.gpg
316
  sudo apt install apt-transport-https
317
  sudo apt update
318
  sudo apt install code
319
}
320

321
# Configure the following environmental variables as required:
322
INSTALL_XFCE=yes
323
INSTALL_CINNAMON=yes
324
INSTALL_CHROME=yes
325
INSTALL_FULL_DESKTOP=yes
326

327
# Any additional packages that should be installed on startup can be added here
328
EXTRA_PACKAGES="less bzip2 zip unzip tasksel wget"
329

330
set_env_var_from_custom_metadata VSC_PROFILE_URL
331
set_env_var_from_custom_metadata DISCORD_WEBHOOK_URL
332
set_env_var_from_custom_metadata GCE_ICON_URL
333
send_discord_notification "VMのカスタムメタデータを環境変数に反映したよ！"
334

335
send_discord_notification "VMのスタートアップスクリプトを実行するよ！"
336

337
apt-get update
338

339
# Install X Windows desktop system
340
if ! is_installed chrome-remote-desktop; then
341
  # install_desktop_env_with_xfce
342
  install_desktop_env_with_lxqt
343
fi
344

345
# install_desktop_env_with_xfce
346
# install_desktop_env_with_lxqt
347
send_discord_notification "VMのデスクトップ環境の設定が完了したよ！"
348

349
# [[ "$INSTALL_CHROME" = "yes" ]] && ! is_installed google-chrome-stable && \
350
#   download_and_install \
351
#     https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb \
352
#     /tmp/google-chrome-stable_current_amd64.deb
353

354
echo "[INFO] Chrome remote desktop installation completed"
355
send_discord_notification "VMのChromeリモデの設定が完了したよ！"
356

357
install_japanese_locale
358
echo "[INFO] Install japanese locale completed"
359
send_discord_notification "VMのロケールの設定が完了したよ！"
360

361
setup_japanese_timezone
362
echo "[INFO] Setup timezone completed"
363
send_discord_notification "VMのタイムゾーンの設定が完了したよ！"
364

365
install_japanese_input_method
366
echo "[INFO] Pre-installation of japanese input methods completed"
367
send_discord_notification "VMのIMEの設定が完了したよ！"
368

369
setup_dev_resources
370
echo "[INFO] Setup development resources completed"
371
send_discord_notification "VMの開発リソースの設定が完了したよ！"
372

373
setup_vscode
374
echo "[INFO] Setup for VSCode completed"
375
send_discord_notification "VMのVSCodeの設定が完了したよ！"
376
send_discord_notification_about_gce "終わった！" "VMのスタートアップスクリプトが完了したよ！" "green"