Skip to content

Conversation

dshatokhin
Copy link
Contributor

What type of PR is this?

This PR creates an instruction in the documentation about running Envoy Gateway Standalone in a container environment

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #5054

Release Notes: No

@dshatokhin dshatokhin requested a review from a team as a code owner January 29, 2025 19:43
@dshatokhin dshatokhin force-pushed the standalone-in-a-container branch from 472d451 to 3e818ba Compare January 29, 2025 19:44
Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.86%. Comparing base (57d4aa8) to head (6d4b769).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5172      +/-   ##
==========================================
- Coverage   66.87%   66.86%   -0.01%     
==========================================
  Files         210      210              
  Lines       32979    32979              
==========================================
- Hits        22054    22052       -2     
- Misses       9586     9588       +2     
  Partials     1339     1339              

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

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
@dshatokhin dshatokhin force-pushed the standalone-in-a-container branch from 3e818ba to 79805b5 Compare January 29, 2025 21:09
@dshatokhin
Copy link
Contributor Author

In my instructions I hardcoded envoyproxy/gateway:v1.3.0-rc.1 as an image because can't find defined shortcode for image tag, how can I approach it?

@dshatokhin dshatokhin changed the title docs: add standalone in container instruction wip: docs: add standalone in container instruction Jan 30, 2025
@@ -16,7 +16,7 @@ Currently, Envoy Gateway only support the file provider and the host infrastruct
- The file provider will configure the Envoy Gateway to get all gateway-api resources from file system.
- The host infrastructure provider will configure the Envoy Gateway to deploy one Envoy Proxy as a host process.

## Quick Start
## Quick Start Locally
Copy link
Contributor

Choose a reason for hiding this comment

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

you can make # QuickStart a top level heading and ## Running locally on the host machine and ## Running in a Docker Container as another sub heading

Copy link
Contributor Author

@dshatokhin dshatokhin Jan 30, 2025

Choose a reason for hiding this comment

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

Good suggestion, sent a new version.

I'm trying to avoid docker as a prefix for container so changed heading slightly

Copy link
Contributor

@arkodg arkodg Jan 30, 2025

Choose a reason for hiding this comment

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

but the docs shows the docker CLI 🙃

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
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 merged commit a3448c1 into envoyproxy:main Jan 30, 2025
27 checks passed
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

---------

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

---------

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

---------

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

---------

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
(cherry picked from commit a3448c1)
Signed-off-by: Guy Daich <guy.daich@sap.com>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

---------

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
(cherry picked from commit a3448c1)
Signed-off-by: Guy Daich <guy.daich@sap.com>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

---------

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
(cherry picked from commit a3448c1)
Signed-off-by: Guy Daich <guy.daich@sap.com>
guydc added a commit that referenced this pull request Jan 31, 2025
* doc: response compression (#5071)

compression docs

Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>
(cherry picked from commit 549fdde)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* docs: how to specify a self-signed ca for the remote jwks host in the SP JWT settings. (#5085)

* docs for jwt self-signed ca

Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>

* fix gen

Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>

* update docs

Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>

---------

Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>
(cherry picked from commit fdc7849)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* chore: fix gen (#5166)

fix gen

Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
(cherry picked from commit 34db8af)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* docs: add api key auth instructions (#5097)

* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <nothinux@gmail.com>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <nothinux@gmail.com>

---------

Signed-off-by: Taufik Mulyana <nothinux@gmail.com>
(cherry picked from commit b5cf087)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* add SECURITY.md (#5167)

Signed-off-by: Arko Dasgupta <arko@tetrate.io>
(cherry picked from commit f7a10eb)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* chore: link SECURITY.md (#5168)

Signed-off-by: Arko Dasgupta <arko@tetrate.io>
(cherry picked from commit ac9026f)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* build(deps): bump actions/stale from 9.0.0 to 9.1.0 (#5162)

Bumps [actions/stale](https://github.com/actions/stale) from 9.0.0 to 9.1.0.
- [Release notes](https://github.com/actions/stale/releases)
- [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md)
- [Commits](actions/stale@28ca103...5bef64f)

---
updated-dependencies:
- dependency-name: actions/stale
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com>
(cherry picked from commit 57d4aa8)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* docs: rm sectionName from some of the examples (#5173)

adds whats left off from #4868

deleted the sectionName in these examples because the Service spec does
not define a port `Name`

Signed-off-by: Arko Dasgupta <arko@tetrate.io>
(cherry picked from commit 45804e2)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* ci(fix): osv-scanner PR mode (#5174)

fix: osv-scanner PR mode

Signed-off-by: shahar-h <shahar.harari@sap.com>
Co-authored-by: Guy Daich <guy.daich@sap.com>
(cherry picked from commit e904d3f)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* wip: docs: add standalone in container instruction (#5172)

* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>

---------

Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
(cherry picked from commit a3448c1)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* docs: update prerequisites files with installation and connectivity t… (#5094)

* docs: update prerequisites files with installation and connectivity testing steps

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

* lint

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

* docs: remove the Note

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

* remove redundant code

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>

---------

Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>
(cherry picked from commit 3253339)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* [release/v1.3] fix 1.3.0-rc.1 release note (#5175)

* fix 1.3.0-rc.1 release note

Signed-off-by: Guy Daich <guy.daich@sap.com>

* more fixes

Signed-off-by: Guy Daich <guy.daich@sap.com>

---------

Signed-off-by: Guy Daich <guy.daich@sap.com>
(cherry picked from commit 4fba2bf)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* fail validation if baseInterval is 0s (#5176)

* fail validation if baseInterval is 0s

Fixes: #5147

Signed-off-by: Arko Dasgupta <arko@tetrate.io>

* more validations

Signed-off-by: Arko Dasgupta <arko@tetrate.io>

---------

Signed-off-by: Arko Dasgupta <arko@tetrate.io>
(cherry picked from commit 4844d9a)
Signed-off-by: Guy Daich <guy.daich@sap.com>

* [release/1.3] release notes (#5177)

Signed-off-by: Guy Daich <guy.daich@sap.com>
(cherry picked from commit c2215b2)
Signed-off-by: Guy Daich <guy.daich@sap.com>

---------

Signed-off-by: Huabing Zhao <zhaohuabing@gmail.com>
Signed-off-by: Guy Daich <guy.daich@sap.com>
Signed-off-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Signed-off-by: Taufik Mulyana <nothinux@gmail.com>
Signed-off-by: Arko Dasgupta <arko@tetrate.io>
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: shahar-h <shahar.harari@sap.com>
Signed-off-by: Denis Shatokhin <d_shatokhin@outlook.com>
Signed-off-by: DeeBi9 <deepanshudb1@gmail.com>
Co-authored-by: Huabing (Robin) Zhao <zhaohuabing@gmail.com>
Co-authored-by: Taufik Mulyana <17433202+nothinux@users.noreply.github.com>
Co-authored-by: Arko Dasgupta <arkodg@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: shahar-h <shahar.harari@sap.com>
Co-authored-by: Denis Shatokhin <d_shatokhin@outlook.com>
Co-authored-by: Deepanshu Bisht <113498676+DeeBi9@users.noreply.github.com>
@dshatokhin dshatokhin deleted the standalone-in-a-container branch January 31, 2025 18:14
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.

docs: Steps for running envoy-gateway in standalone mode in docker
3 participants