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

doc: add standalone deployment doc #4518

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

shawnh2
Copy link
Contributor

@shawnh2 shawnh2 commented Oct 24, 2024

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #1393

Release Notes: No

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.64%. Comparing base (9c9f435) to head (75894a4).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4518      +/-   ##
==========================================
- Coverage   65.66%   65.64%   -0.03%     
==========================================
  Files         211      211              
  Lines       31689    31689              
==========================================
- Hits        20810    20801       -9     
- Misses       9677     9686       +9     
  Partials     1202     1202              

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

@shawnh2 shawnh2 marked this pull request as ready for review October 26, 2024 13:50
@shawnh2 shawnh2 requested a review from a team as a code owner October 26, 2024 13:50
Compile Envoy Gateway binary from project by using command:

```shell
make build
Copy link
Contributor Author

Choose a reason for hiding this comment

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

currently, we let users to build envoy-gateway binary from scratch. should we include this binary in release ?

Copy link
Contributor

@zirain zirain Oct 27, 2024

Choose a reason for hiding this comment

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

Even in standalone mode, we should use docker instead of pure binary?

Copy link
Member

Choose a reason for hiding this comment

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

For now, I think it's fine to use docker to spin up the EG in the documentation.

However, we should include the binaries to the release assets and update the doc to add the binary option. This can be addressed is a follow-up PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

we shouldnt be use make command here, instead either use GH releases assets https://github.com/envoyproxy/gateway/releases/tag/v1.2.0-rc.1 (if envoy-gateway is not present, we should consider pushing it), or Docker Image, my vote is for GH releases

Copy link
Contributor

Choose a reason for hiding this comment

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

if you build binary, you will need to support all the platforms(e.g. macos, windows), TBH, I think there's a kind of waste?

Copy link
Contributor

Choose a reason for hiding this comment

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

it's 2024, Docker is enough for 99% of the cases.

Copy link
Contributor

Choose a reason for hiding this comment

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

there are many production environments/server thats are running a server with a manager like systemd that have no docker installed

Copy link
Contributor

Choose a reason for hiding this comment

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

similar to envoyproxy https://github.com/envoyproxy/envoy/releases/tag/v1.32.0 , imo linux-x86_64 is good enough for now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

like @zhaohuabing 's idea. we should include eg binary in release, and maybe just for linux only, this can be done as a follow-up.

but for now, using docker to start eg sgtm.

Copy link
Contributor

Choose a reason for hiding this comment

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

raised #4566 to track the GH release work

@shawnh2
Copy link
Contributor Author

shawnh2 commented Oct 26, 2024

wait #4535

@shawnh2 shawnh2 added documentation Improvements or additions to documentation hold do not merge area/standalone Issues related to the standalone mode and removed hold do not merge labels Oct 26, 2024
@shawnh2
Copy link
Contributor Author

shawnh2 commented Oct 27, 2024

/retest

{{% /alert %}}

Envoy Gateway also supports running in standalone mode. In this mode, you can configure the
Envoy Gateway to use different file provider and infrastructure provider combinations.
Copy link
Member

@zhaohuabing zhaohuabing Oct 28, 2024

Choose a reason for hiding this comment

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

Not a strong opinion , non-blocking - this would be a bit confusing for readers. I suggest removing this and rephrase the standalone mode as the only support combination is the file provider and the host infrastructure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/standalone Issues related to the standalone mode documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Run Envoy Gateway locally on host
4 participants