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.

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

Fix Operator helm template issues #943

Merged
merged 11 commits into from
Oct 5, 2023
Merged

Conversation

jvoravong
Copy link
Contributor

@jvoravong jvoravong commented Oct 3, 2023

Description:

This PR resolves multiple smaller issues in the Helm template related to the of non-default Operator auto-instrumentation values, which previously could trigger deployment failures.

Link to Splunk Idea: #938 (Refers to Issue 1)

Issue 1:

  • Affected Values:
    • splunkObservability.profilingEnabled
  • Root Issue:
    • The helper splunk-otel-collector.operator.extract-name-keys-from-dict-list returns a list that wasn’t being casted accurately where used, necessitating a toYaml or toJson for proper interpretation.
  • Fix:
    • Refactor splunk-otel-collector.operator.extract-name-keys-from-dict-list to splunk-otel-collector.operator.env-has to exclusively return "true" or "false" string values.

Issue 2:

  • Affected Values:
    • operator.instrumentation.spec.env
    • operator.instrumentation.spec.sampler
  • Root Issue:
    • Incorrect usage of the include function; a combination of "with" + "toYaml" should have been utilized instead.
  • Fix:
    • Employ the appropriate "with" + "toYaml" mechanism instead of the "include" function.

Issue 3:

  • Affected Values:
    • operator.instrumentation.spec.{instrumentation_library}.env
  • Root Issue:
    • Environment variable values equal to "true" and "false" (strings) are being converted into booleans, presumably due to the involved printf function. Environment variables set in opentelemetry.io/v1alpha1 Instrumentation must be strings.
  • Fix:
    • Guarantee that quotes are rendered in the final manifests for environment variables using the quote function.

Testing:
The new example has been tested; it is both renderable and deployable locally.

@jvoravong jvoravong requested review from a team as code owners October 3, 2023 22:42
@jvoravong jvoravong changed the title Fix Operator helm template bug Fix Operator helm template issues Oct 4, 2023
@jvoravong jvoravong merged commit ed11bd9 into signalfx:main Oct 5, 2023
19 checks passed
@jvoravong jvoravong deleted the otl-op-fix branch October 5, 2023 18:32
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.

2 participants