-
Notifications
You must be signed in to change notification settings - Fork 4.7k
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: add section for running Envoy via CLI #21811
Conversation
Basic example on how to run Envoy from the CLI. Signed-off-by: Lucas Martinez <57833320+martinezlucas98@users.noreply.github.com>
Docs for this Pull Request will be rendered here: https://storage.googleapis.com/envoy-pr/21811/docs/index.html The docs are (re-)rendered each time the CI |
Hi @martinezlucas98, welcome and thank you for your contribution. We will try to review your Pull Request as quickly as possible. In the meantime, please take a look at the contribution guidelines if you have not done so already. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@martinezlucas98 thanks for working on this, i agree it would be helpful to provide some further information about running the built binary - a couple of comments inline
Apply @phlax suggestions from code review Signed-off-by: Lucas Martinez <57833320+martinezlucas98@users.noreply.github.com> Co-authored-by: phlax <phlax@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@martinezlucas98 i think we want to resolve the bazel path issue - then this should be good to land
/wait |
…ole command Resolves Bazel's output path issues as stated in envoyproxy#21811 by @daixiang0 and @phlax Signed-off-by: Lucas Martinez <57833320+martinezlucas98@users.noreply.github.com>
Great 👍 , I just added it. Got any suggestions? |
Information about bazel's command `bazel info bazel-genfiles` seems unnecessary in this section. Signed-off-by: Lucas Martinez <57833320+martinezlucas98@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one last ask - would you mind moving this section below all of the build instructions - just above "Testing Envoy with Bazel"
probs you should promote the header also - i think its kinda its own section
I was also thinking about that 🤔, I''ll update it |
… with Bazel" Signed-off-by: Lucas Martinez <57833320+martinezlucas98@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great, lgtm, thanks @martinezlucas98
As a beginner I've had a tough time getting around Envoy. One of the things that got me scratching my head for a while was "how to run Envoy directly from the CLI?".
Although testing Envoy with bazel is magnificently documented (10/10 to whoever wrote it), I couldn't find much information on how to run Envoy from the CLI.
I believe this small section will be of great use for beginners, although I'm not convinced if this doc is the right one for the "Running envoy via CLI" section. What do you thing?
Signed-off-by: Lucas Martinez 57833320+martinezlucas98@users.noreply.github.com