Skip to content

Add Windows subsection to the installation section of the Envoy docs#15699

Merged
mattklein123 merged 1 commit intoenvoyproxy:mainfrom
rmiller14:docs_windows_install
Apr 1, 2021
Merged

Add Windows subsection to the installation section of the Envoy docs#15699
mattklein123 merged 1 commit intoenvoyproxy:mainfrom
rmiller14:docs_windows_install

Conversation

@rmiller14
Copy link
Copy Markdown
Contributor

@rmiller14 rmiller14 commented Mar 26, 2021

Commit Message:

Add Windows subsection to the installation section of the Envoy docs.

Risk Level: Low
Testing: Built the documentation.
Docs Changes: The installation section of the Envoy docs is missing Windows-specific instructions. This PR adds a subsection for installing on Windows, which today only includes using the envoy-windows-dev Docker image.

Addresses #14605.

Signed-off-by: Randy Miller <rmiller14@gmail.com>
@phlax
Copy link
Copy Markdown
Member

phlax commented Mar 26, 2021

@phlax
Copy link
Copy Markdown
Member

phlax commented Mar 29, 2021

im wondering if there is a non "dev" image for windows.

im aware that the current instructions for linux-based image is using the "latest" dev image but i think that was a mistake on my part - i opened a ticket here to deal with it #15730

@wrowe
Copy link
Copy Markdown
Contributor

wrowe commented Mar 29, 2021

The first non-dev image should occur with the 1.18.0 tag, the logic wasn't in place with 1.17.x branch... IIUC, @sunjayBhatia or @lizan can you confirm?

@sunjayBhatia
Copy link
Copy Markdown
Member

Yeah this image should be pushed with the 1.18.0 release: https://hub.docker.com/r/envoyproxy/envoy-windows (the repo wasn't created yet for the 1.17.x line yet)

@phlax
Copy link
Copy Markdown
Member

phlax commented Mar 29, 2021

not sure which way round to deal with this, i can fix the issue above and then you can adjust this PR to add it - or alternately you could land this and ill move it to the dev section

@lizan
Copy link
Copy Markdown
Member

lizan commented Mar 29, 2021

I already created the repo but it won't have any image before 1.18.0.

@rmiller14
Copy link
Copy Markdown
Contributor Author

Can we make an issue to track updating this documentation once the windows release image has been published? I think this PR is good enough for anyone who wants to get a hold of an envoy binary today, right?

@phlax
Copy link
Copy Markdown
Member

phlax commented Mar 29, 2021

i think the issue is that the existing docs are showing the dev image "as if" they were production images - which is wrong - and this risks making the problem worse

@phlax
Copy link
Copy Markdown
Member

phlax commented Mar 29, 2021

hmm - i think that #15730 and #15744 are the same issue - @lizan can you confirm ?

its supposed to show the latest/dev image in the latest docs - altho - for the reasons above i think we need to separate this even in latest docs

and for some reason the release docs are being tagged pre-release

Copy link
Copy Markdown
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.

@rmiller14 thanks for this

i think best land this - and we can resolve the issue/s with dev/production images separately - the underlying issue is unrelated to this PR

@rmiller14
Copy link
Copy Markdown
Contributor Author

@lizan @mattklein123 can we get this merged please?

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.

7 participants