Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit d524ed0

Browse filesBrowse files
jaehanbyunjaehanbyun
committed
apiextensions: enrich kubectl get crd table output
- Add crdConvertor in tableconvertor.go under staging/src/k8s.io/apiextensions-apiserver/pkg/registry/customresourcedefinition - Swap REST store’s default TableConvertor to use new crdConvertor via crdtable.New() - Define table columns: • Name (format:name) • Group (API group of the CRD) • Scope (Cluster or Namespaced) • Versions (comma-separated, sorted list of served versions) • Created At (RFC3339 timestamp) Signed-off-by: jaehanbyun <awbrg789@naver.com>
1 parent e9c4afc commit d524ed0
Copy full SHA for d524ed0

File tree

Expand file treeCollapse file tree

3 files changed

+189
-2
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+189
-2
lines changed

‎staging/src/k8s.io/apiextensions-apiserver/pkg/registry/customresourcedefinition/etcd.go

Copy file name to clipboardExpand all lines: staging/src/k8s.io/apiextensions-apiserver/pkg/registry/customresourcedefinition/etcd.go
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"fmt"
2222

2323
"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
24+
crdtable "k8s.io/apiextensions-apiserver/pkg/registry/customresourcedefinition/tableconvertor"
2425
apierrors "k8s.io/apimachinery/pkg/api/errors"
2526
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2627
"k8s.io/apimachinery/pkg/runtime"
@@ -54,8 +55,7 @@ func NewREST(scheme *runtime.Scheme, optsGetter generic.RESTOptionsGetter) (*RES
5455
DeleteStrategy: strategy,
5556
ResetFieldsStrategy: strategy,
5657

57-
// TODO: define table converter that exposes more than name/creation timestamp
58-
TableConvertor: rest.NewDefaultTableConvertor(apiextensions.Resource("customresourcedefinitions")),
58+
TableConvertor: crdtable.New(),
5959
}
6060
options := &generic.StoreOptions{RESTOptions: optsGetter, AttrFunc: GetAttrs}
6161
if err := store.CompleteWithOptions(options); err != nil {

‎staging/src/k8s.io/apiextensions-apiserver/pkg/registry/customresourcedefinition/tableconvertor/tableconvertor.go

Copy file name to clipboard
+96Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
/*
2+
Copyright 2025 The Kubernetes Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package tableconvertor
18+
19+
import (
20+
"context"
21+
"sort"
22+
"strings"
23+
"time"
24+
25+
apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
26+
"k8s.io/apimachinery/pkg/api/meta"
27+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
28+
"k8s.io/apimachinery/pkg/runtime"
29+
"k8s.io/apiserver/pkg/registry/rest"
30+
)
31+
32+
var metaDocs = metav1.ObjectMeta{}.SwaggerDoc()
33+
34+
func New() rest.TableConvertor { return &crdConvertor{} }
35+
36+
type crdConvertor struct{}
37+
38+
// ConvertToTable satisfies rest.TableConvertor.
39+
func (c *crdConvertor) ConvertToTable(ctx context.Context, obj runtime.Object, tableOpts runtime.Object) (*metav1.Table, error) {
40+
table := &metav1.Table{}
41+
42+
if opt, _ := tableOpts.(*metav1.TableOptions); opt == nil || !opt.NoHeaders {
43+
table.ColumnDefinitions = []metav1.TableColumnDefinition{
44+
{Name: "Name", Type: "string", Format: "name", Description: metaDocs["name"]},
45+
{Name: "Group", Type: "string", Description: "API group"},
46+
{Name: "Scope", Type: "string", Description: "Cluster/Namespaced"},
47+
{Name: "Versions", Type: "string", Description: "Served versions"},
48+
{Name: "Created At", Type: "date", Description: metaDocs["creationTimestamp"]},
49+
}
50+
}
51+
52+
addRow := func(cr *apiextensions.CustomResourceDefinition) {
53+
versions := make([]string, 0, len(cr.Spec.Versions))
54+
for _, v := range cr.Spec.Versions {
55+
versions = append(versions, v.Name)
56+
}
57+
sort.Strings(versions)
58+
59+
table.Rows = append(table.Rows, metav1.TableRow{
60+
Object: runtime.RawExtension{Object: cr},
61+
Cells: []any{
62+
cr.Name,
63+
cr.Spec.Group,
64+
string(cr.Spec.Scope),
65+
strings.Join(versions, ","),
66+
cr.CreationTimestamp.Time.UTC().Format(time.RFC3339),
67+
},
68+
})
69+
}
70+
71+
switch {
72+
case meta.IsListType(obj):
73+
if err := meta.EachListItem(obj, func(item runtime.Object) error {
74+
if typed, ok := item.(*apiextensions.CustomResourceDefinition); ok {
75+
addRow(typed)
76+
}
77+
return nil
78+
}); err != nil {
79+
return nil, err
80+
}
81+
default:
82+
if typed, ok := obj.(*apiextensions.CustomResourceDefinition); ok {
83+
addRow(typed)
84+
}
85+
}
86+
87+
if l, err := meta.ListAccessor(obj); err == nil {
88+
table.ResourceVersion = l.GetResourceVersion()
89+
table.Continue = l.GetContinue()
90+
table.RemainingItemCount = l.GetRemainingItemCount()
91+
} else if m, err := meta.CommonAccessor(obj); err == nil {
92+
table.ResourceVersion = m.GetResourceVersion()
93+
}
94+
95+
return table, nil
96+
}

‎staging/src/k8s.io/apiextensions-apiserver/pkg/registry/customresourcedefinition/tableconvertor/tableconvertor_test.go

Copy file name to clipboard
+91Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
/*
2+
Copyright 2025 The Kubernetes Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package tableconvertor
18+
19+
import (
20+
"context"
21+
"testing"
22+
"time"
23+
24+
apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
25+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
26+
)
27+
28+
func TestConvertToTable_Single(t *testing.T) {
29+
crd := &apiextensions.CustomResourceDefinition{
30+
ObjectMeta: metav1.ObjectMeta{
31+
Name: "tests.mygroup.io",
32+
CreationTimestamp: metav1.NewTime(time.Date(2025, 5, 3, 12, 0, 0, 0, time.UTC)),
33+
},
34+
Spec: apiextensions.CustomResourceDefinitionSpec{
35+
Group: "mygroup.io",
36+
Scope: apiextensions.ClusterScoped,
37+
Versions: []apiextensions.CustomResourceDefinitionVersion{
38+
{Name: "v1"},
39+
{Name: "v2"},
40+
},
41+
},
42+
}
43+
44+
table, err := New().ConvertToTable(context.Background(), crd, &metav1.TableOptions{})
45+
if err != nil {
46+
t.Fatalf("ConvertToTable returned error: %v", err)
47+
}
48+
49+
// Expect one row
50+
if len(table.Rows) != 1 {
51+
t.Fatalf("Expected 1 row, got %d", len(table.Rows))
52+
}
53+
cells := table.Rows[0].Cells
54+
// Verify cells order and content
55+
expected := []string{"tests.mygroup.io", "mygroup.io", string(apiextensions.ClusterScoped), "v1,v2", "2025-05-03T12:00:00Z"}
56+
for i, exp := range expected {
57+
if cells[i] != exp {
58+
t.Errorf("Cell %d: expected %v, got %v", i, exp, cells[i])
59+
}
60+
}
61+
}
62+
63+
func TestConvertToTable_List(t *testing.T) {
64+
crd1 := &apiextensions.CustomResourceDefinition{
65+
ObjectMeta: metav1.ObjectMeta{Name: "one.group.io", CreationTimestamp: metav1.NewTime(time.Now())},
66+
Spec: apiextensions.CustomResourceDefinitionSpec{Group: "group.io", Scope: apiextensions.NamespaceScoped, Versions: []apiextensions.CustomResourceDefinitionVersion{{Name: "v1"}}},
67+
}
68+
crd2 := &apiextensions.CustomResourceDefinition{
69+
ObjectMeta: metav1.ObjectMeta{Name: "two.group.io", CreationTimestamp: metav1.NewTime(time.Now())},
70+
Spec: apiextensions.CustomResourceDefinitionSpec{Group: "group.io", Scope: apiextensions.NamespaceScoped, Versions: []apiextensions.CustomResourceDefinitionVersion{{Name: "v2"}}},
71+
}
72+
list := &apiextensions.CustomResourceDefinitionList{Items: []apiextensions.CustomResourceDefinition{*crd2, *crd1}}
73+
74+
table, err := New().ConvertToTable(context.Background(), list, &metav1.TableOptions{})
75+
if err != nil {
76+
t.Fatalf("ConvertToTable(list) returned error: %v", err)
77+
}
78+
79+
if len(table.Rows) != 2 {
80+
t.Fatalf("Expected 2 rows, got %d", len(table.Rows))
81+
}
82+
83+
// Ensure sorting of list items preserved insertion order of list (not table)
84+
names := []string{table.Rows[0].Cells[0].(string), table.Rows[1].Cells[0].(string)}
85+
expectedNames := []string{"two.group.io", "one.group.io"}
86+
for i, exp := range expectedNames {
87+
if names[i] != exp {
88+
t.Errorf("Row %d Name: expected %s, got %s", i, exp, names[i])
89+
}
90+
}
91+
}

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.