Skip to content

fix(base-cluster): this prevents the user from installing this under another name#1418

Merged
cwrau merged 1 commit intomainfrom
fix/base-cluster/add-check-for-helmrelease-name
May 28, 2025
Merged

fix(base-cluster): this prevents the user from installing this under another name#1418
cwrau merged 1 commit intomainfrom
fix/base-cluster/add-check-for-helmrelease-name

Conversation

@cwrau
Copy link
Copy Markdown
Member

@cwrau cwrau commented Mar 18, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced installation validation to enforce a specific release naming convention.
    • Users entering a different release name receive a clear error message guiding them to use the mandated name.

@cwrau cwrau enabled auto-merge (squash) March 18, 2025 09:10
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 18, 2025

Walkthrough

The changes add a new validation check in the Helm chart template file (charts/base-cluster/templates/validation.yaml). The validation enforces that the release name must be exactly "base-cluster". If this condition is not met, the chart installation will fail with a specified error message. Existing validations for global.clusterName and global.serviceLevelAgreement remain unchanged.

Changes

File(s) Change Summary
charts/base-cluster/.../validation.yaml Added a conditional check to ensure the release name is "base-cluster". The chart fails with an error message if the check fails.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant H as Helm
    participant V as Validator

    U->>H: Initiate chart installation
    H->>V: Run release name validation
    alt Release name is "base-cluster"
        V-->>H: Validation passed
        H-->>U: Installation proceeds
    else
        V-->>H: Validation failed ("This chart must be installed with the release name 'base-cluster'")
        H-->>U: Installation fails with error
    end
Loading

Poem

I'm a little rabbit with ears so fine,
Hopping through validations in a YAML line.
"base-cluster" is the only name I adore,
Without it, I'll stop installation at the door.
A hop, a skip, and error no more! 🐇
Cheers to checks that keep charts pure!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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
Copy Markdown

@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/validation.yaml (1)

11-13: Enforce Release Name Validation & Fix Indentation Warnings

The new conditional check ensuring that the release name is exactly "base-cluster" correctly meets the PR objective. However, YAMLlint reports indentation issues on these lines (expected 0 spaces but found additional indentation). To comply with YAML lint and avoid any potential parsing issues, please consider removing the extra leading spaces so that these templating directives are flush left.

Suggested diff:

-  {{- if ne .Release.Name "base-cluster" -}}
-    {{- fail "This chart must be installed with the release name 'base-cluster'" -}}
-  {{- end -}}
+{{- if ne .Release.Name "base-cluster" -}}
+  {{- fail "This chart must be installed with the release name 'base-cluster'" -}}
+{{- end -}}
🧰 Tools
🪛 YAMLlint (1.35.1)

[warning] 11-11: wrong indentation: expected 0 but found 2

(indentation)


[warning] 12-12: wrong indentation: expected 0 but found 4

(indentation)


[warning] 13-13: wrong indentation: expected 0 but found 2

(indentation)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 24db445 and bf399f0.

📒 Files selected for processing (1)
  • charts/base-cluster/templates/validation.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
charts/base-cluster/templates/validation.yaml

[warning] 11-11: wrong indentation: expected 0 but found 2

(indentation)


[warning] 12-12: wrong indentation: expected 0 but found 4

(indentation)


[warning] 13-13: wrong indentation: expected 0 but found 2

(indentation)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: generateDiffCommentBody
  • GitHub Check: lint helm chart (base-cluster)
  • GitHub Check: wait-for-checks

@teutonet-bot
Copy link
Copy Markdown
Contributor

🤖 I have diffed this beep boop

"/$namespace/$kind/$name.yaml" for normal resources
"/$namespace/HelmRelease/$name/$namespace/$kind/$name.yaml" for HelmReleases <- this is recursive
'null' means it's either cluster-scoped or it's in the default namespace for the HelmRelease

charts/base-cluster/ci/monitoring-ingress-unauthenticated-values.yaml

charts/base-cluster/ci/rbac-values.yaml

charts/base-cluster/ci/pagerduty-values.yaml

charts/base-cluster/ci/velero-backupStorageLocations-gen-values.yaml

charts/base-cluster/ci/flux-gitrepositories-gen-values.yaml

charts/base-cluster/ci/imagepullsecrets-values.yaml has no changes

charts/base-cluster/values.yaml has no changes

charts/base-cluster/ci/artifacthub-values.yaml has no changes

charts/base-cluster/ci/disabled-ingress-values.yaml

charts/base-cluster/ci/priorityclasses-values.yaml

[charts/base-cluster/ci/deadmansswitch-values.yaml](

<title> Error </title> <script src="https://unpkg.com/htmx.org@2.0.2" integrity="sha384-Y7hw+L/jvKeWIRRkqWYfPcvVxHzVzn5REgzbawhxAuQGwX1XWe70vji+VSeHOThJ" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js"></script> <script defer src="https://media.ethicalads.io/media/client/ethicalads.min.js"></script> <script> function key(event, letter) { return (event.charCode == letter.charCodeAt() || event.charCode == letter.charCodeAt() + 32) } </script> <script>
    </script>
    <style></style>
    
    
</head>

<body hx-on:keydown="var path=window.location.pathname; if ((event.key=='n' || event.key=='N') && path && path !== '/' && !path.includes('/duplicate/') && !path.includes('/dashboard/') && !path.includes('/accounts/') && !path.includes('/properties/')) { window.location.href = '/'; }">
    <div id="container">
        
        <div class="topbuttons">
            
                <a href="/accounts/login/"
                   title="Personal dashboard, preferences, API token"
                   class="button"><b>Sign in</b></a>
            
            <a href="/" title="Create a new paste (shortcut: 'N')" class=" button">New</a>
            <a href="/api/v2/"
               title="Paste creation API, with code samples"
               class=" activebutton  button">API</a>
            <a href="/help/"
               title="Usage tips, shortcuts"
               class="  button">Help</a>
            <a href="/about/"
               title="Updates, stats, backstory"
               class=" button">About</a>
        </div>
        
<div class="error">
    <h3>Sorry!</h3>
    Sorry, maximum content size is 1,000,000 characters. Your submission is 2,540,033. Your IP will be blocked if you exceed this limit again in the next 60 seconds.
    <hr>
    <p>
        Something unexpected? Please create a <a href="https://dpaste.freshdesk.com/support/tickets/new">support ticket</a>.
    </p>
</div>
<p>
    <a class="button" href="{$ url 'create' %}" onclick="history.back();return false;">Go back</a>
</p>

    </div>
    
    
    <script>
        window.fwSettings={'widget_id':22000000180 };
        !function(){if("function"!=typeof window.FreshworksWidget){var n=function(){n.q.push(arguments)};n.q=[],window.FreshworksWidget=n}}();
    </script>
    <script defer src='https://widget.freshworks.com/widgets/22000000180.js'></script>
</body>
)

charts/base-cluster/ci/monitoring-oidc-values.yaml

charts/base-cluster/ci/basic-values.yaml has no changes

charts/base-cluster/ci/monitoring-oidc-ingress-disabled-values.yaml

charts/base-cluster/ci/limitrange-resourcequota-values.yaml

@cwrau cwrau disabled auto-merge May 28, 2025 08:26
@cwrau cwrau added this pull request to the merge queue May 28, 2025
Merged via the queue into main with commit f4807e8 May 28, 2025
@cwrau cwrau deleted the fix/base-cluster/add-check-for-helmrelease-name branch May 28, 2025 08:26
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