docs: How to setup oauth provider Grafana #542

surajssd · 2020-06-03T08:49:00Z

No description provided.

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

iaguis · 2020-07-10T10:54:43Z

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

+}
+```
+
+Observe the value of variable `secret_env` it should match the name of variable to be created in [Step 3](#step-3).


I'd move this to Step 3 after defining the variable so the attention doesn't jump back and forth too much.

Step 3 is loaded with lot of information, I think keeping it in step2 and since it is in vicinity of step3 there won't be a lot of jumping.

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

iaguis · 2020-07-10T10:57:33Z

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

+
+**NOTE**: In above configs the boolean value is set to `"'true'"` instead of plain `"true"` because Kubernetes expects the key value pair to be of type string and not boolean.
+
+Modify the values of Github Auth configuration from


I'm a bit confused from this point, where should users change this? How does changing "ini" syntax to yaml work?

Suggested change

Modify the values of Github Auth configuration from

Modify the values of the GitHub Auth configuration from

I'm a bit confused from this point, where should users change this?

If users refer to the Grafana docs then they should change the values specified in the ini file to look like as shown in our docs.

How does changing "ini" syntax to yaml work?

It is a manual work to convert the ini file to terraform key value pairs.

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

surajssd · 2020-08-27T09:10:52Z

@invidian I have overhauled the document and now it is simpler than before.

invidian

Looks nice and crispy @surajssd, thanks!

One thing we could consider adding somewhere is how to go from GF_AUTH_GITHUB_SCOPES to other oauth provider. Perhaps one more note in Step 2 ? 😄

surajssd · 2020-08-27T10:07:21Z

One thing we could consider adding somewhere is how to go from GF_AUTH_GITHUB_SCOPES to other oauth provider

What do you mean? For other oauth providers the entire config will change, the env vars will be named differently.

invidian · 2020-08-27T10:35:03Z

I mean, we could write something like: "if you would like to use different OAuth provider, GF_AUTH_GITHUB_SCOPES should become e.g. GF_AUTH_GOOGLE_FOO, as described in ".

surajssd · 2020-08-28T07:04:18Z

The parameters change from one OAuth provider to another. So I wouldn't just say change from GITHUB to GOOGLE and things will work. So I have added additional line in the note above Step 1, which points user to the Grafana docs that explain how to convert ini config to env var: https://grafana.com/docs/grafana/latest/administration/configuration/#configure-with-environment-variables

invidian

LGTM

iaguis

Some comments.

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

iaguis · 2020-08-28T08:53:02Z

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

+> **NOTE**: On Packet, you either need to create a DNS entry for `grafana.<cluster name>.<DNS zone>`
+> and point it to the Packet external IP for the contour service (see the [Packet ingress guide for
+> more details](./ingress-with-contour-metallb.md)) or use the [External DNS
+> component](../configuration-reference/components/external-dns.md).


Does this still make sense if we ask for the External DNS component in the prerequisites?

I would like to keep it just in case someone is not using external dns and would want to have setup done manually.

iaguis · 2020-08-28T08:54:52Z

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

+> `"true"` because Kubernetes expects the key-value pair to be of type `map[string]string` and not
+> `map[string]bool`.


Mentioning map[string]string and such seems too detailed for a howto, but I don't have a better suggestion...

Yeah I thought how best to put it but I think as programmers this makes most sense to convey why it does not work.

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md

Signed-off-by: Suraj Deshmukh <suraj@kinvolk.io>

surajssd requested a review from johananl as a code owner June 3, 2020 08:49

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch 5 times, most recently from 75fa113 to 6312dd1 Compare June 3, 2020 09:05

surajssd mentioned this pull request Jun 3, 2020

grafana: Add secret_env variable #541

Merged

surajssd requested review from invidian and ipochi June 3, 2020 11:27

surajssd marked this pull request as draft June 4, 2020 09:28

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch from 6312dd1 to 8f8ddd6 Compare June 18, 2020 07:36

surajssd marked this pull request as ready for review July 9, 2020 11:34

surajssd requested a review from iaguis July 9, 2020 11:35

iaguis suggested changes Jul 10, 2020

View reviewed changes

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch from 8f8ddd6 to e628290 Compare August 3, 2020 10:21

invidian suggested changes Aug 24, 2020

View reviewed changes

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch from e628290 to 3639df5 Compare August 25, 2020 10:29

surajssd requested review from invidian and iaguis August 25, 2020 10:31

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch 5 times, most recently from a81c626 to 63fb6c6 Compare August 27, 2020 09:09

invidian previously approved these changes Aug 27, 2020

View reviewed changes

surajssd dismissed invidian’s stale review via f3317ef August 28, 2020 07:02

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch from 63fb6c6 to f3317ef Compare August 28, 2020 07:02

invidian previously approved these changes Aug 28, 2020

View reviewed changes

iaguis suggested changes Aug 28, 2020

View reviewed changes

surajssd dismissed invidian’s stale review via 51dde26 September 2, 2020 08:00

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch from f3317ef to 51dde26 Compare September 2, 2020 08:00

surajssd requested a review from iaguis September 2, 2020 08:00

invidian approved these changes Sep 2, 2020

View reviewed changes

invidian previously approved these changes Sep 2, 2020

View reviewed changes

iaguis previously approved these changes Sep 2, 2020

View reviewed changes

johananl reviewed Sep 2, 2020

View reviewed changes

docs/how-to-guides/setup-thirdparty-auth-for-grafana.md Outdated Show resolved Hide resolved

docs: How to setup oauth provider Grafana

bfb0a74

Signed-off-by: Suraj Deshmukh <suraj@kinvolk.io>

surajssd dismissed stale reviews from iaguis and invidian via bfb0a74 September 2, 2020 14:50

surajssd force-pushed the surajssd/add-how-to-gh-oauth branch from 51dde26 to bfb0a74 Compare September 2, 2020 14:50

surajssd requested review from johananl and invidian and removed request for ipochi September 2, 2020 14:51

invidian approved these changes Sep 2, 2020

View reviewed changes

surajssd merged commit 0fc3d59 into master Sep 2, 2020

surajssd deleted the surajssd/add-how-to-gh-oauth branch September 2, 2020 15:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: How to setup oauth provider Grafana #542

docs: How to setup oauth provider Grafana #542

surajssd commented Jun 3, 2020 •

edited

Loading

iaguis Jul 10, 2020

surajssd Aug 3, 2020

iaguis Jul 10, 2020

iaguis Jul 10, 2020

surajssd Aug 3, 2020

surajssd commented Aug 27, 2020

invidian left a comment

surajssd commented Aug 27, 2020

invidian commented Aug 27, 2020

surajssd commented Aug 28, 2020

invidian left a comment

iaguis left a comment

iaguis Aug 28, 2020

surajssd Sep 2, 2020

iaguis Aug 28, 2020

surajssd Sep 2, 2020


		NOTE: In above configs the boolean value is set to `"'true'"` instead of plain `"true"` because Kubernetes expects the key value pair to be of type string and not boolean.

		Modify the values of Github Auth configuration from

	Modify the values of Github Auth configuration from
	Modify the values of the GitHub Auth configuration from

		> `"true"` because Kubernetes expects the key-value pair to be of type `map[string]string` and not
		> `map[string]bool`.

docs: How to setup oauth provider Grafana #542

docs: How to setup oauth provider Grafana #542

Conversation

surajssd commented Jun 3, 2020 • edited Loading

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

surajssd commented Aug 27, 2020

invidian left a comment

Choose a reason for hiding this comment

surajssd commented Aug 27, 2020

invidian commented Aug 27, 2020

surajssd commented Aug 28, 2020

invidian left a comment

Choose a reason for hiding this comment

iaguis left a 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

surajssd commented Jun 3, 2020 •

edited

Loading