如何惯用地用 Kubernetes API 对象的默认值填充空字段?
How to idiomatically fill empty fields with default values for Kubernetes API objects?
我想比较两个 Kubernetes API 对象(例如 v1.PodSpec
s):其中一个是手动创建的(预期状态),另一个是从 Kubernetes API/client(实际状态)。
问题是,即使这两个对象在语义上是相等的,手动创建的结构对于未指定的字段具有零值,而另一个结构具有默认值,因此两者不匹配。这意味着简单的 reflect.DeepEqual()
调用不足以进行比较。
例如在此之后:
expected := &v1.Container{
Name: "busybox",
Image: "busybox",
}
actual := getContainerSpecFromApi(...)
expected.ImagePullPolicy
会变成""
,而actual.ImagePullPolicy
会变成"IfNotPresent"
(默认值),所以比较失败。
在 Kubernetes API 结构中,是否有一种惯用的方法可以将零值替换为默认值?或者是一个构造函数,它使用在某处可用的默认值初始化结构?
编辑:
目前我正在为每个 K8s API 对象类型使用手写相等性测试,但这对我来说似乎不可维护。我正在寻找一个简单的(一组)函数,它 "knows" 所有内置 Kubernetes API 对象字段的默认值(可能在 k8s.io/api*
下的某个地方?)。像这样:
expected = api.ApplyContainerDefaults(expected)
if !reflect.DeepEqual(expected, actual) {
reconcile(expected, actual)
}
有一些帮助程序可以代替 empty/zero 填写默认值。
例如,查看 SetObjectDefaults_Deployment 部署。
看起来正确的调用方式是通过 (*runtime.Scheme).Default
。
以下是展示总体思路的片段:
import (
"reflect"
appsv1 "k8s.io/api/apps/v1"
"k8s.io/client-go/kubernetes/scheme"
)
func compare() {
scheme := scheme.Scheme
// fetch the existing &appsv1.Deployment via API
actual := ...
expected := &appsv1.Deployment{}
// fill in the fields to generate your expected state
// ...
scheme.Default(expected)
// now you should have your empty values filled in
if !reflect.DeepEqual(expected.Spec, actual.Spec) {
reconcile(expected, actual)
}
}
如果您需要不那么严格的比较,例如,如果您需要容忍一些注入的容器,那么应该使用更宽松的比较,例如 this。
我想比较两个 Kubernetes API 对象(例如 v1.PodSpec
s):其中一个是手动创建的(预期状态),另一个是从 Kubernetes API/client(实际状态)。
问题是,即使这两个对象在语义上是相等的,手动创建的结构对于未指定的字段具有零值,而另一个结构具有默认值,因此两者不匹配。这意味着简单的 reflect.DeepEqual()
调用不足以进行比较。
例如在此之后:
expected := &v1.Container{
Name: "busybox",
Image: "busybox",
}
actual := getContainerSpecFromApi(...)
expected.ImagePullPolicy
会变成""
,而actual.ImagePullPolicy
会变成"IfNotPresent"
(默认值),所以比较失败。
在 Kubernetes API 结构中,是否有一种惯用的方法可以将零值替换为默认值?或者是一个构造函数,它使用在某处可用的默认值初始化结构?
编辑:
目前我正在为每个 K8s API 对象类型使用手写相等性测试,但这对我来说似乎不可维护。我正在寻找一个简单的(一组)函数,它 "knows" 所有内置 Kubernetes API 对象字段的默认值(可能在 k8s.io/api*
下的某个地方?)。像这样:
expected = api.ApplyContainerDefaults(expected)
if !reflect.DeepEqual(expected, actual) {
reconcile(expected, actual)
}
有一些帮助程序可以代替 empty/zero 填写默认值。
例如,查看 SetObjectDefaults_Deployment 部署。
看起来正确的调用方式是通过 (*runtime.Scheme).Default
。
以下是展示总体思路的片段:
import (
"reflect"
appsv1 "k8s.io/api/apps/v1"
"k8s.io/client-go/kubernetes/scheme"
)
func compare() {
scheme := scheme.Scheme
// fetch the existing &appsv1.Deployment via API
actual := ...
expected := &appsv1.Deployment{}
// fill in the fields to generate your expected state
// ...
scheme.Default(expected)
// now you should have your empty values filled in
if !reflect.DeepEqual(expected.Spec, actual.Spec) {
reconcile(expected, actual)
}
}
如果您需要不那么严格的比较,例如,如果您需要容忍一些注入的容器,那么应该使用更宽松的比较,例如 this。