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: add section for running Envoy via CLI #21811

Merged
merged 5 commits into from
Jul 1, 2022

Conversation

martinezlucas98
Copy link
Contributor

@martinezlucas98 martinezlucas98 commented Jun 21, 2022

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?

PS, in case there is already information on this topic, maybe we should make it more visible or easy to find.

Signed-off-by: Lucas Martinez 57833320+martinezlucas98@users.noreply.github.com

Basic example on how to run Envoy from the CLI.

Signed-off-by: Lucas Martinez <57833320+martinezlucas98@users.noreply.github.com>
@repokitteh-read-only
Copy link

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 envoy-presubmit (precheck docs) job completes.

🐱

Caused by: #21811 was opened by martinezlucas98.

see: more, trace.

@repokitteh-read-only
Copy link

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.

🐱

Caused by: #21811 was opened by martinezlucas98.

see: more, trace.

bazel/README.md Outdated Show resolved Hide resolved
Copy link
Member

@phlax phlax left a 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

bazel/README.md Outdated Show resolved Hide resolved
bazel/README.md Outdated Show resolved Hide resolved
bazel/README.md Outdated Show resolved Hide resolved
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>
Copy link
Member

@phlax phlax left a 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

@phlax
Copy link
Member

phlax commented Jun 27, 2022

/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>
@martinezlucas98
Copy link
Contributor Author

@martinezlucas98 i think we want to resolve the bazel path issue - then this should be good to land

Great 👍 , I just added it. Got any suggestions?

bazel/README.md Outdated Show resolved Hide resolved
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>
bazel/README.md Outdated Show resolved Hide resolved
Copy link
Member

@phlax phlax left a 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

@martinezlucas98
Copy link
Contributor Author

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>
Copy link
Member

@phlax phlax left a 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

@phlax phlax merged commit a7f2344 into envoyproxy:main Jul 1, 2022
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.

None yet

3 participants