Skip to content

Commit a4eb0ac

Browse files
authored
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 <marc5.12@outlook.com>
1 parent 78dd825 commit a4eb0ac

35 files changed

+74
-74
lines changed

cmd/deployment/kibana/command.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
// Command represents the top level kibana command.
2727
var Command = &cobra.Command{
2828
Use: "kibana",
29-
Short: "Manages Kibana clusters",
29+
Short: "Manages Kibana instances",
3030
PreRunE: cobra.MaximumNArgs(0),
3131
Run: func(cmd *cobra.Command, args []string) { cmd.Help() },
3232
}

cmd/deployment/kibana/create.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import (
3434

3535
var createKibanaCmd = &cobra.Command{
3636
Use: "create -f <definition.json>",
37-
Short: "Creates a Kibana Cluster",
37+
Short: "Creates a Kibana instance",
3838

3939
PreRunE: cobra.MaximumNArgs(0),
4040
RunE: func(cmd *cobra.Command, args []string) error {
@@ -95,7 +95,7 @@ func parseKibanaDefinitionFile(fp string) (models.CreateKibanaRequest, error) {
9595

9696
func init() {
9797
createKibanaCmd.Flags().BoolP("track", "t", false, cmdutil.TrackFlagMessage)
98-
createKibanaCmd.Flags().StringP("file-template", "f", "", "JSON file that contains the Kibana cluster definition")
98+
createKibanaCmd.Flags().StringP("file-template", "f", "", "JSON file that contains the Kibana instance definition")
9999
createKibanaCmd.Flags().String("id", "", "Optional ID to set for the Elasticsearch cluster (Overrides ID if present).")
100-
createKibanaCmd.Flags().String("name", "", "Optional name to set for the Kibana cluster (Overrides name if present).")
100+
createKibanaCmd.Flags().String("name", "", "Optional name to set for the Kibana instance (Overrides name if present).")
101101
}

cmd/deployment/kibana/delete.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828

2929
var deleteKibanaCmd = &cobra.Command{
3030
Use: "delete <cluster id>",
31-
Short: "Deletes a Kibana cluster",
31+
Short: "Deletes a Kibana instance",
3232
PreRunE: cmdutil.MinimumNArgsAndUUID(1),
3333

3434
RunE: func(cmd *cobra.Command, args []string) error {

cmd/deployment/kibana/list.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929

3030
var kibanaListCmd = &cobra.Command{
3131
Use: "list",
32-
Short: "Returns the list of clusters for a region",
32+
Short: "Returns the list of kibana instances",
3333
PreRunE: cobra.MaximumNArgs(0),
3434
RunE: func(cmd *cobra.Command, args []string) error {
3535
size, _ := cmd.Flags().GetInt64("size")
@@ -53,6 +53,6 @@ var kibanaListCmd = &cobra.Command{
5353

5454
func init() {
5555
kibanaListCmd.Flags().BoolP("metadata", "m", false, "Shows deployment metadata")
56-
kibanaListCmd.Flags().Int64P("size", "s", 100, "Sets the upper limit of Kibana clusters to return")
56+
kibanaListCmd.Flags().Int64P("size", "s", 100, "Sets the upper limit of Kibana instances to return")
5757
kibanaListCmd.Flags().StringP("version", "v", "", "Filters per version")
5858
}

cmd/deployment/kibana/reallocate.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ import (
2727

2828
var reallocateKibanaClusterCmd = &cobra.Command{
2929
Use: "reallocate <cluster id>",
30-
Short: "Reallocates the Kibana cluster nodes",
31-
Long: "Reallocates the Kibana cluster nodes. If no \"--instances\" are specified all of the nodes will be restarted",
30+
Short: "Reallocates Kibana instances",
31+
Long: "Reallocates Kibana instances. If no \"--instances\" are specified all of the nodes will be restarted",
3232
PreRunE: cmdutil.MinimumNArgsAndUUID(1),
3333
RunE: func(cmd *cobra.Command, args []string) error {
3434
instances, _ := cmd.Flags().GetStringSlice("instances")

cmd/deployment/kibana/restart.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828

2929
var restartKibanaCmd = &cobra.Command{
3030
Use: "restart <cluster id>",
31-
Short: "Restarts a Kibana cluster",
31+
Short: "Restarts a Kibana instance",
3232
PreRunE: cmdutil.MinimumNArgsAndUUID(1),
3333
RunE: func(cmd *cobra.Command, args []string) error {
3434
track, _ := cmd.Flags().GetBool("track")

cmd/deployment/kibana/resync.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ import (
2929

3030
var resyncKibanaCmd = &cobra.Command{
3131
Use: "resync <cluster id>",
32-
Short: "Resynchronizes the search index and cache for the selected Kibana cluster",
32+
Short: "Resynchronizes the search index and cache for the selected Kibana instance",
3333
PreRunE: cmdutil.MinimumNArgsAndUUID(1),
3434
RunE: func(cmd *cobra.Command, args []string) error {
35-
fmt.Printf("Resynchronizing Kibana cluster: %s\n", args[0])
35+
fmt.Printf("Resynchronizing Kibana instance: %s\n", args[0])
3636
return kibana.Resync(kibana.DeploymentParams{
3737
API: ecctl.Get().API,
3838
ID: args[0],

cmd/deployment/kibana/start.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import (
3131

3232
var startKibanaCmd = &cobra.Command{
3333
Use: "start <cluster id>",
34-
Short: "Starts a Kibana cluster",
34+
Short: "Starts a Kibana instance",
3535
PreRunE: cmdutil.MinimumNArgsAndUUID(1),
3636
RunE: func(cmd *cobra.Command, args []string) error {
3737
c, err := kibana.Get(kibana.ClusterParams{

cmd/deployment/kibana/stop.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828

2929
var stopKibanaCmd = &cobra.Command{
3030
Use: "stop <cluster id>",
31-
Short: "Downscales a Kibana cluster, so that it no longer contains any running instances.",
31+
Short: "Downscales a Kibana instance",
3232
PreRunE: cmdutil.MinimumNArgsAndUUID(1),
3333
RunE: func(cmd *cobra.Command, args []string) error {
3434
track, _ := cmd.Flags().GetBool("track")

cmd/deployment/kibana/upgrade.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828

2929
var upgradeKibanaCmd = &cobra.Command{
3030
Use: "upgrade <cluster id>>",
31-
Short: "Upgrades the Kibana cluster to the same version as the Elasticsearch one",
31+
Short: "Upgrades the Kibana instance to the same version as the Elasticsearch one",
3232
PreRunE: cmdutil.MinimumNArgsAndUUID(1),
3333
RunE: func(cmd *cobra.Command, args []string) error {
3434
track, _ := cmd.Flags().GetBool("track")

0 commit comments

Comments
 (0)