GPU なしの Ubuntu 24.04 に Amazon DCV でリモートデスクトップ環境を作る手順

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::dcv-license.ap-northeast-1/*"
        }
    ]
}

#!/bin/bash
#
# 実行ログは /var/log/cloud-init-output.log に出るので何か不都合でたときに確認
#
set -x
export DEBIAN_FRONTEND=noninteractive

DCV_VERSION="2025.0-20103"
DCV_ARCHIVE="nice-dcv-${DCV_VERSION}-ubuntu2404-x86_64"
DCV_BASE_URL="https://d1uj6qtbmh3dt5.cloudfront.net"

# =============================================================================
# Linux Amazon DCV サーバーの前提条件
# @see: https://docs.aws.amazon.com/ja_jp/dcv/latest/adminguide/setting-up-installing-linux-prereq.html
# =============================================================================

## デスクトップ環境とデスクトップマネージャーをインストールする
if [ -f /etc/needrestart/needrestart.conf ]; then
    sudo sed -i "s/#\$nrconf{restart} = 'i';/\$nrconf{restart} = 'l';/g" /etc/needrestart/needrestart.conf
    sudo sed -i "s/#\$nrconf{kernelhints} = -1;/\$nrconf{kernelhints} = -1;/g" /etc/needrestart/needrestart.conf
    ### 確認コマンド: 2 行ともコメントアウトが外れていること
    grep -nE 'nrconf\{(restart|kernelhints)\}' /etc/needrestart/needrestart.conf
fi

### デスクトップ環境とデスクトップマネージャーをインストールする
sudo DEBIAN_FRONTEND=noninteractive apt update
sudo DEBIAN_FRONTEND=noninteractive apt install -y ubuntu-desktop
sudo DEBIAN_FRONTEND=noninteractive apt install -y gdm3

### GDM3 を起動する（GDM3 がアクティブでない場合があるため）
sudo systemctl start gdm3

### GDM3 をデフォルトのデスクトップマネージャーに設定する
sudo dpkg-reconfigure -f noninteractive gdm3

### 確認コマンド: /usr/sbin/gdm3 が返ること
cat /etc/X11/default-display-manager

### ソフトウェアパッケージをアップグレードする
sudo DEBIAN_FRONTEND=noninteractive apt upgrade -y

## Wayland プロトコルを無効にする
### Amazon DCV は Wayland に対応しないため、GDM 利用時は無効化が必須
### コメント行の有無に関わらず WaylandEnable=false を確実に置く
if grep -q '^#WaylandEnable=false' /etc/gdm3/custom.conf; then
    sudo sed -i 's/^#WaylandEnable=false/WaylandEnable=false/' /etc/gdm3/custom.conf
elif ! grep -q '^WaylandEnable=false' /etc/gdm3/custom.conf; then
    sudo sed -i '/^\[daemon\]/a WaylandEnable=false' /etc/gdm3/custom.conf
fi

### 確認コマンド: WaylandEnable=false がコメントアウトされずに存在すること
grep -n 'WaylandEnable' /etc/gdm3/custom.conf

### GDM サービスを再起動する
sudo systemctl restart gdm3

## X サーバーを設定する
### コンソールセッションを使うため X サーバーが必要
### （仮想セッションのみを使う構成なら、このセクションと XDummy は不要になる）
sudo systemctl set-default graphical.target
sudo systemctl isolate graphical.target

### 確認コマンド: 出力があること（X サーバーが実行中であること）
ps aux | grep X | grep -v grep

## glxinfo ユーティリティをインストールする
sudo DEBIAN_FRONTEND=noninteractive apt install -y mesa-utils

## グラフィックスインスタンス用の GPU ドライバーをインストールする
### ※ GPU インスタンスの場合のみ。CPU インスタンスでは Mesa による
###    ソフトウェアレンダリングのみがサポートされる

## GPU 以外のインスタンスに XDummy ドライバーをインストールする
sudo DEBIAN_FRONTEND=noninteractive apt install -y xserver-xorg-video-dummy

### xorg.conf で XDummy を設定する
sudo bash -c 'cat > /etc/X11/xorg.conf' << 'EOF'
Section "Device"
    Identifier "DummyDevice"
    Driver "dummy"
    Option "UseEDID" "false"
    VideoRam 512000
EndSection

Section "Monitor"
    Identifier "DummyMonitor"
    HorizSync   5.0 - 1000.0
    VertRefresh 5.0 - 200.0
    Option "ReducedBlanking"
EndSection

Section "Screen"
    Identifier "DummyScreen"
    Device "DummyDevice"
    Monitor "DummyMonitor"
    DefaultDepth 24
    SubSection "Display"
        Viewport 0 0
        Depth 24
        Virtual 4096 2160
    EndSubSection
EndSection
EOF

### X サーバーを再起動して、変更を有効にする
sudo systemctl isolate multi-user.target
sudo systemctl isolate graphical.target

# =============================================================================
# Linux に Amazon DCV サーバーをインストールする
# @see: https://docs.aws.amazon.com/ja_jp/dcv/latest/adminguide/setting-up-installing-linux-server.html
# =============================================================================

## 作業ディレクトリを作成して移動する
mkdir -p /home/ubuntu/dcv && cd /home/ubuntu/dcv

## GPG キーをインポートする
### Ubuntu は rpm --import ではなく wget + gpg --import
### なおこの鍵はユーザーキーリングに入るだけで、ローカルファイル指定の
### apt install では署名検証に使われない
wget "${DCV_BASE_URL}/NICE-GPG-KEY"
gpg --import NICE-GPG-KEY

## Amazon DCV パッケージをダウンロードする
### 例: https://d1uj6qtbmh3dt5.cloudfront.net/2025.0/Servers/nice-dcv-2025.0-20103-ubuntu2404-x86_64.tgz
wget "${DCV_BASE_URL}/${DCV_VERSION%%-*}/Servers/${DCV_ARCHIVE}.tgz"

## .tgz アーカイブを展開し、展開されたディレクトリに移動する
tar -xvzf "${DCV_ARCHIVE}.tgz" && cd "${DCV_ARCHIVE}"

## Amazon DCV サーバーをインストールする
### nice-dcv-server_2025.0.20103-1_amd64.ubuntu2404.deb
sudo DEBIAN_FRONTEND=noninteractive apt install -y ./nice-dcv-server_*_amd64.ubuntu2404.deb

## Web ブラウザクライアント用のパッケージをインストールする
### nice-dcv-web-viewer_2025.0.20103-1_amd64.ubuntu2404.deb
### クライアント側のインストールは不要。サーバー側にこれを入れる
sudo DEBIAN_FRONTEND=noninteractive apt install -y ./nice-dcv-web-viewer_*_amd64.ubuntu2404.deb

## dcv ユーザーを video グループに追加する
### 公式手順ではサーバー → web-viewer の後、nice-xdcv の前に置かれている
sudo usermod -aG video dcv

## 仮想セッションを使う場合は nice-xdcv を入れる
### 今回はコンソールセッション構成のため導入しない
# sudo DEBIAN_FRONTEND=noninteractive apt install -y ./nice-xdcv_*_amd64.ubuntu2404.deb

## GPU 共有を使う場合は nice-dcv-gl を入れる
### CPU インスタンスでは不要
# sudo DEBIAN_FRONTEND=noninteractive apt install -y ./nice-dcv-gl_*_amd64.ubuntu2404.deb

## ホームディレクトリに戻り、ダウンロードした .tgz アーカイブを削除する
cd /home/ubuntu
sudo rm -f "dcv/${DCV_ARCHIVE}.tgz"

# =============================================================================
# インストール後のチェック
# @see: https://docs.aws.amazon.com/ja_jp/dcv/latest/adminguide/setting-up-installing-linux-checks.html
# =============================================================================

## X サーバーがアクセス可能であることを確認する
### X サーバーを再起動する
sudo systemctl isolate multi-user.target
sudo systemctl isolate graphical.target

### isolate の直後は Xorg がまだ起動しておらず、-auth 付きのプロセスが見つからない
### 確認コマンドが空振りしないよう、プロセスが現れるまで最大 60 秒待つ
for i in $(seq 1 30); do
    ps aux | grep "X.*\-auth" | grep -v Xdcv | grep -v grep > /dev/null && break
    sleep 2
done

### 確認コマンド: "SI:localuser:dcv" が返ること
### 公式の現行版は Xdcv プロセスを拾わないよう grep -v Xdcv を挟む
sudo DISPLAY=:0 XAUTHORITY=$(ps aux | grep "X.*\-auth" | grep -v Xdcv | grep -v grep | sed -n 's/.*-auth \([^ ]\+\).*/\1/p') xhost | grep "SI:localuser:dcv$"

### 同コマンドを 2 回実行しなければ "SI:localuser:dcv" が返らない場合がある
sudo DISPLAY=:0 XAUTHORITY=$(ps aux | grep "X.*\-auth" | grep -v Xdcv | grep -v grep | sed -n 's/.*-auth \([^ ]\+\).*/\1/p') xhost | grep "SI:localuser:dcv$"

## GPU なしのため OpenGL がソフトウェアレンダリングで使えることを確認する
sudo DISPLAY=:0 XAUTHORITY=$(ps aux | grep "X.*\-auth" | grep -v Xdcv | grep -v grep | sed -n 's/.*-auth \([^ ]\+\).*/\1/p') glxinfo | grep -i "opengl.*version"

# =============================================================================
# Amazon DCV サーバーが自動的に起動するように設定する
# @see: https://docs.aws.amazon.com/ja_jp/dcv/latest/adminguide/manage-start.html
# =============================================================================
sudo systemctl enable dcvserver

# =============================================================================
# 自動コンソールセッションの有効化
# @see: https://docs.aws.amazon.com/ja_jp/dcv/latest/adminguide/managing-sessions-start.html#managing-sessions-start-auto
# =============================================================================

## [session-management] の create-session を有効にする
### コメント行があれば外し、無ければセクションへ追記する
### （セクションごと無ければ末尾に作る）
if grep -q '^#create-session' /etc/dcv/dcv.conf; then
    sudo sed -i 's/^#create-session.*/create-session = true/' /etc/dcv/dcv.conf
elif ! grep -q '^create-session' /etc/dcv/dcv.conf; then
    if grep -q '^\[session-management\]' /etc/dcv/dcv.conf; then
        sudo sed -i '/^\[session-management\]/a create-session = true' /etc/dcv/dcv.conf
    else
        printf '\n[session-management]\ncreate-session = true\n' | sudo tee -a /etc/dcv/dcv.conf
    fi
fi

## [session-management/automatic-console-session] の owner を ubuntu にする
### 所有者を ubuntu にしないと、コンソールセッションの所有者が root になる
if grep -q '^#owner' /etc/dcv/dcv.conf; then
    sudo sed -i 's/^#owner.*/owner = "ubuntu"/' /etc/dcv/dcv.conf
elif ! grep -q '^owner' /etc/dcv/dcv.conf; then
    if grep -q '^\[session-management/automatic-console-session\]' /etc/dcv/dcv.conf; then
        sudo sed -i '/^\[session-management\/automatic-console-session\]/a owner = "ubuntu"' /etc/dcv/dcv.conf
    else
        printf '\n[session-management/automatic-console-session]\nowner = "ubuntu"\n' | sudo tee -a /etc/dcv/dcv.conf
    fi
fi

### 確認コマンド: create-session と owner がコメントアウトされずに存在すること
### ここが空振りすると自動コンソールセッションが作られない
grep -nE '^\[|^create-session|^owner' /etc/dcv/dcv.conf

## Amazon DCV サービスを再起動する
sudo systemctl restart dcvserver

## 確認コマンド: 'console' セッションが作成されていること
### 起動直後は一覧に出ないことがある。空振りしたら数十秒後に再実行する
sleep 5
sudo dcv list-sessions

aws ssm start-session --target <インスタンスID> --region ap-northeast-1

cloud-init status
sudo dcv list-sessions

status: done
Session: 'console' (owner:ubuntu type:console)

sudo passwd ubuntu

aws ssm start-session --target <インスタンスID> \
  --document-name AWS-StartPortForwardingSession \
  --parameters '{"portNumber":["8443"],"localPortNumber":["8443"]}' \
  --region ap-northeast-1

Starting session with SessionId: <セッションID>
Port 8443 opened for sessionId <セッションID>.
Waiting for connections...