Skip to content

feat(base-cluster/monitoring): set code challenge for grafana #1500

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

Merged
merged 1 commit into from
Jun 6, 2025

Conversation

cwrau
Copy link
Member

@cwrau cwrau commented Jun 6, 2025

See #1496

Summary by CodeRabbit

  • New Features
    • Enabled PKCE (Proof Key for Code Exchange) support for Grafana's OAuth authentication, enhancing security during login.

@Copilot Copilot AI review requested due to automatic review settings June 6, 2025 10:14
@cwrau cwrau enabled auto-merge June 6, 2025 10:14
Copy link

coderabbitai bot commented Jun 6, 2025

Walkthrough

The Grafana OAuth configuration was updated to enable PKCE (Proof Key for Code Exchange) by adding the use_pkce: true parameter. No other changes were made to the authentication or control flow.

Changes

File(s) Change Summary
charts/base-cluster/templates/monitoring/kube-prometheus-stack/_grafana-config.yaml Enabled PKCE in Grafana's OAuth config by adding use_pkce: true

Sequence Diagram(s)

sequenceDiagram
    User -> Grafana: Initiate OAuth login
    Grafana -> OAuth Provider: Redirect with PKCE challenge
    OAuth Provider -> User: Authenticate and authorize
    User -> OAuth Provider: Provide credentials
    OAuth Provider -> Grafana: Return authorization code + PKCE verifier
    Grafana -> OAuth Provider: Exchange code for token (with PKCE verifier)
    OAuth Provider -> Grafana: Issue access token
    Grafana -> User: Grant access
Loading

Possibly related PRs

Suggested labels

base-cluster

Suggested reviewers

  • marvinWolff
  • tasches
  • teutonet-bot

Poem

In the cluster where Grafana glows,
A rabbit hops and swiftly knows—
With PKCE now set to true,
OAuth flows are strong and new.
Secure and bright, the dashboards gleam,
Thanks to this PKCE dream!
🐇✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a code challenge option to improve OAuth security for Grafana by enabling PKCE.

  • Introduces the "use_pkce: true" flag in the OAuth configuration.
  • Enhances the security posture of Grafana authentication.
Comments suppressed due to low confidence (1)

charts/base-cluster/templates/monitoring/kube-prometheus-stack/_grafana-config.yaml:27

  • [nitpick] Consider adding an inline comment to explain the purpose of 'use_pkce: true' for future maintainers, especially if the team is not familiar with PKCE configuration requirements.
use_pkce: true

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
charts/base-cluster/templates/monitoring/kube-prometheus-stack/_grafana-config.yaml (1)

26-27: Expose PKCE toggle via values and document version requirements.

Currently use_pkce is hard-coded:

  scopes: openid profile email
  use_pkce: true
  1. Make it configurable in values.yaml (e.g. .Values.global.authentication.oauth.usePkce) instead of forcing true:
-  use_pkce: true
+  {{- if .config.usePkce }}
+  use_pkce: {{ .config.usePkce }}
+  {{- end }}
  1. Document the minimum Grafana/chart version that supports use_pkce, and bump the chart version in Chart.yaml if needed.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5e0e785 and a993d7e.

📒 Files selected for processing (1)
  • charts/base-cluster/templates/monitoring/kube-prometheus-stack/_grafana-config.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: generateDiffCommentBody
  • GitHub Check: check licenses
  • GitHub Check: lint helm chart (base-cluster)
  • GitHub Check: wait-for-checks

@cwrau cwrau added this pull request to the merge queue Jun 6, 2025
Merged via the queue into main with commit aa803da Jun 6, 2025
42 checks passed
@cwrau cwrau deleted the feat/base-cluster/set-code-challenge-for-grafana branch June 6, 2025 10:49
github-merge-queue bot pushed a commit that referenced this pull request Jun 6, 2025
🤖 I have created a release *beep* *boop*
---


##
[8.1.0](base-cluster-v8.0.0...base-cluster-v8.1.0)
(2025-06-06)


### Features

* **base-cluster/monitoring:** allow upsizing tempo storage
([#1448](#1448))
([db1a742](db1a742))
* **base-cluster/monitoring:** also read secrets for datasources
([#1479](#1479))
([83ba8bd](83ba8bd))
* **base-cluster/monitoring:** configure service graph for grafana
([#1422](#1422))
([8d4bb4c](8d4bb4c))
* **base-cluster/monitoring:** set code challenge for grafana
([#1500](#1500))
([aa803da](aa803da))
* **base-cluster/monitoring:** set code_challenge_method for
oauth2-proxy
([#1496](#1496))
([b252cd7](b252cd7))


### Bug Fixes

* **base-cluster:** this prevents the user from installing this under
another name
([#1418](#1418))
([f4807e8](f4807e8))


### Miscellaneous Chores

* **base-cluster/docs:** update flux helmrelease command to update CRDs
([#1421](#1421))
([a8fd535](a8fd535))
* **base-cluster/monitoring:** remove unnecessary
open-telemetry-collector dashboard
([#1449](#1449))
([520e9e1](520e9e1))
* **base-cluster:** change descheduler syntax
([#1483](#1483))
([907bdae](907bdae))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
  - Enhanced monitoring with support for upsizing tempo storage.
- Enabled reading secrets for datasources and configuring the service
graph in Grafana.
- Added options to set the code challenge and code_challenge_method for
Grafana and oauth2-proxy.
- Introduced an optional persistence configuration for tracing ingester
storage size.

- **Bug Fixes**
- Resolved an issue preventing installation of the chart under
unintended names.

- **Chores**
  - Updated helmrelease command for CRD updates.
  - Removed an unnecessary dashboard and adjusted descheduler syntax.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants