Skip to content

Add a new config to override kubebuilder printcolumn:name #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2021
Merged

Add a new config to override kubebuilder printcolumn:name #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pkg/generate/config/field.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ type FieldConfig struct {
// AdditionalPrinterColumns list to be included in the `kubectl get`
// response.
IsPrintable bool `json:"is_printable"`
// PrintName instructs the code generator to override the column name used
// to include the field in `kubectl get` response. If `IsPrintable` is false
// this field is ignored.
PrintName string `json:"print_name"`
// Required indicates whether this field is a required member or not.
// This field is used to configure '+kubebuilder:validation:Required' on API object's members.
IsRequired *bool `json:"is_required,omitempty"`
Expand Down
38 changes: 22 additions & 16 deletions pkg/model/printer_column.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,21 +82,22 @@ func (r *CRD) addPrintableColumn(
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types
// This maps Go type to OpenAPI type.
acceptableColumnMaps := map[string]string{
"string": "string",
"boolean": "boolean",
"int": "integer",
"int8": "integer",
"int16": "integer",
"int32": "integer",
"int64": "integer",
"uint": "integer",
"uint8": "integer",
"uint16": "integer",
"uint32": "integer",
"uint64": "integer",
"uintptr": "integer",
"float32": "number",
"float64": "number",
"string": "string",
"boolean": "boolean",
"int": "integer",
"int8": "integer",
"int16": "integer",
"int32": "integer",
"int64": "integer",
"uint": "integer",
"uint8": "integer",
"uint16": "integer",
"uint32": "integer",
"uint64": "integer",
"uintptr": "integer",
"float32": "number",
"float64": "number",
"metav1.Time": "date",
}
printColumnType, exists := acceptableColumnMaps[fieldColumnType]

Expand All @@ -108,9 +109,14 @@ func (r *CRD) addPrintableColumn(
panic(msg)
}

name := field.Names.Camel
if field.FieldConfig.PrintName != "" {
name = field.FieldConfig.PrintName
}

column := &PrinterColumn{
CRD: r,
Name: field.Names.Camel,
Name: name,
Type: printColumnType,
JSONPath: jsonPath,
}
Expand Down