Laravel Sailで複数のコンテナ間で同じDBを共有する方法

たとえばフロントエンドとバックエンドでDockerコンテナを分けている場合や、管理画面とサービス画面でコンテナを分けている場合など、同じプロジェクトでもDockerコンテナを分けていることがあります。

今回は「testA」と「testB」という2つのDockerコンテナがあるとして、
testAにDBを持たせて、testBからもtestAのDBと接続するというのを実現してみます。

testAのdocker-compose.ymlでは、networkに名前をつける

こちらはデフォルトのdocker-compose.ymlです。

基本的には特に何もいじっておらず
変更する部分は、一番下のnetworks という部分に、 name: testA を追加することです。ここの名前はプロジェクト名などお好きな名前をつけてください。

# For more information: https://laravel.com/docs/sail
version: '3'
services:
    laravel.test:
        build:
            context: ./vendor/laravel/sail/runtimes/8.1
            dockerfile: Dockerfile
            args:
                WWWGROUP: '${WWWGROUP}'
        image: sail-8.1/app
        extra_hosts:
            - 'host.docker.internal:host-gateway'
        ports:
            - '${APP_PORT:-80}:80'
            - '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
        environment:
            WWWUSER: '${WWWUSER}'
            LARAVEL_SAIL: 1
            XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
            XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
        volumes:
            - '.:/var/www/html'
        networks:
            - sail
        depends_on:
            - mysql
    mysql:
        image: 'mysql/mysql-server:8.0'
        ports:
            - '${FORWARD_DB_PORT:-3306}:3306'
        environment:
            MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
            MYSQL_ROOT_HOST: "%"
            MYSQL_DATABASE: '${DB_DATABASE}'
            MYSQL_USER: '${DB_USERNAME}'
            MYSQL_PASSWORD: '${DB_PASSWORD}'
            MYSQL_ALLOW_EMPTY_PASSWORD: 1
        volumes:
            - 'sail-mysql:/var/lib/mysql'
            - './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
        networks:
            - sail
        healthcheck:
            test: ["CMD", "mysqladmin", "ping", "-p${DB_PASSWORD}"]
            retries: 3
            timeout: 5s
networks:
    sail:
        driver: bridge
        name: testA  # ⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦ ここを変更
volumes:
    sail-mysql:
        driver: local

testBのdocker-compose.ymlで、testAのDBを見る設定を行う

注意点としてこちらのdocker-compose.ymlには、mysqlのサービスは入れません。

そして、追記するのは、networksの部分の2行です。

# For more information: https://laravel.com/docs/sail
version: '3'
services:
    laravel.test:
        build:
            context: ./vendor/laravel/sail/runtimes/8.1
            dockerfile: Dockerfile
            args:
                WWWGROUP: '${WWWGROUP}'
        image: sail-8.1/app
        extra_hosts:
            - 'host.docker.internal:host-gateway'
        ports:
            - '${APP_PORT:-80}:80'
            - '${HMR_PORT:-8080}:8080'
        environment:
            WWWUSER: '${WWWUSER}'
            LARAVEL_SAIL: 1
            XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
            XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
        volumes:
            - '.:/var/www/html'
        networks:
            - sail
        depends_on:
            - mysql
    # mysql:
    #     image: 'mysql/mysql-server:8.0'
    #     ports:
    #         - '${FORWARD_DB_PORT:-3306}:3306'
    #     environment:
    #         MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
    #         MYSQL_ROOT_HOST: "%"
    #         MYSQL_DATABASE: '${DB_DATABASE}'
    #         MYSQL_USER: '${DB_USERNAME}'
    #         MYSQL_PASSWORD: '${DB_PASSWORD}'
    #         MYSQL_ALLOW_EMPTY_PASSWORD: 1
    #     volumes:
    #         - 'sail-mysql:/var/lib/mysql'
    #         - './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
    #     networks:
    #         - sail
    #     healthcheck:
    #         test: ["CMD", "mysqladmin", "ping", "-p${DB_PASSWORD}"]
    #         retries: 3
    #         timeout: 5s

networks:
    sail:
        driver: bridge
        external: true # ⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦ ここを追記する
        name: testA # ⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦ ここを追記する
volumes:
    sail-mysql:
        driver: local

追記したのは、この部分です。nameは先ほどtestAで設定したnameにあわせてください。

networks:
    sail:
        driver: bridge
        external: true # ⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦ ここを追記する
        name: testA # ⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦⇦ ここを追記する

これでtestBからtestAのDBを参照することができます。

補足

ただし、testBのDockerコンテナから、 sail mysqlでデータをmysqlのデータの中身を覗きにいくことはできません。
ソースコードでのデータの参照、作成、更新、削除はできます。

2つのコンテナを両方起動させて実装するのはちょっとややこしいですが、
構築は簡単でした🙌