Update docs

cmd/dr/create_dr.go

@@ -118,6 +118,6 @@ func init() {
 	createDrCmd.MarkFlagRequired("source-cluster-name")
 	createDrCmd.Flags().String("target-cluster-name", "", "[REQUIRED] Target cluster in the DR configuration.")
 	createDrCmd.MarkFlagRequired("target-cluster-name")
-	createDrCmd.Flags().StringArray("databases", []string{}, "[REQUIRED] Databases to be replicated.")
+	createDrCmd.Flags().StringArray("databases", []string{}, "[REQUIRED] Databases to be replicated. Please provide a comma separated list of database names <db-name-1>,<db-name-2>.")
 	createDrCmd.MarkFlagRequired("databases")
 }

cmd/dr/delete_dr.go

@@ -81,7 +81,7 @@ var deleteDrCmd = &cobra.Command{
 
 func init() {
 	DrCmd.AddCommand(deleteDrCmd)
-	deleteDrCmd.Flags().String("dr-name", "", "[REQUIRED] Name of the DR")
+	deleteDrCmd.Flags().String("dr-name", "", "[REQUIRED] Name of the DR configuration")
 	deleteDrCmd.MarkFlagRequired("dr-name")
 
 }

cmd/dr/describe_dr.go

@@ -43,7 +43,7 @@ var describeDrCmd = &cobra.Command{
 		}
 		drId, clusterId, err := authApi.GetDrDetailsByName(drName)
 		if err != nil {
-			logrus.Fatalf("Could not get DR data: %s", ybmAuthClient.GetApiErrorDetails(err))
+			logrus.Fatal(err)
 		}
 		drResp, r, err := authApi.GetXClusterDr(clusterId, drId).Execute()
 		if err != nil {
@@ -62,6 +62,6 @@ var describeDrCmd = &cobra.Command{
 
 func init() {
 	DrCmd.AddCommand(describeDrCmd)
-	describeDrCmd.Flags().String("dr-name", "", "[REQUIRED] Name of the DR.")
+	describeDrCmd.Flags().String("dr-name", "", "[REQUIRED] Name of the DR configuration.")
 	describeDrCmd.MarkFlagRequired("dr-name")
 }

cmd/dr/restart_dr.go

@@ -77,7 +77,7 @@ var restartDrCmd = &cobra.Command{
 			logrus.Fatalf(ybmAuthClient.GetApiErrorDetails(err))
 		}
 
-		msg := fmt.Sprintf("DR config %s is being restartd", formatter.Colorize(drName, formatter.GREEN_COLOR))
+		msg := fmt.Sprintf("DR config %s is being restarted", formatter.Colorize(drName, formatter.GREEN_COLOR))
 
 		if viper.GetBool("wait") {
 			returnStatus, err := authApi.WaitForTaskCompletion(clusterId, ybmclient.ENTITYTYPEENUM_CLUSTER, ybmclient.TASKTYPEENUM_DR_RESTART, []string{"FAILED", "SUCCEEDED"}, msg)
@@ -87,7 +87,7 @@ var restartDrCmd = &cobra.Command{
 			if returnStatus != "SUCCEEDED" {
 				logrus.Fatalf("Operation failed with error: %s", returnStatus)
 			}
-			fmt.Printf("DR config %s is restartd successfully\n", formatter.Colorize(drName, formatter.GREEN_COLOR))
+			fmt.Printf("DR config %s is restarted successfully\n", formatter.Colorize(drName, formatter.GREEN_COLOR))
 
 			drGetResp, r, err := authApi.GetXClusterDr(clusterId, drId).Execute()
 			if err != nil {
@@ -111,5 +111,5 @@ func init() {
 	DrCmd.AddCommand(restartDrCmd)
 	restartDrCmd.Flags().String("dr-name", "", "[REQUIRED] Name of the DR configuration.")
 	restartDrCmd.MarkFlagRequired("dr-name")
-	restartDrCmd.Flags().StringArray("databases", []string{}, "[OPTIONAL] Databases to be restarted.")
+	restartDrCmd.Flags().StringArray("databases", []string{}, "[OPTIONAL] Databases to be restarted. Please provide a comma separated list of database names <db-name-1>,<db-name-2>.")
 }

cmd/dr/update_dr.go

@@ -111,6 +111,6 @@ func init() {
 	DrCmd.AddCommand(updateDrCmd)
 	updateDrCmd.Flags().String("dr-name", "", "[REQUIRED] Name of the DR configuration.")
 	updateDrCmd.MarkFlagRequired("dr-name")
-	updateDrCmd.Flags().StringArray("databases", []string{}, "[REQUIRED] Databases to be replicated.")
+	updateDrCmd.Flags().StringArray("databases", []string{}, "[REQUIRED] Databases to be replicated. Please provide a comma separated list of database names <db-name-1>,<db-name-2>.")
 	updateDrCmd.MarkFlagRequired("databases")
 }

docs/ybm.md

@@ -31,6 +31,7 @@ ybm [flags]
 * [ybm backup](ybm_backup.md)	 - Manage backup operations of a cluster
 * [ybm cluster](ybm_cluster.md)	 - Manage cluster operations
 * [ybm completion](ybm_completion.md)	 - Generate the autocompletion script for the specified shell
+* [ybm dr](ybm_dr.md)	 - Manage DR for a cluster.
 * [ybm integration](ybm_integration.md)	 - Manage Integration
 * [ybm metrics-exporter](ybm_metrics-exporter.md)	 - Manage Metrics Exporter
 * [ybm network-allow-list](ybm_network-allow-list.md)	 - Manage Network Allow Lists

docs/ybm_cluster_db-query-logging.md

@@ -23,7 +23,6 @@ ybm cluster db-query-logging [flags]
   -a, --apiKey string      YugabyteDB Aeon account API key
       --config string      config file (default is $HOME/.ybm-cli.yaml)
       --debug              Use debug mode, same as --logLevel debug
-      --host string        YugabyteDB Aeon Api hostname
   -l, --logLevel string    Select the desired log level format(info). Default to info
       --no-color           Disable colors in output , default to false
   -o, --output string      Select the desired output format (table, json, pretty). Default to table

docs/ybm_cluster_db-query-logging_describe.md

@@ -23,7 +23,6 @@ ybm cluster db-query-logging describe [flags]
   -c, --cluster-name string   [REQUIRED] The name of the cluster.
       --config string         config file (default is $HOME/.ybm-cli.yaml)
       --debug                 Use debug mode, same as --logLevel debug
-      --host string           YugabyteDB Aeon Api hostname
   -l, --logLevel string       Select the desired log level format(info). Default to info
       --no-color              Disable colors in output , default to false
   -o, --output string         Select the desired output format (table, json, pretty). Default to table

docs/ybm_cluster_db-query-logging_disable.md

@@ -24,7 +24,6 @@ ybm cluster db-query-logging disable [flags]
   -c, --cluster-name string   [REQUIRED] The name of the cluster.
       --config string         config file (default is $HOME/.ybm-cli.yaml)
       --debug                 Use debug mode, same as --logLevel debug
-      --host string           YugabyteDB Aeon Api hostname
   -l, --logLevel string       Select the desired log level format(info). Default to info
       --no-color              Disable colors in output , default to false
   -o, --output string         Select the desired output format (table, json, pretty). Default to table

docs/ybm_cluster_db-query-logging_enable.md

@@ -33,7 +33,6 @@ ybm cluster db-query-logging enable [flags]
   -c, --cluster-name string   [REQUIRED] The name of the cluster.
       --config string         config file (default is $HOME/.ybm-cli.yaml)
       --debug                 Use debug mode, same as --logLevel debug
-      --host string           YugabyteDB Aeon Api hostname
   -l, --logLevel string       Select the desired log level format(info). Default to info
       --no-color              Disable colors in output , default to false
   -o, --output string         Select the desired output format (table, json, pretty). Default to table

docs/ybm_cluster_db-query-logging_update.md

@@ -33,7 +33,6 @@ ybm cluster db-query-logging update [flags]
   -c, --cluster-name string   [REQUIRED] The name of the cluster.
       --config string         config file (default is $HOME/.ybm-cli.yaml)
       --debug                 Use debug mode, same as --logLevel debug
-      --host string           YugabyteDB Aeon Api hostname
   -l, --logLevel string       Select the desired log level format(info). Default to info
       --no-color              Disable colors in output , default to false
   -o, --output string         Select the desired output format (table, json, pretty). Default to table

docs/ybm_dr.md

@@ -0,0 +1,45 @@
+## ybm dr
+
+Manage DR for a cluster.
+
+### Synopsis
+
+Manage DR for a cluster.
+
+```
+ybm dr [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for dr
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm](ybm.md)	 - ybm - Effortlessly manage your DB infrastructure on YugabyteDB Aeon (DBaaS) from command line!
+* [ybm dr create](ybm_dr_create.md)	 - Create DR for a cluster
+* [ybm dr delete](ybm_dr_delete.md)	 - Delete DR
+* [ybm dr describe](ybm_dr_describe.md)	 - Describe DR
+* [ybm dr failover](ybm_dr_failover.md)	 - Failover DR for a cluster
+* [ybm dr list](ybm_dr_list.md)	 - List DRs for a given cluster
+* [ybm dr pause](ybm_dr_pause.md)	 - Pause DR for a cluster
+* [ybm dr restart](ybm_dr_restart.md)	 - Restart DR for a cluster
+* [ybm dr resume](ybm_dr_resume.md)	 - Resume DR for a cluster
+* [ybm dr switchover](ybm_dr_switchover.md)	 - Switchover DR for a cluster
+* [ybm dr update](ybm_dr_update.md)	 - Update DR for a cluster
+

docs/ybm_dr_create.md

@@ -0,0 +1,39 @@
+## ybm dr create
+
+Create DR for a cluster
+
+### Synopsis
+
+Create DR for a cluster
+
+```
+ybm dr create [flags]
+```
+
+### Options
+
+```
+      --databases stringArray        [REQUIRED] Databases to be replicated. Please provide a comma separated list of database names <db-name-1>,<db-name-2>.
+      --dr-name string               [REQUIRED] Name of the DR configuration.
+  -h, --help                         help for create
+      --source-cluster-name string   [REQUIRED] Source cluster in the DR configuration.
+      --target-cluster-name string   [REQUIRED] Target cluster in the DR configuration.
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm dr](ybm_dr.md)	 - Manage DR for a cluster.
+

docs/ybm_dr_delete.md

@@ -0,0 +1,36 @@
+## ybm dr delete
+
+Delete DR
+
+### Synopsis
+
+Delete DR
+
+```
+ybm dr delete [flags]
+```
+
+### Options
+
+```
+      --dr-name string   [REQUIRED] Name of the DR configuration
+  -h, --help             help for delete
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm dr](ybm_dr.md)	 - Manage DR for a cluster.
+

docs/ybm_dr_describe.md

@@ -0,0 +1,36 @@
+## ybm dr describe
+
+Describe DR
+
+### Synopsis
+
+Describe DR
+
+```
+ybm dr describe [flags]
+```
+
+### Options
+
+```
+      --dr-name string   [REQUIRED] Name of the DR configuration.
+  -h, --help             help for describe
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm dr](ybm_dr.md)	 - Manage DR for a cluster.
+

docs/ybm_dr_failover.md

@@ -0,0 +1,37 @@
+## ybm dr failover
+
+Failover DR for a cluster
+
+### Synopsis
+
+Failover DR for a cluster
+
+```
+ybm dr failover [flags]
+```
+
+### Options
+
+```
+      --dr-name string          [REQUIRED] Name of the DR configuration.
+  -h, --help                    help for failover
+      --safetimes stringArray   [OPTIONAL] Safetimes of the DR configuation.  Please provide key value pairs <db-name-1>=<epoch-safe-time>,<db-name-2>=<epoch-safe-time>.
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm dr](ybm_dr.md)	 - Manage DR for a cluster.
+

docs/ybm_dr_list.md

@@ -0,0 +1,35 @@
+## ybm dr list
+
+List DRs for a given cluster
+
+### Synopsis
+
+List DRs for a given cluster
+
+```
+ybm dr list [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for list
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm dr](ybm_dr.md)	 - Manage DR for a cluster.
+

docs/ybm_dr_pause.md

@@ -0,0 +1,37 @@
+## ybm dr pause
+
+Pause DR for a cluster
+
+### Synopsis
+
+Pause DR for a cluster
+
+```
+ybm dr pause [flags]
+```
+
+### Options
+
+```
+      --dr-name string   [REQUIRED] Name of the DR configuration.
+      --duration int32   [OPTIONAL] Duration in minutes. (default 60)
+  -h, --help             help for pause
+```
+
+### Options inherited from parent commands
+
+```
+  -a, --apiKey string      YugabyteDB Aeon account API key
+      --config string      config file (default is $HOME/.ybm-cli.yaml)
+      --debug              Use debug mode, same as --logLevel debug
+  -l, --logLevel string    Select the desired log level format(info). Default to info
+      --no-color           Disable colors in output , default to false
+  -o, --output string      Select the desired output format (table, json, pretty). Default to table
+      --timeout duration   Wait command timeout, example: 5m, 1h. (default 168h0m0s)
+      --wait               Wait until the task is completed, otherwise it will exit immediately, default to false
+```
+
+### SEE ALSO
+
+* [ybm dr](ybm_dr.md)	 - Manage DR for a cluster.
+