Add a config.Resource configuration option to be able to mark

the generated CRD API version as the storage version. Signed-off-by: Alper Rifat Ulucinar <[email protected]>
crossplane · Apr 18, 2024 · 7f036c3 · 7f036c3
1 parent 767b88f
commit 7f036c3
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 8 deletions.
diff --git a/pkg/config/common.go b/pkg/config/common.go
@@ -91,6 +91,7 @@ func DefaultResource(name string, terraformSchema *schema.Resource, terraformPlu
 		UseAsync:                         true,
 		SchemaElementOptions:             make(SchemaElementOptions),
 		ServerSideApplyMergeStrategies:   make(ServerSideApplyMergeStrategies),
+		MarkStorageVersion:               true,
 	}
 	for _, f := range opts {
 		f(r)

diff --git a/pkg/config/common_test.go b/pkg/config/common_test.go
@@ -45,6 +45,7 @@ func TestDefaultResource(t *testing.T) {
 				UseAsync:                       true,
 				SchemaElementOptions:           SchemaElementOptions{},
 				ServerSideApplyMergeStrategies: ServerSideApplyMergeStrategies{},
+				MarkStorageVersion:             true,
 			},
 		},
 		"TwoSectionsName": {
@@ -63,6 +64,7 @@ func TestDefaultResource(t *testing.T) {
 				UseAsync:                       true,
 				SchemaElementOptions:           SchemaElementOptions{},
 				ServerSideApplyMergeStrategies: ServerSideApplyMergeStrategies{},
+				MarkStorageVersion:             true,
 			},
 		},
 		"NameWithPrefixAcronym": {
@@ -81,6 +83,7 @@ func TestDefaultResource(t *testing.T) {
 				UseAsync:                       true,
 				SchemaElementOptions:           SchemaElementOptions{},
 				ServerSideApplyMergeStrategies: ServerSideApplyMergeStrategies{},
+				MarkStorageVersion:             true,
 			},
 		},
 		"NameWithSuffixAcronym": {
@@ -99,6 +102,7 @@ func TestDefaultResource(t *testing.T) {
 				UseAsync:                       true,
 				SchemaElementOptions:           SchemaElementOptions{},
 				ServerSideApplyMergeStrategies: ServerSideApplyMergeStrategies{},
+				MarkStorageVersion:             true,
 			},
 		},
 		"NameWithMultipleAcronyms": {
@@ -117,6 +121,7 @@ func TestDefaultResource(t *testing.T) {
 				UseAsync:                       true,
 				SchemaElementOptions:           SchemaElementOptions{},
 				ServerSideApplyMergeStrategies: ServerSideApplyMergeStrategies{},
+				MarkStorageVersion:             true,
 			},
 		},
 	}

diff --git a/pkg/config/resource.go b/pkg/config/resource.go
@@ -436,6 +436,11 @@ type Resource struct {
 	// SchemaElementOption for configuring options for schema elements.
 	SchemaElementOptions SchemaElementOptions
 
+	// MarkStorageVersion sets the generated CRD API version as
+	// the CRD storage version. The default value is true, i.e., the generated
+	// version is by default the storage version.
+	MarkStorageVersion bool
+
 	// listConversionPaths is the Terraform field paths of embedded objects that
 	// need to be converted into singleton lists (lists of at most one element)
 	// at runtime.

diff --git a/pkg/pipeline/crd.go b/pkg/pipeline/crd.go
@@ -9,6 +9,7 @@ import (
 	"go/types"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -85,14 +86,15 @@ func (cg *CRDGenerator) Generate(cfg *config.Resource) (string, error) {
 	vars := map[string]any{
 		"Types": typesStr,
 		"CRD": map[string]string{
-			"APIVersion":       cfg.Version,
-			"Group":            cg.Group,
-			"Kind":             cfg.Kind,
-			"ForProviderType":  gen.ForProviderType.Obj().Name(),
-			"InitProviderType": gen.InitProviderType.Obj().Name(),
-			"AtProviderType":   gen.AtProviderType.Obj().Name(),
-			"ValidationRules":  gen.ValidationRules,
-			"Path":             cfg.Path,
+			"APIVersion":         cfg.Version,
+			"Group":              cg.Group,
+			"Kind":               cfg.Kind,
+			"MarkStorageVersion": strconv.FormatBool(cfg.MarkStorageVersion),
+			"ForProviderType":    gen.ForProviderType.Obj().Name(),
+			"InitProviderType":   gen.InitProviderType.Obj().Name(),
+			"AtProviderType":     gen.AtProviderType.Obj().Name(),
+			"ValidationRules":    gen.ValidationRules,
+			"Path":               cfg.Path,
 		},
 		"Provider": map[string]string{
 			"ShortName": cg.ProviderShortName,

diff --git a/pkg/pipeline/templates/crd_types.go.tmpl b/pkg/pipeline/templates/crd_types.go.tmpl
@@ -38,7 +38,9 @@ type {{ .CRD.Kind }}Status struct {
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+{{ if eq .CRD.MarkStorageVersion "true" -}}
 // +kubebuilder:storageversion
+{{ end }}
 
 // {{ .CRD.Kind }} is the Schema for the {{ .CRD.Kind }}s API. {{ .CRD.Description }}
 // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"