Buildah项目教程：将Buildah集成到自定义构建工具中-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00974/article/details/148441736

Buildah项目教程：将Buildah集成到自定义构建工具中

buildah A tool that facilitates building OCI images. 项目地址: https://gitcode.com/gh_mirrors/bui/buildah

前言

Buildah作为一款强大的容器镜像构建工具，不仅可以直接通过命令行使用，还提供了丰富的Go API接口，允许开发者将其作为库集成到自己的构建工具中。本教程将详细介绍如何利用Buildah的库功能，创建一个能够构建NodeJS应用镜像的自定义工具。

准备工作

开发环境配置

在开始集成Buildah之前，需要确保开发环境已正确配置。首先需要安装以下依赖包：

对于基于RPM的系统（如Fedora/CentOS）：

dnf install btrfs-progs-devel gpgme-devel

对于基于Debian的系统（如Ubuntu）：

apt install libbtrfs-dev libgpgme-dev

项目初始化

创建一个新的Go项目并初始化模块：

go mod init your-project-name

然后添加Buildah作为项目依赖：

go get github.com/containers/buildah

核心构建流程

存储系统初始化

Buildah需要一个存储系统来管理中间镜像和最终镜像。我们可以使用containers/storage库来创建存储实例：

buildStoreOptions, err := storage.DefaultStoreOptionsAutoDetectUID()
buildStore, err := storage.GetStore(buildStoreOptions)

构建器配置

创建BuilderOptions结构体来配置构建参数：

builderOpts := buildah.BuilderOptions{
    FromImage: "node:12-alpine", // 基础镜像
}

构建器实例化

使用配置好的选项创建构建器实例：

builder, err := buildah.NewBuilder(context.TODO(), buildStore, builderOpts)

镜像构建步骤

添加文件到镜像

将本地文件添加到镜像中指定位置：

err = builder.Add("/home/node/", false, buildah.AddAndCopyOptions{}, "script.js")

设置容器启动命令

配置容器启动时执行的命令：

builder.SetCmd([]string{"node", "/home/node/script.js"})

执行构建命令

在构建过程中执行命令（如生成构建日期文件）：

isolation, err := parse.IsolationOption("")
err = builder.Run([]string{"sh", "-c", "date > /home/node/build-date.txt"}, 
    buildah.RunOptions{Isolation: isolation, Terminal: buildah.WithoutTerminal})

镜像提交

创建镜像引用

imageRef, err := is.Transport.ParseStoreReference(buildStore, "docker.io/myusername/my-image")

提交构建结果

imageId, _, _, err := builder.Commit(context.TODO(), imageRef, buildah.CommitOptions{})

无根(rootless)模式支持

Buildah支持在非特权用户环境下运行，只需在程序开始时添加以下代码：

if buildah.InitReexec() {
    return
}
unshare.MaybeReexecUsingUserNamespace(false)

这段代码确保程序在用户命名空间中重新执行，从而获得必要的权限。

完整示例代码

以下是将上述所有步骤整合后的完整代码示例：

package main

import (
    "context"
    "fmt"

    "github.com/containers/buildah"
    "github.com/containers/buildah/pkg/parse"
    "github.com/containers/common/pkg/config"
    is "github.com/containers/image/v5/storage"
    "github.com/containers/storage"
    "github.com/containers/storage/pkg/unshare"
)

func main() {
    // 启用rootless模式
    if buildah.InitReexec() {
        return
    }
    unshare.MaybeReexecUsingUserNamespace(false)

    // 初始化存储系统
    buildStoreOptions, err := storage.DefaultStoreOptionsAutoDetectUID()
    if err != nil {
        panic(err)
    }

    // 获取默认配置
    conf, err := config.Default()
    if err != nil {
        panic(err)
    }
    capabilitiesForRoot, err := conf.Capabilities("root", nil, nil)
    if err != nil {
        panic(err)
    }

    // 创建存储实例
    buildStore, err := storage.GetStore(buildStoreOptions)
    if err != nil {
        panic(err)
    }
    defer buildStore.Shutdown(false)

    // 配置构建选项
    builderOpts := buildah.BuilderOptions{
        FromImage:        "node:12-alpine",
        Capabilities:     capabilitiesForRoot,
    }

    // 创建构建器实例
    builder, err := buildah.NewBuilder(context.TODO(), buildStore, builderOpts)
    if err != nil {
        panic(err)
    }
    defer builder.Delete()

    // 添加文件到镜像
    err = builder.Add("/home/node/", false, buildah.AddAndCopyOptions{}, "script.js")
    if err != nil {
        panic(err)
    }

    // 获取隔离选项
    isolation, err := parse.IsolationOption("")
    if err != nil {
        panic(err)
    }

    // 执行构建命令
    err = builder.Run([]string{"sh", "-c", "date > /home/node/build-date.txt"}, 
        buildah.RunOptions{Isolation: isolation, Terminal: buildah.WithoutTerminal})
    if err != nil {
        panic(err)
    }

    // 设置启动命令
    builder.SetCmd([]string{"node", "/home/node/script.js"})

    // 创建镜像引用
    imageRef, err := is.Transport.ParseStoreReference(buildStore, "docker.io/myusername/my-image")
    if err != nil {
        panic(err)
    }

    // 提交构建结果
    imageId, _, _, err := builder.Commit(context.TODO(), imageRef, buildah.CommitOptions{})
    if err != nil {
        panic(err)
    }

    fmt.Printf("镜像构建完成! ID: %s\n", imageId)
}