Visual Studio Codeについてのメモ

VSCodeについての自分用メモ。

SSHで接続した先のリモートホスト上で動くDockerコンテナ内で開発する方法。開発環境はDockerコンテナ内に構築する。ローカルマシンにはDockerも開発言語もインストールしなくてよい。

クライアント側から公開鍵でパスワードなしで ssh ユーザ名@ホスト名 で接続できるようにしておく
ローカルにVS Codeをインストールする
拡張機能 Visual Studio Code Remote Development Extension Pack (Remote Development)をインストールする

ソースコードはリモートホスト上に置く。正常にビルドできるDockerfileを用意する。

次のように開発用ユーザーを追加する記述も入れておく。

RUN addgroup -g 1000 devuser && \
    adduser -u 1000 --home /tmp devuser -G devuser -D

Dockerを実行するディレクトリに.devcontainerディレクトリを作成し、その中にdevcontainer.jsonを作成する。以下のような内容で事前に準備してもよいが、なければ初回接続時に一般的な内容のものが作成される。

.devcontainer/devcontainer.json:

{
    "name": "testdev",
    "build": {
        "dockerfile": "../Dockerfile"
    },
    "forwardPorts": [3000],
    "remoteUser": "devuser"
}

"remoteUser"にはDockerfileで作成したユーザーを指定する。

左下の><をクリックし、[ Connect Current Window to Host... ] を選択する
ホストを選択するか、+ Add New SSH Host... をクリック → 上記 ユーザ名@ホスト名 を入力 → .ssh/hosts を選択 → Open Remote を選択する
ソースコードのあるディレクトリを開く
コマンドパレットから [ Reopen in Container ] を選択する