重构:保持Dockerfile整洁的5个技巧

时间:2022-07-25
本文章向大家介绍重构:保持Dockerfile整洁的5个技巧,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

当Dockerfile超出合理范围时,会出现以下问题:

  • 很难理解和维护-我们需要阅读数百行以了解所有依赖关系
  • 在这么多行之间可能忽略一个明显的安全问题
  • 当每个人都在更改同一文件时,Git将引发更多冲突
  • 如果我们不清理每个依赖项,可能会导致镜像体积沉重

最好的解决方案是将Dockerfile拆分为多个Dockerfile,以使我们的Dockerfile更小,更易于理解和维护。

这里是一些减少Dockerfile大小的技巧。

重构1:从其官方镜像中获取依赖

避免创建从官方镜像复制的工件。例如:我需要使用terraform没必要再重新apt-get安装了,可以直接使用带有terraform的官方镜像。

原始Dockerfile

FROM golang:1.12
RUN apt-get update && 
    apt-get upgrade -y && 
    apt-get install -y git openssh-client zip
WORKDIR $GOPATH/src/github.com/hashicorp/terraform
RUN git clone https://github.com/hashicorp/terraform.git ./ && 
    git checkout v0.12.9 && 
    ./scripts/build.sh
WORKDIR /my-config
COPY . /my-config/
CMD ["terraform init"]

重构后Dockerfile

FROM hashicorp/terraform:0.12.9 AS terraform
FROM golang:1.12
COPY --from=terraform /go/bin/terraform /usr/bin/terraform
WORKDIR /my-config
COPY . /my-config/
CMD ["terraform init"]

重构2:将依赖项提取到另一个Dockefile中

如果没有正式镜像,您可以从中提取工件,则应将其构建分离到另一个Dockefile中。然后将工件复制到原始Dockerfile中。

原始Dockerfile:

FROM golang:1.12
RUN apt-get update && 
    apt-get upgrade -y && 
    apt-get install -y git openssh-client
WORKDIR /go/src/gitlab.com/sahilm/
RUN git clone https://github.com/sahilm/yamldiff.git
RUN cd yamldiff && 
    go get -u github.com/golang/dep/cmd/dep && 
    dep ensure && 
    GOOS=linux go build -o /usr/local/yamldiff
WORKDIR /my-app
COPY . /my-app/
CMD ["./run.sh"]

重构:用于yamldiff的Dockerfile。

FROM golang:1.12
RUN apt-get update && 
    apt-get upgrade -y && 
    apt-get install -y git openssh-client
WORKDIR /go/src/gitlab.com/sahilm/
RUN git clone https://github.com/sahilm/yamldiff.git
RUN cd yamldiff && 
    go get -u github.com/golang/dep/cmd/dep && 
    dep ensure && 
    GOOS=linux go build -o /usr/local/yamldiff
CMD ["bash"]

重构:应用程序的Dockerfile。

FROM Marvalero/yamldiff:latest AS yamldiff
FROM golang:1.12
COPY --from=yamldiff /usr/bin/yamldiff /usr/bin/yamldiff
WORKDIR /my-app
COPY . /my-app/
CMD ["./run.sh"]

重构3:将镜像分成多个阶段

Docker具有多阶段功能,当您的Dockerfile具有不同的部分时,它会派上用场。最常见的用例是进行构建,然后在主镜像中复制工件。具有不同的阶段可以使您的Dockerfile更加清晰和安全。

FROM golang:1.12
RUN apt-get update && 
    apt-get upgrade -y && 
    apt-get install -y git openssh-client
WORKDIR /go/src/gitlab.com/sahilm/
RUN git clone https://github.com/sahilm/yamldiff.git
RUN cd yamldiff && 
    go get -u github.com/golang/dep/cmd/dep && 
    dep ensure && 
    GOOS=linux go build -o /usr/local/yamldiff
CMD ["bash"]

重构Dockerfile:

FROM golang:1.12 as Builder
RUN apt-get update && 
    apt-get upgrade -y && 
    apt-get install -y git openssh-client
WORKDIR /go/src/gitlab.com/sahilm/
RUN git clone https://github.com/sahilm/yamldiff.git
RUN cd yamldiff && 
    go get -u github.com/golang/dep/cmd/dep && 
    dep ensure && 
    GOOS=linux go build -o /usr/local/yamldiff
FROM ubuntu:18.04
COPY --from=Builder /usr/local/yamldiff /usr/local/yamldiff
CMD ["bash"]

重构4:对多行参数进行排序

尽可能对多行参数进行排序。这有助于仔细检查没有重复的程序包。

FROM ubuntu:18.04
RUN apt-get -yqq install 
    ca-certificates 
    bash 
    jq 
    wget 
    curl 
    openssh-client 
    build-essential 
    libpng-dev 
    python 
    zip
CDM ["bash"]

重构Dockerfile:

FROM ubuntu:18.04
RUN apt-get -yqq install 
    bash 
    build-essential 
    ca-certificates 
    curl 
    jq 
    libpng-dev 
    openssh-client 
    python 
    wget 
    zip
CDM ["bash"]

重构5:标签

在使用Docker镜像时,保持标签整洁也至关重要。我总是觉得拥有三种类型的标签非常有用:

  • 分支名称:标识特定分支的镜像的最新版本

注意:为什么不使用latest?使用时latest,我永远不知道它是表示整个存储库中的最新稳定版本还是最新版本。使用分支的名称(如masterfeature/new-class等)指向一个分支最新版本是方式更直观。

  • 版本:需要区分修补程序和重大更改。我建议使用语义版本控制(major.minor.patch)。
  • 提交:我一直想知道标签所指向的提交。现在,您可以通过在存储库中创建版本标记来执行此操作。但是,当这不可能时,只需使用其Commit SHA标记镜像即可。

谢谢阅读,希望您可以更轻松地维护Dockerfile。