首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Operator-sdk :规范和状态结构中的命名约定

Operator-sdk :规范和状态结构中的命名约定
EN

Stack Overflow用户
提问于 2020-12-21 04:05:04
回答 1查看 113关注 0票数 0

我正在开发一个运算符,想知道是否有链接或文档描述了Spec和Status字段的命名最佳实践?例如:

在这里,我可以找到与每个字段或参数的注释相关的所有信息,以设置字段可选或设置默认值,如下所示:

代码语言:javascript
复制
// MyAppStatus defines the observed state of MyAppSPec
type MyAppStatus struct {
        // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
        // Important: Run "make" to regenerate code after modifying this file
        AppCount              int32                       `json:"appCount,omitempty"`
        Apps                 map[string]string           `json:"apps,omitempty"`
}

如何设置AppCount的默认值?另外,AppCount的命名是否正确?我是否可以使用间接命名,即我可以将其设置为以下内容:

代码语言:javascript
复制
AppCount              int32                       `json:"count,omitempty"`

这将帮助我在YAML文件中公开不同的名称,但在代码中,我将引用AppCount。请让我知道是否有一个文档的评论野兽实践的每个领域和领域的标志,如省略,空或可选?

从评论的角度来看,我看到许多运营商引用了kUbeBuilder,如下所示:

代码语言:javascript
复制
// +kubebuilder:object:root=true
// +kubebuilder:subresource:status

我可以在哪里找到上面的详细信息,以及什么时候使用它们?

EN

回答 1

Stack Overflow用户

发布于 2020-12-21 12:45:43

您可以在https://book.kubebuilder.io/reference/markers.html上找到关于controller-gen注释的文档(请阅读小节)。omitempty表示该字段是可选的。JSON名称和结构名称通常应该相同(大小写除外),除非您有很好的理由不这样做。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/65384289

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档