kubebuilder:printcolumn怎么用?
创始人
2024-11-13 13:38:39
0

+kubebuilder:printcolumn 标签用于自定义 kubectl get 命令输出时显示的列。通过在自定义资源定义(CRD)中使用 +kubebuilder:printcolumn 标签,你可以定义在执行 kubectl get 时,哪些字段会以列的形式显示,以及如何格式化这些字段。

示例场景

假设你正在定义一个自定义资源 MyResource,它有以下字段:

  • Name:资源的名称
  • Age:资源的年龄
  • Status:资源的当前状态
  • CreationTimestamp:资源的创建时间

你想要 kubectl get myresources 的输出显示 NameAgeStatus 以及 CreationTimestamp,并自定义输出的列。

完整代码示例

以下是一个完整的例子,展示如何在 MyResource 的定义中使用 +kubebuilder:printcolumn 标签:

// api/v1/myresource_types.go  package v1  import (     metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" )  // MyResourceSpec defines the desired state of MyResource type MyResourceSpec struct {     // Age is the age of the resource     Age int `json:"age,omitempty"`      // Status represents the current state of the resource     Status string `json:"status,omitempty"` }  // MyResourceStatus defines the observed state of MyResource type MyResourceStatus struct {     // Add additional status fields here }  // +kubebuilder:object:root=true // +kubebuilder:subresource:status  // +kubebuilder:resource:path=myresources,scope=Namespaced // +kubebuilder:printcolumn:name="Age",type="integer",JSONPath=".spec.age",description="Age of the resource" // +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".spec.status",description="Current status of the resource" // +kubebuilder:printcolumn:name="Created",type="date",JSONPath=".metadata.creationTimestamp",description="Creation time of the resource" // +kubebuilder:printcolumn:name="Namespaced",type="string",JSONPath=".metadata.namespace",priority=1,description="Namespace of the resource" // +kubebuilder:printcolumn:name="Name",type="string",JSONPath=".metadata.name",priority=1,description="Name of the resource"  // MyResource is the Schema for the myresources API type MyResource struct {     metav1.TypeMeta   `json:",inline"`     metav1.ObjectMeta `json:"metadata,omitempty"`      Spec   MyResourceSpec   `json:"spec,omitempty"`     Status MyResourceStatus `json:"status,omitempty"` }  // +kubebuilder:object:root=true  // MyResourceList contains a list of MyResource type MyResourceList struct {     metav1.TypeMeta `json:",inline"`     metav1.ListMeta `json:"metadata,omitempty"`     Items           []MyResource `json:"items"` }  func init() {     SchemeBuilder.Register(&MyResource{}, &MyResourceList{}) } 

解释

  • +kubebuilder:printcolumn:name="Age",type="integer",JSONPath=".spec.age",description="Age of the resource"

    • 添加一个名为 Age 的列,类型为 integer,显示 spec.age 字段的值,列描述为 "Age of the resource"。
  • +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".spec.status",description="Current status of the resource"

    • 添加一个名为 Status 的列,类型为 string,显示 spec.status 字段的值,列描述为 "Current status of the resource"。
  • +kubebuilder:printcolumn:name="Created",type="date",JSONPath=".metadata.creationTimestamp",description="Creation time of the resource"

    • 添加一个名为 Created 的列,类型为 date,显示资源的创建时间 metadata.creationTimestamp
  • +kubebuilder:printcolumn:name="Namespaced",type="string",JSONPath=".metadata.namespace",priority=1,description="Namespace of the resource"

    • 添加一个名为 Namespaced 的列,类型为 string,显示资源的命名空间 metadata.namespace
  • +kubebuilder:printcolumn:name="Name",type="string",JSONPath=".metadata.name",priority=1,description="Name of the resource"

    • 添加一个名为 Name 的列,类型为 string,显示资源的名称 metadata.name

应用CRD

编辑完成后,生成CRD并应用:

make generate make manifests kubectl apply -f config/crd/bases 

测试

执行 kubectl get myresources 时,将显示自定义列:

kubectl get myresources 

输出:

NAME   AGE   STATUS   CREATED               NAMESPACED foo    5     Ready    2024-08-01T12:00:00Z  default bar    10    Pending  2024-08-01T12:05:00Z  custom 

通过这种方式,你可以自定义 kubectl get 输出的列,更直观地查看和管理你的CR实例。

相关内容

热门资讯

黑科技辅助!德扑之星ai计算(... 黑科技辅助!德扑之星ai计算(透视)一贯是有挂(有挂神器)-哔哩哔哩,德扑之星ai计算是用手机号来登...
黑科技辅助!智星德州菠萝辅助器... 【福星临门,好运相随】;黑科技辅助!智星德州菠萝辅助器推荐(透视)软件透明挂ai辅助app(竟然是真...
黑科技神器(WePoKe挂件)... 您好:WePoKe挂件这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用户的牌...
黑科技辅助(WEPOke)外挂... 黑科技辅助(WEPOke)外挂透明挂辅助器(透视)力荐教程(2022已更新)(哔哩哔哩);1、这是跨...
黑科技辅助!wpk有透视辅助(... 黑科技辅助!wpk有透视辅助(透视)软件透明挂ai辅助器(本来真的有挂)-哔哩哔哩;wpk有透视辅助...
黑科技辅助!德扑之星软件有有挂... 黑科技辅助!德扑之星软件有有挂规律(透视)最初真的有挂(真实有挂)-哔哩哔哩;德扑之星软件有有挂规律...
黑科技美元局(AAPoKer安... 黑科技美元局(AAPoKer安卓版)外挂透明挂辅助插件(透视)本来真的是有挂(有挂总结)-哔哩哔哩是...
黑科技辅助(aaPoker)外... 黑科技辅助(aaPoker)外挂透明挂辅助安装(透视)曝光教程(2025已更新)(哔哩哔哩);aaP...
黑科技辅助!德扑之星可以抽水(... 黑科技辅助!德扑之星可以抽水(透视)起初有挂(有挂方法)-哔哩哔哩;是一款可以让一直输的玩家,快速成...
黑科技辅助!poker软件免费... 黑科技辅助!poker软件免费(透视)软件透明挂ai辅助插件(都是是有挂)-哔哩哔哩;黑科技辅助!p...