Support TLS Secret Configuration in Both Helm Charts#90
Conversation
WalkthroughThis pull request updates the Helm charts for both Plane-CE and Plane Enterprise. Version numbers in the Chart files have been bumped, and a new SSL configuration option ( Changes
Sequence Diagram(s)sequenceDiagram
participant IT as "Ingress Template"
participant SSL as "SSL Configuration"
IT->>SSL: Check if tls_secret_name is provided
alt tls_secret_name provided
IT->>IT: Configure TLS block with custom secret name
else tls_secret_name not provided
IT->>SSL: Check generateCerts & createIssuer flags
alt Both flags enabled
IT->>IT: Configure TLS block with default secret name
else
IT->>IT: No TLS configuration applied
end
end
sequenceDiagram
participant CT as "Certificate Template"
participant SSL as "SSL Config"
CT->>SSL: Evaluate ingress.enabled, createIssuer, and empty tls_secret_name
alt All conditions met
CT->>CT: Create certificate/issuer resource
else
CT->>CT: Skip resource creation
end
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
charts/plane-enterprise/templates/certs/certs.yaml (1)
1-3: Helm Template Linting Note.
YAML lint tools may report a syntax error (e.g., "expected the node content, but found '-'") due to Helm templating syntax. Verify that your linter is configured to either ignore or properly parse Helm template markers.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-ce/templates/certs/certs.yaml (1)
1-3: Helm Templating Syntax Notice.
Similar to the enterprise template, any YAML lint warnings here are likely due to Helm’s templating markers. Ensure your YAML linter is set up to handle these expressions.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-enterprise/questions.yml (1)
703-709: New TLS Secret Variable Addition and Trailing Spaces
The addition of thessl.tls_secret_namevariable is clear and correctly configured (with a default of an empty string, appropriate label, and grouping under "Ingress"). Please remove the trailing spaces on line 707 as flagged by YAMLlint to ensure compliance with linting standards.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 707-707: trailing spaces
(trailing-spaces)
charts/plane-ce/templates/certs/cert-issuers.yaml (1)
1-1: Helm Condition and YAMLlint Warning
The condition combining.Values.ingress.enabled,.Values.ssl.createIssuer, and(empty .Values.ssl.tls_secret_name)correctly ensures that the issuer is only created when a custom TLS secret name is not provided. Note that YAMLlint reports a syntax error at line 1 due to the Helm templating syntax. This is likely a false positive; however, please verify that the Helm templating engine processes this correctly. If the warning persists, consider adding a YAMLlint disable comment or adjusting the linter settings for Helm templates.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-ce/templates/ingress.yaml (1)
96-107: Flexible TLS Configuration Using Custom Secret Name
The new conditional block checking for.Values.ssl.tls_secret_nameis well implemented. It correctly defines the TLS section by listing the relevant hosts and referencing the provided secret name. For clarity and maintainability, consider adding an inline comment to explain that this branch takes precedence over certificate generation viassl.generateCertsandssl.createIssuerwhen a custom secret is provided.charts/plane-enterprise/templates/ingress.yaml (2)
111-121: TLS Configuration Using Custom Secret Name for Enterprise Ingress
In this Enterprise chart, the TLS block now uses.Values.license.licenseDomainas the primary host and conditionally adds MinIO and RabbitMQ hosts when available. This ensures that when a custom TLS secret name is provided, it is honored across all relevant endpoints. The implementation is consistent with the Plane-CE variant.
122-133: Fallback TLS Configuration with Auto-Generated Certificates
If no custom TLS secret name is set, the template correctly falls back to generating certificates using the combination ofssl.generateCertsandssl.createIssuer. This alternative branch is clear in its intent and mirrors the behavior in the CE chart.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
charts/plane-ce/Chart.yaml(1 hunks)charts/plane-ce/README.md(1 hunks)charts/plane-ce/questions.yml(1 hunks)charts/plane-ce/templates/certs/cert-issuers.yaml(1 hunks)charts/plane-ce/templates/certs/certs.yaml(1 hunks)charts/plane-ce/templates/ingress.yaml(1 hunks)charts/plane-ce/values.yaml(1 hunks)charts/plane-enterprise/Chart.yaml(1 hunks)charts/plane-enterprise/README.md(1 hunks)charts/plane-enterprise/questions.yml(1 hunks)charts/plane-enterprise/templates/certs/cert-issuers.yaml(1 hunks)charts/plane-enterprise/templates/certs/certs.yaml(1 hunks)charts/plane-enterprise/templates/ingress.yaml(1 hunks)charts/plane-enterprise/values.yaml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.35.1)
charts/plane-enterprise/templates/certs/certs.yaml
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-ce/templates/certs/certs.yaml
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-enterprise/questions.yml
[error] 707-707: trailing spaces
(trailing-spaces)
charts/plane-ce/templates/certs/cert-issuers.yaml
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-enterprise/templates/certs/cert-issuers.yaml
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
🔇 Additional comments (10)
charts/plane-enterprise/Chart.yaml (1)
8-9: Version Bump Validated.
The version field has been updated from the previous value to1.1.8and the appVersion to"1.8.3"as expected. This aligns with the TLS configuration enhancements and overall release update.charts/plane-enterprise/templates/certs/certs.yaml (1)
1-1: Refined Condition for Certificate Creation.
The addition of(empty .Values.ssl.tls_secret_name)to the existing condition ensures that a Certificate resource is only created when no custom TLS secret is provided. This logic matches the PR objective for providing TLS secret configuration flexibility.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-ce/templates/certs/certs.yaml (1)
1-1: Updated Certificate Creation Condition.
The condition now includes(empty .Values.ssl.tls_secret_name), ensuring that a Certificate is only generated when a custom TLS secret name hasn’t been specified. This change is well aligned with the new TLS secret configuration approach.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-ce/questions.yml (1)
559-565: Addition of Custom TLS Secret Name Variable.
The new variablessl.tls_secret_namehas been correctly added with a default empty string and is placed under the "Ingress" group. Its conditionalshow_if: "ssl.createIssuer=false"correctly ensures that it is only displayed when an issuer is not being created, fulfilling the intended functionality for configurable TLS secrets.charts/plane-ce/Chart.yaml (1)
8-9: Version Update Confirmed.
The update ofversion: 1.1.0andappVersion: "0.25.3"in this Chart file is consistent with the overall release and TLS configuration enhancements. No issues detected with these updates.charts/plane-ce/README.md (1)
240-240: Document new TLS secret configuration option.
The newly addedssl.tls_secret_nameoption is clearly documented with conditions for its use (i.e. applicable wheningress.enabled=trueandssl.createIssuer=false). This addition helps users understand how to use a custom TLS secret.charts/plane-enterprise/templates/certs/cert-issuers.yaml (1)
1-1: Refine certificate issuer creation condition.
The updated conditional expression now checks thatssl.tls_secret_nameis empty in addition toingress.enabledandssl.createIssuerbeing true. This ensures that when a custom TLS secret is provided, the Helm chart will not create the default issuer resources.🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 1-1: syntax error: expected the node content, but found '-'
(syntax)
charts/plane-enterprise/values.yaml (1)
21-22: Add new TLS secret configuration option.
The addition of thetls_secret_namekey under thesslsection—with a default empty string and a clarifying comment about using Let's Encrypt—is a clear enhancement. This change gives administrators more flexibility when they wish to manage their own TLS secrets.charts/plane-enterprise/README.md (1)
302-302: Document the custom TLS secret name configuration.
The new table row forssl.tls_secret_nameclearly communicates its purpose and usage conditions, ensuring users know they should only set this value whenssl.createIssueris false and ingress is enabled.charts/plane-ce/values.yaml (1)
19-21: Introduce TLS secret configuration option.
Thesslsection now includes thetls_secret_namekey initialized to an empty string, along with a comment guiding users on using Let's Encrypt. This is consistent with the Enterprise chart updates and improves overall configuration clarity.
2 participants
Changes:
Summary by CodeRabbit
New Features
Chores
Documentation