Deprecate 'operator-sdk add crd' cmd

Hide `add crd` command and add deprecation message.
operator-framework · Jun 4, 2020 · ec06d64 · ec06d64
1 parent 4e3cc47
commit ec06d64
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 8 deletions.
diff --git a/cmd/operator-sdk/add/crd.go b/cmd/operator-sdk/add/crd.go
@@ -29,11 +29,14 @@ import (
 	"github.com/spf13/cobra"
 )
 
+const deprecationTemplate = "\033[1;36m%s\033[0m"
+
 // newAddCRDCmd - add crd command
 func newAddCRDCmd() *cobra.Command {
 	crdCmd := &cobra.Command{
-		Use:   "crd",
-		Short: "Adds a Custom Resource Definition (CRD) and the Custom Resource (CR) files",
+		Hidden: true,
+		Use:    "crd",
+		Short:  "Adds a Custom Resource Definition (CRD) and the Custom Resource (CR) files",
 		Long: `The operator-sdk add crd command will create a Custom Resource Definition (CRD)` +
 			`and the Custom Resource (CR) files for the specified api-version and kind.
 
@@ -61,6 +64,17 @@ Generated CR  filename: <project-name>/deploy/crds/<full group>_<version>_<kind>
 }
 
 func crdFunc(cmd *cobra.Command, args []string) error {
+	fmt.Printf(deprecationTemplate, `[Deprecation notice] The 'operator-sdk add crd' command is deprecated!
+
+Use 'operaot-sdk add api' command to create a new API definition for a custom resource.
+
+'add api' command will also generate or update CRDs for a particular GVK based on values
+provided for '--kind' and '--api-version' flags specified in the command. 
+
+Refer 'https://sdk.operatorframework.io/docs/cli/operator-sdk_add_api/' for more details.
+
+`)
+
 	projutil.MustInProjectRoot()
 
 	cfg := &input.Config{

diff --git a/website/content/en/docs/cli/operator-sdk_add.md b/website/content/en/docs/cli/operator-sdk_add.md
@@ -19,6 +19,4 @@ Adds a controller or resource to the project
 
 * [operator-sdk](../operator-sdk)	 - An SDK for building operators with ease
 * [operator-sdk add api](../operator-sdk_add_api)	 - Adds a new api definition under pkg/apis
-* [operator-sdk add controller](../operator-sdk_add_controller)	 - Adds a new controller pkg
-* [operator-sdk add crd](../operator-sdk_add_crd)	 - Adds a Custom Resource Definition (CRD) and the Custom Resource (CR) files
-
+* [operator-sdk add controller](../operator-sdk_add_controller)	 - Adds a new controller pkg
diff --git a/website/content/en/docs/cli/operator-sdk_add_crd.md b/website/content/en/docs/cli/operator-sdk_add_crd.md
@@ -1,6 +1,3 @@
----
-title: "operator-sdk add crd"
----
 ## operator-sdk add crd
 
 Adds a Custom Resource Definition (CRD) and the Custom Resource (CR) files