You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update list CLI Options of Selenium Grid align to version 4.41.0 (#2596)
* Update list CLI Options of Selenium Grid align to version 4.41.0
* Update download list to 4.41.0
[deploy site]
---------
Signed-off-by: Viet Nguyen Duc <nguyenducviet4496@gmail.com>
Copy file name to clipboardExpand all lines: website_and_docs/content/documentation/grid/configuration/cli_options.en.md
+47-8Lines changed: 47 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,6 +57,16 @@ pull request updating this page.
57
57
<td></td>
58
58
<td></td>
59
59
</tr>
60
+
<tr>
61
+
<th><a href="#kubernetes">Kubernetes</a></th>
62
+
<td><i class="fas fa-check"></i></td>
63
+
<td></td>
64
+
<td><i class="fas fa-check"></i></td>
65
+
<td></td>
66
+
<td></td>
67
+
<td></td>
68
+
<td></td>
69
+
</tr>
60
70
<tr>
61
71
<th><a href="#events">Events</a></th>
62
72
<td></td>
@@ -170,13 +180,34 @@ pull request updating this page.
170
180
| Option | Type | Value/Example | Description |
171
181
|---|---|---|---|
172
182
|`--docker-assets-path`| string |`/opt/selenium/assets`| Absolute path where assets will be stored |
173
-
|`--docker-`| string[]|`selenium/standalone-firefox:latest '{"browserName": "firefox"}'`| Docker configs which map image name to stereotype capabilities (example `-D selenium/standalone-firefox:latest '{"browserName": "firefox"}') |
183
+
|`--docker` / `-D`| string[]|`selenium/standalone-firefox:latest '{"browserName": "firefox"}'`| Docker configs which map image name to stereotype capabilities (example:`-D selenium/standalone-firefox:latest '{"browserName": "firefox"}'`) |
174
184
|`--docker-devices`| string[]|`/dev/kvm:/dev/kvm`| Exposes devices to a container. Each device mapping declaration must have at least the path of the device in both host and container separated by a colon like in this example: /device/path/in/host:/device/path/in/container |
175
185
|`--docker-host`| string |`localhost`| Host name where the Docker daemon is running |
176
186
|`--docker-port`| int |`2375`| Port where the Docker daemon is running |
177
187
|`--docker-url`| string |`http://localhost:2375`| URL for connecting to the Docker daemon |
178
188
|`--docker-video-image`| string |`selenium/video:latest`| Docker image to be used when video recording is enabled |
179
-
|`--docker-host-config-keys`| string[]|`Dns DnsOptions DnsSearch ExtraHosts Binds`| Specify which docker host configuration keys should be passed to browser containers. Keys name can be found in the Docker API [documentation](https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerCreate), or by running `docker inspect` the node-docker container. |
189
+
|`--docker-host-config-keys`| string[]|`Dns DnsOptions DnsSearch ExtraHosts Binds`| Specify which docker host configuration keys should be passed to browser containers. Keys name can be found in the Docker API [documentation](https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerCreate), or by running `docker inspect` the node-docker container. |
190
+
|`--docker-api-version`| string |`1.40`| Docker API version to use. Pin a specific API version instead of relying on auto-detection by the implementation. |
191
+
|`--docker-server-start-timeout`| int |`55`| Max time (in seconds) to wait for the browser server to successfully start up inside the container, before cancelling the process. |
192
+
|`--docker-grouping-labels`| string[]|`azure.container.group aws.ecs.cluster`| Custom labels used for grouping dynamic containers. Makes the system more flexible for different platforms and use cases. |
193
+
194
+
### Kubernetes
195
+
196
+
| Option | Type | Value/Example | Description |
197
+
|---|---|---|---|
198
+
|`--kubernetes-url`| string |`"https://my-k8s-cluster:6443"`| Kubernetes API server URL. When set, connects to a remote cluster instead of using in-cluster or kubeconfig auto-discovery. |
199
+
|`--kubernetes-configs` / `-K`| string[]|`selenium/standalone-firefox:latest '{"browserName": "firefox"}'`| Kubernetes configs which map image name to stereotype capabilities (example: `-K selenium/standalone-firefox:latest '{"browserName": "firefox"}'`). Use `configmap:[namespace/]<name>` as the key to load a Job template from a Kubernetes ConfigMap instead of an image name. |
200
+
|`--kubernetes-namespace`| string |`"selenium"`| Kubernetes namespace to create browser Jobs in. Auto-detected from the client when running in-cluster if not set. |
201
+
|`--kubernetes-service-account`| string |`"selenium-session"`| Override service account for browser Jobs. Auto-inherited from the Node Pod when running in K8s. |
202
+
|`--kubernetes-image-pull-policy`| string |`"IfNotPresent"`| Override image pull policy for browser containers (`Always`, `IfNotPresent`, `Never`). Auto-inherited from the Node Pod when running in K8s. |
203
+
|`--kubernetes-server-start-timeout`| int |`120`| Max time (in seconds) to wait for the browser server to start up in the K8s Pod. |
204
+
|`--kubernetes-termination-grace-period`| int |`30`| Seconds to wait for containers to shut down gracefully before force-killing them. |
205
+
|`--kubernetes-resource-requests`| string |`"cpu=500m,memory=512Mi"`| Override resource requests for browser containers (comma-separated `key=value` pairs). Auto-inherited from the Node Pod when running in K8s. |
206
+
|`--kubernetes-resource-limits`| string |`"cpu=1,memory=1Gi"`| Override resource limits for browser containers (comma-separated `key=value` pairs). Auto-inherited from the Node Pod when running in K8s. |
207
+
|`--kubernetes-node-selector`| string |`"disktype=ssd,region=us-west"`| Override node selector for scheduling browser Pods (comma-separated `key=value` pairs). Auto-inherited from the Node Pod when running in K8s. |
208
+
|`--kubernetes-video-image`| string |`"selenium/video:latest"`| Container image to use as a video recording sidecar. Set to `false` to disable video recording (default). |
209
+
|`--kubernetes-assets-path`| string |`"/opt/selenium/assets"`| Absolute path where session assets will be stored. |
210
+
|`--kubernetes-label-inherit-prefix`| string |`"se/"`| Prefix filter for inheriting labels/annotations from the Node Pod to browser Jobs. Only labels/annotations whose keys start with this prefix are inherited. An empty string inherits all. |
180
211
181
212
### Events
182
213
@@ -186,6 +217,7 @@ pull request updating this page.
186
217
|`--events-implementation`| string |`org.openqa.selenium.events.zeromq.ZeroMqEventBus`| Full class name of non-default event bus implementation |
187
218
|`--publish-events`| string |`tcp://*:4442`| Connection string for publishing events to the event bus |
188
219
|`--subscribe-events`| string |`tcp://*:4443`| Connection string for subscribing to events from the event bus |
220
+
|`--eventbus-heartbeat-period`| int |`30`| How often, in seconds, will the EventBus socket send heartbeats. |
189
221
190
222
### Logging
191
223
@@ -209,7 +241,7 @@ pull request updating this page.
209
241
### Node
210
242
211
243
| Option | Type | Value/Example | Description |
212
-
|---|---|---|---|---|
244
+
|---|---|---|---|
213
245
|`--detect-drivers`| boolean |`true`| Autodetect which drivers are available on the current system, and add them to the Node. |
214
246
|`--driver-configuration`| string[]|`display-name="Firefox Nightly" max-sessions=2 webdriver-path="/usr/local/bin/geckodriver" stereotype="{\"browserName\": \"firefox\", \"browserVersion\": \"86\", \"moz:firefoxOptions\": {\"binary\":\"/Applications/Firefox Nightly.app/Contents/MacOS/firefox-bin\"}}"`| List of configured drivers a Node supports. It is recommended to provide this type of configuration through a toml config file to improve readability |
215
247
|`--driver-factory`| string[]|`org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'`| Mapping of fully qualified class name to a browser configuration that this matches against. |
@@ -227,9 +259,13 @@ pull request updating this page.
227
259
|`--drain-after-session-count`| int |`1`| Drain and shutdown the Node after X sessions have been executed. Useful for environments like Kubernetes. A value higher than zero enables this feature. |
228
260
|`--hub`| string |`http://localhost:4444`| The address of the Hub in a Hub-and-Node configuration. Can be a hostname or IP address (`hostname`), in which case the Hub will be assumed to be `http://hostname:4444`, the `--grid-url` will be the same `--publish-events` will be `tcp://hostname:4442` and `--subscribe-events` will be `tcp://hostname:4443`. If `hostname` contains a port number, that will be used for `--grid-url` but the URIs for the event bus will remain the same. Any of these default values may be overridden but setting the correct flags. If the hostname has a protocol (such as `https`) that will be used too. |
229
261
|`--enable-cdp`| boolean |`true`| Enable CDP proxying in Grid. A Grid admin can disable CDP if the network does not allow websockets. True by default. |
262
+
|`--enable-bidi`| boolean |`true`| Enable BiDi proxying in Grid. A Grid admin can disable BiDi if the network does not allow websockets. True by default. |
230
263
|`--enable-managed-downloads`| boolean |`false`| This causes the Node to auto manage files downloaded for a given session on the Node. |
231
264
|`--selenium-manager`| boolean |`false`| When drivers are not available on the current system, use Selenium Manager. False by default. |
232
-
|`--connection-limit-per-session`| int |`10`| Let X be the maximum number of websocket connections per session.This will ensure one session is not able to exhaust the connection limit of the host. |
265
+
|`--connection-limit-per-session`| int |`10`| Let X be the maximum number of websocket connections per session. This will ensure one session is not able to exhaust the connection limit of the host. |
266
+
|`--delete-session-on-ui`| boolean |`false`| Enable capability to support deleting a session via the Grid UI. False by default. |
267
+
|`--register-shutdown-on-failure`| boolean |`false`| If enabled, the Node will shut down after the register period is completed without a successful registration. Useful in container environments to trigger a restart. |
268
+
|`--node-down-failure-threshold`| int |`3`| Maximum number of consecutive session creation failures before the Node is marked as DOWN. A value of `0` (default) disables this feature and allows unlimited retries. |
233
269
234
270
### Relay
235
271
@@ -264,17 +300,20 @@ pull request updating this page.
264
300
|`--https-private-key`| path |`/path/to/key.pkcs8`| Private key for https. Get more detailed information by running "java -jar selenium-server.jar info security" |
265
301
|`--max-threads`| int |`24`| Maximum number of listener threads. Default value is: (available processors) * 3. |
266
302
|`--port`| int |`4444`| Port to listen on. There is no default as this parameter is used by different components, for example, Router/Hub/Standalone will use 4444 and Node will use 5555. |
303
+
|`--registration-secret`| string |`"Hunter2"`| Shared secret used to authenticate Node registration requests. Must match the value set on the Hub/Distributor. |
267
304
268
305
### SessionQueue
269
306
270
307
| Option | Type | Value/Example | Description |
271
308
|---|---|---|---|
272
-
|`--sessionqueue`| uri |`http://localhost:1237`| Address of the session queue server. |
273
-
|`-sessionqueue-host`| string |`localhost`| Host on which the session queue server is listening. |
309
+
|`--sessionqueue`/ `--sq`| uri |`http://localhost:1237`| Address of the session queue server. |
310
+
|`--sessionqueue-host`| string |`localhost`| Host on which the session queue server is listening. |
274
311
|`--sessionqueue-port`| int |`1234`| Port on which the session queue server is listening. |
275
312
|`--session-request-timeout`| int |`300`| Timeout in seconds. A new incoming session request is added to the queue. Requests sitting in the queue for longer than the configured time will timeout. |
276
-
|`--session-retry-interval`| int |`5`| Retry interval in seconds. If all slots are busy, new session request will be retried after the given interval. |
277
-
|`--maximum-response-delay`| int |`8`| How often, in seconds, will the the SessionQueue response in case there is no data, to reduce the http requests while polling for new session requests. |
313
+
|`--session-request-timeout-period`| int |`10`| How often, in seconds, the timeout for queued new session requests is checked. |
314
+
|`--session-retry-interval`| int |`15`| Retry interval in milliseconds. If all slots are busy, new session request will be retried after the given interval. |
315
+
|`--sessionqueue-batch-size`| int |`20`| Maximum number of session requests that can be consumed from the queue at a time, based on the available slots. |
316
+
|`--maximum-response-delay`| int |`8`| How often, in seconds, will the SessionQueue respond in case there is no data, to reduce the http requests while polling for new session requests. (Config file only; not a CLI flag.) |
0 commit comments