PublicDashboards: Add setting to disable the feature (grafana#78894)

* Replace feature toggle with configuration setting

* Fix permission alert

* Update documentation

* Add back feature toggle

* revert unwanted commited changes

* fix tests

* run prettier

* Update SharePublicDashboard.test.tsx

* fix linter and frontend tests

* Update api.go

* Apply docs edit from code review

Co-authored-by: Isabel <[email protected]>

* Update index.md

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

Co-authored-by: Agnès Toulet <[email protected]>

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Agnès Toulet <[email protected]>

* add isPublicDashboardsEnabled + test

* fix test

* update ff description in registry

* move isPublicDashboardsEnabled

* revert getConfig() update

---------

Co-authored-by: Isabel <[email protected]>
Co-authored-by: Christopher Moyer <[email protected]>

Author: 3 people

conf/defaults.ini

@@ -1762,3 +1762,8 @@ hidden_toggles =
 
 # Disables updating specific feature toggles in the feature management page
 read_only_toggles =
+
+#################################### Public Dashboards #####################################
+[public_dashboards]
+# Set to false to disable public dashboards
+enabled = true

conf/sample.ini

@@ -1615,3 +1615,9 @@
 ;hidden_toggles =
 # Disable updating specific feature toggles in the feature management page
 ;read_only_toggles =
+
+#################################### Public Dashboards #####################################
+[public_dashboards]
+# Set to false to disable public dashboards
+;enabled = true
+

docs/sources/dashboards/assess-dashboard-usage/index.md

@@ -62,7 +62,7 @@ Dashboard insights show the following information:
 
 {{% admonition type="note" %}}
 
-If you've enabled the `publicDashboards` feature toggle, you'll also see a Public dashboards tab in your analytics.
+If public dashboards are [enabled]({{< relref "../../setup-grafana/configure-grafana/#public_dashboards" >}}), you'll also see a **Public dashboards** tab in your analytics.
 
 {{% /admonition %}}
 

docs/sources/setup-grafana/configure-grafana/_index.md

@@ -2538,3 +2538,11 @@ Move an app plugin (referenced by its id), including all its pages, to a specifi
 
 Move an individual app plugin page (referenced by its `path` field) to a specific navigation section.
 Format: `<pageUrl> = <sectionId> <sortWeight>`
+
+## [public_dashboards]
+
+This section configures the [public dashboards]({{< relref "../../dashboards/dashboard-public" >}}) feature.
+
+### enabled
+
+Set this to `false` to disable the public dashboards feature. This prevents users from creating new public dashboards and disables existing ones.

docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

@@ -22,7 +22,7 @@ Some features are enabled by default. You can disable these feature by setting t
 | Feature toggle name                  | Description                                                                                                                                                                                                                  | Enabled by default |
 | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
 | `disableEnvelopeEncryption`          | Disable envelope encryption (emergency only)                                                                                                                                                                                 |                    |
-| `publicDashboards`                   | Enables public access to dashboards                                                                                                                                                                                          | Yes                |
+| `publicDashboards`                   | [Deprecated] Public dashboards are now enabled by default; to disable them, use the configuration setting. This feature toggle will be removed in the next major version.                                                    | Yes                |
 | `featureHighlights`                  | Highlight Grafana Enterprise features                                                                                                                                                                                        |                    |
 | `exploreContentOutline`              | Content outline sidebar                                                                                                                                                                                                      | Yes                |
 | `newVizTooltips`                     | New visualizations tooltips UX                                                                                                                                                                                               |                    |

docs/sources/setup-grafana/installation/docker/index.md

@@ -117,10 +117,10 @@ docker run -d -p 3000:3000 --name=grafana \
 Grafana supports specifying custom configuration settings using [environment variables]({{< relref "../../../setup-grafana/configure-grafana#override-configuration-with-environment-variables" >}}).
 
 ```bash
-# enabling public dashboard feature
+# enable debug logs
 
 docker run -d -p 3000:3000 --name=grafana \
-  -e "GF_FEATURE_TOGGLES_ENABLE=publicDashboards" \
+  -e "GF_LOG_LEVEL=debug" \
   grafana/grafana-enterprise
 ```
 

packages/grafana-data/src/types/config.ts

@@ -148,6 +148,7 @@ export interface BootData {
  */
 export interface GrafanaConfig {
   publicDashboardAccessToken?: string;
+  publicDashboardsEnabled: boolean;
   snapshotEnabled: boolean;
   datasources: { [str: string]: DataSourceInstanceSettings };
   panels: { [key: string]: PanelPluginMeta };

packages/grafana-runtime/src/config.ts

@@ -36,6 +36,7 @@ export type AppPluginConfig = {
 
 export class GrafanaBootConfig implements GrafanaConfig {
   publicDashboardAccessToken?: string;
+  publicDashboardsEnabled = true;
   snapshotEnabled = true;
   datasources: { [str: string]: DataSourceInstanceSettings } = {};
   panels: { [key: string]: PanelPluginMeta } = {};

pkg/api/api.go

@@ -161,7 +161,7 @@ func (hs *HTTPServer) registerRoutes() {
 		r.Get("/d-embed", reqSignedIn, middleware.AddAllowEmbeddingHeader(), hs.Index)
 	}
 
-	if hs.Features.IsEnabledGlobally(featuremgmt.FlagPublicDashboards) {
+	if hs.Features.IsEnabledGlobally(featuremgmt.FlagPublicDashboards) && hs.Cfg.PublicDashboardsEnabled {
 		// list public dashboards
 		r.Get("/public-dashboards/list", reqSignedIn, hs.Index)
 

pkg/api/dashboard.go

@@ -90,9 +90,8 @@ func (hs *HTTPServer) GetDashboard(c *contextmodel.ReqContext) response.Response
 		err                    error
 	)
 
-	// If public dashboards is enabled and we have a public dashboard, update meta
-	// values
-	if hs.Features.IsEnabledGlobally(featuremgmt.FlagPublicDashboards) {
+	// If public dashboards is enabled and we have a public dashboard, update meta values
+	if hs.Features.IsEnabledGlobally(featuremgmt.FlagPublicDashboards) && hs.Cfg.PublicDashboardsEnabled {
 		publicDashboard, err := hs.PublicDashboardsApi.PublicDashboardService.FindByDashboardUid(c.Req.Context(), c.SignedInUser.GetOrgID(), dash.UID)
 		if err != nil && !errors.Is(err, publicdashboardModels.ErrPublicDashboardNotFound) {
 			return response.Error(http.StatusInternalServerError, "Error while retrieving public dashboards", err)