Skip to content

Commit 98dbc41

Browse files
VietND96VietND96
authored
[docs] Generate list environment variables README automatically (#2564)
Signed-off-by: Viet Nguyen Duc <[email protected]>
1 parent 2d3c355 commit 98dbc41

File tree

18 files changed

+924
-67
lines changed

18 files changed

+924
-67
lines changed

‎Base/Dockerfile‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -169,31 +169,31 @@ RUN /opt/bin/add-jks-helper.sh -d /opt/selenium/secrets \
169169
# Configure environement
170170
#======================================
171171
# Boolean value, maps "--bind-host"
172-
ENV SE_BIND_HOST=false \
172+
ENV SE_BIND_HOST="false" \
173173
SE_SERVER_PROTOCOL="http" \
174174
CONFIG_FILE="/opt/selenium/config.toml" \
175175
# Boolean value, maps "--reject-unsupported-caps"
176-
SE_REJECT_UNSUPPORTED_CAPS=false \
177-
SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED=true \
176+
SE_REJECT_UNSUPPORTED_CAPS="false" \
177+
SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED="true" \
178178
SE_OTEL_TRACES_EXPORTER="otlp" \
179179
SE_SUPERVISORD_LOG_LEVEL="info" \
180180
SE_SUPERVISORD_CHILD_LOG_DIR="/tmp" \
181181
SE_SUPERVISORD_LOG_FILE="/tmp/supervisord.log" \
182182
SE_SUPERVISORD_PID_FILE="/tmp/supervisord.pid" \
183-
SE_SUPERVISORD_AUTO_RESTART=true \
184-
SE_SUPERVISORD_START_RETRIES=5 \
183+
SE_SUPERVISORD_AUTO_RESTART="true" \
184+
SE_SUPERVISORD_START_RETRIES="5" \
185185
SE_LOG_TIMESTAMP_FORMAT="%Y-%m-%d %H:%M:%S,%3N" \
186186
SE_LOG_LEVEL="INFO" \
187-
SE_HTTP_LOGS=false \
188-
SE_STRUCTURED_LOGS=false \
189-
SE_ENABLE_TRACING=true \
190-
SE_ENABLE_TLS=false \
187+
SE_HTTP_LOGS="false" \
188+
SE_STRUCTURED_LOGS="false" \
189+
SE_ENABLE_TRACING="true" \
190+
SE_ENABLE_TLS="false" \
191191
SE_JAVA_OPTS_DEFAULT="-XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/opt/selenium/logs" \
192192
SE_JAVA_HEAP_DUMP="false" \
193193
SE_JAVA_HTTPCLIENT_VERSION="HTTP_1_1" \
194194
SE_JAVA_SSL_TRUST_STORE="/opt/selenium/secrets/server.jks" \
195195
SE_JAVA_SSL_TRUST_STORE_PASSWORD="/opt/selenium/secrets/server.pass" \
196-
SE_JAVA_DISABLE_HOSTNAME_VERIFICATION=true \
196+
SE_JAVA_DISABLE_HOSTNAME_VERIFICATION="true" \
197197
SE_HTTPS_CERTIFICATE="/opt/selenium/secrets/tls.crt" \
198198
SE_HTTPS_PRIVATE_KEY="/opt/selenium/secrets/tls.key"
199199

‎Distributor/Dockerfile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-grid-distributor.sh \
1818
COPY selenium-grid-distributor.conf /etc/supervisor/conf.d/
1919

2020
# In seconds, maps to "--session-request-timeout"
21-
ENV SE_SESSION_REQUEST_TIMEOUT=300 \
21+
ENV SE_SESSION_REQUEST_TIMEOUT="300" \
2222
# In seconds, maps to "--session-retry-interval"
23-
SE_SESSION_RETRY_INTERVAL=15 \
23+
SE_SESSION_RETRY_INTERVAL="15" \
2424
# In seconds, maps to "--healthcheck-interval"
25-
SE_HEALTHCHECK_INTERVAL=120 \
25+
SE_HEALTHCHECK_INTERVAL="120" \
2626
SE_OTEL_SERVICE_NAME="selenium-distributor"

‎ENV_VARIABLES.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
| ENV variable | Default value | Description | CLI option represent |
2+
|--------------|---------------|-------------|----------------------|
3+
| SE_SCREEN_WIDTH | 1920 | Use in Node to set the screen width | |
4+
| SE_SCREEN_HEIGHT | 1080 | Use in Node to set the screen height | |
5+
| SE_VIDEO_FILE_NAME | video.mp4 | Use in function video recording to set the output file name. Set `auto` for dynamic file name relying on test metadata | |
6+
| SE_FRAME_RATE | 15 | Set the frame rate for FFmpeg in video recording | |
7+
| SE_CODEC | libx264 | Set the codec for FFmpeg in video recording | |
8+
| SE_PRESET | -preset ultrafast | Set the preset for FFmpeg in video recording | |
9+
| SE_VIDEO_UPLOAD_ENABLED | false | Enable video upload | |
10+
| SE_VIDEO_INTERNAL_UPLOAD | true | Enable video upload using Rclone in the same recorder container | |
11+
| SE_UPLOAD_DESTINATION_PREFIX | | Remote name and destination path to upload | |
12+
| SE_UPLOAD_PIPE_FILE_NAME | | Set the pipe file name for video upload to consume | |
13+
| SE_SERVER_PROTOCOL | http | Protocol for communication between components | |
14+
| SE_VIDEO_POLL_INTERVAL | 1 | | |
15+
| SE_VIDEO_WAIT_ATTEMPTS | | | |
16+
| SE_VIDEO_FILE_READY_WAIT_ATTEMPTS | | | |
17+
| SE_VIDEO_WAIT_UPLOADER_SHUTDOWN_ATTEMPTS | | | |
18+
| SE_LOG_TIMESTAMP_FORMAT | %Y-%m-%d %H:%M:%S,%3N | | |
19+
| SE_VIDEO_RECORD_STANDALONE | | | |
20+
| SE_NODE_PORT | | | --port |
21+
| SE_ROUTER_USERNAME | | Set the username for basic authentication | --username |
22+
| SE_ROUTER_PASSWORD | | Set the password for basic authentication | |
23+
| SE_SUPERVISORD_PID_FILE | /tmp/supervisord.pid | Default pid file will be created by supervisord | |
24+
| SE_DRAIN_AFTER_SESSION_COUNT | 0 | Drain and detach node from grid after session count exceeds | --drain-after-session-count |
25+
| SE_SUB_PATH | | A sub-path that should be considered for all user facing routes on the Hub/Router/Standalone | --sub-path |
26+
| SE_NODE_GRID_URL | | Node config, public URL of the Grid as a whole (typically the address of the Hub or the Router) | --grid-url |
27+
| SE_HUB_HOST | | Hub config, host address the Hub should listen on | --host |
28+
| SE_ROUTER_HOST | | Router config, host address the Router should listen on | --host |
29+
| SE_HUB_PORT | | Hub config, port the Hub should listen on (default 4444) | --port |
30+
| SE_ROUTER_PORT | | Router config, port the Router should listen on (default 4444) | --port |
31+
| SE_NODE_GRID_GRAPHQL_URL | | Video recording config, GraphQL URL to query test metadata for dynamic file name | |
32+
| SE_VIDEO_FILE_NAME_TRIM_REGEX | [:alnum:]-_ | Bash regex to trim the file name if it is too long | |
33+
| SE_VIDEO_FILE_NAME_SUFFIX | | Append a suffix session id along with test metadata | |
34+
| SE_RCLONE_CONFIG | | | |
35+
| SE_UPLOAD_COMMAND | | | |
36+
| SE_UPLOAD_OPTS | | | |
37+
| SE_UPLOAD_RETAIN_LOCAL_FILE | | | |
38+
| SE_VIDEO_UPLOAD_BATCH_CHECK | | | |
39+
| SE_RCLONE_ | | | |
40+
| SE_OPTS | | | |
41+
| SE_EVENT_BUS_HOST | | | |
42+
| SE_EVENT_BUS_PORT | | | |
43+
| SE_LOG_LEVEL | INFO | | |
44+
| SE_HTTP_LOGS | false | | |
45+
| SE_STRUCTURED_LOGS | false | | |
46+
| SE_EXTERNAL_URL | | | |
47+
| SE_ENABLE_TLS | false | | |
48+
| SE_JAVA_SSL_TRUST_STORE | /opt/selenium/secrets/server.jks | | |
49+
| SE_JAVA_OPTS | | | |
50+
| SE_JAVA_SSL_TRUST_STORE_PASSWORD | /opt/selenium/secrets/server.pass | | |
51+
| SE_JAVA_DISABLE_HOSTNAME_VERIFICATION | true | | |
52+
| SE_HTTPS_CERTIFICATE | /opt/selenium/secrets/tls.crt | | |
53+
| SE_HTTPS_PRIVATE_KEY | /opt/selenium/secrets/tls.key | | |
54+
| SE_ENABLE_TRACING | true | | |
55+
| SE_OTEL_EXPORTER_ENDPOINT | | | |
56+
| SE_OTEL_SERVICE_NAME | selenium-router | | |
57+
| SE_OTEL_JVM_ARGS | | | |
58+
| SE_OTEL_TRACES_EXPORTER | otlp | | |
59+
| SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED | true | | |
60+
| SE_JAVA_HTTPCLIENT_VERSION | HTTP_1_1 | | |
61+
| SE_JAVA_OPTS_DEFAULT | -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/opt/selenium/logs | | |
62+
| SE_JAVA_HEAP_DUMP | false | | |
63+
| SE_BIND_HOST | false | | |
64+
| SE_SCREEN_DEPTH | 24 | | |
65+
| SE_SCREEN_DPI | 96 | | |
66+
| SE_START_XVFB | true | | |
67+
| SE_START_VNC | true | | |
68+
| SE_START_NO_VNC | true | | |
69+
| SE_VNC_ULIMIT | | | |
70+
| SE_NO_VNC_PORT | 7900 | | |
71+
| SE_VNC_PORT | 5900 | | |
72+
| SE_VNC_NO_PASSWORD | | | |
73+
| SE_VNC_VIEW_ONLY | | | |
74+
| SE_VNC_PASSWORD | | | |
75+
| SE_EVENT_BUS_PUBLISH_PORT | | | |
76+
| SE_EVENT_BUS_SUBSCRIBE_PORT | | | |
77+
| SE_NODE_SESSION_TIMEOUT | 300 | | |
78+
| SE_NODE_ENABLE_MANAGED_DOWNLOADS | | | |
79+
| SE_NODE_ENABLE_CDP | | | |
80+
| SE_NODE_REGISTER_PERIOD | | | |
81+
| SE_NODE_REGISTER_CYCLE | | | |
82+
| SE_NODE_HEARTBEAT_PERIOD | 30 | | |
83+
| SE_REGISTRATION_SECRET | | | |
84+
| SE_BROWSER_LEFTOVERS_PROCESSES_SECS | 7200 | | |
85+
| SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS | 1 | | |
86+
| SE_BROWSER_LEFTOVERS_INTERVAL_SECS | 3600 | | |
87+
| SE_DISABLE_UI | | | |
88+
| SE_REJECT_UNSUPPORTED_CAPS | false | | |
89+
| SE_NEW_SESSION_THREAD_POOL_SIZE | | | |
90+
| SE_SESSION_REQUEST_TIMEOUT | 300 | | |
91+
| SE_SESSION_RETRY_INTERVAL | 5 | | |
92+
| SE_HEALTHCHECK_INTERVAL | 120 | | |
93+
| SE_RELAX_CHECKS | true | | |
94+
| SE_SESSION_QUEUE_HOST | | | |
95+
| SE_SESSION_QUEUE_PORT | | | |
96+
| SE_VIDEO_FOLDER | | | |
97+
| SE_LOG_LISTEN_GRAPHQL | | | |
98+
| SE_NODE_PRESTOP_WAIT_STRATEGY | | | |
99+
| SE_SESSIONS_HOST | | | |
100+
| SE_SESSIONS_PORT | | | |
101+
| SE_SESSIONS_MAP_EXTERNAL_DATASTORE | false | | |
102+
| SE_SESSIONS_MAP_HOST | | | |
103+
| SE_SESSIONS_MAP_PORT | | | |
104+
| SE_DISTRIBUTOR_HOST | | | |
105+
| SE_DISTRIBUTOR_PORT | | | |
106+
| SE_GRID_URL | | | |
107+
| SE_NODE_DOCKER_CONFIG_FILENAME | | | |
108+
| SE_NODE_GRACEFUL_SHUTDOWN | | | |
109+
| SE_VIDEO_CONTAINER_NAME | | | |
110+
| SE_RECORD_VIDEO | true | | |
111+
| SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP | false | | |
112+
| SE_NODE_MAX_SESSIONS | 1 | | |
113+
| SE_NODE_OVERRIDE_MAX_SESSIONS | false | | |
114+
| SE_OFFLINE | true | Selenium Manager offline mode, use the browser and driver pre-configured in the image | |
115+
| SE_NODE_BROWSER_VERSION | stable | Overwrite the default browserVersion in Node stereotype | |
116+
| SE_NODE_PLATFORM_NAME | Linux | Overwrite the default platformName in Node stereotype | |
117+
| SE_SUPERVISORD_LOG_LEVEL | info | | |
118+
| SE_SUPERVISORD_CHILD_LOG_DIR | /tmp | | |
119+
| SE_SUPERVISORD_LOG_FILE | /tmp/supervisord.log | | |
120+
| SE_SUPERVISORD_AUTO_RESTART | true | | |
121+
| SE_SUPERVISORD_START_RETRIES | 5 | | |

‎Hub/Dockerfile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ EXPOSE 4443
1515
EXPOSE 4444
1616

1717
# In seconds, maps to "--session-request-timeout"
18-
ENV SE_SESSION_REQUEST_TIMEOUT=300 \
18+
ENV SE_SESSION_REQUEST_TIMEOUT="300" \
1919
# In seconds, maps to "--session-retry-interval"
20-
SE_SESSION_RETRY_INTERVAL=15 \
20+
SE_SESSION_RETRY_INTERVAL="15" \
2121
# In seconds, maps to "--healthcheck-interval"
22-
SE_HEALTHCHECK_INTERVAL=120 \
22+
SE_HEALTHCHECK_INTERVAL="120" \
2323
# Boolean value, maps "--relax-checks"
24-
SE_RELAX_CHECKS=true \
24+
SE_RELAX_CHECKS="true" \
2525
SE_OTEL_SERVICE_NAME="selenium-hub"
2626

2727
COPY --chown="${SEL_UID}:${SEL_GID}" start-selenium-grid-hub.sh \

‎Makefile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ generate_readme_charts:
8888
$$HOME/go/bin/helm-docs --chart-search-root charts/selenium-grid --output-file CONFIGURATION.md --sort-values-order file ; \
8989
fi
9090

91+
update_list_env_vars:
92+
python3 -m pip install -r tests/requirements.txt ; \
93+
python3 scripts/generate_list_env_vars/extract_env.py
94+
9195
lint_readme_charts: generate_readme_charts
9296
git diff --stat --exit-code ; \
9397
EXIT_CODE=$$? ; \

‎NodeBase/Dockerfile‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,45 +31,45 @@ ENV LANG_WHICH=${LANG_WHICH} \
3131
#============================================
3232
# Shared cleanup script environment variables
3333
#============================================
34-
SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP=false \
35-
SE_BROWSER_LEFTOVERS_INTERVAL_SECS=3600 \
36-
SE_BROWSER_LEFTOVERS_PROCESSES_SECS=7200 \
37-
SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS=1 \
34+
SE_ENABLE_BROWSER_LEFTOVERS_CLEANUP="false" \
35+
SE_BROWSER_LEFTOVERS_INTERVAL_SECS="3600" \
36+
SE_BROWSER_LEFTOVERS_PROCESSES_SECS="7200" \
37+
SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS="1" \
3838
#========================
3939
# Selenium Configuration
4040
#========================
4141
# Drain the Node after N sessions (a value higher than zero enables the feature)
42-
SE_DRAIN_AFTER_SESSION_COUNT=0 \
43-
SE_NODE_MAX_SESSIONS=1 \
44-
SE_NODE_SESSION_TIMEOUT=300 \
45-
SE_NODE_OVERRIDE_MAX_SESSIONS=false \
46-
SE_NODE_HEARTBEAT_PERIOD=30 \
42+
SE_DRAIN_AFTER_SESSION_COUNT="0" \
43+
SE_NODE_MAX_SESSIONS="1" \
44+
SE_NODE_SESSION_TIMEOUT="300" \
45+
SE_NODE_OVERRIDE_MAX_SESSIONS="false" \
46+
SE_NODE_HEARTBEAT_PERIOD="30" \
4747
SE_OTEL_SERVICE_NAME="selenium-node" \
4848
# Setting Selenium Manager to work offline
49-
SE_OFFLINE=true \
49+
SE_OFFLINE="true" \
5050
SE_NODE_BROWSER_VERSION="stable" \
5151
SE_NODE_PLATFORM_NAME="Linux" \
5252
#============================
5353
# Some configuration options
5454
#============================
5555
SE_RECORD_VIDEO=false \
5656
DISPLAY_CONTAINER_NAME="localhost" \
57-
SE_SCREEN_WIDTH=1920 \
58-
SE_SCREEN_HEIGHT=1080 \
59-
SE_SCREEN_DEPTH=24 \
60-
SE_SCREEN_DPI=96 \
61-
SE_START_XVFB=true \
62-
SE_START_VNC=true \
63-
SE_START_NO_VNC=true \
64-
SE_NO_VNC_PORT=7900 \
65-
SE_VNC_PORT=5900 \
66-
DISPLAY=:99.0 \
67-
DISPLAY_NUM=99 \
57+
SE_SCREEN_WIDTH="1920" \
58+
SE_SCREEN_HEIGHT="1080" \
59+
SE_SCREEN_DEPTH="24" \
60+
SE_SCREEN_DPI="96" \
61+
SE_START_XVFB="true" \
62+
SE_START_VNC="true" \
63+
SE_START_NO_VNC="true" \
64+
SE_NO_VNC_PORT="7900" \
65+
SE_VNC_PORT="5900" \
66+
DISPLAY=":99.0" \
67+
DISPLAY_NUM="99" \
6868
# Path to the Configfile
69-
CONFIG_FILE=/opt/selenium/config.toml \
70-
GENERATE_CONFIG=true \
69+
CONFIG_FILE="/opt/selenium/config.toml" \
70+
GENERATE_CONFIG="true" \
7171
# Following line fixes https://github.com/SeleniumHQ/docker-selenium/issues/87
72-
DBUS_SESSION_BUS_ADDRESS=/dev/null
72+
DBUS_SESSION_BUS_ADDRESS="/dev/null"
7373

7474
RUN apt-get update -qqy \
7575
&& apt-get -qqy --no-install-recommends install \

‎README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Talk to us at https://www.selenium.dev/support/
3434
* [Dev and Beta Channel Browser Images](#dev-and-beta-channel-browser-images)
3535
* [Dev and Beta Standalone Mode](#dev-and-beta-standalone-mode)
3636
* [Dev and Beta on the Grid](#dev-and-beta-on-the-grid)
37+
* [Environment Variables](#environment-variables)
3738
* [Execution modes](#execution-modes)
3839
* [Standalone](#standalone)
3940
* [Hub and Nodes](#hub-and-nodes)
@@ -348,6 +349,24 @@ services:
348349

349350
For more information on the Dev and Beta channel container images, see the blog post on [Dev and Beta Channel Browsers via Docker Selenium](https://www.selenium.dev/blog/2022/dev-and-beta-channel-browsers-via-docker-selenium/).
350351

352+
## Environment Variables
353+
354+
**Checkout full list of environment variables [here](ENV_VARIABLES.md).**
355+
356+
How to update or contribute to list of environment variables? Follow below steps:
357+
358+
1. Refresh the list to pick up new environment variables or default value
359+
360+
```bash
361+
make update_list_env_vars
362+
```
363+
364+
The script can be updated in [scripts/generate_list_env_vars/extract_env.py](scripts/generate_list_env_vars/extract_env.py).
365+
366+
2. Update the description for each environment variable in the file [scripts/generate_list_env_vars/description.yaml](scripts/generate_list_env_vars/description.yaml).
367+
368+
3. Run the command in step (1) one more time to update the list of environment variables with new descriptions.
369+
351370
## Execution modes
352371

353372
### Standalone

‎Router/Dockerfile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ USER ${SEL_UID}
1111
#========================
1212

1313
# In seconds, maps to "--session-request-timeout"
14-
ENV SE_SESSION_REQUEST_TIMEOUT=300 \
14+
ENV SE_SESSION_REQUEST_TIMEOUT="300" \
1515
# In seconds, maps to "--session-retry-interval"
16-
SE_SESSION_RETRY_INTERVAL=5 \
16+
SE_SESSION_RETRY_INTERVAL="5" \
1717
SE_OTEL_SERVICE_NAME="selenium-router"
1818

1919
EXPOSE 4444

‎SessionQueue/Dockerfile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ USER ${SEL_UID}
1111
#========================
1212

1313
# In seconds, maps to "--session-request-timeout"
14-
ENV SE_SESSION_REQUEST_TIMEOUT=300 \
14+
ENV SE_SESSION_REQUEST_TIMEOUT="300" \
1515
# In seconds, maps to "--session-retry-interval"
16-
SE_SESSION_RETRY_INTERVAL=15 \
16+
SE_SESSION_RETRY_INTERVAL="15" \
1717
SE_OTEL_SERVICE_NAME="selenium-session-queue"
1818

1919
EXPOSE 5559

‎Sessions/Dockerfile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ EXPOSE 5556
2222

2323
ENV SE_OTEL_SERVICE_NAME="selenium-session-map" \
2424
# Path to the Configfile
25-
CONFIG_FILE=/opt/selenium/config.toml \
26-
GENERATE_CONFIG=true \
27-
SE_SESSIONS_MAP_EXTERNAL_DATASTORE=false
25+
CONFIG_FILE="/opt/selenium/config.toml" \
26+
GENERATE_CONFIG="true" \
27+
SE_SESSIONS_MAP_EXTERNAL_DATASTORE="false"

0 commit comments

Comments
 (0)