Skip to content

Commit 78dc23e

Browse files
giffletgifflet
authored
Update docker configuration section in documentation (#1011)
* Update docker configuration section in documentation This PR is the documentation of SeleniumHQ/selenium#10645. * Comment out the devices declaration [deploy site]
1 parent 94ab771 commit 78dc23e

8 files changed

Lines changed: 46 additions & 15 deletions

File tree

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ pull request updating this page.
170170
|---|---|---|---|
171171
| `--docker-assets-path` | string | `/opt/selenium/assets` | Absolute path where assets will be stored |
172172
| `--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"}') |
173+
| `--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 |
173174
| `--docker-host` | string | `localhost` | Host name where the Docker daemon is running |
174175
| `--docker-port` | int | `2375` | Port where the Docker daemon is running |
175176
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ pull request updating this page.
179179
|---|---|---|---|
180180
| `--docker-assets-path` | string | `/opt/selenium/assets` | Absolute path where assets will be stored |
181181
| `--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"}') |
182+
| `--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 |
182183
| `--docker-host` | string | `localhost` | Host name where the Docker daemon is running |
183184
| `--docker-port` | int | `2375` | Port where the Docker daemon is running |
184185
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ pull request updating this page.
179179
|---|---|---|---|
180180
| `--docker-assets-path` | string | `/opt/selenium/assets` | Absolute path where assets will be stored |
181181
| `--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"}') |
182+
| `--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 |
182183
| `--docker-host` | string | `localhost` | Host name where the Docker daemon is running |
183184
| `--docker-port` | int | `2375` | Port where the Docker daemon is running |
184185
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ pull request updating this page.
179179
|---|---|---|---|
180180
| `--docker-assets-path` | string | `/opt/selenium/assets` | Absolute path where assets will be stored |
181181
| `--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"}') |
182+
| `--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 |
182183
| `--docker-host` | string | `localhost` | Host name where the Docker daemon is running |
183184
| `--docker-port` | int | `2375` | Port where the Docker daemon is running |
184185
| `--docker-url` | string | `http://localhost:2375` | URL for connecting to the Docker daemon |

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,10 @@ webdriver-executable = '/path/to/chromedriver/95/chromedriver'
9494

9595
A Standalone or Node server that is able to run each new session in a Docker container. Disabling
9696
drivers detection, having maximum 2 concurrent sessions. Stereotypes configured need to be mapped
97-
to a Docker image, and the Docker daemon needs to be exposed via http/tcp.
97+
to a Docker image, and the Docker daemon needs to be exposed via http/tcp. In addition, it is
98+
possible to define which device files, accessible on the host, will be available in containers
99+
through the `devices` property. Refer to the [docker](https://docs.docker.com/engine/reference/commandline/run/#add-host-device-to-container---device) documentation
100+
for more information about how docker device mapping works.
98101

99102

100103
```toml
@@ -104,9 +107,13 @@ max-sessions = 2
104107

105108
[docker]
106109
configs = [
107-
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
108-
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
109-
]
110+
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
111+
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
112+
]
113+
#Optionally define all device files that should be mapped to docker containers
114+
#devices = [
115+
# "/dev/kvm:/dev/kvm"
116+
#]
110117
url = "http://localhost:2375"
111118
video-image = "selenium/video:latest"
112119
```

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,10 @@ webdriver-executable = '/path/to/chromedriver/95/chromedriver'
103103

104104
A Standalone or Node server that is able to run each new session in a Docker container. Disabling
105105
drivers detection, having maximum 2 concurrent sessions. Stereotypes configured need to be mapped
106-
to a Docker image, and the Docker daemon needs to be exposed via http/tcp.
106+
to a Docker image, and the Docker daemon needs to be exposed via http/tcp. In addition, it is
107+
possible to define which device files, accessible on the host, will be available in containers
108+
through the `devices` property. Refer to the [docker](https://docs.docker.com/engine/reference/commandline/run/#add-host-device-to-container---device) documentation
109+
for more information about how docker device mapping works.
107110

108111

109112
```toml
@@ -113,9 +116,13 @@ max-sessions = 2
113116

114117
[docker]
115118
configs = [
116-
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
117-
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
118-
]
119+
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
120+
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
121+
]
122+
#Optionally define all device files that should be mapped to docker containers
123+
#devices = [
124+
# "/dev/kvm:/dev/kvm"
125+
#]
119126
url = "http://localhost:2375"
120127
video-image = "selenium/video:latest"
121128
```

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,10 @@ webdriver-executable = '/path/to/chromedriver/95/chromedriver'
103103

104104
A Standalone or Node server that is able to run each new session in a Docker container. Disabling
105105
drivers detection, having maximum 2 concurrent sessions. Stereotypes configured need to be mapped
106-
to a Docker image, and the Docker daemon needs to be exposed via http/tcp.
106+
to a Docker image, and the Docker daemon needs to be exposed via http/tcp. In addition, it is
107+
possible to define which device files, accessible on the host, will be available in containers
108+
through the `devices` property. Refer to the [docker](https://docs.docker.com/engine/reference/commandline/run/#add-host-device-to-container---device) documentation
109+
for more information about how docker device mapping works.
107110

108111

109112
```toml
@@ -113,9 +116,13 @@ max-sessions = 2
113116

114117
[docker]
115118
configs = [
116-
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
117-
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
118-
]
119+
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
120+
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
121+
]
122+
#Optionally define all device files that should be mapped to docker containers
123+
#devices = [
124+
# "/dev/kvm:/dev/kvm"
125+
#]
119126
url = "http://localhost:2375"
120127
video-image = "selenium/video:latest"
121128
```

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ webdriver-executable = '/path/to/chromedriver/95/chromedriver'
110110
则最多有2个并发会话.
111111
原型配置需要映射一个Docker映像,
112112
Docker的守护进程需要通过http/tcp公开.
113+
此外，可以通过 `devices` 属性定义在主机上可访问的哪些设备文件将在容器中可用。
114+
有关 docker 设备映射如何工作的更多信息，请参阅 [docker](https://docs.docker.com/engine/reference/commandline/run/#add-host-device-to-container---device) 文档。
113115

114116
```toml
115117
[node]
@@ -118,9 +120,13 @@ max-sessions = 2
118120

119121
[docker]
120122
configs = [
121-
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
122-
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
123-
]
123+
"selenium/standalone-chrome:93.0", "{\"browserName\": \"chrome\", \"browserVersion\": \"91\"}",
124+
"selenium/standalone-firefox:92.0", "{\"browserName\": \"firefox\", \"browserVersion\": \"92\"}"
125+
]
126+
#Optionally define all device files that should be mapped to docker containers
127+
#devices = [
128+
# "/dev/kvm:/dev/kvm"
129+
#]
124130
url = "http://localhost:2375"
125131
video-image = "selenium/video:latest"
126132
```

0 commit comments

Comments
 (0)