Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Remove region mentions #50

Merged
merged 3 commits into from
Nov 18, 2019
Merged

docs: Remove region mentions #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
937625f
docs: Remove reegion mentions
marclop Nov 15, 2019
eba14a1
Re-generate docs
marclop Nov 15, 2019
9fd29b8
Add MarkHidden to the list of noerr exceptions
marclop Nov 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion build/errcheck-exclusions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion cmd/deployment/elasticsearch/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions cmd/platform/allocator/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion cmd/platform/constructor/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
)
Expand Down
2 changes: 1 addition & 1 deletion cmd/platform/proxy/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
)

Expand Down
2 changes: 1 addition & 1 deletion cmd/platform/proxy/filteredgroup/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
13 changes: 8 additions & 5 deletions cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,10 @@ func Execute(v, c, o, r string) 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")
Expand All @@ -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())
}

Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_auth_key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_auth_key_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,13 @@ ecctl auth key create [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_auth_key_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ ecctl auth key delete <key id> <key id> ... [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_auth_key_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ ecctl auth key list [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_auth_key_show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ ecctl auth key show <key id> [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ ecctl deployment [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_deployment_apm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,13 @@ ecctl deployment apm [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_deployment_apm_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,13 @@ ecctl deployment apm create -f <file definition> --id <deployment id> [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_deployment_apm_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,13 @@ ecctl deployment apm delete <apm deployment id> [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)
Expand Down
3 changes: 1 addition & 2 deletions docs/ecctl_deployment_apm_enable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,13 @@ ecctl deployment apm enable <deployment id> [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)
Expand Down
Loading