cmd/operator-sdk: add --crd-version flag to relevant commands

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - The flag `--watch-namespace` and `--operator-namespace` was added to `operator-sdk run --local`, `operator-sdk test --local` and `operator-sdk cleanup` commands in order to replace the flag `--namespace` which was  deprecated.([#2617](https://github.com/operator-framework/operator-sdk/pull/2617))
 - The methods `ctx.GetOperatorNamespace()` and `ctx.GetWatchNamespace()` was added `pkg/test` in order to replace `ctx.GetNamespace()` which is  deprecated. ([#2617](https://github.com/operator-framework/operator-sdk/pull/2617))
+- The `--crd-version` flag was added to the `new`, `add api`, `add crd`, and `generate crds` commands so that users can opt-in to `v1` CRDs. ([#2684](https://github.com/operator-framework/operator-sdk/pull/2684))
 
 ### Changed
 

cmd/operator-sdk/add/api.go

@@ -21,6 +21,7 @@ import (
 	"path/filepath"
 
 	"github.com/operator-framework/operator-sdk/cmd/operator-sdk/internal/genutil"
+	gencrd "github.com/operator-framework/operator-sdk/internal/generate/crd"
 	"github.com/operator-framework/operator-sdk/internal/scaffold"
 	"github.com/operator-framework/operator-sdk/internal/scaffold/input"
 	"github.com/operator-framework/operator-sdk/internal/util/projutil"
@@ -33,6 +34,7 @@ var (
 	apiVersion     string
 	kind           string
 	skipGeneration bool
+	crdVersion     string
 )
 
 func newAddAPICmd() *cobra.Command {
@@ -84,6 +86,8 @@ Example:
 	}
 	apiCmd.Flags().BoolVar(&skipGeneration, "skip-generation", false,
 		"Skip generation of deepcopy and OpenAPI code and OpenAPI CRD specs")
+	apiCmd.Flags().StringVar(&crdVersion, "crd-version", gencrd.DefaultCRDVersion,
+		"CRD version to generate")
 
 	return apiCmd
 }
@@ -143,7 +147,7 @@ func apiRun(cmd *cobra.Command, args []string) error {
 		}
 
 		// Generate a validation spec for the new CRD.
-		if err := genutil.CRDGen(); err != nil {
+		if err := genutil.CRDGen(crdVersion); err != nil {
 			log.Fatal(err)
 		}
 	}

cmd/operator-sdk/add/crd.go

@@ -56,6 +56,8 @@ Generated CR  filename: <project-name>/deploy/crds/<full group>_<version>_<kind>
 	if err := crdCmd.MarkFlagRequired("kind"); err != nil {
 		log.Fatalf("Failed to mark `kind` flag for `add crd` subcommand as required")
 	}
+	crdCmd.Flags().StringVar(&crdVersion, "crd-version", gencrd.DefaultCRDVersion,
+		"CRD version to generate")
 	return crdCmd
 }
 
@@ -101,7 +103,7 @@ func crdFunc(cmd *cobra.Command, args []string) error {
 	// This command does not consider an APIs dir. Instead it adds a plain CRD
 	// for the provided resource. We can use NewCRDNonGo to get this behavior.
 	gcfg := gen.Config{}
-	crd := gencrd.NewCRDNonGo(gcfg, *resource)
+	crd := gencrd.NewCRDNonGo(gcfg, *resource, crdVersion)
 	if err := crd.Generate(); err != nil {
 		log.Fatalf("Error generating CRD for %s: %w", resource, err)
 	}

cmd/operator-sdk/generate/crds.go

@@ -18,13 +18,18 @@ import (
 	"fmt"
 
 	"github.com/operator-framework/operator-sdk/cmd/operator-sdk/internal/genutil"
+	gencrd "github.com/operator-framework/operator-sdk/internal/generate/crd"
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
+var (
+	crdVersion string
+)
+
 func newGenerateCRDsCmd() *cobra.Command {
-	return &cobra.Command{
+	cmd := &cobra.Command{
 		Use:   "crds",
 		Short: "Generates CRDs for API's",
 		Long: `generate crds generates CRDs or updates them if they exist,
@@ -40,6 +45,9 @@ Example:
 `,
 		RunE: crdsFunc,
 	}
+
+	cmd.Flags().StringVar(&crdVersion, "crd-version", gencrd.DefaultCRDVersion, "CRD version to generate")
+	return cmd
 }
 
 func crdsFunc(cmd *cobra.Command, args []string) error {
@@ -49,7 +57,7 @@ func crdsFunc(cmd *cobra.Command, args []string) error {
 
 	// Skip usage printing on error, since this command will never fail from
 	// improper CLI usage.
-	if err := genutil.CRDGen(); err != nil {
+	if err := genutil.CRDGen(crdVersion); err != nil {
 		log.Fatal(err)
 	}
 	return nil

cmd/operator-sdk/generate/openapi.go

@@ -72,14 +72,14 @@ func openAPIFunc(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("command %s doesn't accept any arguments", cmd.CommandPath())
 	}
 
-	fs := []func() error{
-		genutil.OpenAPIGen,
-		genutil.CRDGen,
+	if err := genutil.OpenAPIGen(); err != nil {
+		log.Fatal(err)
 	}
-	for _, f := range fs {
-		if err := f(); err != nil {
-			log.Fatal(err)
-		}
+
+	// Hardcode "v1beta1" here because we never want to change the functionality of this deprecated function.
+	if err := genutil.CRDGen("v1beta1"); err != nil {
+		log.Fatal(err)
 	}
+
 	return nil
 }

cmd/operator-sdk/internal/genutil/crds.go

@@ -26,13 +26,13 @@ import (
 )
 
 // CRDGen generates CRDs for all APIs in pkg/apis.
-func CRDGen() error {
+func CRDGen(crdVersion string) error {
 	projutil.MustInProjectRoot()
 
 	log.Info("Running CRD generator.")
 
 	cfg := gen.Config{}
-	crd := gencrd.NewCRDGo(cfg)
+	crd := gencrd.NewCRDGo(cfg, crdVersion)
 	if err := crd.Generate(); err != nil {
 		return fmt.Errorf("error generating CRDs from APIs in %s: %w", scaffold.ApisDir, err)
 	}

cmd/operator-sdk/new/cmd.go

@@ -123,6 +123,8 @@ generates a default directory layout based on the input <project-name>.
 		"Specific version of the helm chart (default is latest version)")
 	newCmd.Flags().StringVar(&helmChartRepo, "helm-chart-repo", "",
 		"Chart repository URL for the requested helm chart")
+	newCmd.Flags().StringVar(&crdVersion, "crd-version", gencrd.DefaultCRDVersion,
+		"CRD version to generate (Only used for --type=ansible|helm)")
 
 	return newCmd
 }
@@ -142,6 +144,8 @@ var (
 	helmChartRef     string
 	helmChartVersion string
 	helmChartRepo    string
+
+	crdVersion string
 )
 
 func newFunc(cmd *cobra.Command, args []string) error {
@@ -321,7 +325,7 @@ func doAnsibleScaffold() error {
 		return fmt.Errorf("new ansible scaffold failed: %v", err)
 	}
 
-	if err = generateCRDNonGo(projectName, *resource); err != nil {
+	if err = generateCRDNonGo(projectName, *resource, crdVersion); err != nil {
 		return err
 	}
 
@@ -411,7 +415,7 @@ func doHelmScaffold() error {
 		return fmt.Errorf("new helm scaffold failed: %v", err)
 	}
 
-	if err = generateCRDNonGo(projectName, *resource); err != nil {
+	if err = generateCRDNonGo(projectName, *resource, crdVersion); err != nil {
 		return err
 	}
 
@@ -422,13 +426,13 @@ func doHelmScaffold() error {
 	return nil
 }
 
-func generateCRDNonGo(projectName string, resource scaffold.Resource) error {
+func generateCRDNonGo(projectName string, resource scaffold.Resource, crdVersion string) error {
 	crdsDir := filepath.Join(projectName, scaffold.CRDsDir)
 	gcfg := gen.Config{
 		Inputs:    map[string]string{gencrd.CRDsDirKey: crdsDir},
 		OutputDir: crdsDir,
 	}
-	crd := gencrd.NewCRDNonGo(gcfg, resource)
+	crd := gencrd.NewCRDNonGo(gcfg, resource, crdVersion)
 	if err := crd.Generate(); err != nil {
 		return fmt.Errorf("error generating CRD for %s: %w", resource, err)
 	}

doc/cli/operator-sdk_add_api.md

@@ -44,6 +44,7 @@ operator-sdk add api [flags]
 
 ```
       --api-version string   Kubernetes APIVersion that has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)
+      --crd-version string   CRD version to generate (default "v1beta1")
   -h, --help                 help for api
       --kind string          Kubernetes resource Kind name. (e.g AppService)
       --skip-generation      Skip generation of deepcopy and OpenAPI code and OpenAPI CRD specs

doc/cli/operator-sdk_add_crd.md

@@ -21,6 +21,7 @@ operator-sdk add crd [flags]
 
 ```
       --api-version string   Kubernetes apiVersion and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1)
+      --crd-version string   CRD version to generate (default "v1beta1")
   -h, --help                 help for crd
       --kind string          Kubernetes CustomResourceDefintion kind. (e.g AppService)
 ```

doc/cli/operator-sdk_generate_crds.md

@@ -23,7 +23,8 @@ operator-sdk generate crds [flags]
 ### Options
 
 ```
-  -h, --help   help for crds
+      --crd-version string   CRD version to generate (default "v1beta1")
+  -h, --help                 help for crds
 ```
 
 ### SEE ALSO

doc/cli/operator-sdk_new.md

@@ -67,6 +67,7 @@ operator-sdk new <project-name> [flags]
 
 ```
       --api-version string          Kubernetes apiVersion and has a format of $GROUP_NAME/$VERSION (e.g app.example.com/v1alpha1) - used with "ansible" or "helm" types
+      --crd-version string          CRD version to generate (Only used for --type=ansible|helm) (default "v1beta1")
       --generate-playbook           Generate a playbook skeleton. (Only used for --type ansible)
       --git-init                    Initialize the project directory as a git repository (default false)
       --header-file string          Path to file containing headers for generated Go files. Copied to hack/boilerplate.go.txt

internal/generate/crd/crd.go

@@ -23,7 +23,7 @@ import (
 	"sort"
 	"strings"
 
-	gen "github.com/operator-framework/operator-sdk/internal/generate/gen"
+	"github.com/operator-framework/operator-sdk/internal/generate/gen"
 	"github.com/operator-framework/operator-sdk/internal/scaffold"
 	"github.com/operator-framework/operator-sdk/internal/util/fileutil"
 	"github.com/operator-framework/operator-sdk/internal/util/k8sutil"
@@ -32,6 +32,8 @@ import (
 	"github.com/ghodss/yaml"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/afero"
+	apiext "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
+	apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	apiextv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -45,20 +47,23 @@ type crdGenerator struct {
 	isOperatorGo bool
 	// resource contains API information used to configure single-CRD generation.
 	// This is only required when isOperatorGo is false.
-	resource scaffold.Resource
+	resource   scaffold.Resource
+	crdVersion string
 }
 
 const (
-	APIsDirKey = "apis"
-	CRDsDirKey = "crds"
+	APIsDirKey        = "apis"
+	CRDsDirKey        = "crds"
+	DefaultCRDVersion = "v1beta1"
 )
 
 // NewCRDGo returns a CRD generator configured to generate CustomResourceDefintion
 // manifests from Go API files.
-func NewCRDGo(cfg gen.Config) gen.Generator {
+func NewCRDGo(cfg gen.Config, crdVersion string) gen.Generator {
 	g := crdGenerator{
 		Config:       cfg,
 		isOperatorGo: true,
+		crdVersion:   crdVersion,
 	}
 	if g.Inputs == nil {
 		g.Inputs = map[string]string{}
@@ -77,11 +82,12 @@ func NewCRDGo(cfg gen.Config) gen.Generator {
 
 // NewCRDNonGo returns a CRD generator configured to generate a
 // CustomResourceDefintion manifest from scratch using data in resource.
-func NewCRDNonGo(cfg gen.Config, resource scaffold.Resource) gen.Generator {
+func NewCRDNonGo(cfg gen.Config, resource scaffold.Resource, crdVersion string) gen.Generator {
 	g := crdGenerator{
 		Config:       cfg,
 		resource:     resource,
 		isOperatorGo: false,
+		crdVersion:   crdVersion,
 	}
 	if g.Inputs == nil {
 		g.Inputs = map[string]string{}
@@ -115,6 +121,11 @@ func (g crdGenerator) validate() error {
 			return fmt.Errorf("resource is invalid: %w", err)
 		}
 	}
+	switch g.crdVersion {
+	case "v1", "v1beta1":
+	default:
+		return fmt.Errorf("crd version %q is invalid", g.crdVersion)
+	}
 	return nil
 }
 
@@ -156,10 +167,11 @@ func (g crdGenerator) generateGo() (map[string][]byte, error) {
 	defName := "output:crd:cache"
 	cacheOutputDir := filepath.Clean(g.OutputDir)
 	rawOpts := []string{
-		"crd",
+		fmt.Sprintf("crd:crdVersions={%s}", g.crdVersion),
 		fmt.Sprintf("paths=%s/...", fileutil.DotPath(g.Inputs[APIsDirKey])),
 		fmt.Sprintf("%s:dir=%s", defName, cacheOutputDir),
 	}
+
 	runner := gen.NewCachedRunner()
 	runner.AddOutputRule(defName, gen.OutputToCachedDirectory{})
 	if err := runner.Run(rawOpts); err != nil {
@@ -268,7 +280,31 @@ func (g crdGenerator) generateNonGo() (map[string][]byte, error) {
 	if err := checkCRDVersions(crd); err != nil {
 		return nil, fmt.Errorf("error checking CRD %s versions: %w", crd.GetName(), err)
 	}
-	b, err := k8sutil.GetObjectBytes(&crd, yaml.Marshal)
+
+	var (
+		b   []byte
+		err error
+	)
+	switch g.crdVersion {
+	case "v1beta1":
+		crd.TypeMeta.APIVersion = apiextv1beta1.SchemeGroupVersion.String()
+		b, err = k8sutil.GetObjectBytes(&crd, yaml.Marshal)
+	case "v1":
+		var unversioned apiext.CustomResourceDefinition
+		//nolint:lll
+		if err := apiextv1beta1.Convert_v1beta1_CustomResourceDefinition_To_apiextensions_CustomResourceDefinition(&crd, &unversioned, nil); err != nil {
+			return nil, err
+		}
+		var out apiextv1.CustomResourceDefinition
+		out.TypeMeta.APIVersion = apiextv1.SchemeGroupVersion.String()
+		out.TypeMeta.Kind = "CustomResourceDefinition"
+		//nolint:lll
+		if err := apiextv1.Convert_apiextensions_CustomResourceDefinition_To_v1_CustomResourceDefinition(&unversioned, &out, nil); err != nil {
+			return nil, err
+		}
+		b, err = k8sutil.GetObjectBytes(&out, yaml.Marshal)
+	}
+
 	if err != nil {
 		return nil, fmt.Errorf("error marshalling CRD %s: %w", crd.GetName(), err)
 	}