Skip to content

Commit f0e8a6c

Browse files
committed
[docs] Update list env vars
Signed-off-by: Viet Nguyen Duc <[email protected]>
1 parent b6df8d5 commit f0e8a6c

File tree

3 files changed

+75
-63
lines changed

3 files changed

+75
-63
lines changed

ENV_VARIABLES.md

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -40,25 +40,25 @@
4040
| SE_OPTS | | | |
4141
| SE_EVENT_BUS_HOST | | | |
4242
| SE_EVENT_BUS_PORT | 5557 | | |
43-
| SE_LOG_LEVEL | INFO | | |
44-
| SE_HTTP_LOGS | false | | |
45-
| SE_STRUCTURED_LOGS | false | | |
46-
| SE_EXTERNAL_URL | | | |
43+
| SE_LOG_LEVEL | INFO | | --log-level |
44+
| SE_HTTP_LOGS | false | | --http-logs |
45+
| SE_STRUCTURED_LOGS | false | | --structured-logs |
46+
| SE_EXTERNAL_URL | | | --external-url |
4747
| SE_ENABLE_TLS | false | | |
4848
| SE_JAVA_SSL_TRUST_STORE | /opt/selenium/secrets/server.jks | | |
4949
| SE_JAVA_OPTS | | | |
5050
| SE_JAVA_SSL_TRUST_STORE_PASSWORD | /opt/selenium/secrets/server.pass | | |
5151
| 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 | | |
52+
| SE_HTTPS_CERTIFICATE | /opt/selenium/secrets/tls.crt | | --https-certificate |
53+
| SE_HTTPS_PRIVATE_KEY | /opt/selenium/secrets/tls.key | | --https-private-key |
54+
| SE_ENABLE_TRACING | true | | --tracing |
55+
| SE_OTEL_EXPORTER_ENDPOINT | | | -Dotel.exporter.otlp.endpoint= |
56+
| SE_OTEL_SERVICE_NAME | selenium-event-bus | | -Dotel.resource.attributes=service.name= |
5757
| SE_OTEL_JVM_ARGS | | | |
58-
| SE_OTEL_TRACES_EXPORTER | otlp | | |
58+
| SE_OTEL_TRACES_EXPORTER | otlp | | -Dotel.traces.exporter |
5959
| 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 | | |
60+
| SE_JAVA_HTTPCLIENT_VERSION | HTTP_1_1 | | -Dwebdriver.httpclient.version |
61+
| SE_JAVA_OPTS_DEFAULT | | | |
6262
| SE_JAVA_HEAP_DUMP | false | | |
6363
| SE_BIND_HOST | false | | |
6464
| SE_SCREEN_DEPTH | 24 | | |
@@ -74,34 +74,34 @@
7474
| SE_VNC_PASSWORD | | | |
7575
| SE_EVENT_BUS_PUBLISH_PORT | 4442 | | |
7676
| SE_EVENT_BUS_SUBSCRIBE_PORT | 4443 | | |
77-
| SE_NODE_SESSION_TIMEOUT | 300 | | |
78-
| SE_NODE_ENABLE_MANAGED_DOWNLOADS | | | |
79-
| SE_NODE_ENABLE_CDP | | | |
80-
| SE_NODE_REGISTER_PERIOD | 120 | | |
81-
| SE_NODE_REGISTER_CYCLE | 10 | | |
82-
| SE_NODE_HEARTBEAT_PERIOD | 30 | | |
83-
| SE_REGISTRATION_SECRET | | | |
77+
| SE_NODE_SESSION_TIMEOUT | 300 | | --session-timeout |
78+
| SE_NODE_ENABLE_MANAGED_DOWNLOADS | | | --enable-managed-downloads |
79+
| SE_NODE_ENABLE_CDP | | | --enable-cdp |
80+
| SE_NODE_REGISTER_PERIOD | 120 | | --register-period |
81+
| SE_NODE_REGISTER_CYCLE | 10 | | --register-cycle |
82+
| SE_NODE_HEARTBEAT_PERIOD | 30 | | --heartbeat-period |
83+
| SE_REGISTRATION_SECRET | | | --registration-secret |
8484
| SE_BROWSER_LEFTOVERS_PROCESSES_SECS | 7200 | | |
8585
| SE_BROWSER_LEFTOVERS_TEMPFILES_DAYS | 1 | | |
8686
| 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 | 15 | | |
92-
| SE_HEALTHCHECK_INTERVAL | 120 | | |
93-
| SE_RELAX_CHECKS | true | | |
94-
| SE_SESSION_QUEUE_HOST | | | |
95-
| SE_SESSION_QUEUE_PORT | 5559 | | |
87+
| SE_DISABLE_UI | | | --disable-ui |
88+
| SE_REJECT_UNSUPPORTED_CAPS | false | | --reject-unsupported-caps |
89+
| SE_NEW_SESSION_THREAD_POOL_SIZE | | | --newsession-threadpool-size |
90+
| SE_SESSION_REQUEST_TIMEOUT | 300 | | --session-request-timeout |
91+
| SE_SESSION_RETRY_INTERVAL | 15 | | --session-retry-interval |
92+
| SE_HEALTHCHECK_INTERVAL | 120 | | --healthcheck-interval |
93+
| SE_RELAX_CHECKS | true | | --relax-checks |
94+
| SE_SESSION_QUEUE_HOST | | | --sessionqueue-host |
95+
| SE_SESSION_QUEUE_PORT | 5559 | | --sessionqueue-port |
9696
| SE_VIDEO_FOLDER | | | |
9797
| SE_LOG_LISTEN_GRAPHQL | | | |
9898
| SE_NODE_PRESTOP_WAIT_STRATEGY | | | |
9999
| SE_SESSIONS_MAP_EXTERNAL_DATASTORE | false | | |
100-
| SE_SESSIONS_MAP_HOST | | | |
101-
| SE_SESSIONS_MAP_PORT | 5556 | | |
100+
| SE_SESSIONS_MAP_HOST | | | --sessions-host |
101+
| SE_SESSIONS_MAP_PORT | 5556 | | --sessions-port |
102102
| SE_DISTRIBUTOR_HOST | | | |
103103
| SE_DISTRIBUTOR_PORT | 5553 | | |
104-
| SE_GRID_URL | | | |
104+
| SE_GRID_URL | | | --grid-url |
105105
| SE_NODE_DOCKER_CONFIG_FILENAME | | | |
106106
| SE_NODE_GRACEFUL_SHUTDOWN | | | |
107107
| SE_VIDEO_CONTAINER_NAME | | | |
@@ -142,3 +142,5 @@
142142
| SE_NODE_RELAY_STEREOTYPE | | Capabilities in JSON string to overwrite the default Node relay stereotype | |
143143
| SE_NODE_RELAY_STEREOTYPE_EXTRA | | Extra capabilities in JSON string that wants to merge to the default Node relay stereotype | |
144144
| SE_NODE_REGISTER_SHUTDOWN_ON_FAILURE | true | If this flag is enabled, the Node will shut down after the register period is completed. This is useful for container environments to restart and register again. If restarted multiple times, the Node container status will be CrashLoopBackOff | --register-shutdown-on-failure |
145+
| SE_NODE_RELAY_BROWSER_VERSION | | | |
146+
| SE_NODE_RELAY_ONLY | true | | |

scripts/generate_list_env_vars/description.yaml

Lines changed: 36 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -124,16 +124,16 @@
124124
cli: ''
125125
- name: SE_LOG_LEVEL
126126
description: ''
127-
cli: ''
127+
cli: --log-level
128128
- name: SE_HTTP_LOGS
129129
description: ''
130-
cli: ''
130+
cli: --http-logs
131131
- name: SE_STRUCTURED_LOGS
132132
description: ''
133-
cli: ''
133+
cli: --structured-logs
134134
- name: SE_EXTERNAL_URL
135135
description: ''
136-
cli: ''
136+
cli: --external-url
137137
- name: SE_ENABLE_TLS
138138
description: ''
139139
cli: ''
@@ -151,31 +151,31 @@
151151
cli: ''
152152
- name: SE_HTTPS_CERTIFICATE
153153
description: ''
154-
cli: ''
154+
cli: --https-certificate
155155
- name: SE_HTTPS_PRIVATE_KEY
156156
description: ''
157-
cli: ''
157+
cli: --https-private-key
158158
- name: SE_ENABLE_TRACING
159159
description: ''
160-
cli: ''
160+
cli: --tracing
161161
- name: SE_OTEL_EXPORTER_ENDPOINT
162162
description: ''
163-
cli: ''
163+
cli: -Dotel.exporter.otlp.endpoint=
164164
- name: SE_OTEL_SERVICE_NAME
165165
description: ''
166-
cli: ''
166+
cli: -Dotel.resource.attributes=service.name=
167167
- name: SE_OTEL_JVM_ARGS
168168
description: ''
169169
cli: ''
170170
- name: SE_OTEL_TRACES_EXPORTER
171171
description: ''
172-
cli: ''
172+
cli: -Dotel.traces.exporter
173173
- name: SE_OTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED
174174
description: ''
175175
cli: ''
176176
- name: SE_JAVA_HTTPCLIENT_VERSION
177177
description: ''
178-
cli: ''
178+
cli: -Dwebdriver.httpclient.version
179179
- name: SE_JAVA_OPTS_DEFAULT
180180
description: ''
181181
cli: ''
@@ -226,25 +226,25 @@
226226
cli: ''
227227
- name: SE_NODE_SESSION_TIMEOUT
228228
description: ''
229-
cli: ''
229+
cli: --session-timeout
230230
- name: SE_NODE_ENABLE_MANAGED_DOWNLOADS
231231
description: ''
232-
cli: ''
232+
cli: --enable-managed-downloads
233233
- name: SE_NODE_ENABLE_CDP
234234
description: ''
235-
cli: ''
235+
cli: --enable-cdp
236236
- name: SE_NODE_REGISTER_PERIOD
237237
description: ''
238-
cli: ''
238+
cli: --register-period
239239
- name: SE_NODE_REGISTER_CYCLE
240240
description: ''
241-
cli: ''
241+
cli: --register-cycle
242242
- name: SE_NODE_HEARTBEAT_PERIOD
243243
description: ''
244-
cli: ''
244+
cli: --heartbeat-period
245245
- name: SE_REGISTRATION_SECRET
246246
description: ''
247-
cli: ''
247+
cli: --registration-secret
248248
- name: SE_BROWSER_LEFTOVERS_PROCESSES_SECS
249249
description: ''
250250
cli: ''
@@ -256,31 +256,31 @@
256256
cli: ''
257257
- name: SE_DISABLE_UI
258258
description: ''
259-
cli: ''
259+
cli: --disable-ui
260260
- name: SE_REJECT_UNSUPPORTED_CAPS
261261
description: ''
262-
cli: ''
262+
cli: --reject-unsupported-caps
263263
- name: SE_NEW_SESSION_THREAD_POOL_SIZE
264264
description: ''
265-
cli: ''
265+
cli: --newsession-threadpool-size
266266
- name: SE_SESSION_REQUEST_TIMEOUT
267267
description: ''
268-
cli: ''
268+
cli: --session-request-timeout
269269
- name: SE_SESSION_RETRY_INTERVAL
270270
description: ''
271-
cli: ''
271+
cli: --session-retry-interval
272272
- name: SE_HEALTHCHECK_INTERVAL
273273
description: ''
274-
cli: ''
274+
cli: --healthcheck-interval
275275
- name: SE_RELAX_CHECKS
276276
description: ''
277-
cli: ''
277+
cli: --relax-checks
278278
- name: SE_SESSION_QUEUE_HOST
279279
description: ''
280-
cli: ''
280+
cli: --sessionqueue-host
281281
- name: SE_SESSION_QUEUE_PORT
282282
description: ''
283-
cli: ''
283+
cli: --sessionqueue-port
284284
- name: SE_VIDEO_FOLDER
285285
description: ''
286286
cli: ''
@@ -295,10 +295,10 @@
295295
cli: ''
296296
- name: SE_SESSIONS_MAP_HOST
297297
description: ''
298-
cli: ''
298+
cli: --sessions-host
299299
- name: SE_SESSIONS_MAP_PORT
300300
description: ''
301-
cli: ''
301+
cli: --sessions-port
302302
- name: SE_DISTRIBUTOR_HOST
303303
description: ''
304304
cli: ''
@@ -307,7 +307,7 @@
307307
cli: ''
308308
- name: SE_GRID_URL
309309
description: ''
310-
cli: ''
310+
cli: --grid-url
311311
- name: SE_NODE_DOCKER_CONFIG_FILENAME
312312
description: ''
313313
cli: ''
@@ -434,3 +434,9 @@
434434
register again. If restarted multiple times, the Node container status will be
435435
CrashLoopBackOff
436436
cli: --register-shutdown-on-failure
437+
- name: SE_NODE_RELAY_BROWSER_VERSION
438+
description: ''
439+
cli: ''
440+
- name: SE_NODE_RELAY_ONLY
441+
description: ''
442+
cli: ''

scripts/generate_list_env_vars/value.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
- name: SE_JAVA_OPTS
6262
default: ''
6363
- name: SE_JAVA_OPTS_DEFAULT
64-
default: -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/opt/selenium/logs
64+
default: ''
6565
- name: SE_JAVA_SSL_TRUST_STORE
6666
default: /opt/selenium/secrets/server.jks
6767
- name: SE_JAVA_SSL_TRUST_STORE_PASSWORD
@@ -114,8 +114,12 @@
114114
default: 'true'
115115
- name: SE_NODE_RELAY_BROWSER_NAME
116116
default: ''
117+
- name: SE_NODE_RELAY_BROWSER_VERSION
118+
default: ''
117119
- name: SE_NODE_RELAY_MAX_SESSIONS
118120
default: ''
121+
- name: SE_NODE_RELAY_ONLY
122+
default: 'true'
119123
- name: SE_NODE_RELAY_PLATFORM_NAME
120124
default: ''
121125
- name: SE_NODE_RELAY_PLATFORM_VERSION
@@ -149,7 +153,7 @@
149153
- name: SE_OTEL_JVM_ARGS
150154
default: ''
151155
- name: SE_OTEL_SERVICE_NAME
152-
default: selenium-router
156+
default: selenium-event-bus
153157
- name: SE_OTEL_TRACES_EXPORTER
154158
default: otlp
155159
- name: SE_PRESET

0 commit comments

Comments
 (0)