containerd/cgroups

GitHub: containerd/cgroups

containerd 维护的 Go 库,提供创建、管理和销毁 Linux cgroups 的完整 API,支持 cgroups v1 与 v2。

Stars: 1192 | Forks: 253

# cgroups [![构建状态](https://static.pigsec.cn/wp-content/uploads/repos/cas/ad/ad5834178f7599af9fdda11629d49cae07f2997beec49821b2920eff5bfd50e7.svg)](https://github.com/containerd/cgroups/actions?query=workflow%3ACI) [![codecov](https://codecov.io/gh/containerd/cgroups/branch/main/graph/badge.svg)](https://codecov.io/gh/containerd/cgroups) [![GoDoc](https://godoc.org/github.com/containerd/cgroups?status.svg)](https://godoc.org/github.com/containerd/cgroups) [![Go Report Card](https://goreportcard.com/badge/github.com/containerd/cgroups)](https://goreportcard.com/report/github.com/containerd/cgroups) 用于创建、管理、检查和销毁 cgroups 的 Go 包。 cgroup 的资源设置格式使用了 OCI runtime-spec,可以在 [这里](https://github.com/opencontainers/runtime-spec) 找到。 ## 示例 (v1) ### 创建一个新的 cgroup 这会为 `/test` 下的所有 subsystem 使用静态路径创建一个新的 cgroup。 * /sys/fs/cgroup/cpu/test * /sys/fs/cgroup/memory/test * 等.... 它使用单一层级,指定 cpu shares 作为资源限制,并 使用 cgroups 的 v1 实现。 ``` shares := uint64(100) control, err := cgroup1.New(cgroup1.StaticPath("/test"), &specs.LinuxResources{ CPU: &specs.LinuxCPU{ Shares: &shares, }, }) defer control.Delete() ``` ### 加载现有的 cgroup ``` control, err = cgroup1.Load(cgroup1.Default, cgroups.StaticPath("/test")) ``` ### 将进程添加到 cgroup ``` if err := control.Add(cgroup1.Process{Pid:1234}); err != nil { } ``` ### 更新 cgroup 用于更新 cgroup 中应用的资源 ``` shares = uint64(200) if err := control.Update(&specs.LinuxResources{ CPU: &specs.LinuxCPU{ Shares: &shares, }, }); err != nil { } ``` ### 冻结和解冻 cgroup ``` if err := control.Freeze(); err != nil { } if err := control.Thaw(); err != nil { } ``` ### 列出 cgroup 中的所有进程或递归列出 ``` processes, err := control.Processes(cgroup1.Devices, recursive) ``` ### 获取 cgroup 的统计信息 ``` stats, err := control.Stat() ``` 通过添加 `cgroups.IgnoreNotExist`,所有不存在的文件将被忽略,例如未启用 swap 时的 swap memory 统计信息 ``` stats, err := control.Stat(cgroup1.IgnoreNotExist) ``` ### 跨 cgroup 移动进程 这允许你将进程从一个 cgroup 移动到另一个。 ``` err := control.MoveTo(destination) ``` ### 创建 subcgroup ``` subCgroup, err := control.New("child", resources) ``` ### 注册内存事件 这允许你通过 eventfd 接收 v1 memory cgroups 事件的通知。 ``` event := cgroup1.MemoryThresholdEvent(50 * 1024 * 1024, false) efd, err := control.RegisterMemoryEvent(event) ``` ``` event := cgroup1.MemoryPressureEvent(cgroup1.MediumPressure, cgroup1.DefaultMode) efd, err := control.RegisterMemoryEvent(event) ``` ``` efd, err := control.OOMEventFD() // or by using RegisterMemoryEvent event := cgroup1.OOMEvent() efd, err := control.RegisterMemoryEvent(event) ``` ## 示例 (v2/unified) ### 检查当前系统是否正在运行 cgroups v2 ``` var cgroupV2 bool if cgroups.Mode() == cgroups.Unified { cgroupV2 = true } ``` ### 创建一个新的 cgroup 这将创建一个新的 systemd v2 cgroup slice。Systemd slice 将 ["-" 视为特殊字符](https://www.freedesktop.org/software/systemd/man/systemd.slice.html), 因此生成的 slice 将位于磁盘上的以下位置: * /sys/fs/cgroup/my.slice/my-cgroup.slice/my-cgroup-abc.slice ``` import ( "github.com/containerd/cgroups/v3/cgroup2" specs "github.com/opencontainers/runtime-spec/specs-go" ) res := cgroup2.Resources{} // dummy PID of -1 is used for creating a "general slice" to be used as a parent cgroup. // see https://github.com/containerd/cgroups/blob/1df78138f1e1e6ee593db155c6b369466f577651/v2/manager.go#L732-L735 m, err := cgroup2.NewSystemd("/", "my-cgroup-abc.slice", -1, &res) if err != nil { return err } ``` ### 加载现有的 cgroup ### 删除 cgroup ### 杀死 cgroup 中的所有进程 ### 获取和设置 cgroup 类型 ### 注意 所有静态路径都不应包含 `/sys/fs/cgroup/` 前缀,它应以你自己的 cgroups 名称开头 ## 项目详情 Cgroups 是一个 containerd 子项目,遵循 [Apache 2.0 license](./LICENSE) 授权。 作为 containerd 子项目,你将在我们的 [`containerd/project`](https://github.com/containerd/project) 仓库中找到以下信息: * [项目治理](https://github.com/containerd/project/blob/main/GOVERNANCE.md), * [维护者](https://github.com/containerd/project/blob/main/MAINTAINERS), * 和 [贡献指南](https://github.com/containerd/project/blob/main/CONTRIBUTING.md)
标签:cgroups, EVTX分析, Go, OCI规范, Ruby工具, 容器, 日志审计, 系统底层, 资源管理