docs: Change the term Kibana Cluster to instance (#49)

Kibana can have multiple instances but they do not form a cluster. Changed the documentation to refer them as Kibana Instances Signed-off-by: Marc Lopez <[email protected]>
elastic · Nov 15, 2019 · a4eb0ac · a4eb0ac
1 parent 78dd825
commit a4eb0ac
Show file tree

Hide file tree

Showing 35 changed files with 74 additions and 74 deletions.
diff --git a/cmd/deployment/kibana/command.go b/cmd/deployment/kibana/command.go
@@ -26,7 +26,7 @@ import (
 // Command represents the top level kibana command.
 var Command = &cobra.Command{
 	Use:     "kibana",
-	Short:   "Manages Kibana clusters",
+	Short:   "Manages Kibana instances",
 	PreRunE: cobra.MaximumNArgs(0),
 	Run:     func(cmd *cobra.Command, args []string) { cmd.Help() },
 }

diff --git a/cmd/deployment/kibana/create.go b/cmd/deployment/kibana/create.go
@@ -34,7 +34,7 @@ import (
 
 var createKibanaCmd = &cobra.Command{
 	Use:   "create -f <definition.json>",
-	Short: "Creates a Kibana Cluster",
+	Short: "Creates a Kibana instance",
 
 	PreRunE: cobra.MaximumNArgs(0),
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -95,7 +95,7 @@ func parseKibanaDefinitionFile(fp string) (models.CreateKibanaRequest, error) {
 
 func init() {
 	createKibanaCmd.Flags().BoolP("track", "t", false, cmdutil.TrackFlagMessage)
-	createKibanaCmd.Flags().StringP("file-template", "f", "", "JSON file that contains the Kibana cluster definition")
+	createKibanaCmd.Flags().StringP("file-template", "f", "", "JSON file that contains the Kibana instance definition")
 	createKibanaCmd.Flags().String("id", "", "Optional ID to set for the Elasticsearch cluster (Overrides ID if present).")
-	createKibanaCmd.Flags().String("name", "", "Optional name to set for the Kibana cluster (Overrides name if present).")
+	createKibanaCmd.Flags().String("name", "", "Optional name to set for the Kibana instance (Overrides name if present).")
 }
diff --git a/cmd/deployment/kibana/delete.go b/cmd/deployment/kibana/delete.go
@@ -28,7 +28,7 @@ import (
 
 var deleteKibanaCmd = &cobra.Command{
 	Use:     "delete <cluster id>",
-	Short:   "Deletes a Kibana cluster",
+	Short:   "Deletes a Kibana instance",
 	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
 
 	RunE: func(cmd *cobra.Command, args []string) error {

diff --git a/cmd/deployment/kibana/list.go b/cmd/deployment/kibana/list.go
@@ -29,7 +29,7 @@ import (
 
 var kibanaListCmd = &cobra.Command{
 	Use:     "list",
-	Short:   "Returns the list of clusters for a region",
+	Short:   "Returns the list of kibana instances",
 	PreRunE: cobra.MaximumNArgs(0),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		size, _ := cmd.Flags().GetInt64("size")
@@ -53,6 +53,6 @@ var kibanaListCmd = &cobra.Command{
 
 func init() {
 	kibanaListCmd.Flags().BoolP("metadata", "m", false, "Shows deployment metadata")
-	kibanaListCmd.Flags().Int64P("size", "s", 100, "Sets the upper limit of Kibana clusters to return")
+	kibanaListCmd.Flags().Int64P("size", "s", 100, "Sets the upper limit of Kibana instances to return")
 	kibanaListCmd.Flags().StringP("version", "v", "", "Filters per version")
 }
diff --git a/cmd/deployment/kibana/reallocate.go b/cmd/deployment/kibana/reallocate.go
@@ -27,8 +27,8 @@ import (
 
 var reallocateKibanaClusterCmd = &cobra.Command{
 	Use:     "reallocate <cluster id>",
-	Short:   "Reallocates the Kibana cluster nodes",
-	Long:    "Reallocates the Kibana cluster nodes. If no \"--instances\" are specified all of the nodes will be restarted",
+	Short:   "Reallocates Kibana instances",
+	Long:    "Reallocates Kibana instances. If no \"--instances\" are specified all of the nodes will be restarted",
 	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		instances, _ := cmd.Flags().GetStringSlice("instances")

diff --git a/cmd/deployment/kibana/restart.go b/cmd/deployment/kibana/restart.go
@@ -28,7 +28,7 @@ import (
 
 var restartKibanaCmd = &cobra.Command{
 	Use:     "restart <cluster id>",
-	Short:   "Restarts a Kibana cluster",
+	Short:   "Restarts a Kibana instance",
 	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		track, _ := cmd.Flags().GetBool("track")

diff --git a/cmd/deployment/kibana/resync.go b/cmd/deployment/kibana/resync.go
@@ -29,10 +29,10 @@ import (
 
 var resyncKibanaCmd = &cobra.Command{
 	Use:     "resync <cluster id>",
-	Short:   "Resynchronizes the search index and cache for the selected Kibana cluster",
+	Short:   "Resynchronizes the search index and cache for the selected Kibana instance",
 	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
-		fmt.Printf("Resynchronizing Kibana cluster: %s\n", args[0])
+		fmt.Printf("Resynchronizing Kibana instance: %s\n", args[0])
 		return kibana.Resync(kibana.DeploymentParams{
 			API: ecctl.Get().API,
 			ID:  args[0],

diff --git a/cmd/deployment/kibana/start.go b/cmd/deployment/kibana/start.go
@@ -31,7 +31,7 @@ import (
 
 var startKibanaCmd = &cobra.Command{
 	Use:     "start <cluster id>",
-	Short:   "Starts a Kibana cluster",
+	Short:   "Starts a Kibana instance",
 	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		c, err := kibana.Get(kibana.ClusterParams{

diff --git a/cmd/deployment/kibana/stop.go b/cmd/deployment/kibana/stop.go
@@ -28,7 +28,7 @@ import (
 
 var stopKibanaCmd = &cobra.Command{
 	Use:     "stop <cluster id>",
-	Short:   "Downscales a Kibana cluster, so that it no longer contains any running instances.",
+	Short:   "Downscales a Kibana instance",
 	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		track, _ := cmd.Flags().GetBool("track")

diff --git a/cmd/deployment/kibana/upgrade.go b/cmd/deployment/kibana/upgrade.go
@@ -28,7 +28,7 @@ import (
 
 var upgradeKibanaCmd = &cobra.Command{
 	Use:     "upgrade <cluster id>>",
-	Short:   "Upgrades the Kibana cluster to the same version as the Elasticsearch one",
+	Short:   "Upgrades the Kibana instance to the same version as the Elasticsearch one",
 	PreRunE: cmdutil.MinimumNArgsAndUUID(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		track, _ := cmd.Flags().GetBool("track")

diff --git a/docs/ecctl_deployment.md b/docs/ecctl_deployment.md
@@ -44,7 +44,7 @@ ecctl deployment [flags]
 * [ecctl deployment create](ecctl_deployment_create.md)	 - Creates a deployment from a file definition, allowing certain flag overrides
 * [ecctl deployment delete](ecctl_deployment_delete.md)	 - Deletes a previously stopped deployment from the platform
 * [ecctl deployment elasticsearch](ecctl_deployment_elasticsearch.md)	 - Manages Elasticsearch clusters
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 * [ecctl deployment list](ecctl_deployment_list.md)	 - Lists the platform's deployments
 * [ecctl deployment note](ecctl_deployment_note.md)	 - Manages a deployment's notes
 * [ecctl deployment restore](ecctl_deployment_restore.md)	 - Restores a previously shut down deployment and all of its associated sub-resources

diff --git a/docs/ecctl_deployment_kibana.md b/docs/ecctl_deployment_kibana.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana
 
-Manages Kibana clusters
+Manages Kibana instances
 
 ### Synopsis
 
-Manages Kibana clusters
+Manages Kibana instances
 
 ```
 ecctl deployment kibana [flags]
@@ -40,16 +40,16 @@ ecctl deployment kibana [flags]
 ### SEE ALSO
 
 * [ecctl deployment](ecctl_deployment.md)	 - Manages deployments
-* [ecctl deployment kibana create](ecctl_deployment_kibana_create.md)	 - Creates a Kibana Cluster
-* [ecctl deployment kibana delete](ecctl_deployment_kibana_delete.md)	 - Deletes a Kibana cluster
+* [ecctl deployment kibana create](ecctl_deployment_kibana_create.md)	 - Creates a Kibana instance
+* [ecctl deployment kibana delete](ecctl_deployment_kibana_delete.md)	 - Deletes a Kibana instance
 * [ecctl deployment kibana enable](ecctl_deployment_kibana_enable.md)	 - Enables a kibana instance in the selected deployment
-* [ecctl deployment kibana list](ecctl_deployment_kibana_list.md)	 - Returns the list of clusters for a region
+* [ecctl deployment kibana list](ecctl_deployment_kibana_list.md)	 - Returns the list of kibana instances
 * [ecctl deployment kibana plan](ecctl_deployment_kibana_plan.md)	 - Manages Kibana plans
-* [ecctl deployment kibana reallocate](ecctl_deployment_kibana_reallocate.md)	 - Reallocates the Kibana cluster nodes
-* [ecctl deployment kibana restart](ecctl_deployment_kibana_restart.md)	 - Restarts a Kibana cluster
-* [ecctl deployment kibana resync](ecctl_deployment_kibana_resync.md)	 - Resynchronizes the search index and cache for the selected Kibana cluster
+* [ecctl deployment kibana reallocate](ecctl_deployment_kibana_reallocate.md)	 - Reallocates Kibana instances
+* [ecctl deployment kibana restart](ecctl_deployment_kibana_restart.md)	 - Restarts a Kibana instance
+* [ecctl deployment kibana resync](ecctl_deployment_kibana_resync.md)	 - Resynchronizes the search index and cache for the selected Kibana instance
 * [ecctl deployment kibana show](ecctl_deployment_kibana_show.md)	 - Returns the cluster information
-* [ecctl deployment kibana start](ecctl_deployment_kibana_start.md)	 - Starts a Kibana cluster
-* [ecctl deployment kibana stop](ecctl_deployment_kibana_stop.md)	 - Downscales a Kibana cluster, so that it no longer contains any running instances.
-* [ecctl deployment kibana upgrade](ecctl_deployment_kibana_upgrade.md)	 - Upgrades the Kibana cluster to the same version as the Elasticsearch one
+* [ecctl deployment kibana start](ecctl_deployment_kibana_start.md)	 - Starts a Kibana instance
+* [ecctl deployment kibana stop](ecctl_deployment_kibana_stop.md)	 - Downscales a Kibana instance
+* [ecctl deployment kibana upgrade](ecctl_deployment_kibana_upgrade.md)	 - Upgrades the Kibana instance to the same version as the Elasticsearch one
 
diff --git a/docs/ecctl_deployment_kibana_create.md b/docs/ecctl_deployment_kibana_create.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana create
 
-Creates a Kibana Cluster
+Creates a Kibana instance
 
 ### Synopsis
 
-Creates a Kibana Cluster
+Creates a Kibana instance
 
 ```
 ecctl deployment kibana create -f <definition.json> [flags]
@@ -13,10 +13,10 @@ ecctl deployment kibana create -f <definition.json> [flags]
 ### Options
 
 ```
-  -f, --file-template string   JSON file that contains the Kibana cluster definition
+  -f, --file-template string   JSON file that contains the Kibana instance definition
   -h, --help                   help for create
       --id string              Optional ID to set for the Elasticsearch cluster (Overrides ID if present).
-      --name string            Optional name to set for the Kibana cluster (Overrides name if present).
+      --name string            Optional name to set for the Kibana instance (Overrides name if present).
   -t, --track                  Tracks the progress of the performed task
 ```
 
@@ -43,5 +43,5 @@ ecctl deployment kibana create -f <definition.json> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_delete.md b/docs/ecctl_deployment_kibana_delete.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana delete
 
-Deletes a Kibana cluster
+Deletes a Kibana instance
 
 ### Synopsis
 
-Deletes a Kibana cluster
+Deletes a Kibana instance
 
 ```
 ecctl deployment kibana delete <cluster id> [flags]
@@ -41,5 +41,5 @@ ecctl deployment kibana delete <cluster id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_enable.md b/docs/ecctl_deployment_kibana_enable.md
@@ -40,5 +40,5 @@ ecctl deployment kibana enable <deployment id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_list.md b/docs/ecctl_deployment_kibana_list.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana list
 
-Returns the list of clusters for a region
+Returns the list of kibana instances
 
 ### Synopsis
 
-Returns the list of clusters for a region
+Returns the list of kibana instances
 
 ```
 ecctl deployment kibana list [flags]
@@ -15,7 +15,7 @@ ecctl deployment kibana list [flags]
 ```
   -h, --help             help for list
   -m, --metadata         Shows deployment metadata
-  -s, --size int         Sets the upper limit of Kibana clusters to return (default 100)
+  -s, --size int         Sets the upper limit of Kibana instances to return (default 100)
   -v, --version string   Filters per version
 ```
 
@@ -42,5 +42,5 @@ ecctl deployment kibana list [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_plan.md b/docs/ecctl_deployment_kibana_plan.md
@@ -39,6 +39,6 @@ ecctl deployment kibana plan [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 * [ecctl deployment kibana plan monitor](ecctl_deployment_kibana_plan_monitor.md)	 - Monitors the pending plan
 
diff --git a/docs/ecctl_deployment_kibana_reallocate.md b/docs/ecctl_deployment_kibana_reallocate.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana reallocate
 
-Reallocates the Kibana cluster nodes
+Reallocates Kibana instances
 
 ### Synopsis
 
-Reallocates the Kibana cluster nodes. If no "--instances" are specified all of the nodes will be restarted
+Reallocates Kibana instances. If no "--instances" are specified all of the nodes will be restarted
 
 ```
 ecctl deployment kibana reallocate <cluster id> [flags]
@@ -40,5 +40,5 @@ ecctl deployment kibana reallocate <cluster id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_restart.md b/docs/ecctl_deployment_kibana_restart.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana restart
 
-Restarts a Kibana cluster
+Restarts a Kibana instance
 
 ### Synopsis
 
-Restarts a Kibana cluster
+Restarts a Kibana instance
 
 ```
 ecctl deployment kibana restart <cluster id> [flags]
@@ -40,5 +40,5 @@ ecctl deployment kibana restart <cluster id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_resync.md b/docs/ecctl_deployment_kibana_resync.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana resync
 
-Resynchronizes the search index and cache for the selected Kibana cluster
+Resynchronizes the search index and cache for the selected Kibana instance
 
 ### Synopsis
 
-Resynchronizes the search index and cache for the selected Kibana cluster
+Resynchronizes the search index and cache for the selected Kibana instance
 
 ```
 ecctl deployment kibana resync <cluster id> [flags]
@@ -39,5 +39,5 @@ ecctl deployment kibana resync <cluster id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_show.md b/docs/ecctl_deployment_kibana_show.md
@@ -44,5 +44,5 @@ ecctl deployment kibana show <cluster id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_start.md b/docs/ecctl_deployment_kibana_start.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana start
 
-Starts a Kibana cluster
+Starts a Kibana instance
 
 ### Synopsis
 
-Starts a Kibana cluster
+Starts a Kibana instance
 
 ```
 ecctl deployment kibana start <cluster id> [flags]
@@ -40,5 +40,5 @@ ecctl deployment kibana start <cluster id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_stop.md b/docs/ecctl_deployment_kibana_stop.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana stop
 
-Downscales a Kibana cluster, so that it no longer contains any running instances.
+Downscales a Kibana instance
 
 ### Synopsis
 
-Downscales a Kibana cluster, so that it no longer contains any running instances.
+Downscales a Kibana instance
 
 ```
 ecctl deployment kibana stop <cluster id> [flags]
@@ -40,5 +40,5 @@ ecctl deployment kibana stop <cluster id> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
 
diff --git a/docs/ecctl_deployment_kibana_upgrade.md b/docs/ecctl_deployment_kibana_upgrade.md
@@ -1,10 +1,10 @@
 ## ecctl deployment kibana upgrade
 
-Upgrades the Kibana cluster to the same version as the Elasticsearch one
+Upgrades the Kibana instance to the same version as the Elasticsearch one
 
 ### Synopsis
 
-Upgrades the Kibana cluster to the same version as the Elasticsearch one
+Upgrades the Kibana instance to the same version as the Elasticsearch one
 
 ```
 ecctl deployment kibana upgrade <cluster id>> [flags]
@@ -40,5 +40,5 @@ ecctl deployment kibana upgrade <cluster id>> [flags]
 
 ### SEE ALSO
 
-* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana clusters
+* [ecctl deployment kibana](ecctl_deployment_kibana.md)	 - Manages Kibana instances
Original file line number	Diff line number	Diff line change
Expand Up		@@ -40,5 +40,5 @@ ecctl deployment kibana enable <deployment id> [flags]

		### SEE ALSO

		* [ecctl deployment kibana](ecctl_deployment_kibana.md) - Manages Kibana clusters
		* [ecctl deployment kibana](ecctl_deployment_kibana.md) - Manages Kibana instances
Original file line number	Diff line number	Diff line change
Expand Up		@@ -44,5 +44,5 @@ ecctl deployment kibana show <cluster id> [flags]

		### SEE ALSO

		* [ecctl deployment kibana](ecctl_deployment_kibana.md) - Manages Kibana clusters
		* [ecctl deployment kibana](ecctl_deployment_kibana.md) - Manages Kibana instances