Rename feature-flag from 'context-aware-discovery' to 'context-aware-cli-for-plugins'

Author: Anuj Chaudhari

Makefile

@@ -393,7 +393,7 @@ install-cli-plugins: ## Install Tanzu CLI plugins
 	fi
 
 .PHONY: install-cli-plugins-without-discovery
-install-cli-plugins-without-discovery: set-unstable-versions set-context-aware-discovery ## Install Tanzu CLI plugins when context-aware discovery is disabled
+install-cli-plugins-without-discovery: set-unstable-versions set-context-aware-cli-for-plugins ## Install Tanzu CLI plugins when context-aware discovery is disabled
 	TANZU_CLI_NO_INIT=true $(GO) run -ldflags "$(LD_FLAGS)" ./cmd/cli/tanzu/main.go \
 		plugin install all --local $(ARTIFACTS_DIR)/$(GOHOSTOS)/$(GOHOSTARCH)/cli
 	TANZU_CLI_NO_INIT=true $(GO) run -ldflags "$(LD_FLAGS)" ./cmd/cli/tanzu/main.go \
@@ -402,20 +402,20 @@ install-cli-plugins-without-discovery: set-unstable-versions set-context-aware-d
 		test fetch --local $(ARTIFACTS_DIR)/$(GOHOSTOS)/$(GOHOSTARCH)/cli --local $(ARTIFACTS_DIR)-admin/$(GOHOSTOS)/$(GOHOSTARCH)/cli
 
 .PHONY: install-cli-plugins-from-local-discovery
-install-cli-plugins-from-local-discovery: clean-catalog-cache clean-cli-plugins set-context-aware-discovery configure-admin-plugins-discovery-source-local ## Install Tanzu CLI plugins from local discovery
+install-cli-plugins-from-local-discovery: clean-catalog-cache clean-cli-plugins set-context-aware-cli-for-plugins configure-admin-plugins-discovery-source-local ## Install Tanzu CLI plugins from local discovery
 	TANZU_CLI_NO_INIT=true $(GO) run -ldflags "$(LD_FLAGS) -X 'github.com/vmware-tanzu/tanzu-framework/pkg/v1/config.DefaultStandaloneDiscoveryType=local'" ./cmd/cli/tanzu/main.go plugin sync
 
 .PHONY: install-cli-plugins-from-oci-discovery
-install-cli-plugins-from-oci-discovery: clean-catalog-cache clean-cli-plugins set-context-aware-discovery ## Install Tanzu CLI plugins from OCI discovery
+install-cli-plugins-from-oci-discovery: clean-catalog-cache clean-cli-plugins set-context-aware-cli-for-plugins ## Install Tanzu CLI plugins from OCI discovery
 	TANZU_CLI_NO_INIT=true $(GO) run -ldflags "$(LD_FLAGS) -X 'github.com/vmware-tanzu/tanzu-framework/pkg/v1/config.DefaultStandaloneDiscoveryType=oci'" ./cmd/cli/tanzu/main.go plugin sync
 
 .PHONY: set-unstable-versions
 set-unstable-versions:  ## Configures the unstable versions
 	TANZU_CLI_NO_INIT=true $(GO) run -ldflags "$(LD_FLAGS)" ./cmd/cli/tanzu/main.go config set unstable-versions $(TANZU_PLUGIN_UNSTABLE_VERSIONS)
 
-.PHONY: set-context-aware-discovery
-set-context-aware-discovery: ## Configures the context-aware-discovery feature flag
-	TANZU_CLI_NO_INIT=true $(GO) run -ldflags "$(LD_FLAGS)" ./cmd/cli/tanzu/main.go config set features.global.context-aware-discovery $(ENABLE_CONTEXT_AWARE_PLUGIN_DISCOVERY)
+.PHONY: set-context-aware-cli-for-plugins
+set-context-aware-cli-for-plugins: ## Configures the context-aware-cli-for-plugins-beta feature flag
+	TANZU_CLI_NO_INIT=true $(GO) run -ldflags "$(LD_FLAGS)" ./cmd/cli/tanzu/main.go config set features.global.context-aware-cli-for-plugins $(ENABLE_CONTEXT_AWARE_PLUGIN_DISCOVERY)
 
 .PHONY: configure-admin-plugins-discovery-source-local
 configure-admin-plugins-discovery-source-local: ## Configures the admin plugins discovery source

cmd/cli/plugin/login/main.go

@@ -132,8 +132,8 @@ func login(cmd *cobra.Command, args []string) (err error) {
 		return err
 	}
 
-	// Sync all required plugins if the "features.global.context-aware-discovery" feature is enabled
-	if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+	// Sync all required plugins if the "features.global.context-aware-cli-for-plugins" feature is enabled
+	if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 		if err = pluginmanager.SyncPlugins(serverTarget.Name); err != nil {
 			log.Warning("unable to automatically sync the plugins from target server. Please run 'tanzu plugin sync' command to sync plugins manually")
 		}

cmd/cli/plugin/managementcluster/create.go

@@ -188,7 +188,7 @@ func runInit() error {
 	}
 
 	// Sync plugins if management-cluster creation is successful
-	if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+	if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 		server, err := config.GetCurrentServer()
 		if err == nil && server != nil {
 			err = pluginmanager.SyncPlugins(server.Name)

cmd/cli/plugin/managementcluster/upgrade.go

@@ -97,7 +97,7 @@ func runUpgradeRegion(server *v1alpha1.Server) error {
 	}
 
 	// Sync plugins if management-cluster upgrade is successful
-	if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+	if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 		err = pluginmanager.SyncPlugins(server.Name)
 		if err != nil {
 			log.Warningf("unable to sync plugins after management cluster upgrade. Please run `tanzu plugin sync` command manually to install/update plugins")

docs/dev/build.md

@@ -86,6 +86,6 @@ For more detailed information on these APIs check out this [doc](../api-machiner
 
 The Tanzu CLI is an amalgamation of all the Tanzu infrastructure elements under one unified core CLI experience. The core CLI supports a plugin model where the developers of different Tanzu services (bundled or SaaS) can distribute plugins that target functionalities of the services they own. When users switch between different services via the CLI context, we want to surface only the relevant plugins for the given context for a crisp user experience.
 
-This feature is gated by `features.global.context-aware-discovery` CLI feature flag and can be turned on/off as described [here](../cli/config-features.md). When this feature is enabled, CLI will not automatically use already installed plugins with context-aware discovery and users will need to install plugins again with `tanzu plugin install` command.
+This feature is gated by `features.global.context-aware-cli-for-plugins` CLI feature flag and can be turned on/off as described [here](../cli/config-features.md). When this feature is enabled, CLI will not automatically use already installed plugins with context-aware discovery and users will need to install plugins again with `tanzu plugin install` command.
 
 For more detailed information on these design check out this [doc](../design/context-aware-plugin-discovery.md)

pkg/v1/cli/catalog/catalog_test.go

@@ -173,7 +173,7 @@ func Test_ContextCatalog_With_Context(t *testing.T) {
 // the featuregate is configured to true by default
 func Test_CatalogCacheFileName(t *testing.T) {
 	assert := assert.New(t)
-	if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+	if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 		assert.Equal(catalogCacheFileName, "catalog.yaml")
 	}
 }

pkg/v1/cli/command/core/plugin_manager.go

@@ -58,7 +58,7 @@ var listPluginCmd = &cobra.Command{
 	Use:   "list",
 	Short: "List available plugins",
 	RunE: func(cmd *cobra.Command, args []string) error {
-		if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+		if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 			serverName := ""
 			server, err := config.GetCurrentServer()
 			if err == nil && server != nil {
@@ -178,7 +178,7 @@ var describePluginCmd = &cobra.Command{
 		}
 		pluginName := args[0]
 
-		if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+		if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 			serverName := ""
 			server, err := config.GetCurrentServer()
 			if err == nil && server != nil {
@@ -228,7 +228,7 @@ var installPluginCmd = &cobra.Command{
 		}
 		pluginName := args[0]
 
-		if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+		if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 			serverName := ""
 			server, err := config.GetCurrentServer()
 			if err == nil && server != nil {
@@ -287,7 +287,7 @@ var upgradePluginCmd = &cobra.Command{
 		}
 		pluginName := args[0]
 
-		if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+		if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 			serverName := ""
 			server, err := config.GetCurrentServer()
 			if err == nil && server != nil {
@@ -333,7 +333,7 @@ var deletePluginCmd = &cobra.Command{
 		}
 		pluginName := args[0]
 
-		if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+		if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 			serverName := ""
 			server, err := config.GetCurrentServer()
 			if err == nil && server != nil {
@@ -359,7 +359,7 @@ var cleanPluginCmd = &cobra.Command{
 	Use:   "clean",
 	Short: "Clean the plugins",
 	RunE: func(cmd *cobra.Command, args []string) (err error) {
-		if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+		if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 			return pluginmanager.Clean()
 		}
 		return cli.Clean()
@@ -370,7 +370,7 @@ var syncPluginCmd = &cobra.Command{
 	Use:   "sync",
 	Short: "Sync the plugins",
 	RunE: func(cmd *cobra.Command, args []string) (err error) {
-		if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+		if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 			serverName := ""
 			server, err := config.GetCurrentServer()
 			if err == nil && server != nil {
@@ -383,7 +383,7 @@ var syncPluginCmd = &cobra.Command{
 			log.Success("Done")
 			return nil
 		}
-		return errors.Errorf("command is only applicable if `%s` feature is enabled", config.FeatureContextAwareDiscovery)
+		return errors.Errorf("command is only applicable if `%s` feature is enabled", config.FeatureContextAwareCLIForPlugins)
 	},
 }
 

pkg/v1/cli/command/core/root.go

@@ -69,9 +69,9 @@ func NewRootCmd() (*cobra.Command, error) {
 		return nil, fmt.Errorf("failed to copy legacy configuration directory to new location: %w", err)
 	}
 
-	// If context-aware-discovery is not enabled
+	// If context-aware-cli-for-plugins feature is not enabled
 	// check that all plugins in the core distro are installed or do so.
-	if !config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+	if !config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 		plugins, err = checkAndInstallMissingPlugins(plugins)
 		if err != nil {
 			return nil, err
@@ -99,7 +99,7 @@ func getAvailablePlugins() ([]*v1alpha1.PluginDescriptor, error) {
 	plugins := make([]*v1alpha1.PluginDescriptor, 0)
 	var err error
 
-	if config.IsFeatureActivated(config.FeatureContextAwareDiscovery) {
+	if config.IsFeatureActivated(config.FeatureContextAwareCLIForPlugins) {
 		currentServerName := ""
 
 		server, err := config.GetCurrentServer()

pkg/v1/cli/pluginmanager/manager.go

@@ -178,9 +178,9 @@ func availablePluginsFromStandaloneAndServerPlugins(discoveredServerPlugins, dis
 	for i := range discoveredStandalonePlugins {
 		matchIndex := pluginIndexForName(availablePlugins, discoveredStandalonePlugins[i].Name)
 
-		// Add the standalone plugin to available plugin if it doesn't exist in the serverPlugins list
+		// Add the standalone plugin to available plugins if it doesn't exist in the serverPlugins list
 		// OR
-		// Current standalone discovery type is local and there is
+		// Current standalone discovery is of type 'local'
 		// We are overriding the discovered plugins that we got from server in case of 'local' discovery type
 		// to allow developers to use the plugins that are built locally and not returned from the server
 		// This local discovery is only used for development purpose and should not be used for production

pkg/v1/config/clientconfig.go

@@ -20,10 +20,10 @@ import (
 
 // This block is for global feature constants, to allow them to be used more broadly
 const (
-	// FeatureContextAwareDiscovery determines whether to use legacy way of discovering plugins or
+	// FeatureContextAwareCLIForPlugins determines whether to use legacy way of discovering plugins or
 	// to use the new context-aware Plugin API based plugin discovery mechanism
 	// Users can set this featureflag so that we can have context-aware plugin discovery be opt-in for now.
-	FeatureContextAwareDiscovery = "features.global.context-aware-discovery"
+	FeatureContextAwareCLIForPlugins = "features.global.context-aware-cli-for-plugins"
 	// DualStack feature flags determine whether it is permitted to create
 	// clusters with a dualstack TKG_IP_FAMILY.  There are separate flags for
 	// each primary, "ipv4,ipv6" vs "ipv6,ipv4", and flags for management vs
@@ -40,13 +40,20 @@ const (
 )
 
 // DefaultCliFeatureFlags is used to populate an initially empty config file with default values for feature flags.
-// If a developer expects that their feature will be ready to release, they should create an entry here with a true
-// value. If a developer has a beta feature they want to expose, but leave turned off by default, they should create
-// an entry here with a false value. The keys MUST be in the format "features.<plugin>.<feature>" or initialization
+// The keys MUST be in the format "features.<plugin>.<feature>" or initialization
 // will fail. Note that "global" is a special value for <plugin> to be used for CLI-wide features.
+//
+// If a developer expects that their feature will be ready to release, they should create an entry here with a true
+// value.
+// If a developer has a beta feature they want to expose, but leave turned off by default, they should create
+// an entry here with a false value. WE HIGHLY RECOMMEND the use of a SEPARATE flag for beta use; one that ends in "-beta".
+// Thus, if you plan to eventually release a feature with a flag named "features.cluster.foo-bar", you should consider
+// releasing the beta version with "features.cluster.foo-bar-beta". This will make it much easier when it comes time for
+// mainstreaming the feature (with a default true value) under the flag name "features.cluster.foo-bar", as there will be
+// no conflict with previous installs (that have a false value for the entry "features.cluster.foo-bar-beta").
 var (
 	DefaultCliFeatureFlags = map[string]bool{
-		FeatureContextAwareDiscovery:                          common.ContextAwareDiscoveryEnabled(),
+		FeatureContextAwareCLIForPlugins:                      common.ContextAwareDiscoveryEnabled(),
 		"features.management-cluster.import":                  false,
 		"features.management-cluster.export-from-confirm":     true,
 		"features.management-cluster.standalone-cluster-mode": false,