dfg - Dockerfile Generator

dfg 是一个 Go 库和可执行文件，可以使用各种输入通道生成有效的 Dockerfile。

概述

dfg 是一个 Dockerfile 生成器，它接受来自各种来源的输入数据，生成并将生成的 Dockerfile 重定向到输出目标（如文件或 stdout）。

当 Dockerfile 语言没有控制流逻辑时，它特别适用于有条件地生成 Dockerfile 指令。

安装

作为可执行文件安装

MacOS:

curl -o dfg -L https://github.com/ozankasikci/dockerfile-generator/releases/download/v1.0.0/dfg_v1.0.0_darwin_amd64
chmod +x dfg && sudo mv dfg /usr/local/bin

Linux:

curl -o dfg -L https://github.com/ozankasikci/dockerfile-generator/releases/download/v1.0.0/dfg_v1.0.0_linux_amd64
chmod +x dfg && sudo mv dfg /usr/local/bin

Windows:

curl -o dfg.exe -L https://github.com/ozankasikci/dockerfile-generator/releases/download/v1.0.0/dfg_v1.0.0_windows_amd64.exe

作为库安装

go get -u github.com/ozankasikci/dockerfile-generator

使用指南

作为可执行文件使用

可用命令:

• dfg generate --input path/to/yaml --out Dockerfile 生成名为 Dockerfile 的文件
• dfg generate --input path/to/yaml --target-field ".server.dockerfile" --out Dockerfile 读取 YAML 文件的 .server.dockerfile 字段生成 Dockerfile
• dfg generate --help 列出可用标志

作为库使用

使用 dfg 作为 Go 库时，需要传递一个 []dfg.Stage 切片作为数据。这种方法支持并鼓励使用多阶段 Dockerfile。Dockerfile 指令将按照 []dfg.Instruction 切片的顺序生成。

某些 Instruction 接受 runForm 字段，指定 Instruction 应在 shell form 还是 exec form 中运行。如果未指定 runForm，将根据 Dockerfile 最佳实践选择。

示例

单 YAML 文件示例（期望顶层有 stages 键）

stages:
  final:
    - from:
        image: kstaken/apache2
    - run:
        runForm: shell
        params:
          - apt-get update &&
          - apt-get install -y
          - php5
          - libapache2-mod-php5 &&
          - apt-get clean &&
          - rm -rf /var/lib/apt/lists/*
    - cmd:
        params:
          - /usr/sbin/apache2
          - -D
          - FOREGROUND

使用 dfg 作为二进制文件:

dfg generate -i ./example-input-files/apache-php.yaml --stdout

或作为库:

data, err := dfg.NewDockerFileDataFromYamlFile("./example-input-files/apache-php.yaml")
tmpl := dfg.NewDockerfileTemplate(data)
err = tmpl.Render(output)

输出:

FROM kstaken/apache2
RUN apt-get update && apt-get install -y php5 libapache2-mod-php5 && apt-get clean && rm -rf /var/lib/apt/lists/*
CMD ["/usr/sbin/apache2", "-D", "FOREGROUND"]

带目标字段的 YAML 文件示例（允许使用任何字段）

someConfig:
  key: value
serverConfig:
  dockerfile:
    stages:
      final:
        - from:
            image: kstaken/apache2
        - run:
            runForm: shell
            params:
              - apt-get update &&
              - apt-get clean &&
              - rm -rf /var/lib/apt/lists/*

使用 dfg 作为二进制文件:

dfg generate -i ./example-input-files/test-input-with-target-key-6.yaml --target-field ".serverConfig.dockerfile" --stdout

或作为库:

data, err := dfg.NewDockerFileDataFromYamlField("./example-input-files/test-input-with-target-key-6.yaml", ".serverConfig.dockerfile")
tmpl := dfg.NewDockerfileTemplate(data)
err = tmpl.Render(output)

输出:

FROM kstaken/apache2
RUN apt-get update && apt-get clean && rm -rf /var/lib/apt/lists/*

库使用示例

package main

import dfg "github.com/ozankasikci/dockerfile-generator"

func main() {
	data := &dfg.DockerfileData{
		Stages: []dfg.Stage{
			// 阶段 1 - 构建器镜像
			// 指令只是一个接口，所以你也可以传递自定义结构体
			[]dfg.Instruction{
				dfg.From{
					Image: "golang:1.7.3", As: "builder",
				},
				dfg.User{
					User: "ozan",
				},
				dfg.Workdir{
					Dir: "/go/src/github.com/ozankasikci/dockerfile-generator/",
				},
				dfg.RunCommand{
					Params: []string{"go", "get", "-d", "-v", "golang.org/x/net/html"},
				},
				dfg.CopyCommand{
					Sources: []string{"app.go"}, Destination: ".",
				},
				dfg.RunCommand{
					Params: []string{"CGO_ENABLED=0", "GOOS=linux", "go", "build", "-a", "-installsuffix", "cgo", "-o", "app", "."},
				},
			},
			// 阶段 2 - 最终镜像
			[]dfg.Instruction{
				dfg.From{
					Image: "alpine:latest", As: "final",
				},
				dfg.RunCommand{
					Params: []string{"apk", "--no-cache", "add", "ca-certificates"},
				},
				dfg.User{
					User: "root", Group: "admin",
				},
				dfg.Workdir{
					Dir: "/root/",
				},
				dfg.CopyCommand{
					From: "builder", Sources: []string{"/go/src/github.com/ozankasikci/dockerfile-generator/app"}, Destination: ".",
				},
				dfg.Cmd{
					Params: []string{"./app"},
				},
			},
		},
	}
	tmpl := dfg.NewDockerfileTemplate(data)
	
	// 写入文件
	file, err := os.Create("Dockerfile")
	err = tmpl.Render(file)
	
	// 或写入 stdout
	err = tmpl.Render(os.Stdout)
}

输出:

FROM golang:1.7.3 as builder
USER ozan
WORKDIR /go/src/github.com/ozankasikci/dockerfile-generator/
RUN go get -d -v golang.org/x/net/html
COPY app.go .
RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o app .

FROM alpine:latest as final
RUN apk --no-cache add ca-certificates
USER root:admin
WORKDIR /root/
COPY --from=builder /go/src/github.com/ozankasikci/dockerfile-generator/app .
CMD ["./app"]