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

Docs mistake: enabling feature gates #2390

Closed
artem-nefedov opened this issue Nov 27, 2023 · 2 comments · Fixed by #2391
Closed

Docs mistake: enabling feature gates #2390

artem-nefedov opened this issue Nov 27, 2023 · 2 comments · Fixed by #2391
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@artem-nefedov
Copy link
Contributor

artem-nefedov commented Nov 27, 2023

Component(s)

No response

What happened?

Documentation currently contains an example on how to enable a feature gate via values in helm chart:

helm install opentelemetry-operator open-telemetry/opentelemetry-operator --set manager.featureGates=operator.autoinstrumentation.multi-instrumentation=enabled

If you try to use this example, controller won't be able to start, and will throw an error:

invalid argument "operator.autoinstrumentation.multi-instrumentation=enabled" for "--feature-gates" flag: no such feature gate "operator.autoinstrumentation.multi-instrumentation=enabled"

According to description of --feature-gates option, the correct way is without "=enabled" at the end (confirmed to work):

helm install opentelemetry-operator open-telemetry/opentelemetry-operator --set manager.featureGates=operator.autoinstrumentation.multi-instrumentation
 --feature-gates flag                               Comma-delimited list of feature gate identifiers. Prefix with '-' to disable the feature. '+' or no prefix will enable the feature. (default operator.autoinstrumentation.apache-httpd,operator.autoinstrumentation.dotnet,-operator.autoinstrumentation.go,operator.autoinstrumentation.java,-operator.autoinstrumentation.multi-instrumentation,-operator.autoinstrumentation.nginx,operator.autoinstrumentation.nodejs,operator.autoinstrumentation.python,operator.collector.rewritetargetallocator,-operator.observability.prometheus)

Kubernetes Version

Operator version

v0.89.0

Collector version

Environment information

No response

Log output

No response

Additional context

No response

@artem-nefedov artem-nefedov added bug Something isn't working needs triage labels Nov 27, 2023
@jaronoff97 jaronoff97 added documentation Improvements or additions to documentation good first issue Good for newcomers and removed needs triage labels Nov 27, 2023
@jaronoff97
Copy link
Contributor

Yeah good catch – do you want to make the fix given it's minor? If not, I'll see if anyone else can make the change.

@artem-nefedov
Copy link
Contributor Author

Sure, I'll post a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants