PublicDashboards: Add setting to disable the feature #78894

AgnesToulet · 2023-11-30T10:42:27Z

What is this feature?
This PR adds a setting in the configuration files to disable the public dashboards feature (enabled by default):

[public_dashboards]
enabled = true

Why do we need this feature?
We want to remove the publicDashboards feature toggle as the feature is now in GA but we should keep the possibility to disable the feature as it has security implications. We want to add this setting before remove the feature toggle to give time to users who wants to disable the feature to update their configuration file.

Who is this feature for?
Users who want do disable the public dashboards features.

Which issue(s) does this PR fix?:

Fixes #78050

Special notes for your reviewer:

Please check that:

It works as expected from a user's perspective.
If this is a pre-GA feature, it is behind a feature toggle.
The docs are updated, and if this is a notable improvement, it's added to our What's New doc.

…flag

pkg/services/publicdashboards/api/api.go

imatwawana

I made some small grammar edits and shortened the same phrase in several places. Otherwise, LGTM!

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

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

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

pkg/services/featuremgmt/registry.go

pkg/services/featuremgmt/toggles_gen.go

pkg/services/publicdashboards/api/api.go

IevaVasiljeva

LGTM from the IAM perspective and in general.

I wonder if it could be made more explicit in the docs that the feature toggle still needs to be enabled to enable public dashboards. But otherwise all looks good 👌

AgnesToulet · 2023-12-12T12:53:05Z

@IevaVasiljeva As the feature toggle is enabled by default, users don't really have to know about this. They just need to not explicitly set the feature toggle to false for the feature to work.

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

IevaVasiljeva · 2023-12-12T13:00:01Z

@IevaVasiljeva As the feature toggle is enabled by default, users don't really have to know about this. They just need to not explicitly set the feature toggle to false for the feature to work.

Thanks for clarifying, I didn't realise that the feature toggle was enabled by default. All looks good to me then :)

evictorero

LGTM! Just left a comment to think about it.
The cutoff for Grafana 11 is March 29, we should create and issue and put something in our calendar to make the changes to remove the flag.

conf/defaults.ini

pkg/services/publicdashboards/api/api.go

imatwawana

LGTM!

evictorero · 2023-12-12T14:59:07Z

We should check the enterprise code, I think we are using this flag somewhere (besides the email sharing one).

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

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

chri2547

Just two small tweaks. Thanks for the contribution!

public/app/features/admin/UserListPage.tsx

juanicabanas · 2023-12-12T16:08:02Z

public/app/features/dashboard-scene/sharing/ShareModal.tsx

@@ -61,7 +61,7 @@ export class ShareModal extends SceneObjectBase<ShareModalState> implements Moda
      }
    }

-    if (Boolean(config.featureToggles['publicDashboards'])) {
+    if (Boolean(config.featureToggles['publicDashboards']) && config.publicDashboardsEnabled) {


we could reuse the new function here

public/app/features/dashboard/components/ShareModal/ShareModal.tsx

...ashboard/components/ShareModal/SharePublicDashboard/ModalAlerts/NoUpsertPermissionsAlert.tsx

.../features/dashboard/components/ShareModal/SharePublicDashboard/SharePublicDashboard.test.tsx

AgnesToulet · 2023-12-14T09:43:00Z

We should check the enterprise code, I think we are using this flag somewhere (besides the email sharing one).

Yes the Enterprise PR is ready to be reviewed as well (just forgot to put our squad as reviewers)

…ndex.md Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>

Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>

…tps://github.com/grafana/grafana into agnestoulet/remove-publicdashboards-feature-flag

…flag

juanicabanas · 2023-12-18T13:29:07Z

public/app/features/dashboard/components/ShareModal/SharePublicDashboard/config.ts

There's a SharePublicDashboardUtils.ts file. I think we should add this function there.
I think it should also be renamed to utils.ts because of the rest of the project

AgnesToulet added 5 commits November 28, 2023 10:46

Replace feature toggle with configuration setting

13ca376

Fix permission alert

d5aba03

Update documentation

670fabd

Add back feature toggle

a9ade2b

revert unwanted commited changes

de1dc16

grafana-delivery-bot bot added this to the 10.3.x milestone Nov 30, 2023

grafana-pr-automation bot added area/frontend type/docs area/backend labels Nov 30, 2023

AgnesToulet added 7 commits December 1, 2023 11:15

fix tests

c99b21d

Merge branch 'main' into agnestoulet/remove-publicdashboards-feature-…

354b764

…flag

run prettier

7aa5a13

Update SharePublicDashboard.test.tsx

a152266

fix linter and frontend tests

e7f0b7f

Merge branch 'main' into agnestoulet/remove-publicdashboards-feature-…

47ed4b5

…flag

Update api.go

e5f6d56

AgnesToulet marked this pull request as ready for review December 11, 2023 09:34

AgnesToulet requested review from torkelo, grafanabot, a team, chri2547 and imatwawana as code owners December 11, 2023 09:34

AgnesToulet requested review from juanicabanas and removed request for a team December 11, 2023 09:34

AgnesToulet commented Dec 11, 2023

View reviewed changes

pkg/services/publicdashboards/api/api.go Outdated Show resolved Hide resolved

imatwawana approved these changes Dec 11, 2023

View reviewed changes

IevaVasiljeva approved these changes Dec 12, 2023

View reviewed changes

Apply docs edit from code review

c8912cf

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

evictorero approved these changes Dec 12, 2023

View reviewed changes

conf/defaults.ini Show resolved Hide resolved

pkg/services/publicdashboards/api/api.go Outdated Show resolved Hide resolved

Update index.md

1c04ab3

imatwawana approved these changes Dec 12, 2023

View reviewed changes

chri2547 reviewed Dec 12, 2023

View reviewed changes

docs/sources/setup-grafana/configure-grafana/_index.md Outdated Show resolved Hide resolved

chri2547 reviewed Dec 12, 2023

View reviewed changes

docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md Outdated Show resolved Hide resolved

chri2547 approved these changes Dec 12, 2023

View reviewed changes

juanicabanas approved these changes Dec 12, 2023

View reviewed changes

chri2547 and others added 7 commits December 15, 2023 08:41

Update docs/sources/setup-grafana/configure-grafana/feature-toggles/i…

c1ce1ec

…ndex.md Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>

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

2218b2c

Co-authored-by: Agnès Toulet <35176601+AgnesToulet@users.noreply.github.com>

add isPublicDashboardsEnabled + test

d853ec4

Merge branch 'agnestoulet/remove-publicdashboards-feature-flag' of ht…

33f91f7

…tps://github.com/grafana/grafana into agnestoulet/remove-publicdashboards-feature-flag

fix test

5534428

Merge branch 'main' into agnestoulet/remove-publicdashboards-feature-…

efcde46

…flag

update ff description in registry

aa56af6

juanicabanas approved these changes Dec 18, 2023

View reviewed changes

AgnesToulet added 2 commits December 19, 2023 10:33

move isPublicDashboardsEnabled

827ee39

revert getConfig() update

351719e

AgnesToulet merged commit fdaf6e3 into main Dec 19, 2023
19 checks passed

AgnesToulet deleted the agnestoulet/remove-publicdashboards-feature-flag branch December 19, 2023 10:43

AgnesToulet mentioned this pull request Dec 19, 2023

Task: remove publicDashboard FF disclaimer in dashboard insights documentation #78049

Closed

summerwollin modified the milestones: 10.3.x, 10.3.0 Jan 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PublicDashboards: Add setting to disable the feature #78894

PublicDashboards: Add setting to disable the feature #78894

AgnesToulet commented Nov 30, 2023

imatwawana left a comment

IevaVasiljeva left a comment

AgnesToulet commented Dec 12, 2023

IevaVasiljeva commented Dec 12, 2023

evictorero left a comment

imatwawana left a comment

evictorero commented Dec 12, 2023

chri2547 left a comment

juanicabanas Dec 12, 2023

AgnesToulet commented Dec 14, 2023

juanicabanas Dec 18, 2023

PublicDashboards: Add setting to disable the feature #78894

PublicDashboards: Add setting to disable the feature #78894

Conversation

AgnesToulet commented Nov 30, 2023

imatwawana left a comment

Choose a reason for hiding this comment

IevaVasiljeva left a comment

Choose a reason for hiding this comment

AgnesToulet commented Dec 12, 2023

IevaVasiljeva commented Dec 12, 2023

evictorero left a comment

Choose a reason for hiding this comment

imatwawana left a comment

Choose a reason for hiding this comment

evictorero commented Dec 12, 2023

chri2547 left a comment

Choose a reason for hiding this comment

juanicabanas Dec 12, 2023

Choose a reason for hiding this comment

AgnesToulet commented Dec 14, 2023

juanicabanas Dec 18, 2023

Choose a reason for hiding this comment