Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Grafana access for communities #198

Open
3 of 6 tasks
Tracked by #3469
GeorgianaElena opened this issue Dec 6, 2023 · 1 comment
Open
3 of 6 tasks
Tracked by #3469

Document Grafana access for communities #198

GeorgianaElena opened this issue Dec 6, 2023 · 1 comment
Assignees

Comments

@GeorgianaElena
Copy link
Member

GeorgianaElena commented Dec 6, 2023

We need documentation about Grafana for our communities.

Minimal information

Such documentation should contain at least the following information:

  • that this is a feature available only on dedicated clusters
  • how a community champion can create a Grafana username using the invite link that 2i2c creates and shared with them (engineering facing docs https://infrastructure.2i2c.org/sre-guide/support/grafana-account/)
  • how a community champion can give access to other users via invite links as well. I think multiple users can use the same link to register, but this should be checked
  • any changes made to the JupyterHub dashboards directory will not be persisted
  • A very big warning that at the moment there isn't any documentation about what each dashboard or panel represents and this is an upstream work in progress

Extra information

  • we should also have a policy about whether or not they can create other dashboards in other directories
@jmunroe
Copy link
Contributor

jmunroe commented Dec 8, 2023

I've made a first pass at adding some documentation in #200.

Still need to

  • verify what exactly gets sent to hub champion and take screenshots of the process to set up an account
  • verify the procedure if there are multiple community hub champions -- can the same invite link be reused?
  • decide if community champions should be allowed to create their own dashboards
    • although those dashboards should persist, those changes will not be backed up anywhere
    • we may want to instead encourage hub champions to contribute upstream to jupyterhub/grafana-dashboards so that improvements propagate to all communities

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Review / QA 👀
Development

No branches or pull requests

2 participants