Skip to content

fix(otel): OPENFGA_TRACE_OTLP_TLS_ENABLED boolean flag quote#280

Open
yannchabed wants to merge 2 commits intoopenfga:mainfrom
yannchabed:fix/trace-otlp-enabled-flag-quote
Open

fix(otel): OPENFGA_TRACE_OTLP_TLS_ENABLED boolean flag quote#280
yannchabed wants to merge 2 commits intoopenfga:mainfrom
yannchabed:fix/trace-otlp-enabled-flag-quote

Conversation

@yannchabed
Copy link

@yannchabed yannchabed commented Jan 27, 2026

This PR ensures that the OPENFGA_TRACE_OTLP_TLS_ENABLED environment variable is correctly handled as a boolean string within the Helm chart templates.

Description

What problem is being solved?

Updates the OpenFGA Helm chart deployment template so OPENFGA_TRACE_OTLP_TLS_ENABLED is rendered as a Kubernetes-compatible string value when enabled, avoiding boolean-type env var rendering.

How is it being solved?

The issue is resolved by updating the deployment template to ensure that the value of OPENFGA_TRACE_OTLP_TLS_ENABLED is explicitly converted to a string (quoted) before being injected into the container environment. This ensures compatibility with Kubernetes API expectations and OpenFGA's configuration logic.

What changes are made to solve it?

Quote the rendered value for OPENFGA_TRACE_OTLP_TLS_ENABLED in deployment.yaml so it becomes "true" instead of true.
Keep the env var conditional on .Values.telemetry.trace.otlp.tls.enabled.

In the current Helm chart, the OPENFGA_TRACE_OTLP_TLS_ENABLED variable—used to toggle TLS for OpenTelemetry Protocol (OTLP) tracing—was not being correctly processed. In Kubernetes manifests, environment variable values must be strings. If a boolean (true/false) is passed directly from Helm's values.yaml without explicit casting or quoting, it causes template rendering errors or be misinterpreted by the OpenFGA server at runtime.

References

Review Checklist


Next Step: Would you like me to help you draft a specific comment for the maintainers or analyze the related CI/CD failures if there are any?

Summary by CodeRabbit

  • Chores
    • Updated deployment configuration formatting for improved consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2026

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

The OpenFGA Helm chart deployment template was updated to change the OPENFGA_TRACE_OTLP_TLS_ENABLED environment variable from an unquoted YAML value to a quoted string literal, ensuring proper YAML formatting.

Changes

Cohort / File(s) Summary
OpenFGA Deployment Configuration
charts/openfga/templates/deployment.yaml
Changed OPENFGA_TRACE_OTLP_TLS_ENABLED environment variable value to quoted string format for YAML compliance

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately describes the main change: quoting a boolean flag for OPENFGA_TRACE_OTLP_TLS_ENABLED in the context of OpenTelemetry configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@yannchabed
Copy link
Author

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@yannchabed yannchabed marked this pull request as ready for review January 27, 2026 08:23
@yannchabed yannchabed requested review from a team as code owners January 27, 2026 08:23
@yannchabed
Copy link
Author

cc @rhamzeh as a regular contributor WDYT?
This is a very small update. But necessary for a clean OTEL deployment.

Copilot AI review requested due to automatic review settings February 17, 2026 08:43
Copy link

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

Updates the OpenFGA Helm chart deployment template so OPENFGA_TRACE_OTLP_TLS_ENABLED is rendered as a Kubernetes-compatible string value when enabled, avoiding boolean-type env var rendering.

Changes:

  • Quote the rendered value for OPENFGA_TRACE_OTLP_TLS_ENABLED in deployment.yaml so it becomes "true" instead of true.
  • Keep the env var conditional on .Values.telemetry.trace.otlp.tls.enabled.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 383 to 386
{{- if .Values.telemetry.trace.otlp.tls.enabled }}
- name: OPENFGA_TRACE_OTLP_TLS_ENABLED
value: {{ .Values.telemetry.trace.otlp.tls.enabled }}
value: "{{ .Values.telemetry.trace.otlp.tls.enabled }}"
{{- end }}
Copy link

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

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

The CI chart-testing install uses default values (where telemetry.trace.otlp.tls.enabled is false), so this rendering path likely isn’t exercised in tests. Consider adding a charts/openfga/ci/ values file (used by chart-testing) that sets telemetry.trace.otlp.tls.enabled=true to prevent regressions and ensure the env var renders as a string.

Copilot uses AI. Check for mistakes.
Comment on lines 383 to 386
{{- if .Values.telemetry.trace.otlp.tls.enabled }}
- name: OPENFGA_TRACE_OTLP_TLS_ENABLED
value: {{ .Values.telemetry.trace.otlp.tls.enabled }}
value: "{{ .Values.telemetry.trace.otlp.tls.enabled }}"
{{- end }}
Copy link

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

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

The PR description says this change "includes" OPENFGA_TRACE_OTLP_TLS_ENABLED in the deployment, but this template block already existed; the actual change is quoting/casting the value. It may be worth updating the PR description to avoid confusion for reviewers and release notes.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants