admin: make admin HTML a compile-time option#21814
Merged
jmarantz merged 9 commits intoenvoyproxy:mainfrom Jun 24, 2022
Merged
Conversation
Signed-off-by: Joshua Marantz <jmarantz@google.com>
Signed-off-by: Joshua Marantz <jmarantz@google.com>
Signed-off-by: Joshua Marantz <jmarantz@google.com>
Signed-off-by: Joshua Marantz <jmarantz@google.com>
Signed-off-by: Joshua Marantz <jmarantz@google.com>
Signed-off-by: Joshua Marantz <jmarantz@google.com>
Signed-off-by: Joshua Marantz <jmarantz@google.com>
jmarantz
changed the title
jmarantz
commented
Jun 22, 2022
| EXPECT_THAT(response->body(), HasSubstr("admin commands are:")); | ||
|
|
||
| EXPECT_EQ("200", request("admin", "GET", "/", response)); | ||
| #ifdef ENVOY_ADMIN_HTML |
Contributor
Author
There was a problem hiding this comment.
note: in other cases I did not need a -D for this, but it seemed painful to tweak this particular test without it.
I have this gut feel that this define is costly from a build perspective since it is passed on every compile-command, even though it's needed only by one test.
LMK if you think I should re-work this somehow.
jmarantz
commented
Jun 22, 2022
| @@ -0,0 +1,122 @@ | |||
| #include "source/common/html/utility.h" | |||
Contributor
Author
There was a problem hiding this comment.
note to reviewers: this code is unchanged; just moved.
jmarantz
commented
Jun 22, 2022
| namespace Envoy { | ||
| namespace Server { | ||
|
|
||
| Http::Code AdminImpl::handlerAdminHome(absl::string_view, Http::ResponseHeaderMap& response_headers, |
Contributor
Author
There was a problem hiding this comment.
this block here is the only new code in the PR.
mattklein123
requested changes
Jun 23, 2022
Member
mattklein123
left a comment
mattklein123
left a comment
There was a problem hiding this comment.
Thanks LGTM with a small comment. Thank you!
/wait
Comment on lines
+321
to
+325
| config_setting( | ||
| name = "disable_admin_html", | ||
| values = {"define": "admin_html=disabled"}, | ||
| ) | ||
|
|
Member
There was a problem hiding this comment.
Can you document this here? https://github.com/envoyproxy/envoy/tree/main/bazel#disabling-optional-features
Probably also worth a release note?
Signed-off-by: Joshua Marantz <jmarantz@google.com>
Contributor
Author
|
/retest |
|
Retrying Azure Pipelines: |
Contributor
Author
|
Thanks Matt! |
Amila-Rukshan
pushed a commit
to Amila-Rukshan/envoy
that referenced
this pull request
Jun 28, 2022
Commit Message: Make the HTML view for stats a compile-time option, defaulting to on. This PR doesn't change any code-paths, but it moves the HTML support into a separate file, compiled into //source/server/admin:admin_lib. In the future, and admin_html_lib will be added, built only when admin-html is not disabled. That will allow envoyproxy#19546 and ultimately envoyproxy#18670 to proceed. To disable, compile with `--define=admin_html=disabled`, in which case the admin `"/"` endpoint will just print that the thml mode was disabled. Additional Description: This PR is a step toward solving envoyproxy#18675 Risk Level: low -- this just moves code around and doesn't change it at all. Testing: //test/..., both with and without `--define=admin_html=disabled` Docs Changes: included Release Notes: included Platform Specific Features: n/a Signed-off-by: Joshua Marantz <jmarantz@google.com> Signed-off-by: Amila Senadheera <amila.15@cse.mrt.ac.lk>
jpsim
added a commit
to envoyproxy/envoy-mobile
that referenced
this pull request
Jun 28, 2022
This isn't something we want to expose when running Envoy Mobile. For more details: envoyproxy/envoy#21814 Signed-off-by: JP Simard <jp@jpsim.com>
This was referenced Jul 19, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Commit Message: Make the HTML view for stats a compile-time option, defaulting to on. This PR doesn't change any code-paths, but it moves the HTML support into a separate file, compiled into //source/server/admin:admin_lib. In the future, and admin_html_lib will be added, built only when admin-html is not disabled. That will allow #19546 and ultimately #18670 to proceed.
To disable, compile with
--define=admin_html=disabled, in which case the admin"/"endpoint will just print that the thml mode was disabled.Additional Description: This PR is a step toward solving #18675
Risk Level: low -- this just moves code around and doesn't change it at all.
Testing: //test/..., both with and without
--define=admin_html=disabledDocs Changes: included
Release Notes: included
Platform Specific Features: n/a