# Docker & Docker-compose部署
###### tags: `環境工具`, `VM`, `docker`

- [大綱](#大綱)
- [撰寫Dockerfile及打包映像檔](#撰寫Dockerfile及打包映像檔)
- [建立spring-boot-映像檔](#建立spring-boot-映像檔)
- [建立mariadb的映像檔且將現有資料庫放入並打包](#建立mariadb的映像檔且將現有資料庫放入並打包)
- [建立docker-compose以一次啟動多個container](#建立docker-compose以一次啟動多個container)
- [docker-compose介紹](#docker-compose介紹)
- [單獨使用docker-compose完成上述動作](#單獨使用docker-compose完成上述動作)

# 大綱

本文將會一步步用Dockerfile建立映像檔，並建立docker-compose檔來一次啟動多個容器。

大致分為三大步驟:

1. 建立名為bpm的映像檔
2. 建立名為db的映像檔
3. 撰寫docker-compose將上述二者同時啟動並設定相關環境變數

>💡 在章節: [單獨使用docker-compose完成上述動作](#單獨使用docker-compose完成上述動作) ，有更快、更方便的方法。

# 撰寫Dockerfile及打包映像檔

## 建立spring boot 映像檔

docker可以直接使用docker build，但也可以使用Dockerfile來自定義一些設定。接下來將會使用Dockerfile來建立docker image。

1. 建立一個新的資料夾，命名為”app”。
2. 在app資料夾中建立一個文字檔並另存為檔名”Dockerfile”，沒有副檔名。
3. 開啟[Dockerfile](https://www.notion.so/bpm-Dockerfile-4de58420c1c5426f952859cc5a0bfb9d)，填入以下內容:

    FROM ibmjava:8-sfj
    ARG JAR_FILE=*.jar
    COPY ${JAR_FILE} app.jar
    COPY wait.sh /wait.sh
    RUN chmod +x /wait.sh
    ENTRYPOINT ["/bin/bash", "./wait.sh", "db:3306", "-t", "0", "--", "java", "-jar", "app.jar"]

- `FROM image` : 此映像檔是基於哪個基礎映像檔。
- `ARG 變數名稱 = 變數值` : 建立變數，若要使用此變數則用{$變數名稱}來引用。
- `COPY source destination` : 根據當前位置，將source複製到image裡的目的地。
- 請注意destination(目的地)是在linux image裡的位置，而非當前windows的路徑。
- `RUN linux-command` : RUN後面加上要執行的linux指令。
- `ENTRYPOINT [“executable”, “param1”, “param2”]` : 在image開啟後執行。
- 若有多個ENTRYPOINT，只會取最後的ENTRYPOINT執行。CMD亦是。

由上述程式碼可知，執行Dockerfile會將`*.jar`與`wait.sh`複製進image裡，所以還需要將此兩檔案放入與Dockerfile同層。完成後資料夾會長:

- app
- Dockerfile
- ```wait.sh```
- *.jar

    
    - port : 指定監聽的port
    - -t param : 等待的上限時間，超過則直接結束。若為0則無上限。
    - —command : 監聽的port成功接通後執行的指令。
4. 在app資料夾中開啟cmd，並執行`docker build -t bpm .`，執行完將會建立名為bpm的映像檔。 
    - `docker build [OPTIONS] path` : 此指令用來建立映像檔。
    - `-t bpm` : OPTIONS`--tag`，是將建立的映像檔命名為bpm
    - 執行成功將會如下圖:
        
        ![](https://i.imgur.com/dwtjMMV.png)

        
    - 可以在docker desktop裡的image看到
        
        ![](https://i.imgur.com/RXPiP3I.png)

        
5. 若想要將此映像檔保存起來，則使用指令`docker save -o bpm.tar bpm` ，即可將映像檔打包成.tar檔。
    - `docker save [OPTIONS] image_tag` : 用此指令將映像檔打包。
    - `-o 輸出檔名` : OPTIONS，`--output`，指定輸出的檔名，包含副檔名。

## 建立mariadb的映像檔且將現有資料庫放入並打包

1. 建立新資料夾，命名為”db”。
2. 在資料夾db內建立一個文字檔並另存為檔名”Dockerfile”，沒有副檔名。
3. 開啟Dockerfile，填入以下內容 :
    

FROM mariadb
COPY data/. /var/lib/mysql

    
    - 由程式碼可知，應會將data資料夾內的所有東西複製到linux裡的/var/lib/mysql裡，所以還需要將data資料夾放入與Dockerfile同層，而data資料夾裡放的是資料庫的資料，為bpm用到的資料庫，可在所需資料下載，完成後資料夾會長:
        - db
            - Dockerfile
            - data
4. 在app資料夾中開啟cmd，並執行`docker build -t db .`，執行完將會建立名為db的映像檔。 
    - 執行成功將如下圖:
        
        ![](https://i.imgur.com/HGHvDhA.png)

        
    - 可以在docker desktop裡的image看到
        
        ![](https://i.imgur.com/A8YgbDl.png)

        
5. 若想要將此映像檔保存起來，則使用指令`docker save -o db.tar db` ，即可將映像檔打包成.tar檔。

# 建立docker-compose以一次啟動多個container

## docker-compose介紹

- 建立新的文字檔並命名成docker-compose，副檔名為.yml。
- docker-compose包含~~四~~六大部分:
    1. `version` : 非必要，docker compose的架構版本。
    2. `services` : 必要，容器的相關設定。
    3. `networks` : 非必要，容器之間的網路設定
    4. `volumes` : 非必要，容器之間的共用資料空間的設定。
    5. `configs` : 非必要，容器額外設定。
    6. `secrets` : 非必要，管理敏感數據，ex:token、password、SSH金鑰等。

前面已經建立兩個我們要用的映像檔，現在就是用docker-compose.yml來整合，並一次啟動所有的服務，跟著以下步驟即可簡單又快速地建立起服務 : 

1. 建立新資料夾，命名為”compose”。
2. 在compose資料夾中建立新的文字檔並命名成docker-compose，副檔名為.yml。
3. docker-compose.yml:
    1. 首先，先寫大項目，本次只會用到services與networks。
        

services:

networks:

        
    2. 我們有兩個容器要建立，bpm與db，其對應的映像檔為前面建立的，先寫db的部分:
        

services:
db:
image: db
environment:
- MYSQL_ROOT_PASSWORD=root
- MYSQL_USER=test
- MYSQL_PASSWORD=test

networks:

        
        - `services` :
            - `db` : 建立的容器名字
                - `image` : 為此容器要使用的映像檔。
                - `environment` : 此容器的環境變數。
                    - `MYSQL_ROOT_PASSWORD=root` : 資料庫的root使用者密碼。
                    - `MYSQL_USER=test` : 建立名為test的使用者。
                    - `MYSQL_PASSWORD=test` : 設定使用者test的密碼。
    3. 再來寫bpm的部分 :
        

services:
db:
image: db
ports:
- 3306:3306
environment:
- MYSQL_ROOT_PASSWORD=root
- MYSQL_USER=test
- MYSQL_PASSWORD=test
bpm:
image: bpm
depends_on:
- db
ports:
- 8080:8080
environment:
- DATASOURCE_HOST=db
- DATASOURCE_POST=3306
- DATASOURCE_NAME=rp_bpm
- DATASOURCE_USERNAME=test
- DATASOURCE_PASSWORD=test
networks:

        
        - `bpm` :
            - `image` : 建立的容器名字
            - `depends_on` : 等到指定的container啟動後，該容器才會啟動。此處情況為等到db啟動，bpm才會啟動。
            - `ports` : 指定對外的port，前者為本機的port，後者為容器的port。此處為將本機的port:8080與容器的port:8080作連接。
            - `environment` : 此容器的環境變數。
                - `DATASOURCE_HOST=db` : 要連接的ip，此處可用容器的名字來代表ip
                - `DATASOURCE_POST=3306` : 要連接的ip的port。
                - `DATASOURCE_NAME=rp_bpm` : 要連接的database名稱。
                - `DATASOURCE_USERNAME=test` : 存取資料庫所使用的使用者名字。
                - `DATASOURCE_PASSWORD=test` : 存取資料庫所使用的使用者密碼。
    4. 若不寫networks的項目也是可以，因為系統會自動建立以當前資料夾名稱+"_default"為名的network，並將db與bpm以其容器名稱加入到此網路中。但我想寫:
        

services:
db:
image: db
environment:
- MYSQL_ROOT_PASSWORD=root
- MYSQL_USER=test
- MYSQL_PASSWORD=test
networks:
- net001
bpm:
image: bpm
depends_on:
- db
ports:
- 8080:8080
environment:
- DATASOURCE_HOST=db
- DATASOURCE_POST=3306
- DATASOURCE_NAME=rp_bpm
- DATASOURCE_USERNAME=test
- DATASOURCE_PASSWORD=test
networks:
- net001

networks:
net001:

        
        - 新增net001的網路至netowrks，並將db與bpm都配置進去
    5. 如此一來docker-compose檔就建立完成了，在當前資料夾開啟cmd，並執行指令        `docker compose up -d` 。
        - `-d` : 設定為背景執行。
        - 執行成功將會如下圖:
            
            <img src="https://i.imgur.com/4ivlVBH.png"/>
 
        - 在docker desktop的container中會看到如下圖:
        
            <img src="https://i.imgur.com/2BvUlMV.png"/>    
            
        - 點擊紅圈部分進入執行視窗，如下圖 。出現紅色箭頭即為成功。
        
            <img src="https://i.imgur.com/bnThg7A.jpg" />

        
            
    6. 進入網頁[http://localhost:8080/](http://localhost:8080/)，成功的話會出現下圖:
    
        <img src="https://i.imgur.com/npR9OxZ.png"/>
        
        

# 單獨使用docker-compose完成上述動作

- 此章節將單獨使用docker-compose來啟動服務，核心概念其實就是撰寫指令使其去讀取特定的dockerfile，讓使用者只需打一個指令即可架設服務。
- 目前的資料夾結構與前面章節應不會差太多:
    - compose
        - app
            - *.jar
            - Dockerfile
            - wait.sh
        - db
            - data
                
                此資料夾存放資料庫的資料。
                
        - docker-compose.yml
- 需要在docker-compose.yml裡新增一些指令:
    

services:
db:
image: mariadb #修改的
volumes:
- "./db/data:/var/lib/mysql" #新增的
environment:
- MYSQL_ROOT_PASSWORD=root
- MYSQL_USER=test
- MYSQL_PASSWORD=test
networks:
- net001
bpm:
#image: bpm 移除的
build: #新增的
context: ./app #新增的
dockerfile: Dockerfile #新增的
depends_on:
- db
ports:
- 8080:8080
environment:
- DATASOURCE_HOST=db
- DATASOURCE_POST=3306
- DATASOURCE_NAME=rp_bpm
- DATASOURCE_USERNAME=test
- DATASOURCE_PASSWORD=test
networks:
- net001

networks:
net001:

    
    - 在db裡
        - 將`image`修改成mariadb
        - 新增`volumes`，將本機上的`./db/data`掛載到container裡的`/var/lib/mysql` ，如此便不用多花時間將檔案複製進container。
    - 在bpm裡
        - 將`image`移除，因為此動作將在我們所指定的dockerfile完成。
        - 新增`build`，建立映像檔時的一些設定。
            - `context`: 上下文路徑，與docker-compose的相對路徑，通常用於指定dockerfile的位置。
            - `dockerfile`: 要存取的dockerfile的檔案名稱。
- 將`docker-compose.yml`修改完，即可在該路徑下叫出cmd並輸入指令`docker compose up`來啟動服務

# 所需檔案

### wait.sh

#!/bin/bash
# Use this script to test if a given TCP host/port are available

WAITFORIT_cmdname=${0##*/}

echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }

usage()
{
cat << USAGE >&2
Usage:
$WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
-h HOST | --host=HOST Host or IP under test
-p PORT | --port=PORT TCP port under test
Alternatively, you specify the host and port as host:port
-s | --strict Only execute subcommand if the test succeeds
-q | --quiet Don't output any status messages
-t TIMEOUT | --timeout=TIMEOUT
Timeout in seconds, zero for no timeout
-- COMMAND ARGS Execute command with args after the test finishes
USAGE
exit 1
}

wait_for()
{
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
else
echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
fi
WAITFORIT_start_ts=$(date +%s)
while :
do
if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
nc -z $WAITFORIT_HOST $WAITFORIT_PORT
WAITFORIT_result=$?
else
(echo -n > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
WAITFORIT_result=$?
fi
if [[ $WAITFORIT_result -eq 0 ]]; then
WAITFORIT_end_ts=$(date +%s)
echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
break
fi
sleep 1
done
return $WAITFORIT_result
}

wait_for_wrapper()
{
# In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
if [[ $WAITFORIT_QUIET -eq 1 ]]; then
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
else
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
fi
WAITFORIT_PID=$!
trap "kill -INT -$WAITFORIT_PID" INT
wait $WAITFORIT_PID
WAITFORIT_RESULT=$?
if [[ $WAITFORIT_RESULT -ne 0 ]]; then
echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
fi
return $WAITFORIT_RESULT
}

# process arguments
while [[ $# -gt 0 ]]
do
case "$1" in
*:* )
WAITFORIT_hostport=(${1//:/ })
WAITFORIT_HOST=${WAITFORIT_hostport[0]}
WAITFORIT_PORT=${WAITFORIT_hostport[1]}
shift 1
;;
--child)
WAITFORIT_CHILD=1
shift 1
;;
-q | --quiet)
WAITFORIT_QUIET=1
shift 1
;;
-s | --strict)
WAITFORIT_STRICT=1
shift 1
;;
-h)
WAITFORIT_HOST="$2"
if [[ $WAITFORIT_HOST == "" ]]; then break; fi
shift 2
;;
--host=*)
WAITFORIT_HOST="${1#*=}"
shift 1
;;
-p)
WAITFORIT_PORT="$2"
if [[ $WAITFORIT_PORT == "" ]]; then break; fi
shift 2
;;
--port=*)
WAITFORIT_PORT="${1#*=}"
shift 1
;;
-t)
WAITFORIT_TIMEOUT="$2"
if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
shift 2
;;
--timeout=*)
WAITFORIT_TIMEOUT="${1#*=}"
shift 1
;;
--)
shift
WAITFORIT_CLI=("$@")
break
;;
--help)
usage
;;
*)
echoerr "Unknown argument: $1"
usage
;;
esac
done

if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
echoerr "Error: you need to provide a host and port to test."
usage
fi

WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}

# Check to see if timeout is from busybox?
WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)

WAITFORIT_BUSYTIMEFLAG=""
if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
WAITFORIT_ISBUSY=1
# Check if busybox timeout uses -t flag
# (recent Alpine versions don't support -t anymore)
if timeout &>/dev/stdout | grep -q -e '-t '; then
WAITFORIT_BUSYTIMEFLAG="-t"
fi
else
WAITFORIT_ISBUSY=0
fi

if [[ $WAITFORIT_CHILD -gt 0 ]]; then
wait_for
WAITFORIT_RESULT=$?
exit $WAITFORIT_RESULT
else
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
wait_for_wrapper
WAITFORIT_RESULT=$?
else
wait_for
WAITFORIT_RESULT=$?
fi
fi

if [[ $WAITFORIT_CLI != "" ]]; then
if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
exit $WAITFORIT_RESULT
fi
exec "${WAITFORIT_CLI[@]}"
else
exit $WAITFORIT_RESULT
fi

### bpm Dockerfile

FROM ibmjava:8-sfj
ARG JAR_FILE=*.jar
COPY ${JAR_FILE} app.jar
COPY wait.sh /wait.sh
RUN chmod +x /wait.sh
ENTRYPOINT ["/bin/bash", "./wait.sh", "db:3306", "-t", "0", "--", "java", "-jar", "app.jar"]

[data.rar](https://drive.google.com/file/d/15Frrd0GLAmJnjXy7Qnsjv5BdGjksDtQR/view?usp=sharing)

### db Dockerfile

FROM mariadb
COPY data/. /var/lib/mysql

### docker-compose.yml

- 用於已有自定義的映像檔的compose.yml

services:
db:
image: db
environment:
- MYSQL_ROOT_PASSWORD=root
- MYSQL_USER=test
- MYSQL_PASSWORD=test
networks:
- net001
bpm:
image: bpm
depends_on:
- db
ports:
- 8080:8080
environment:
- DATASOURCE_HOST=db
- DATASOURCE_POST=3306
- DATASOURCE_NAME=rp_bpm
- DATASOURCE_USERNAME=test
- DATASOURCE_PASSWORD=test
networks:
- net001

networks:
net001:

- 用於章節 [單獨使用docker-compose完成上述動作](https://www.notion.so/docker-compose-4e13a244e5b9429b944f2e316a4ef81e) 的獨立部署的compose檔

services:
db:
image: mariadb
volumes:
- "./db/data:/var/lib/mysql"
environment:
- MYSQL_ROOT_PASSWORD=root
- MYSQL_USER=test
- MYSQL_PASSWORD=test
networks:
- net001
bpm:
build:
context: ./app
dockerfile: Dockerfile
depends_on:
- db
ports:
- 8080:8080
environment:
- DATASOURCE_HOST=db
- DATASOURCE_POST=3306
- DATASOURCE_NAME=rp_bpm
- DATASOURCE_USERNAME=test
- DATASOURCE_PASSWORD=test
networks:
- net001

networks:
net001:

# 參考網址

[Docker Dockerfile | 菜鸟教程 (runoob.com)](https://www.runoob.com/docker/docker-dockerfile.html)

[Day12. Dockerfile 語法深入探討 - iT 邦幫忙::一起幫忙解決難題，拯救 IT 人的一天 (ithome.com.tw)](https://ithelp.ithome.com.tw/articles/10239890)

[https://github.com/vishnubob/wait-for-it](https://github.com/vishnubob/wait-for-it)

[使用 Docker Compose 摻在一起做懶人包 - iT 邦幫忙::一起幫忙解決難題，拯救 IT 人的一天 (ithome.com.tw)](https://ithelp.ithome.com.tw/articles/10243618)

[Compose specification | Docker Documentation](https://docs.docker.com/compose/compose-file/)

[docker compose 配置文件 .yml 全面指南](https://zhuanlan.zhihu.com/p/387840381)

[Day 30- 三周目 - Docker network 暨完賽回顧 - iT 邦幫忙::一起幫忙解決難題，拯救 IT 人的一天 (ithome.com.tw)](https://ithelp.ithome.com.tw/articles/10206725)