概要
本記事は、Dockerfile無しにVS Codeの拡張機能を使って、Dockerの開発環境を構築する方法を提供します。Dockerは開発環境の汚染を防ぐにあたり、有用なツールです。一方、Dockerfileの記載とデバッグに面倒さを感じることがあります。ここでは、簡単にDockerでの開発環境を構築する方法を紹介します。
想定読者
- Dockerに興味を持ったが動かしたことがまだない方
- Dockerを使った開発を体感したい方
- VS CodeからDocker環境へアクセスしたい方
- 簡単にチームの開発環境を統一したい方
環境要件(要Install)
当方はm1 Macbook proに以下をインストールして実施しています。
- Visual Studio Code (Ver. 1.77.3)
- VS code Dev Containers Extension (v0.288.1)
- Docker desktop, Rancher desktopなどのDockerクライアント
方法
工程としては、環境設定ファイル作成、コンテナの起動に分けられます。
Step1. 環境設定ファイル作成
- 任意のフォルダ、ワークスペースをVScodeで開く(本記事では「Qiita」フォルダを開いている)
- VScodeのコマンドパレットを開く
- 「Dev Containers: Add Dev Container configuration Files...」を選択
- 構築したい環境を選択. 今回は以下を例とする
- Python 3 -> 3.11-bullseye
- M1 mac (Apple silicon)でない場合、3.11-bullseyeではなく3.11を選択
- その他環境に入れたいツールを選択(本記事では「Google Cloud CLIを選択」)
- 「.devcontainer」というディレクトリが作成され、devcontainer.jsonが開かれる
Step2: Docker Containerの起動
- 再度、VScodeのコマンドパレットを開く
- 「Dev Containers: Rebuild~~」を選択
- 数十秒から数分待つとコンテナに接続され、VScodeの左下の接続先が画像の様になれば成功(「Dev Container: ~~」の表記)
接続後の状態
Step1-1で開いたQiitaフォルダがマウントされた状態になっています。したがって、git cloneしたフォルダを対象にでStep1-1から始めると、コンテナにそのままLocal Repositoryを持って来れます。あとは必要なPythonモジュールなどをインストールしてください。
最後に
もし本記事がそれなりにアクセスや「いいね」等される様であれば、コンテナの起動と同時にPythonモジュールもインストールする方法も記事にしたいと思います。それでは、御眼鏡に適いましたら、また次回に。