Add edit dashboards command

cmd/edit.go

@@ -103,20 +103,17 @@ func editDashboardsCmd(cmd *cobra.Command, args []string) error {
 		}
 	}
 
-	var updatedDashboardIDs []string
-	var errMsgs []string
+	updatedDashboardIDs := make([]string, 0, len(dashboardIDs))
+	failedDashboardUpdates := make(map[string]string, len(dashboardIDs))
 	for _, dashboardID := range dashboardIDs {
 		err = kibanaClient.SetManagedSavedObject("dashboard", dashboardID, false)
 		if err != nil {
-			errMsgs = append(errMsgs, err.Error())
+			failedDashboardUpdates[dashboardID] = err.Error()
 		} else {
 			updatedDashboardIDs = append(updatedDashboardIDs, dashboardID)
 		}
 	}
 
-	if len(errMsgs) > 0 {
-		cmd.Println(fmt.Sprintf("\nFailed to make the following dashboards editable in Kibana:\n%s", strings.Join(errMsgs, "\n")))
-	}
 	if len(updatedDashboardIDs) > 0 {
 		urls, err := dashboardURLs(*kibanaClient, updatedDashboardIDs)
 		if err != nil {
@@ -126,6 +123,18 @@ func editDashboardsCmd(cmd *cobra.Command, args []string) error {
 			cmd.Println(fmt.Sprintf("\nThe following dashboards are now editable in Kibana:%s", urls))
 		}
 	}
+
+	if len(failedDashboardUpdates) > 0 {
+		errMsgs := make([]string, 0, len(failedDashboardUpdates))
+		for _, value := range failedDashboardUpdates {
+			errMsgs = append(errMsgs, value)
+		}
+		formattedErrMsgs := strings.Join(errMsgs, "\n")
+		fmt.Println("")
+		return fmt.Errorf("failed to make one or more dashboards editable: %s", formattedErrMsgs)
+	}
+
+	fmt.Println("\nDone")
 	return nil
 }
 
@@ -138,6 +147,7 @@ func dashboardURLs(kibanaClient kibana.Client, dashboardIDs []string) (string, e
 	var urls strings.Builder
 	for _, dashboardID := range dashboardIDs {
 		dashboardURL := *kibanaURL
+		dashboardURL.Path = "app/dashboards"
 		dashboardURL.Fragment = "/view/" + dashboardID
 		fmt.Fprintf(&urls, "\n%s", dashboardURL.String())
 	}

docs/howto/create_new_package.md

@@ -41,3 +41,7 @@ _Enter the package directory. For nginx integration, it's: [packages/nginx/](htt
 3. Verify the package:
     1. Enter the package directory: `cd <new_package>`.
     2. Check package correctness: `elastic-package check`.
+
+### Edit package dashboards
+
+Once a package has been created, assets may need to be updated, e.g. make use of recently added features. Dashboards can be made editable by using the [`elastic-package edit dashboards` command](https://github.com/elastic/elastic-package/blob/main/docs/howto/make_dashboards_editable.md).

docs/howto/make_dashboards_editable.md

@@ -0,0 +1,68 @@
+# HOWTO: Make dashboards editable in Kibana
+
+## Introduction
+
+As of 8.11, managed assets, including dashboards, are read-only in Kibana. This change was introduced to prevent users from losing changes on package upgrades. Integrations authors, however, need the ability to edit assets in order to adopt new features.
+
+## Making a dashboard editable
+
+Dashboards can be made editable in Kibana by using the `elastic-package edit dashboards` command. This command can eiter be run interactively, allowing manual selection of dashboards, or be passed a comma-separated list of dashboard ids.
+
+### Using the interactive dashboard selection prompt
+
+Run the following command:
+```
+elastic-package edit dashboards
+```
+
+Use the interactive dashboard selection prompt to select the dashboard(s) that should be made editable.
+
+### Using a comma-separated list of dashboard ids
+
+Pass the list with the `-d` flag:
+```
+elastic-package edit dashboards -d 123,456,789
+```
+
+Each dashboard id will be processed and the outcome of the updates will be listed in the command's final output.
+
+### Command output
+
+The final output will provide the outcome (success or failure) of the update for each dashboard.
+
+For example, assuming the following command:
+```
+elastic-package edit dashboards -d 123,456,789
+```
+
+#### Success
+
+Assuming '123', '456' and '789' are valid dashboard ids and all three updates succeed, the output will be successful and report the URLs of the updated dashboards:
+```
+Make Kibana dashboards editable
+
+The following dashboards are now editable in Kibana:
+https://<kibanaURL>/app/dashboards#/view/123
+https://<kibanaURL>/app/dashboards#/view/456
+https://<kibanaURL>/app/dashboards#/view/789
+
+Done
+```
+
+#### Partial failure
+
+Assuming that `456` is an invalid dashboard id and that the update is successful for ids `123` and `789`, the output will report the URLs of the updated dashboards as well as an error listing the failures:
+```
+Make Kibana dashboards editable
+
+The following dashboards are now editable in Kibana:
+https://<kibanaURL>/app/dashboards#/view/123
+https://<kibanaURL>/app/dashboards#/view/789
+
+Error: failed to make one or more dashboards editable: failed to export dashboard 456: could not export saved objects; API status code = 400; response body = {"statusCode":400,"error":"Bad Request","message":"Error fetching objects to export","attributes":{"objects":[{"id":"456","type":"dashboard","error":{"statusCode":404,"error":"Not Found","message":"Saved object [dashboard/456] not found"}}]}}
+```
+
+### Optional flags
+
+* `allow-snapshot`: to allow exporting dashboards from a Elastic stack SNAPSHOT version
+* `tls-skip-verify`: to skip TLS verify