newrelic-quickstarts icon indicating copy to clipboard operation
newrelic-quickstarts copied to clipboard

[Repository] Dashboard permissions in copy and paste JSON experience

Open jpvajda opened this issue 3 years ago • 1 comments

Problem

We've had many questions on the requirement of Dashboard JSON imports to New Relic to contain the permissions field. BUT quickstart dashboard JSON doesn't require that and we actually have a check in the repo to ensure that is not included in the JSON.

Questions

  • Why is this required only on the import of a dashboard via JSON into the platform?

We made an intentional choice to omit permissions because multiple values are allowed for that field, and the user could get into a situation where they can't actually view the dashboard after creation. So in an effort to avoid that, we required omission of permissions and then set it explicitly to permissions: PUBLIC_READ_WRITE in the OILS service when we create dashboards. OILS is ultimately using the same DashboardCreate mutation that's used by the in-product import tool, the service just handles the details of actually setting what's necessary

  • Is any dashboard team looking at this requirement to remove that dependency so we can align the JSON for quickstarts dashboards with the import process and make it the same?

it's a feature to have permissions. Although it's never been clearly communicated in documentation, the dashboard.json that's in the newrelic-quickstarts repo isn't expected to work with the in-product dashboard import.

once a dashboard is created it needs to have permissions defined to import into NR1

References

{
  "name": "[DevEn] 3rd Party App (Nerdpack) Deprecations",
  "description": null,
  "permissions": "PUBLIC_READ_WRITE",
  "pages": [
  ]
}

Dashboards can have 3 different permissions in the product

image

Considerations

  • Dashboard JSON should be the source of truth. If Quickstarts wants all dashboards to be public, could it be possible to change/confirm the permissions on import of the dashboard during the quickstart install step? So when you the user goes through the install flow, they are asked what permissions level you want to set on the dashboard, with a default to public.
  • How can the quickstarts repo allow the permissions field, so we better support the copy and paste scenario when a user copies JSON from NR1 and adds it into a quickstart?
  • How does our dashboard functionality in quickstarts impact basic users vs paid users?

jpvajda avatar Feb 10 '22 16:02 jpvajda

Moving back to ToDo, as it will take some more cross team discussions to address this particular issue.

jpvajda avatar Feb 15 '22 17:02 jpvajda

Old issues will be closed after 105 days of inactivity. This issue has been quiet for 90 days and is being marked as stale. Reply here to keep this issue open.

github-actions[bot] avatar Feb 23 '23 02:02 github-actions[bot]

This issue is being closed due to inactivity. Is this a mistake? Please re-open this issue or create a new one.

github-actions[bot] avatar Jun 08 '23 02:06 github-actions[bot]