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

feat: support Envoy extra args #2489

Merged
merged 7 commits into from
Jan 24, 2024
Merged

Conversation

shahar-h
Copy link
Contributor

What this PR does / why we need it:
Add support for providing Envoy extra command line options via EnvoyProxy resource.
Sample use case: disable some Envoy extension by providing --disable-extensions arg.

Which issue(s) this PR fixes:
Fixes #2479

Signed-off-by: Shahar Harari <shahar.harari@sap.com>
Signed-off-by: Shahar Harari <shahar.harari@sap.com>
@shahar-h shahar-h requested a review from a team as a code owner January 23, 2024 21:00
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (daa2c23) 64.65% compared to head (0309e5d) 64.70%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2489      +/-   ##
==========================================
+ Coverage   64.65%   64.70%   +0.05%     
==========================================
  Files         115      115              
  Lines       17472    17475       +3     
==========================================
+ Hits        11296    11307      +11     
+ Misses       5454     5447       -7     
+ Partials      722      721       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

arkodg
arkodg previously approved these changes Jan 23, 2024
Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

LGTM thanks !

@arkodg arkodg requested review from a team January 23, 2024 21:40
@@ -67,6 +67,12 @@ type EnvoyProxySpec struct {
// +optional
Concurrency *int32 `json:"concurrency,omitempty"`

// ExtraArgs defines additional command line options that are provided to Envoy.
// More info: https://www.envoyproxy.io/docs/envoy/latest/operations/cli#command-line-options
//
Copy link
Member

Choose a reason for hiding this comment

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

can you add a warning message about duplicate arg?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I add a generic message or specify all internal args that can't be used(--service-cluster, --service-node, --log-level, --conponent-log-level, --concurrency, --config-yaml, --cpuset-threads)?

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine to not list all of them.

Copy link
Contributor Author

@shahar-h shahar-h Jan 24, 2024

Choose a reason for hiding this comment

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

That's what I thought, thanks.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added

Copy link
Member

@zhaohuabing zhaohuabing Jan 24, 2024

Choose a reason for hiding this comment

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

It may be useful to tell users which args can/can't be configured through ExtraArgs in the comment here. So they won't have to try and fail. And we can add validation here as well.

Copy link
Contributor

@shawnh2 shawnh2 left a comment

Choose a reason for hiding this comment

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

lgtm, thanks

@shahar-h
Copy link
Contributor Author

Should I also add a sample usage in the user guide?

@zirain
Copy link
Member

zirain commented Jan 24, 2024

Should I also add a sample usage in the user guide?

yes, that would be better, and you can do that with a follow up PR.

Signed-off-by: Shahar Harari <shahar.harari@sap.com>
Signed-off-by: Shahar Harari <shahar.harari@sap.com>
Signed-off-by: Shahar Harari <shahar.harari@sap.com>
Copy link
Member

@zirain zirain left a comment

Choose a reason for hiding this comment

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

LGTM, defer to @arkodg

@arkodg
Copy link
Contributor

arkodg commented Jan 24, 2024

hey @shahar-h can you run make generate and commit those changes and repush ?

Signed-off-by: Shahar Harari <shahar.harari@sap.com>
@shahar-h
Copy link
Contributor Author

hey @shahar-h can you run make generate and commit those changes and repush ?

done

@arkodg arkodg merged commit 100d310 into envoyproxy:main Jan 24, 2024
20 checks passed
@shahar-h shahar-h deleted the envoy-extra-args branch January 24, 2024 17:55
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.

Support disablement of Envoy extensions
5 participants