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

Update operator integration statuses and cli arg options #1251

Closed
wants to merge 13 commits into from

Conversation

jvoravong
Copy link
Contributor

@jvoravong jvoravong commented Apr 15, 2024

Description:

  • Move to using operator command line args to enable instrumentation
    • The operator added support for these args in v0.99.0 of the operator.
    • Update NOTES.txt and documentation for new usage. Made sure to add user migration notes.
  • Manually update the operator application to v0.99.0
    • During this work I found a blocker that prohibits us from upgrading the operator chart past v0.49.1, so we will only update the application for now.
    • Disabled the related CI/CD pipeline for now, add TODOs to fix it later.

@jvoravong jvoravong marked this pull request as ready for review April 29, 2024 15:04
@jvoravong jvoravong requested review from a team as code owners April 29, 2024 15:04
@jvoravong jvoravong requested a review from aunshc April 29, 2024 16:24
@jvoravong
Copy link
Contributor Author

jvoravong commented Apr 30, 2024

@jvoravong jvoravong marked this pull request as draft April 30, 2024 16:36
@jvoravong jvoravong changed the title Update operator integration statuses and feature gate options Update operator integration statuses and cli arg options Apr 30, 2024
@jvoravong jvoravong marked this pull request as ready for review May 17, 2024 15:44
UPGRADING.md Show resolved Hide resolved
.chloggen/add-operator-cli-args.yaml Show resolved Hide resolved
yaml_file_path: 'helm-charts/splunk-otel-collector/Chart.yaml'
dependency_name: 'opentelemetry-operator'
# TODO: Add this back once this chart has been updated to adhere to
# the operator chart schema validation rules. See: https://github.com/open-telemetry/opentelemetry-helm-charts/pull/1065
Copy link
Contributor

Choose a reason for hiding this comment

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

What extra properties do we supply?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The upstream operator chart doesn't have a field to enable adding default instrumentation anymore since open-telemetry/opentelemetry-helm-charts#1065 was added. This affected us and other companies.

Copy link
Contributor

@dmitryax dmitryax May 17, 2024

Choose a reason for hiding this comment

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

doesn't have a field to enable adding default instrumentation

Which field in instrumentation.*?

Copy link
Contributor

@dmitryax dmitryax May 17, 2024

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

We should've not used a section that is supposed to be passed to the sub-chart for our own purposes. Now we should either:

  1. move instrumentation out from operator breaking users relying on this option
  2. or change the operator alias breaking user passing stuff to the operator.

The second option seems preferable to me. Similar to what you do, but instead of removing subchart, remove the alias

Copy link
Contributor

@dmitryax dmitryax May 17, 2024

Choose a reason for hiding this comment

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

I understand. But this is still wrong. open-telemetry/opentelemetry-helm-charts#1065 should not be reverted. There is nothing wrong with that PR

Copy link
Contributor

Choose a reason for hiding this comment

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

Trying to explain why it's wrong: Imagine the sub-chart adds support of the instrumentation section with conflicting behavior.

Copy link
Contributor

@dmitryax dmitryax May 17, 2024

Choose a reason for hiding this comment

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

Actually, I think we should move instrumentation out of operator and keep the alias. Otherwise we break operator.enabled and operator.admissionWebhooks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • Yeah option 1 is starting to sound good to me. Going to think on it a little more. I wanted to handle updating our instrumentation helm values as part of a separate ticket.
  • I should also mention the related blocker for this PR. The operator replaced several instrumentation feature gates with command-line arguments incrementally from version 0.95.0 (used before this PR) to version 0.99.0 (used after this PR). This is why I want to upgrade to operator v0.99.0 in this PR. Otherwise, our documentation would have to include feature gates and CLI arguments at the same time which is more confusing.

Copy link
Contributor Author

@jvoravong jvoravong May 23, 2024

Choose a reason for hiding this comment

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

This ticket is blocked until we complete the following in a separate PR.

  • Complete option 1, move operator.instrumentation out of the operator sub-chart values.
  • Upgrade the operator sub-chart to the latest version
  • This will include moving some code from this PR to the separate PR.

@atoulme atoulme closed this Oct 1, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants