Add Steps: Remove Getting Started panel from Grafana
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- docker, grafana, kubernetes
- Domain
- devops, infrastructure, observability
Research direction
Start with add-steps/docker-compose.yml and bootstrap.sh, then compare the referenced Grafana datasource provisioning example and add-steps/k8s/add-steps.yml. Run the Add Steps setup and verify that the dashboard no longer shows the Getting Started panel, the Prometheus datasource is provisioned, and Grafana access still works.
Written by the indexing model from the issue text.
Description
#245 fixed a build issue in the Add Steps demo by upgrading Grafana. That version bump introduced a "Getting Started" panel in the Grafana dashboard, which should be removed.
Background
Newer versions of Grafana include a "Getting Started" panel that should be disabled for our demo:
Proposal
Change the anonymous org role from Admin to Editor:
diff --git a/add-steps/docker-compose.yml b/add-steps/docker-compose.yml
index b391b36..5573f71 100644
--- a/add-steps/docker-compose.yml
+++ b/add-steps/docker-compose.yml
@@ -149,7 +149,7 @@ services:
- 3000:3000
environment:
- GF_AUTH_ANONYMOUS_ENABLED=true
- - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
+ - GF_AUTH_ANONYMOUS_ORG_ROLE=Editor
baseline_slow_cooker:
image: buoyantio/slow_cooker:1.1.0-golang1.8rc2
Note that this breaks our bootstrap.sh script because we can no longer add datasources via the Grafana HTTP API:
$ curl http://localhost:3000/api/datasources
{"message":"Permission denied"}
To address this, add the Prometheus datasource via Datasource provisioning rather than via API. For example:
https://github.com/linkerd/linkerd-viz/blob/c6b4f2baff880ac5c093b6beaec1d42140ce2a48/linkerd-viz#L45-L61
Also bump the Kubernetes version to Grafana 5.4.3:
https://github.com/linkerd/linkerd-examples/blob/d50b911dec4d811a188f66979c45edc1fdb9a90e/add-steps/k8s/add-steps.yml#L918
- Dominant language
- Go
- Stars
- 444
- Forks
- 216
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from linkerd/linkerd-examples
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
linkerd/linkerd-examples#274 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
linkerd/linkerd-examples#273 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
linkerd/linkerd-examples#259 · 1 comment ·
-
additional test dimensions in lifecycle test environmentMay be free again @siggy claimed this 2987 days ago, and no pull request is open. Openbenchmarking in progress
linkerd/linkerd-examples#225 · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
linkerd/linkerd-examples#223 ·
All issues in linkerd/linkerd-examples
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
NVIDIA/k8s-device-plugin#2076 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
area/release kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
kubernetes-sigs/kueue#16455 · 1 comment ·
Maintainers usually reply within 1 day