自分だけのクイズ作成 - Quipha公開中

【Django】DockerコンテナにMySQL/phpMyAdminを追加

Django
スポンサーリンク

はじめに

前回、Django環境をDockerを使用し構築しました。

上記の記事で解説した環境に、MySQLを追加する手順を解説します。
また、MySQLを管理するためのツールである、phpMyAdminもインストールします。

本記事ではDjangoの開発環境をDockerで構築し、VS Codeからリモートで開発を行います。

今回使用する環境とバージョン

今回試した環境
  • Windows 11 / 10
  • macOS Monterey (M1)
  • PostgreSQL 14.2
  • pgAdmin 6.5

2022/04/20 WindowsとMacを使い、最新バージョンで確認しました。

他にも私のブログで、Djangoについて解説している記事がありますのでご覧ください。

ちなみにPostgreSQL/pgAdminを追加する方法は、以下の記事をご覧ください。

VS Codeインストール

VS Codeのインストール方法は、以下の記事にまとめましたのでご覧ください。

VS Codeのオススメ設定や拡張機能などは、以下の記事にまとめました。

以降の解説キャプチャはWindowsをベースにしていますが、Macでの操作も同様です。

Dockerコンテナの設定

Dockerfile

前回の続きになりますので、構築が済んでいる状態で解説します。

まずは、Dockerfileの定義を修正します。
PythonからMySQLを操作するために、「mysqlclient」というライブラリをインストールします。

FROM python:3.6
ENV PYTHONUNBUFFERED 1
RUN pip install django
RUN pip install mysqlclient

docker-compose.yml

「.devcontainer」フォルダの中に、docker-compose.ymlファイルを作成します。
MySQLなどが稼働するコンテナを複数追加しますので、Docker Composeを利用します。

まずは、それぞれのコンテナごとに解説しています。
最後には全容を載せています。

Pythonコンテナ

「web」というサービス名で、Pythonコンテナを作成します。
Dockerfileをベースにビルドを行います。

  web:
    build: .
    tty: true
    volumes:
      - ../:/workspace
    depends_on:
      - db

ttyを指定することにより、コンテナが終了しないようにしています。
また、コンテナ内の「/workspace」ディレクトリに、ホスト側のDjangoプロジェクトを配置しました。

MySQLコンテナ

mysqlイメージを使用しました。
バージョンを指定し、MySQL 5.7系をインストールします。

DB名と、rootのパスワードを任意で指定します。
また、コマンドで文字コードにutf8mb4を指定します。(デフォルトでlatin1のため)

  db:
    image: mysql:5.7
    volumes:
      - mysql_data:/var/lib/mysql
    environment:
      MYSQL_ROOT_PASSWORD: password
      MYSQL_DATABASE: django_sample
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_bin

volumes:
    mysql_data:

今回は開発目的として、データベースへのアクセスをrootユーザで行います。
また、データは永続化しています。

phpMyAdminコンテナ

phpmyadminのイメージを指定しました。
バージョンは指定していませんが、今回はphpMyAdmin 5.1.1がインストールされます。

開発環境のため、phpMyAdminへ自動でログインできるようにします。(ログイン画面不要)
自動ログインを行うためのホスト、ログイン情報を指定します。

  phpmyadmin:
    image: phpmyadmin/phpmyadmin
    ports:
      - 8080:80
    environment:
      - PMA_HOST=db
      - PMA_USER=root
      - PMA_PASSWORD=password

rootユーザを使用します。
また、開発環境以外でphpMyAdminコンテナを使用する場合は、この自動ログインの設定は適切ではありませんのでご注意ください。

全容

改めて、docker-compose.ymlの中身は以下のようになります。

version: '3'

services:
  web:
    build: .
    tty: true
    volumes:
      - ../:/workspace
    depends_on:
      - db

  db:
    image: mysql:5.7
    volumes:
      - mysql_data:/var/lib/mysql
    environment:
      MYSQL_ROOT_PASSWORD: password
      MYSQL_DATABASE: django_sample
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_bin

  phpmyadmin:
    image: phpmyadmin/phpmyadmin
    ports:
      - 8080:80
    environment:
      - PMA_HOST=db
      - PMA_USER=root
      - PMA_PASSWORD=password

volumes:
    mysql_data:

devcontainer.json

devcontainer.jsonファイルを以下のように修正します。

  • dockerComposeFileにdocker-compose.ymlを指定します。
  • workspaceFolderは、コンテナ側のディレクトリを指定します。(プロジェクトディレクトリ)
  • serviceは、使用するコンテナを指定します。(Pythonコンテナ)
{
	"name": "Django Sample",
	// Dockerfileでイメージ・コンテナを作成
	"dockerComposeFile": "docker-compose.yml",
	// VS Codeのワークスペースフォルダ
	"workspaceFolder": "/workspace",
	// 使用するサービス
	"service": "web",
	// リモート先のVS Codeにインストールする拡張機能
	"extensions": [
		"ms-python.python"
	],
	"shutdownAction": "stopCompose"
}
スポンサーリンク

コンテナのビルド

VS Codeを起動し、左下の緑のアイコンをクリックします。

「Open Folder in Container…」を選択します。

今回作成したプロジェクトフォルダを開きます。
私の場合は以下です。

Windows例:
D:\django-sample-app\
Mac例:
/users/xxx/Documents/django-sample-app

開く際にコンテナがビルドされます。
もし既に開いている状態であれば、「Remote-Containers: Rebuild Container」を選択し、ビルドし直すこともできます。

Docker上から、三つのコンテナが稼働しているのが確認できます。

Djangoのテーブル作成

Djangoのデータベースの設定を変更します。
デフォルトでsqlite3が指定されていますが、MySQLに変更します。

djangoSampleApp/settings.py
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'django_sample',
        'USER': 'root',
        'PASSWORD': 'password',
        'HOST': 'db',
        'PORT': '3306',
    }
}

DB名やユーザ、パスワードなどは、docker-compose.ymlの「db」に記載の通りです。

VS Codeのターミナルを開きます。

以下のコマンドでDjangoのテーブルを作成しましょう。

$ python manage.py migrate

以下のような出力になればOKです。

Operations to perform:
  Apply all migrations: admin, auth, contenttypes, sessions
Running migrations:
  Applying contenttypes.0001_initial... OK
  Applying auth.0001_initial... OK
  Applying admin.0001_initial... OK
  Applying admin.0002_logentry_remove_auto_add... OK
  Applying admin.0003_logentry_add_action_flag_choices... OK
  Applying contenttypes.0002_remove_content_type_name... OK
  Applying auth.0002_alter_permission_name_max_length... OK
  Applying auth.0003_alter_user_email_max_length... OK
  Applying auth.0004_alter_user_username_opts... OK
  Applying auth.0005_alter_user_last_login_null... OK
  Applying auth.0006_require_contenttypes_0002... OK
  Applying auth.0007_alter_validators_add_error_messages... OK
  Applying auth.0008_alter_user_username_max_length... OK
  Applying auth.0009_alter_user_last_name_max_length... OK
  Applying auth.0010_alter_group_name_max_length... OK
  Applying auth.0011_update_proxy_permissions... OK
  Applying auth.0012_alter_user_first_name_max_length... OK
  Applying sessions.0001_initial... OK

phpMyAdminから確認

phpMyAdminコンテナも作成しましたので、ブラウザから以下のURLにアクセスします。

http://localhost:8080/

phpMyAdminの画面が表示されました。
事前にログイン情報などを指定していたため、ログイン画面は表示されずそのままホーム画面が表示されます。

Djangoで作成したテーブルを確認します。
データが正しく挿入されています。

その他

外部サーバーへ公開

作成したアプリは公開して使ってもらいましょう!
Djangoアプリケーションを外部公開する方法をまとめました。

脆弱性対策

脆弱性を抱えたアプリケーションの場合、攻撃を受ける可能性があり大変危険です。
作成したアプリケーションは、脆弱性対策も意識しましょう。

GitHubと連携

GitHubと連携する方法を解説しました。
プロジェクトの管理はGitHubを活用しましょう。

さいごに

今回はDjango環境をDockerを使用し、さらにMySQLを追加する手順を解説しました。
Dockerを使い、コンテナを追加するだけで簡単に拡張できました。

コンテナを作り直すことも容易ですので、開発に便利です。

他にも、Django REST Frameworkを導入すると、APIが簡単に実装できます。

是非活用しましょう。

他にも私のブログで、Djangoについて解説している記事がありますのでご覧ください。

\オススメ/

コメント

タイトルとURLをコピーしました