如何構建基於 docker 的開發環境

Gevin發表於2019-02-21

本文首發於Gevin的部落格

原文連結:如何構建基於docker的開發環境

未經 Gevin 授權,禁止轉載


【概要】想了解整個構建思路的同學可以將本文通讀一遍,如果只想瞭解如何構建,直接調到第三部分簡化方案即可

最近docker釋出了Mac版本和Windows版本,使開發者用起來更方便簡單了。Docker本來就是虛擬化技術,基於Docker來構建開發環境順理成章。Gevin這兩天也整理了構建開發環境的思路,在Mac下試驗了一下,整體效果還是滿意的。今天以django開發環境的構建為例,把構建思路記錄下來,和大家分享一下。

如何構建基於 docker 的開發環境
如何構建基於docker的開發環境

一、基本思路

1. 建立一個用於開發Django App的目錄

mkdir django-example && cd django-example複製程式碼

2. 構建基本開發環境

touch Dockerfile
touch pip.conf requirements.txt複製程式碼

pip.conf檔案填入以下內容,以便一會用pip安裝Python 模組時使用阿里雲映象加速:

[global]
index-url = http://mirrors.aliyun.com/pypi/simple/

[install]
trusted-host=mirrors.aliyun.com複製程式碼

requirements.txt檔案中填入要安裝的Python 模組:

django複製程式碼

編寫構建開發環境的Dockerfile檔案,填入以下內容:


# MAINTAINER        Gevin <flyhigher139@gmail.com>
# DOCKER-VERSION    1.12.0
#
# Dockerizing Python: Dockerfile for building python applications


FROM python:2.7.12
MAINTAINER Gevin <flyhigher139@gmail.com>

WORKDIR /usr/src/app

# 使用阿里雲的pip映象
COPY pip.conf /root/.pip/pip.conf 
COPY requirements.txt /usr/src/app/requirements.txt
RUN pip install -r /usr/src/app/requirements.txt

EXPOSE 8000

CMD ["bash"]複製程式碼

然後執行下面命令構建映象:

docker build -t gevin/django-example:0.1 .複製程式碼

構建成功後,執行docker images命令,可以檢視到當前構建好的image

docker images

REPOSITORY             TAG                 IMAGE ID            CREATED             SIZE
gevin/django-example   0.1                 1855fc3c8062        12 hours ago        698.9 MB複製程式碼

3. 使用構建的image拉起開發環境

執行下面命令,可以以前臺形式拉起django-example映象的一個container:

docker run -it --rm -v $(pwd):/usr/src/app gevin/django-example:0.1複製程式碼

上面命令使用了data volume,把當前目錄掛載到container中的工作目錄下,這樣當前目錄下的所有檔案都會對映到container的工作目錄下,在工作目錄下的所有改動,也都會儲存到宿主機的當前目錄下。

4. 建立django專案

上一步的命令建立了一個安裝了django的互動式的container,直接在該container中執行建立django專案的命令即可:

root@7c91f460599f:/usr/src/app# django-admin startproject dj_example複製程式碼

上述命令,在container中基於django的命令建立了一個django專案,由於上一步操作時把宿主機的當前目錄掛載到container的工作目錄下,因此,剛剛在container中建立的django專案,在宿主機上也能看到。

container:

root@7c91f460599f:/usr/src/app# ls
Dockerfile  dj_example    pip.conf  requirements.txt複製程式碼

宿主機:

django-example ls
Dockerfile       dj_example       pip.conf         requirements.txt複製程式碼

5. 啟動django專案

docker run -it --rm -p 8000:8000 -v $(pwd):/usr/src/app gevin/django-example:0.1 python dj_example/manage.py runserver 0.0.0.0:8000複製程式碼

二、Docker-compose與Django環境的結合

每次使用上面章節中介紹的冗長命令來使用django環境非常麻煩,docker-compose可以簡化操作。

首先在當前目錄下建立docker-compose.yml檔案:

➜  django-example touch docker-compose.yml複製程式碼

然後在該檔案中寫入如下內容:

version: `2`
services:
   django-example:
    image: gevin/django-example:0.1
    volumes: 
      - ./dj_example:/usr/src/app
    ports:
      - 8000:8000
    command: python manage.py runserver 0.0.0.0:8000複製程式碼

執行下面命令即可拉起django服務:

➜  django-example docker-compose up

# Starting djangoexample_django-example_1
# Attaching to djangoexample_django-example_1複製程式碼

在瀏覽器中訪問http://localhost:8000,即可看到預設的django頁面

注:

上面的docker-compose檔案,把./dj_example目錄掛載到/usr/src/app,免去執行django命令時,需要對應到下級目錄的麻煩,但這樣隱藏了原來container中的requirements.txt檔案,需要注意。

基於docker-compose 執行django 命令

使用docker-compose 的 run命令,可以在容器內執行相應操作,如:

對django服務的資料庫做migrate操作:

docker-compose run django-example python manage.py migrate複製程式碼

建立超級使用者:

docker-compose run django-example python manage.py createsuperuser

# Username (leave blank to use `root`): gevin
# Email address:
# Password:
# Password (again):
# Superuser created successfully.複製程式碼

建立成功後,訪問http://localhost:8000/admin,即可使用剛建立的使用者(即gevin),登入資料庫管理頁面

由於使用了資料卷,儲存在sqlite資料庫中的資料會一直有效。

三、簡化方案

上面方案已經成功構建了django 環境,並應用於開發。上面的方案主要是為了闡述實現思路,在實際操作起來至少有兩個麻煩:(1)需要進入容器裡面建立django專案;(2)由於django專案是建立在當前目錄的子目錄下,使用docker-compose 時為了命令簡單通用,更換了資料卷。

在實踐中,利用docker-compose的run命令,沒必要進入容器建立django專案;只要把django專案建立在當前目錄下,也沒必要更換資料捲了。

因此,可以把上面的方案再理一下,按下面步驟構建開發環境,並應用到開發中去。

Outline:

  1. 建立Dockerfile檔案
  2. 構建映象
  3. 建立docker-compose檔案
  4. 建立專案
  5. 拉起專案

1. 建立Dockerfile檔案

對Python開發環境而言,最好再建立pip.conf和requirements.txt檔案,以便方便安裝專案必須的Python依賴,其他語言的開發環境就具體情況而定。

以Python為例,Dockerfile 內容如下:

# MAINTAINER        Gevin <flyhigher139@gmail.com>
# DOCKER-VERSION    1.12.0
#
# Dockerizing Python: Dockerfile for building python applications


FROM python:2.7.12
MAINTAINER Gevin <flyhigher139@gmail.com>

WORKDIR /usr/src/app

# 使用阿里雲的pip映象
COPY pip.conf /root/.pip/pip.conf 
COPY requirements.txt /usr/src/app/requirements.txt
RUN pip install -r /usr/src/app/requirements.txt

EXPOSE 8000

CMD ["bash"]複製程式碼

2. 構建映象

docker build -t gevin/django-example:0.1 .複製程式碼

3. 建立docker-compose檔案

docker-compose檔案內容如下:

version: `2`
services:
   django-example:
    image: gevin/django-example:0.1
    volumes: 
      - .:/usr/src/app
    ports:
      - 8000:8000
    command: python manage.py runserver 0.0.0.0:8000複製程式碼

4. 建立專案

docker-compose run django-example django-admin startproject dj_project .複製程式碼

果然需要migrate資料庫,建立超級使用者等,可以在這裡一併建立,也可以在後面的開發中再建立:

docker-compose run django-example python manage.py migrate

docker-compose run django-example python manage.py createsuperuser複製程式碼

5. 拉起專案

docker-compose up複製程式碼

四、其他

Gevin認為,雖然基於docker可以構建開發環境,但還是vagrant用起來更舒服,docker更加適合做CI,測試和部署。

實際工作中如何使用docker,就仁者見仁,智者見智了。

相關文章