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.

Sign up for GitHub

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

Jump to bottom

add multi-tenancy public tutorial #2393

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

add multi-tenancy public tutorial #2393

wants to merge 17 commits into from

Conversation

QuentinBisson
Copy link
Contributor

What this PR does / why we need it

Towards https://github.com/giantswarm/giantswarm/issues/25198

This PR adds a tutorial explaining how to ad a grafana organization via a CR

Things to check/remember before submitting

  • If you made content changes

    • Run make lint dev to render and proofread content changes locally.
    • Bump last_review_date in the front matter header if you reviewed the entire page.

@QuentinBisson QuentinBisson requested a review from a team December 12, 2024 08:53
@QuentinBisson QuentinBisson self-assigned this Dec 12, 2024
@QuentinBisson QuentinBisson requested a review from a team as a code owner December 12, 2024 08:53
pipo02mix
pipo02mix reviewed Dec 12, 2024
View reviewed changes
Copy link
Contributor

@pipo02mix pipo02mix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, only few grammar style points

pipo02mix and others added 9 commits December 13, 2024 10:01
@pipo02mix
Merge branch 'main' into add-multi-tenancy-public-doc
19523fe
@QuentinBisson @pipo02mix
Update src/content/overview/observability/_index.md
bca5657 
Co-authored-by: Fernando Ripoll <fernando@giantswarm.io>
@QuentinBisson @pipo02mix
Update src/content/tutorials/observability/data-exploration/accessing…
27308d7 
…-grafana/_index.md

Co-authored-by: Fernando Ripoll <fernando@giantswarm.io>
@QuentinBisson @pipo02mix
Update src/content/tutorials/observability/multi-tenancy/creating-gra…
cef3f5e 
…fana-organization/_index.md

Co-authored-by: Fernando Ripoll <fernando@giantswarm.io>
@QuentinBisson @pipo02mix
Update src/content/tutorials/observability/multi-tenancy/creating-gra…
ea1a7d3 
…fana-organization/_index.md

Co-authored-by: Fernando Ripoll <fernando@giantswarm.io>
@QuentinBisson @pipo02mix
Update src/content/tutorials/observability/multi-tenancy/creating-gra…
9b471e1 
…fana-organization/_index.md

Co-authored-by: Fernando Ripoll <fernando@giantswarm.io>
@QuentinBisson @pipo02mix
Update src/content/tutorials/observability/multi-tenancy/creating-gra…
62ba86f 
…fana-organization/_index.md

Co-authored-by: Fernando Ripoll <fernando@giantswarm.io>
@pipo02mix
Merge branch 'main' into add-multi-tenancy-public-doc
76a27d9
@QuentinBisson
Merge branch 'main' into add-multi-tenancy-public-doc
1ba3c2f
@QuentinBisson
Copy link
Contributor Author

FYI: internal ADR is here https://github.com/giantswarm/giantswarm/pull/32256 with a bit more detail.

@giantswarm/sig-docs I'm a bit confused where we would document higher level concepts like Multi-tenancy as would like to have a kind of overview page to not have to redefine multi-tenancy everywhere. Would you have some hints?

@QuentinBisson
Copy link
Contributor Author

This documentation only talks about the tenancy read path as the write path will be in the data ingestion section.

So we have:

  • data exploration
    • how to access grafana
    • others ...
  • data ingestion
    • how to ingest logs
    • how to ingest metrics
  • multi-tenancy
    • how to create organizations

I think the write path should be explained in the data ingestion sections (as this will most likely be a label)

But then I'm not sure if we actually need a multi-tenancy specific section? cc @Rotfuks as i've talked about this a bit with you already

TheoBrigitte
TheoBrigitte reviewed Dec 16, 2024
View reviewed changes
src/content/tutorials/observability/multi-tenancy/creating-grafana-organization/_index.md
```

Our operators will create this `Grafana` organization named _Giant Swarm_. It will be equipped with a basic set of data sources for Loki, Mimir and Alertmanager, giving you access to the `giantswarm` tenant.
The Role Base Access Control (RBAC) section defines how to map your groups from your identity provider to `Grafana` admin roles (`Admin`, `Editor`, `Viewer`). Note that only the `admins` field is mandatory in this section.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide more information and examples regarding RBAC like, where does those values comes from. Probably adding a link to Grafana OAuth would be helpfull too

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 references would be helpful, and beyond the scope of this PR, it might be nice to also include a reference to this doc in other OIDC RBAC docs to give admins a clue about this when they are doing group management

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually a good idea

stone-z
stone-z reviewed Dec 16, 2024
View reviewed changes
src/content/tutorials/observability/multi-tenancy/creating-grafana-organization/_index.md Outdated Show resolved Hide resolved
src/content/tutorials/observability/multi-tenancy/creating-grafana-organization/_index.md Outdated Show resolved Hide resolved
src/content/tutorials/observability/multi-tenancy/creating-grafana-organization/_index.md
```

Our operators will create this `Grafana` organization named _Giant Swarm_. It will be equipped with a basic set of data sources for Loki, Mimir and Alertmanager, giving you access to the `giantswarm` tenant.
The Role Base Access Control (RBAC) section defines how to map your groups from your identity provider to `Grafana` admin roles (`Admin`, `Editor`, `Viewer`). Note that only the `admins` field is mandatory in this section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 references would be helpful, and beyond the scope of this PR, it might be nice to also include a reference to this doc in other OIDC RBAC docs to give admins a clue about this when they are doing group management

QuentinBisson and others added 2 commits December 17, 2024 14:07
@QuentinBisson @stone-z
Update src/content/tutorials/observability/multi-tenancy/creating-gra…
3956b3c 
…fana-organization/_index.md

Co-authored-by: Zach Stone <zach@giantswarm.io>
@QuentinBisson @stone-z
Update src/content/tutorials/observability/multi-tenancy/creating-gra…
d2ffc03 
…fana-organization/_index.md

Co-authored-by: Zach Stone <zach@giantswarm.io>
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 17, 2024 •
edited
Loading

Hugo yielded some warnings. Please check whether they require action.

WARN  Template shortcodes/autoscaling_supported_versions.html is unused, source file /home/runner/work/docs/docs/src/layouts/shortcodes/autoscaling_supported_versions.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stone-z stone-z stone-z left review comments

@TheoBrigitte TheoBrigitte TheoBrigitte left review comments

@pipo02mix pipo02mix pipo02mix left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@QuentinBisson QuentinBisson

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@QuentinBisson @pipo02mix @TheoBrigitte @stone-z