containerd中文翻译系列(五)客户端选项

containerd 客户端的构建是为了方便用户进行扩展。
我们的目标是，调用的执行流程在不同的实现中保持不变，同时编写 Opts 来扩展功能。
为了实现这一目标，我们依赖于 Go 中的 Opts 模式。

方法调用

对于客户端软件包中的许多函数和方法，你通常会看到变量参数作为最后一个参数。

如果我们查看客户端上的 NewContainer 方法，就会发现它有一个必要参数 id 和附加的 NewContainerOpts。

有几个内置选项允许使用现有规范创建容器，即 WithSpec，以及用于创建或使用现有快照的选项。

func (c *Client) NewContainer(ctx context.Context, id string, opts ...NewContainerOpts) (Container, error) {
}

扩展客户端

作为 containerd 客户端的用户，你需要能够添加自己领域的特定功能。
有几种方法可以做到这一点：更改客户端代码、向containerd客户端提交 PR 或fork客户端。
只有在尝试过所有其他方法之后，才能考虑这些扩展客户端的方法。

扩展客户端的正确且受支持的方法是构建一个 Opts包，定义应用程序的特定逻辑。

举例来说，如果 Docker 正在集成 containerd 支持并需要添加卷等概念，他们就会创建一个包含选项的 docker 包。

坏的扩展示例

// 示例代码
container, err := client.NewContainer(ctx, id)

// 添加卷及其配置并绑定挂载
container.Labels["volumes"] = VolumeConfig{}
container.Spec.Binds  = append({"/var/lib/docker/volumes..."})

好的扩展示例

// 示例代码
import "github.com/docker/docker"
import "github.com/docker/libnetwork"

container, err := client.NewContainer(ctx, id,
	docker.WithVolume("volume-name"),
	libnetwork.WithOverlayNetwork("cluster-network"),
)

使用这种模式有几个好处。

SpecOpt 示例

如果我们想制作一个 SpecOpt 来设置一个容器，以便使用 htop 监控主机系统，这可以很容易地完成，而无需碰触 containerd 代码库中的任何一行代码。

package monitor

import (
	"github.com/containerd/containerd/v2/oci"
	specs "github.com/opencontainers/runtime-spec/specs-go"
)

// WithHtop配置容器，以便通过 `htop` 监控主机系统
func WithHtop(s *specs.Spec) error {
	// 确保在host pid 命名空间
	if err := oci.WithHostNamespace(specs.PIDNamespace)(s); err != nil {
		return err
	}
	// 确保将 htop 设置为参数
	s.Process.Args = []string{"htop"}
	// 确保为htop设置TTY
	if err := oci.WithTTY(s); err != nil {
		return err
	}
	return nil
}

将新选项添加到规范生成中，就像导入新软件包并在创建规范时添加该选项一样简单。

import "github.com/crosbymichael/monitor"

container, err := client.NewContainer(ctx, id,
	containerd.WithNewSpec(oci.WithImageConfig(image), monitor.WithHtop),
)

您可以在这里查看完整代码并运行监控容器