Skip to content

docs: record distroless images #16359

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.

Sign up for GitHub

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

Merged
phlax merged 4 commits into from
May 10, 2021
Merged

docs: record distroless images #16359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b56c382
docs: record distroless images
daixiang0 May 6, 2021
382ba76
feedback
daixiang0 May 7, 2021
8e3531f
feedback
daixiang0 May 7, 2021
568eea1
update comment
daixiang0 May 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,15 @@ def setup(app):

# Setup global substitutions
if 'pre-release' in release_level:
substitutions = [('|envoy_docker_image|', 'envoy-dev:{}'.format(blob_sha)),
('|envoy_windows_docker_image|', 'envoy-windows-dev:{}'.format(blob_sha))]
substitutions = [
('|envoy_docker_image|', 'envoy-dev:{}'.format(blob_sha)),
('|envoy_windows_docker_image|', 'envoy-windows-dev:{}'.format(blob_sha)),
('|envoy_distroless_docker_image|', 'envoy-distroless-dev:{}'.format(blob_sha))
]
else:
substitutions = [('|envoy_docker_image|', 'envoy:{}'.format(blob_sha)),
('|envoy_windows_docker_image|', 'envoy-windows:{}'.format(blob_sha))]
('|envoy_windows_docker_image|', 'envoy-windows:{}'.format(blob_sha)),
('|envoy_distroless_docker_image|', 'envoy-distroless:{}'.format(blob_sha))]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
19 changes: 19 additions & 0 deletions docs/root/start/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,13 @@ The following commands will pull and show the Envoy version of current images.
$ docker pull envoyproxy/|envoy_docker_image|
$ docker run --rm envoyproxy/|envoy_docker_image| --version

.. tab:: Envoy (distroless)

.. substitution-code-block:: console

$ docker pull envoyproxy/|envoy_distroless_docker_image|
$ docker run --rm envoyproxy/|envoy_distroless_docker_image| --version

.. tab:: Get Envoy

.. code-block:: console
Expand Down Expand Up @@ -201,6 +208,12 @@ The following table shows the available Docker images
- |DOCKER_IMAGE_TAG_NAME|
-
-
* - `envoyproxy/envoy-distroless <https://hub.docker.com/r/envoyproxy/envoy-distroless/tags/>`_
- Release binary with symbols stripped on top of a distroless base.
- |DOCKER_IMAGE_TAG_NAME|
-
-
-
* - `envoyproxy/envoy-alpine <https://hub.docker.com/r/envoyproxy/envoy-alpine/tags/>`_
- Release binary with symbols stripped on top of a **glibc** alpine base.
- |DOCKER_IMAGE_TAG_NAME|
Expand All @@ -225,6 +238,12 @@ The following table shows the available Docker images
-
- latest
- latest
* - `envoyproxy/envoy-distroless-dev <https://hub.docker.com/r/envoyproxy/envoy-distroless-dev/tags/>`_
- Release binary with symbols stripped on top of a distroless base.
-
-
- latest
-
* - `envoyproxy/envoy-alpine-dev <https://hub.docker.com/r/envoyproxy/envoy-alpine-dev/tags/>`_
- Release binary with symbols stripped on top of a **glibc** alpine base.
-
Expand Down