✨ Initialize the Grafana plugin #2718

Kavinjsir · 2022-06-10T23:58:15Z

Description of the Change

Initialize the Grafana plugin with the basic function to scaffold raw json manifest that can be copied to Grafana Web UI to visualize the controller/operator status.

Plugin Basic Function

Scaffold a new grafana folder with dashboard manifests (raw json to be imported to Grafana UI)

Sample Usage

Motivation

This is the starting entry for developing the Grafana plugin.
Relative EP is in PR: #2708

k8s-ci-robot · 2022-06-10T23:58:24Z

Hi @Kavinjsir. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go

cmd/main.go

pkg/plugins/optional/grafana/alphav1/plugin.go

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go

camilamacedo86 · 2022-06-14T00:32:08Z

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go

+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",


should we have a dashaboard with all or could we divide per category?

should we have a dashaboard with all or could we divide per category?

Are we talking about displaying all default metrics in dashboards? (If so, I feel like having multiple dashboards for different groups of metrics makes more sense, since there are so many..)

Talking about one single dashboard, it is available to divide panels into different folders, so that some folders can be folded up in case of the limited web page size.

Why we need many folders?
Could not be dashboards and we have <metric_category>.json

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go

Kavinjsir · 2022-06-14T17:39:45Z

Just added test cases bymake generate.

Some error happens when running make test-e2e-local:

Will see if it works for CI tests.

pkg/plugins/optional/grafana/alphav1/scaffolds/edit.go

pkg/plugins/optional/grafana/alphav1/scaffolds/init.go

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/runtime.go

camilamacedo86 · 2022-06-28T09:47:17Z

/test pull-kubebuilder-e2e-k8s-1-18-20

camilamacedo86 · 2022-06-28T09:48:30Z

cmd/main.go

@@ -33,6 +33,7 @@ import (
 	deployimagev1alpha1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/deploy-image/v1alpha1"
 	golangv2 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v2"
 	golangv3 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v3"
+	grafana "sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/alphav1"


Suggested change

grafana "sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/alphav1"

grafanaalphav1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/alphav1"

Could we change the alias to have alphav1 so that we follow its standards?

@camilamacedo86 @Kavinjsir Wdyt about renaming the directory to v1alpha instead of alphav1, to make it in sync with other plugin naming.
The path would be sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/v1alpha, the alias would be grafanav1alpha

camilamacedo86 · 2022-06-28T09:55:38Z

pkg/plugins/optional/grafana/alphav1/edit.go

+*/
+
+package alphav1
+


See that code for init and edit are the same. Therefore we can centralize the content by:
a) creating a new file constants.go and adding all contacts there for the examples and descriptions
b) creating a new file commons.go and centralize the code that is used in both by encapsulating them with cohesion to be called in the subcommand implementations.

camilamacedo86 · 2022-06-28T09:56:44Z

testdata/project-v3/PROJECT

@@ -1,6 +1,8 @@
 domain: testproject.org
 layout:
 - go.kubebuilder.io/v3
+plugins:
+  grafana.kubebuilder.io/v1-alpha: {}


Terrific 🥇

camilamacedo86 · 2022-06-28T09:59:48Z

docs/book/src/SUMMARY.md

@@ -112,6 +112,7 @@
    - [go/v2 plugin (Deprecated)](./plugins/go-v2-plugin.md)
    - [go/v3 plugin](./plugins/go-v3-plugin.md)
    - [Declarative V1](./plugins/declarative-v1.md)
+    - [Grafana V1](./plugins/grafana-v1-alpha.md)


we ne

Suggested change

- [Grafana V1](./plugins/grafana-v1-alpha.md)

- [grafana/v1-alpha](./plugins/grafana-v1-alpha.md)

docs/book/src/plugins/grafana-v1-alpha.md

camilamacedo86 · 2022-06-28T10:04:59Z

docs/book/src/plugins/grafana-v1-alpha.md

+
+The plugin will create a new directory and scaffold the JSON files under it (i.e. `grafana/controller-runtime-metrics.json`).
+
+#### Grafana Manifest Usage


Suggested change

#### Grafana Manifest Usage

#### Now, let's check how to use the Grafana Dashboards

docs/book/src/plugins/grafana-v1-alpha.md

varshaprasad96 · 2022-06-28T20:25:16Z

cmd/main.go

@@ -33,6 +33,7 @@ import (
 	deployimagev1alpha1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/deploy-image/v1alpha1"
 	golangv2 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v2"
 	golangv3 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/golang/v3"
+	grafana "sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/alphav1"


@camilamacedo86 @Kavinjsir Wdyt about renaming the directory to v1alpha instead of alphav1, to make it in sync with other plugin naming.
The path would be sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/v1alpha, the alias would be grafanav1alpha

varshaprasad96 · 2022-06-28T20:52:41Z

docs/book/src/plugins/grafana-v1-alpha.md

+   <img width="644" alt="Screen Shot 2022-06-28 at 3 40 22 AM" src="https://user-images.githubusercontent.com/18136486/176121955-1c4aec9c-0ba4-4271-9767-e8d1726d9d9a.png">
+4. Select the data source for Prometheus metrics
+   <img width="633" alt="Screen Shot 2022-06-28 at 3 41 26 AM" src="https://user-images.githubusercontent.com/18136486/176122261-e3eab5b0-9fc4-45fc-a68c-d9ce1cfe96ee.png">
+5. Once `import` the json, the dashboard is ready.


Nit

Suggested change

5. Once `import` the json, the dashboard is ready.

5. Once the json is imported in grafana, the dashboard is ready.

Kavinjsir · 2022-06-28T21:23:49Z

/test pull-kubebuilder-e2e-k8s-1-18-20

camilamacedo86 · 2022-06-28T22:41:07Z

/test pull-kubebuilder-e2e-k8s-1-18-20

varshaprasad96

Looks good, nice work @Kavinjsir!
/lgtm

camilamacedo86

/approved

/hold cancel

k8s-ci-robot · 2022-06-30T09:17:02Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, Kavinjsir, varshaprasad96

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 10, 2022

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 10, 2022

k8s-ci-robot requested review from camilamacedo86 and pwittrock June 10, 2022 23:58

Kavinjsir force-pushed the feat/grafana-plugin-base branch from cbafd02 to 02cd2ed Compare June 11, 2022 06:26

Kavinjsir changed the title ~~Draft: ✨ Initialize the Grafana plugin~~ WIP: ✨ Initialize the Grafana plugin Jun 11, 2022

Kavinjsir force-pushed the feat/grafana-plugin-base branch from 02cd2ed to cc599f8 Compare June 13, 2022 19:25

Kavinjsir marked this pull request as ready for review June 13, 2022 21:09

k8s-ci-robot requested a review from joelanford June 13, 2022 21:10

Kavinjsir commented Jun 13, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jun 13, 2022

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jun 13, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/plugin.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jun 13, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go Outdated Show resolved Hide resolved

varshaprasad96 reviewed Jun 13, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go Outdated Show resolved Hide resolved

Kavinjsir force-pushed the feat/grafana-plugin-base branch from cc599f8 to aefb041 Compare June 13, 2022 23:08

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 13, 2022

Kavinjsir force-pushed the feat/grafana-plugin-base branch 2 times, most recently from 75f103b to 071265a Compare June 13, 2022 23:43

Kavinjsir changed the title ~~WIP: ✨ Initialize the Grafana plugin~~ ✨ Initialize the Grafana plugin Jun 13, 2022

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 13, 2022

camilamacedo86 reviewed Jun 14, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/overall.go Outdated Show resolved Hide resolved

Kavinjsir force-pushed the feat/grafana-plugin-base branch from 071265a to 4343371 Compare June 14, 2022 16:43

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 14, 2022

Kavinjsir force-pushed the feat/grafana-plugin-base branch from dacff4f to 3a57b94 Compare June 23, 2022 19:44

camilamacedo86 reviewed Jun 24, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/scaffolds/edit.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jun 24, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/scaffolds/init.go Outdated Show resolved Hide resolved

camilamacedo86 reviewed Jun 24, 2022

View reviewed changes

pkg/plugins/optional/grafana/alphav1/scaffolds/internal/templates/runtime.go Outdated Show resolved Hide resolved

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 27, 2022

Kavinjsir force-pushed the feat/grafana-plugin-base branch from 3a57b94 to f3a6ba4 Compare June 28, 2022 07:15

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 28, 2022

Kavinjsir force-pushed the feat/grafana-plugin-base branch from f3a6ba4 to de641bd Compare June 28, 2022 07:59

camilamacedo86 reviewed Jun 28, 2022

View reviewed changes

docs/book/src/plugins/grafana-v1-alpha.md Show resolved Hide resolved

camilamacedo86 reviewed Jun 28, 2022

View reviewed changes

docs/book/src/plugins/grafana-v1-alpha.md Outdated Show resolved Hide resolved

varshaprasad96 reviewed Jun 28, 2022

View reviewed changes

feat: Initialize the grafana plugin

fae8f05

Kavinjsir force-pushed the feat/grafana-plugin-base branch from de641bd to fae8f05 Compare June 28, 2022 21:13

varshaprasad96 approved these changes Jun 29, 2022

View reviewed changes

k8s-ci-robot assigned varshaprasad96 Jun 29, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 29, 2022

camilamacedo86 approved these changes Jun 30, 2022

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 30, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 30, 2022

k8s-ci-robot merged commit 68b0809 into kubernetes-sigs:master Jun 30, 2022

Kavinjsir mentioned this pull request Sep 14, 2022

REQUEST: New membership for Kavinjsir kubernetes/org#3694

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Initialize the Grafana plugin #2718

✨ Initialize the Grafana plugin #2718

Kavinjsir commented Jun 10, 2022 •

edited

Loading

k8s-ci-robot commented Jun 10, 2022

camilamacedo86 Jun 14, 2022

Kavinjsir Jun 14, 2022

camilamacedo86 Jun 14, 2022

Kavinjsir commented Jun 14, 2022

camilamacedo86 commented Jun 28, 2022

camilamacedo86 Jun 28, 2022

varshaprasad96 Jun 28, 2022

camilamacedo86 Jun 28, 2022

camilamacedo86 Jun 28, 2022

camilamacedo86 Jun 28, 2022

camilamacedo86 Jun 28, 2022

varshaprasad96 Jun 28, 2022

varshaprasad96 Jun 28, 2022

Kavinjsir commented Jun 28, 2022

camilamacedo86 commented Jun 28, 2022

varshaprasad96 left a comment

camilamacedo86 left a comment

k8s-ci-robot commented Jun 30, 2022

	grafana "sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/alphav1"
	grafanaalphav1 "sigs.k8s.io/kubebuilder/v3/pkg/plugins/optional/grafana/alphav1"

	- [Grafana V1](./plugins/grafana-v1-alpha.md)
	- [grafana/v1-alpha](./plugins/grafana-v1-alpha.md)


		The plugin will create a new directory and scaffold the JSON files under it (i.e. `grafana/controller-runtime-metrics.json`).

		#### Grafana Manifest Usage

	#### Grafana Manifest Usage
	#### Now, let's check how to use the Grafana Dashboards

	5. Once `import` the json, the dashboard is ready.
	5. Once the json is imported in grafana, the dashboard is ready.

		*/

		package alphav1

✨ Initialize the Grafana plugin #2718

✨ Initialize the Grafana plugin #2718

Conversation

Kavinjsir commented Jun 10, 2022 • edited Loading

Description of the Change

Plugin Basic Function

Sample Usage

Motivation

k8s-ci-robot commented Jun 10, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kavinjsir commented Jun 14, 2022

camilamacedo86 commented Jun 28, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kavinjsir commented Jun 28, 2022

camilamacedo86 commented Jun 28, 2022

varshaprasad96 left a comment

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 30, 2022

Kavinjsir commented Jun 10, 2022 •

edited

Loading