IDEA遠端部署專案到Docker

2022-09-23 12:00:50

前言

最近在寫東西部署到伺服器,結構是springboot工程配合docker部署。
但是每次部署都3個步驟:

  1. 本地構建jar
  2. 複製jar到遠端伺服器
  3. 用DockerFile構建映象

部署次數一多,我就懷疑人生了。就在找有沒有IDEA遠端部署Docker的方案,於是就有本篇部落格。

環境:
本地IP:192.168.1.5
Docker遠端主機:192.168.1.199

開啟docker remote API

docker遠端存取api有兩種方式:

  • 普通方式(一般用2375埠)
  • TSL方式(一般用2376埠)

建議使用TSL方式,更安全。

普通方式

  1. 修改組態檔/lib/systemd/system/docker.service

    修改ExecStart這一項的內容,在末尾新增引數
    -H unix:///var/run/docker.sock -H tcp://0.0.0.0:2373

    # 修改前
    # ExecStart=/usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock
    # 修改後
    ExecStart=/usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock -H unix:///var/run/docker.sock -H tcp://0.0.0.0:2375
    

    一般使用2375埠,可以改成自己喜歡的

  2. 重新載入設定重啟docker服務

    # 重新載入設定
    systemctl daemon-reload
    # 重啟docker服務
    systemctl restart docker
    
  3. 驗證

    瀏覽器輸入http://192.168.1.199:2375/version
    如果顯示一串json資訊,就證明成功了。注意自己修改成自己的ip

TSL方式

  1. 生成CA證書

    編寫生成證書的shell指令碼,然後直接執行指令碼即可。請自行修改前4行中的引數,下面是指令碼的內容:

    #!/bin/sh
    ip=遠端伺服器的ip
    password=校驗密碼
    dir=生成證書的目錄
    
    if [ ! -d "$dir" ];then
    echo ""
    echo "$dir , not dir , will create"
    echo ""
    mkdir -p $dir
    else
    echo ""
    echo "$dir , dir exist , will delete and create"
    echo ""
    rm -rf $dir
    mkdir -p $dir
    fi
     
    cd $dir
    # 建立根證書RSA私鑰
    openssl genrsa -aes256 -passout pass:$password  -out ca-key.pem 4096
    # 建立CA證書
    openssl req -new -x509 -days 365 -key ca-key.pem -passin pass:$password -sha256 -out ca.pem -subj "/C=NL/ST=./L=./O=./CN=$ip"
    # 建立伺服器端私鑰
    openssl genrsa -out server-key.pem 4096
    # 建立伺服器端簽名請求證書檔案
    openssl req -subj "/CN=$ip" -sha256 -new -key server-key.pem -out server.csr
    echo subjectAltName = IP:$ip,IP:0.0.0.0 >> extfile.cnf
    echo extendedKeyUsage = serverAuth >> extfile.cnf
    # 建立簽名生效的伺服器端證書檔案 
    openssl x509 -req -days 365 -sha256 -in server.csr -CA ca.pem -CAkey ca-key.pem -passin "pass:$password" -CAcreateserial -out server-cert.pem -extfile extfile.cnf
    # 建立使用者端私鑰
    openssl genrsa -out key.pem 4096
    # 建立使用者端簽名請求證書檔案
    openssl req -subj '/CN=client' -new -key key.pem -out client.csr
    echo extendedKeyUsage = clientAuth >> extfile.cnf
    echo extendedKeyUsage = clientAuth > extfile-client.cnf
    # 建立簽名生效的使用者端證書檔案
    openssl x509 -req -days 365 -sha256 -in client.csr -CA ca.pem -CAkey ca-key.pem -passin "pass:$password" -CAcreateserial -out cert.pem -extfile extfile-client.cnf
    # 刪除多餘檔案
    rm -f -v client.csr server.csr extfile.cnf extfile-client.cnf
    chmod -v 0400 ca-key.pem key.pem server-key.pem
    chmod -v 0444 ca.pem server-cert.pem cert.pem
    
  2. 修改組態檔/lib/systemd/system/docker.service

    修改ExecStart這一項的內容,/home/docker_ca是我CA證書的目錄,請自行替換成自己的

    # 修改前
    # ExecStart=/usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock
    # 修改後
    ExecStart=/usr/bin/dockerd \
            --tlsverify \
            --tlscacert=/home/docker_ca/ca.pem \
            --tlscert=/home/docker_ca/server-cert.pem \
            --tlskey=/home/docker_ca/server-key.pem \
            -H tcp://0.0.0.0:2376 \
            -H unix:///var/run/docker.sock \
            -H fd:// --containerd=/run/containerd/containerd.sock
    
  3. 重新載入設定重啟docker服務

    # 重新載入設定
    systemctl daemon-reload
    # 重啟docker服務
    systemctl restart docker
    

構建

建立測試工程

  1. 建立測試的maven工程

    https://start.spring.io/建立測試工程,我的工程命名為testdocker,只新增了web模組用來測試

  2. 新增測試介面

    開啟測試工程,在TestdockerApplication中新增測試介面

    @SpringBootApplication
    public class TestdockerApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(TestdockerApplication.class, args);
    	}
    
    	@RestController
    	class HelloController {
    		@GetMapping("/hello")
    		public String hello() {
    			return "hello world";
    		}
    	}
    }
    
  3. 測試

    啟動工程,瀏覽器輸入 http://localhost:8080/hello

部署到Docker

部署到Docker我這裡提供兩種方式:

  1. IDEA的Docker外掛 + DockerFile
  2. Maven外掛docker-maven-plugin + DockerFile

因為兩種方式都需要用到DockerFile,所以先建立DockerFile

在專案根目錄新增DockerFile

# 基礎映象使用java
FROM openjdk:8-jdk-alpine
# 暴露埠
EXPOSE 8080 5005
# 將jar包新增到容器中並更名為app.jar
ADD ./target/testdocker-0.0.1-SNAPSHOT.jar app.jar
# 執行jar包
ENTRYPOINT ["java","-Dfile.encoding=utf-8","-jar","app.jar"]

因為我的DockerFile在專案根目錄,而maven構建的jar在target目錄,專案目錄結構如下

testdocker
├─src
├─target
│   └─testdocker-0.0.1-SNAPSHOT.jar
├─DockerFile
└─pom.xml

IDEA的Docker外掛 + DockerFile

  1. IDEA安裝Docker外掛

  2. 連線Docker

    選單 File → Settings → Build,Execution → Docker

    下圖的設定的是用TSL方式的Docker Remote API。如果是普通方式,這不需要設定CA證書目錄,Engine API URL改成:tcp://192.158.1.199:2375
    ps:記得替換成自己的ip

  3. 新增執行設定

  4. maven構建專案jar包

    控制檯執行

    mvn clean package 
    

    不進行這一步,target目錄就沒有jar包,DockerFile會提示構建失敗

  5. 啟動並測試

    啟動工程,瀏覽器輸入 http://192.168.1.199:8080/hello

    注意修改成自己Docker服務所在伺服器的ip

Maven外掛docker-maven-plugin + DockerFile

這種方式,可以完全脫離IDEA來操作

  1. 新增Maven外掛

    在pom.xml檔案的plugins節點中新增如下內容

    <plugin>
        <groupId>io.fabric8</groupId>
        <artifactId>docker-maven-plugin</artifactId>
        <version>0.40.2</version>
        <!--全域性設定-->
        <configuration>
            <!--這一部分是為了實現對遠端docker容器的控制-->
            <!--docker主機地址,用於完成docker各項功能-->
            <dockerHost>https://192.168.1.199:2376</dockerHost>
            <!--docker遠端存取所需證書地址,如果docker遠端主機沒有啟用TLS驗證則不需要配證書-->
            <certPath>F:\docker_ca</certPath>
    
            <!--映象相關設定,支援多映象-->
            <images>
                <!-- 單個映象設定 -->
                <image>
                    <!--映象名(含版本號)-->
                    <name>testdocker</name>
                    <!--別名-->
                    <alias>${project.name}</alias>
                    <!--映象build相關設定-->
                    <build>
                        <!--使用dockerFile檔案-->
                        <dockerFile>${project.basedir}/Dockerfile</dockerFile>
                    </build>
                    <!--容器run相關設定-->
                    <run>
                        <!--設定執行時容器命名策略為:別名-->
                        <containerNamePattern>%a</containerNamePattern>
                        <ports>
                            <port>8080:8080</port>
                            <port>5005:5005</port>
                        </ports>
                    </run>
                </image>
            </images>
        </configuration>
    </plugin>
    
  2. 構建並啟動容器

    控制檯執行如下命令:

    mvn clean package docker:stop docker:remove docker:build docker:run
    
    • docker:stop 停止並刪除docker容器
    • docker:remove 刪除映象
    • docker:build 構建映象
    • docker:run 建立並啟動docker容器
  3. 測試

瀏覽器輸入 http://192.168.1.199:8080/hello
注意修改成自己Docker服務所在伺服器的ip

總結

本文介紹了兩種遠端部署Docker的方法,一種需要用到IDEA,一種只需要用到Maven。


參考資料

fabric8io/docker-maven-plugin官方檔案

docker開啟TLS遠端存取 2376_寫碼的猿是攻城獅的部落格

Docker部署IDEA專案_路言汐的部落格