docs/examples: Assorted cleanups

.github/workflows/_stage_verify.yml

@@ -85,5 +85,5 @@ jobs:
                 export DEBIAN_FRONTEND=noninteractive
                 sudo apt-get -qq update -y
                 sudo apt-get -qq install -y --no-install-recommends expect gettext whois
-                sudo snap install yq
+                pip install -r ./.github/workflows/verify-requirements.txt
               shell: bash

.github/workflows/verify-requirements.in

@@ -0,0 +1 @@
+yq

.github/workflows/verify-requirements.txt

@@ -0,0 +1,74 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile --allow-unsafe --generate-hashes verify-requirements.in
+#
+argcomplete==3.2.1 \
+    --hash=sha256:30891d87f3c1abe091f2142613c9d33cac84a5e15404489f033b20399b691fec \
+    --hash=sha256:437f67fb9b058da5a090df505ef9be0297c4883993f3f56cb186ff087778cfb4
+    # via yq
+pyyaml==6.0.1 \
+    --hash=sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5 \
+    --hash=sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc \
+    --hash=sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df \
+    --hash=sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741 \
+    --hash=sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206 \
+    --hash=sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27 \
+    --hash=sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595 \
+    --hash=sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62 \
+    --hash=sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98 \
+    --hash=sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696 \
+    --hash=sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290 \
+    --hash=sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9 \
+    --hash=sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d \
+    --hash=sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6 \
+    --hash=sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867 \
+    --hash=sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47 \
+    --hash=sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486 \
+    --hash=sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6 \
+    --hash=sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3 \
+    --hash=sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007 \
+    --hash=sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938 \
+    --hash=sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0 \
+    --hash=sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c \
+    --hash=sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735 \
+    --hash=sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d \
+    --hash=sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28 \
+    --hash=sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4 \
+    --hash=sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba \
+    --hash=sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8 \
+    --hash=sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5 \
+    --hash=sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd \
+    --hash=sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3 \
+    --hash=sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0 \
+    --hash=sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515 \
+    --hash=sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c \
+    --hash=sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c \
+    --hash=sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924 \
+    --hash=sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34 \
+    --hash=sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43 \
+    --hash=sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859 \
+    --hash=sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673 \
+    --hash=sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54 \
+    --hash=sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a \
+    --hash=sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b \
+    --hash=sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab \
+    --hash=sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa \
+    --hash=sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c \
+    --hash=sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585 \
+    --hash=sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d \
+    --hash=sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f
+    # via yq
+tomlkit==0.12.3 \
+    --hash=sha256:75baf5012d06501f07bee5bf8e801b9f343e7aac5a92581f20f80ce632e6b5a4 \
+    --hash=sha256:b0a645a9156dc7cb5d3a1f0d4bab66db287fcb8e0430bdd4664a095ea16414ba
+    # via yq
+xmltodict==0.13.0 \
+    --hash=sha256:341595a488e3e01a85a9d8911d8912fd922ede5fecc4dce437eb4b6c8d037e56 \
+    --hash=sha256:aa89e8fd76320154a40d19a0df04a4695fb9dc5ba977cbb68ab3e4eb225e7852
+    # via yq
+yq==3.2.3 \
+    --hash=sha256:29c8fe1d36b4f64163f4d01314c6ae217539870f610216dee6025dfb5eafafb1 \
+    --hash=sha256:b50c91894dad9894d1d36ea77d5722d5495cac9482d2351e55089360a90709ae
+    # via -r verify-requirements.in

docs/root/_static/css/envoy.css

@@ -46,6 +46,11 @@ table.docutils div.line-block {
     border: solid #eee 1px;
 }
 
+/* restore margin bottom on aligned images */
+.rst-content img.align-center {
+    margin-bottom: 24px
+}
+
 /* suppress errs on pseudo-json code highlights */
 .highlight-json .highlight .err {
     border: inherit;

docs/root/start/sandboxes/setup.rst

@@ -107,6 +107,15 @@ Many of the examples use the `curl <https://curl.se/>`_ utility to make ``HTTP``
 Instructions for installing `curl <https://curl.se/>`_ on many platforms and operating systems
 can be `found on the curl website <https://curl.haxx.se/download.html>`_.
 
+.. _start_sandboxes_setup_envsubst:
+
+envsubst
+~~~~~~~~
+
+Some of the examples require the ``envsubst`` command to interpolate environment variables in templates.
+
+The command is a part of the GNU ‘gettext’ package, and is available through most package managers.
+
 .. _start_sandboxes_setup_jq:
 
 jq
@@ -118,6 +127,15 @@ whether it be ``HTTP`` response data, logs or statistics.
 Instructions for installing `jq <https://stedolan.github.io/jq/>`_ on many platforms and operating systems
 can be `found on the jq website <https://stedolan.github.io/jq/download/>`_.
 
+.. _start_sandboxes_setup_mkpasswd:
+
+mkpasswd
+~~~~~~~~
+
+Some of the examples require the ``mkpasswd`` command to generate ~random tokens.
+
+The command is a part of the ‘whois’ package, and is available through most package managers.
+
 .. _start_sandboxes_setup_netcat:
 
 netcat

examples/shared/python/Dockerfile

@@ -15,7 +15,9 @@ CMD tail -f /dev/null
 
 
 FROM python-base as aiohttp-service
-ENV DEBIAN_FRONTEND=noninteractive
+ARG SERVICE_PORT=8080
+ENV DEBIAN_FRONTEND=noninteractive \
+    SERVICE_PORT=$SERVICE_PORT
 ADD "$PYTHON_REQUIREMENTS_FILE" /tmp/requirements.txt
 RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
     --mount=type=cache,target=/var/lib/apt/lists,sharing=locked \
@@ -28,7 +30,7 @@ HEALTHCHECK \
     --timeout=1s \
     --start-period=1s \
     --retries=3 \
-    CMD nc -zv localhost 8080
+    CMD nc -zv localhost "$SERVICE_PORT"
 ENTRYPOINT ["python3", "/code/service.py"]
 
 

examples/skywalking/verify.sh

@@ -1,8 +1,8 @@
 #!/bin/bash -e
 
 export NAME=skywalking
-export PORT_PROXY="${SKYWALKING_PORT_PROXY:-12600}"
-export PORT_UI="${SKYWALKING_PORT_UI:-12601}"
+export PORT_PROXY="${SKYWALKING_PORT_PROXY:-11910}"
+export PORT_UI="${SKYWALKING_PORT_UI:-11911}"
 
 # NB: This allows ES to run in a low-resource environment,
 #   dont do this in a production environment.