docs: Remove region mentions (#50)

In most cases drop in replacement with the word `platform`

Signed-off-by: Marc Lopez <marc5.12@outlook.com>

Author: marclop

build/errcheck-exclusions.txt

@@ -4,4 +4,5 @@ github.com/spf13/cobra.MarkFlagRequired
 github.com/spf13/cobra.MarkFlagFilename
 github.com/spf13/cobra.MarkFlagFilename
 (*github.com/spf13/cobra.Command).Help
-(*github.com/spf13/viper.Viper).BindPFlags
+(*github.com/spf13/viper.Viper).BindPFlags
+(*github.com/spf13/pflag.FlagSet).MarkHidden

cmd/deployment/elasticsearch/list.go

@@ -45,7 +45,7 @@ Read all the simple query string syntax in https://www.elastic.co/guide/en/elast
 
 var listElasticsearchCmd = &cobra.Command{
 	Use:     "list",
-	Short:   "Returns the list of Elasticsearch clusters for a region",
+	Short:   "Returns the list of Elasticsearch clusters",
 	Example: elasticSearchQueryExamples,
 	PreRunE: cobra.MaximumNArgs(0),
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/platform/allocator/list.go

@@ -30,7 +30,7 @@ import (
 
 const (
 	allocatorFilterCmdMessage = `Post-query filter out allocators based on metadata tags, for instance 'instanceType:i3.large'`
-	allocatorListMessage      = `Returns all allocators that have instances or are connected in the region. Use --all flag or --output json to show all. Use --query to match any of the allocators properties.`
+	allocatorListMessage      = `Returns all allocators that have instances or are connected to the platform. Use --all flag or --output json to show all. Use --query to match any of the allocators properties.`
 	allocatorQueryExample     = `
 
 Query examples:
@@ -79,7 +79,7 @@ func listAllocators(cmd *cobra.Command, args []string) error {
 	}
 
 	if cmd.Flag("output").Value.String() != "json" && !allFlag {
-		fmt.Printf("Showing allocators that have instances or are connected in the region. Use --all flag or --output json to show all\n")
+		fmt.Printf("Showing allocators that have instances or are connected in the platform. Use --all flag or --output json to show all\n")
 	}
 
 	return ecctl.Get().Formatter.Format(filepath.Join("allocator", templateName), a)

cmd/platform/constructor/command.go

@@ -28,7 +28,7 @@ import (
 )
 
 const (
-	constructorListMessage        = `Returns all of the constructors in the region`
+	constructorListMessage        = `Returns all of the constructors in the platform`
 	constructorShowMessage        = `Returns information about the constructor with given ID`
 	constructorMaintenanceMessage = `Sets/un-sets a constructor's maintenance mode`
 )

cmd/platform/proxy/command.go

@@ -28,7 +28,7 @@ import (
 )
 
 const (
-	proxyListMessage = `Returns all of the proxies in the region`
+	proxyListMessage = `Returns all of the proxies in the platform`
 	proxyShowMessage = `Returns information about the proxy with given id`
 )
 

cmd/platform/proxy/filteredgroup/list.go

@@ -27,7 +27,7 @@ import (
 )
 
 const (
-	filteredGroupsUse = `Returns all proxies filtered groups in the region`
+	filteredGroupsUse = `Returns all proxies filtered groups in the platform`
 )
 
 func listProxyFilteredGroups(cmd *cobra.Command, args []string) error {

cmd/root.go

@@ -99,14 +99,10 @@ func Execute(v ecctl.VersionInfo) int {
 
 func init() {
 	RootCmd.PersistentFlags().String("config", "config", "Config name, used to have multiple configs in $HOME/.ecctl/<env>")
-	RootCmd.PersistentFlags().String("host", "https://api.elastic-cloud.com", "Base URL to use")
+	RootCmd.PersistentFlags().String("host", "", "Base URL to use")
 	RootCmd.PersistentFlags().String("user", "", "Username to use to authenticate (If empty will look for EC_USER environment variable)")
 	RootCmd.PersistentFlags().String("pass", "", "Password to use to authenticate (If empty will look for EC_PASS environment variable)")
 	RootCmd.PersistentFlags().String("apikey", "", "API key to use to authenticate (If empty will look for EC_APIKEY environment variable)")
-	RootCmd.PersistentFlags().String("region", "", "Elastic Cloud region")
-	RootCmd.Flag("region").Annotations = map[string][]string{
-		cobra.BashCompCustom: {"__ecctl_valid_regions"},
-	}
 	RootCmd.PersistentFlags().Bool("verbose", false, "Enable verbose mode")
 	RootCmd.PersistentFlags().String("output", "text", "Output format [text|json]")
 	RootCmd.PersistentFlags().Bool("force", false, "Do not ask for confirmation")
@@ -117,6 +113,13 @@ func init() {
 	RootCmd.PersistentFlags().Bool("insecure", false, "Skips all TLS validation")
 	RootCmd.PersistentFlags().BoolP("quiet", "q", false, "Suppresses the configuration file used for the run, if any")
 	RootCmd.PersistentFlags().Duration("timeout", time.Second*30, "Timeout to use on all HTTP calls")
+	RootCmd.PersistentFlags().String("region", "", "Elastic Cloud region")
+	RootCmd.Flag("region").Annotations = map[string][]string{
+		cobra.BashCompCustom: {"__ecctl_valid_regions"},
+	}
+	// Remove this line after ESS Public API is available.
+	RootCmd.PersistentFlags().MarkHidden("region")
+
 	defaultViper.BindPFlags(RootCmd.PersistentFlags())
 }
 

docs/ecctl.md

@@ -14,14 +14,13 @@ Elastic Cloud Control
       --force              Do not ask for confirmation
       --format string      Formats the output using a Go template
   -h, --help               help for ecctl
-      --host string        Base URL to use (default "https://api.elastic-cloud.com")
+      --host string        Base URL to use
       --insecure           Skips all TLS validation
       --message string     A message to set on cluster operation
       --output string      Output format [text|json] (default "text")
       --pass string        Password to use to authenticate (If empty will look for EC_PASS environment variable)
       --pprof              Enables pprofing and saves the profile to pprof-20060102150405
   -q, --quiet              Suppresses the configuration file used for the run, if any
-      --region string      Elastic Cloud region
       --timeout duration   Timeout to use on all HTTP calls (default 30s)
       --trace              Enables tracing saves the trace to trace-20060102150405
       --user string        Username to use to authenticate (If empty will look for EC_USER environment variable)

docs/ecctl_auth.md

@@ -23,14 +23,13 @@ ecctl auth [flags]
       --config string      Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config")
       --force              Do not ask for confirmation
       --format string      Formats the output using a Go template
-      --host string        Base URL to use (default "https://api.elastic-cloud.com")
+      --host string        Base URL to use
       --insecure           Skips all TLS validation
       --message string     A message to set on cluster operation
       --output string      Output format [text|json] (default "text")
       --pass string        Password to use to authenticate (If empty will look for EC_PASS environment variable)
       --pprof              Enables pprofing and saves the profile to pprof-20060102150405
   -q, --quiet              Suppresses the configuration file used for the run, if any
-      --region string      Elastic Cloud region
       --timeout duration   Timeout to use on all HTTP calls (default 30s)
       --trace              Enables tracing saves the trace to trace-20060102150405
       --user string        Username to use to authenticate (If empty will look for EC_USER environment variable)

docs/ecctl_auth_key.md

@@ -23,14 +23,13 @@ ecctl auth key [flags]
       --config string      Config name, used to have multiple configs in $HOME/.ecctl/<env> (default "config")
       --force              Do not ask for confirmation
       --format string      Formats the output using a Go template
-      --host string        Base URL to use (default "https://api.elastic-cloud.com")
+      --host string        Base URL to use
       --insecure           Skips all TLS validation
       --message string     A message to set on cluster operation
       --output string      Output format [text|json] (default "text")
       --pass string        Password to use to authenticate (If empty will look for EC_PASS environment variable)
       --pprof              Enables pprofing and saves the profile to pprof-20060102150405
   -q, --quiet              Suppresses the configuration file used for the run, if any
-      --region string      Elastic Cloud region
       --timeout duration   Timeout to use on all HTTP calls (default 30s)
       --trace              Enables tracing saves the trace to trace-20060102150405
       --user string        Username to use to authenticate (If empty will look for EC_USER environment variable)