Skip to content

Commit a273e13

Browse files
diemoldiemol
committed
Adding node implementation parameter to docs
[deploy site]
1 parent 124a8c1 commit a273e13

File tree

4 files changed

+38
-34
lines changed

4 files changed

+38
-34
lines changed

‎website_and_docs/content/documentation/grid/configuration/cli_options.en.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ pull request updating this page.
175175
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |
176176
| `--docker-video-image` | string | `selenium/video:latest` | Docker image to be used when video recording is enabled |
177177

178-
### Events
178+
### Events
179179

180180
| Option | Type | Value/Example | Description |
181181
|---|---|---|---|
@@ -196,7 +196,7 @@ pull request updating this page.
196196
| `--structured-logs` | boolean | `false` | Use structured logs |
197197
| `--tracing` | boolean | `true` | Enable trace collection |
198198

199-
### Network
199+
### Network
200200

201201
| Option | Type | Value/Example | Description |
202202
|---|---|---|---|
@@ -208,8 +208,9 @@ pull request updating this page.
208208
|---|---|---|---|---|
209209
| `--detect-drivers` | boolean | `true` | Autodetect which drivers are available on the current system, and add them to the Node. |
210210
| `--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 |
211-
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
211+
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
212212
| `--driver-implementation` | string[] | `"firefox"` | Drivers that should be checked. If specified, will skip autoconfiguration. |
213+
| `--node-implementation` | string | `"org.openqa.selenium.grid.node.local.LocalNodeFactory"` | Full classname of non-default Node implementation. This is used to manage a session's lifecycle. |
213214
| `--grid-url` | string | `https://grid.example.com` | Public URL of the Grid as a whole (typically the address of the Hub or the Router) |
214215
| `--heartbeat-period` | int | `60` | How often, in seconds, will the Node send heartbeat events to the Distributor to inform it that the Node is up. |
215216
| `--max-sessions` | int | `8` | Maximum number of concurrent sessions. Default value is the number of available processors. |
@@ -237,7 +238,7 @@ pull request updating this page.
237238
| `--username` | string | `admin` | User name clients must use to connect to the server. Both this and the password need to be set in order to be used. |
238239

239240

240-
### Server
241+
### Server
241242

242243
| Option | Type | Value/Example | Description |
243244
|---|---|---|---|
@@ -281,9 +282,9 @@ When needed, you can combine a Toml file configuration with CLI arguments.
281282
{{% /pageinfo %}}
282283

283284

284-
### Command-line flags
285+
### Command-line flags
285286

286-
To pass config options as command-line flags, identify the valid options for the component
287+
To pass config options as command-line flags, identify the valid options for the component
287288
and follow the template below.
288289

289290
```
@@ -308,7 +309,7 @@ java -jar selenium-server-<version>.jar hub --session-request-timeout 500 --port
308309
java -jar selenium-server-<version>.jar node --max-sessions 4 --log-level "fine" --port 7777 --driver-implementation "firefox" --driver-implementation "edge"
309310
```
310311

311-
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
312+
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
312313

313314
```
314315
java -jar selenium-server-<version>.jar distributor --sessions http://localhost:5556 --sessionqueue http://localhost:5559 --bind-bus false

‎website_and_docs/content/documentation/grid/configuration/cli_options.ja.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ aliases: [
1010

1111
{{% pageinfo color="warning" %}}
1212
<p class="lead">
13-
<i class="fas fa-language display-4"></i>
14-
Page being translated from
13+
<i class="fas fa-language display-4"></i>
14+
Page being translated from
1515
English to Japanese. Do you speak Japanese? Help us to translate
1616
it by sending us pull requests!
1717
</p>
@@ -184,7 +184,7 @@ pull request updating this page.
184184
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |
185185
| `--docker-video-image` | string | `selenium/video:latest` | Docker image to be used when video recording is enabled |
186186

187-
### Events
187+
### Events
188188

189189
| Option | Type | Value/Example | Description |
190190
|---|---|---|---|
@@ -205,7 +205,7 @@ pull request updating this page.
205205
| `--structured-logs` | boolean | `false` | Use structured logs |
206206
| `--tracing` | boolean | `true` | Enable trace collection |
207207

208-
### Network
208+
### Network
209209

210210
| Option | Type | Value/Example | Description |
211211
|---|---|---|---|
@@ -217,8 +217,9 @@ pull request updating this page.
217217
|---|---|---|---|---|
218218
| `--detect-drivers` | boolean | `true` | Autodetect which drivers are available on the current system, and add them to the Node. |
219219
| `--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 |
220-
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
220+
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
221221
| `--driver-implementation` | string[] | `"firefox"` | Drivers that should be checked. If specified, will skip autoconfiguration. |
222+
| `--node-implementation` | string | `"org.openqa.selenium.grid.node.local.LocalNodeFactory"` | Full classname of non-default Node implementation. This is used to manage a session's lifecycle. |
222223
| `--grid-url` | string | `https://grid.example.com` | Public URL of the Grid as a whole (typically the address of the Hub or the Router) |
223224
| `--heartbeat-period` | int | `60` | How often, in seconds, will the Node send heartbeat events to the Distributor to inform it that the Node is up. |
224225
| `--max-sessions` | int | `8` | Maximum number of concurrent sessions. Default value is the number of available processors. |
@@ -246,7 +247,7 @@ pull request updating this page.
246247
| `--username` | string | `admin` | User name clients must use to connect to the server. Both this and the password need to be set in order to be used. |
247248

248249

249-
### Server
250+
### Server
250251

251252
| Option | Type | Value/Example | Description |
252253
|---|---|---|---|
@@ -290,9 +291,9 @@ When needed, you can combine a Toml file configuration with CLI arguments.
290291
{{% /pageinfo %}}
291292

292293

293-
### Command-line flags
294+
### Command-line flags
294295

295-
To pass config options as command-line flags, identify the valid options for the component
296+
To pass config options as command-line flags, identify the valid options for the component
296297
and follow the template below.
297298

298299
```
@@ -317,7 +318,7 @@ java -jar selenium-server-<version>.jar hub --session-request-timeout 500 --port
317318
java -jar selenium-server-<version>.jar node --max-sessions 4 --log-level "fine" --port 7777 --driver-implementation "firefox" --driver-implementation "edge"
318319
```
319320

320-
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
321+
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
321322

322323
```
323324
java -jar selenium-server-<version>.jar distributor --sessions http://localhost:5556 --sessionqueue http://localhost:5559 --bind-bus false

‎website_and_docs/content/documentation/grid/configuration/cli_options.pt-br.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ aliases: [
1010

1111
{{% pageinfo color="warning" %}}
1212
<p class="lead">
13-
<i class="fas fa-language display-4"></i>
14-
Page being translated from
13+
<i class="fas fa-language display-4"></i>
14+
Page being translated from
1515
English to Portuguese. Do you speak Portuguese? Help us to translate
1616
it by sending us pull requests!
1717
</p>
@@ -184,7 +184,7 @@ pull request updating this page.
184184
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |
185185
| `--docker-video-image` | string | `selenium/video:latest` | Docker image to be used when video recording is enabled |
186186

187-
### Events
187+
### Events
188188

189189
| Option | Type | Value/Example | Description |
190190
|---|---|---|---|
@@ -205,7 +205,7 @@ pull request updating this page.
205205
| `--structured-logs` | boolean | `false` | Use structured logs |
206206
| `--tracing` | boolean | `true` | Enable trace collection |
207207

208-
### Network
208+
### Network
209209

210210
| Option | Type | Value/Example | Description |
211211
|---|---|---|---|
@@ -217,8 +217,9 @@ pull request updating this page.
217217
|---|---|---|---|---|
218218
| `--detect-drivers` | boolean | `true` | Autodetect which drivers are available on the current system, and add them to the Node. |
219219
| `--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 |
220-
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
220+
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
221221
| `--driver-implementation` | string[] | `"firefox"` | Drivers that should be checked. If specified, will skip autoconfiguration. |
222+
| `--node-implementation` | string | `"org.openqa.selenium.grid.node.local.LocalNodeFactory"` | Full classname of non-default Node implementation. This is used to manage a session's lifecycle. |
222223
| `--grid-url` | string | `https://grid.example.com` | Public URL of the Grid as a whole (typically the address of the Hub or the Router) |
223224
| `--heartbeat-period` | int | `60` | How often, in seconds, will the Node send heartbeat events to the Distributor to inform it that the Node is up. |
224225
| `--max-sessions` | int | `8` | Maximum number of concurrent sessions. Default value is the number of available processors. |
@@ -246,7 +247,7 @@ pull request updating this page.
246247
| `--username` | string | `admin` | User name clients must use to connect to the server. Both this and the password need to be set in order to be used. |
247248

248249

249-
### Server
250+
### Server
250251

251252
| Option | Type | Value/Example | Description |
252253
|---|---|---|---|
@@ -290,9 +291,9 @@ When needed, you can combine a Toml file configuration with CLI arguments.
290291
{{% /pageinfo %}}
291292

292293

293-
### Command-line flags
294+
### Command-line flags
294295

295-
To pass config options as command-line flags, identify the valid options for the component
296+
To pass config options as command-line flags, identify the valid options for the component
296297
and follow the template below.
297298

298299
```
@@ -317,7 +318,7 @@ java -jar selenium-server-<version>.jar hub --session-request-timeout 500 --port
317318
java -jar selenium-server-<version>.jar node --max-sessions 4 --log-level "fine" --port 7777 --driver-implementation "firefox" --driver-implementation "edge"
318319
```
319320

320-
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
321+
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
321322

322323
```
323324
java -jar selenium-server-<version>.jar distributor --sessions http://localhost:5556 --sessionqueue http://localhost:5559 --bind-bus false

‎website_and_docs/content/documentation/grid/configuration/cli_options.zh-cn.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ aliases: [
1010

1111
{{% pageinfo color="warning" %}}
1212
<p class="lead">
13-
<i class="fas fa-language display-4"></i>
14-
Page being translated from
13+
<i class="fas fa-language display-4"></i>
14+
Page being translated from
1515
English to Chinese. Do you speak Chinese? Help us to translate
1616
it by sending us pull requests!
1717
</p>
@@ -184,7 +184,7 @@ pull request updating this page.
184184
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |
185185
| `--docker-video-image` | string | `selenium/video:latest` | Docker image to be used when video recording is enabled |
186186

187-
### Events
187+
### Events
188188

189189
| Option | Type | Value/Example | Description |
190190
|---|---|---|---|
@@ -205,7 +205,7 @@ pull request updating this page.
205205
| `--structured-logs` | boolean | `false` | Use structured logs |
206206
| `--tracing` | boolean | `true` | Enable trace collection |
207207

208-
### Network
208+
### Network
209209

210210
| Option | Type | Value/Example | Description |
211211
|---|---|---|---|
@@ -217,8 +217,9 @@ pull request updating this page.
217217
|---|---|---|---|---|
218218
| `--detect-drivers` | boolean | `true` | Autodetect which drivers are available on the current system, and add them to the Node. |
219219
| `--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 |
220-
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
220+
| `--driver-factory` | string[] | `org.openqa.selenium.example.LynxDriverFactory '{"browserName": "lynx"}'` | Mapping of fully qualified class name to a browser configuration that this matches against. |
221221
| `--driver-implementation` | string[] | `"firefox"` | Drivers that should be checked. If specified, will skip autoconfiguration. |
222+
| `--node-implementation` | string | `"org.openqa.selenium.grid.node.local.LocalNodeFactory"` | Full classname of non-default Node implementation. This is used to manage a session's lifecycle. |
222223
| `--grid-url` | string | `https://grid.example.com` | Public URL of the Grid as a whole (typically the address of the Hub or the Router) |
223224
| `--heartbeat-period` | int | `60` | How often, in seconds, will the Node send heartbeat events to the Distributor to inform it that the Node is up. |
224225
| `--max-sessions` | int | `8` | Maximum number of concurrent sessions. Default value is the number of available processors. |
@@ -246,7 +247,7 @@ pull request updating this page.
246247
| `--username` | string | `admin` | User name clients must use to connect to the server. Both this and the password need to be set in order to be used. |
247248

248249

249-
### Server
250+
### Server
250251

251252
| Option | Type | Value/Example | Description |
252253
|---|---|---|---|
@@ -290,9 +291,9 @@ When needed, you can combine a Toml file configuration with CLI arguments.
290291
{{% /pageinfo %}}
291292

292293

293-
### Command-line flags
294+
### Command-line flags
294295

295-
To pass config options as command-line flags, identify the valid options for the component
296+
To pass config options as command-line flags, identify the valid options for the component
296297
and follow the template below.
297298

298299
```
@@ -317,7 +318,7 @@ java -jar selenium-server-<version>.jar hub --session-request-timeout 500 --port
317318
java -jar selenium-server-<version>.jar node --max-sessions 4 --log-level "fine" --port 7777 --driver-implementation "firefox" --driver-implementation "edge"
318319
```
319320

320-
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
321+
#### Distributor, setting Session Map server url, Session Queue server url, and disabling bus
321322

322323
```
323324
java -jar selenium-server-<version>.jar distributor --sessions http://localhost:5556 --sessionqueue http://localhost:5559 --bind-bus false

0 commit comments

Comments
 (0)