[docs] pre-update for release docs generation

Signed-off-by: Viet Nguyen Duc <[email protected]>
SeleniumHQ · Apr 24, 2024 · f39a9da · f39a9da
1 parent 677168f
commit f39a9da
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 24 deletions.
diff --git a/.github/workflows/helm-chart-test.yml b/.github/workflows/helm-chart-test.yml
@@ -37,40 +37,40 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - k8s-version: 'v1.25.16'
+          - k8s-version: 'v1.26.15'
             test-strategy: job
-            cluster: 'kind'
+            cluster: 'minikube'
             helm-version: 'v3.10.3'
             test-existing-keda: true
             test-upgrade: true
-          - k8s-version: 'v1.26.15'
+          - k8s-version: 'v1.27.13'
             test-strategy: deployment
             cluster: 'minikube'
             helm-version: 'v3.11.3'
             test-existing-keda: true
             test-upgrade: true
-          - k8s-version: 'v1.27.12'
+          - k8s-version: 'v1.28.9'
             test-strategy: job_https
             cluster: 'minikube'
             helm-version: 'v3.12.3'
             test-existing-keda: true
             test-upgrade: true
-          - k8s-version: 'v1.28.8'
+          - k8s-version: 'v1.29.4'
             test-strategy: job_hostname
             cluster: 'minikube'
             helm-version: 'v3.13.3'
             test-existing-keda: false
             test-upgrade: true
-          - k8s-version: 'v1.29.3'
+          - k8s-version: 'v1.30.0'
             test-strategy: deployment_https
             cluster: 'minikube'
-            helm-version: 'v3.14.3'
+            helm-version: 'v3.14.4'
             test-existing-keda: false
             test-upgrade: true
     env:
       CLUSTER: ${{ matrix.cluster }}
       KUBERNETES_VERSION: ${{ matrix.k8s-version }}
-      ARTIFACT_NAME: ${{ matrix.k8s-version }}-${{ matrix.test-strategy }}
+      ARTIFACT_NAME: "${{ matrix.k8s-version }}-${{ matrix.test-strategy }}"
       HELM_VERSION: ${{ matrix.helm-version }}
       TEST_EXISTING_KEDA: ${{ matrix.test-existing-keda }}
       TEST_UPGRADE_CHART: ${{ matrix.test-upgrade }}
@@ -155,7 +155,7 @@ jobs:
         if: always()
         uses: actions/upload-artifact@main
         with:
-          name: ${{ env.ARTIFACT_NAME }}_${{ env.CHART_FILE_NAME }}
+          name: "${{ env.ARTIFACT_NAME }}_${{ env.CHART_FILE_NAME }}"
           path: ${{ env.CHART_PACKAGE_PATH }}
       - name: Upload chart test artifacts
         if: always()

diff --git a/NodeDocker/config.toml b/NodeDocker/config.toml
@@ -14,7 +14,7 @@ configs = [
 # socat -4 TCP-LISTEN:2375,fork UNIX-CONNECT:/var/run/docker.sock
 url = "http://127.0.0.1:2375"
 # Docker image used for video recording
-video-image = "selenium/video:ffmpeg-6.1-20240402"
+video-image = "selenium/video:ffmpeg-7.0-20240402"
 
 # Uncomment the following section if you are running the node on a separate VM
 # Fill out the placeholders with appropriate values

diff --git a/README.md b/README.md
@@ -512,7 +512,7 @@ ___
 
 ## Video recording
 
-Tests execution can be recorded by using the `selenium/video:ffmpeg-6.1-20240402`
+Tests execution can be recorded by using the `selenium/video:ffmpeg-7.0-20240402`
 Docker image. One container is needed per each container where a browser is running. This means if you are
 running 5 Nodes/Standalone containers, you will need 5 video containers, the mapping is 1-1.
 
@@ -539,7 +539,7 @@ This example shows how to start the containers manually:
 ``` bash
 $ docker network create grid
 $ docker run -d -p 4444:4444 -p 6900:5900 --net grid --name selenium --shm-size="2g" selenium/standalone-chrome:4.19.1-20240402
-$ docker run -d --net grid --name video -v /tmp/videos:/videos selenium/video:ffmpeg-6.1-20240402
+$ docker run -d --net grid --name video -v /tmp/videos:/videos selenium/video:ffmpeg-7.0-20240402
 # Run your tests
 $ docker stop video && docker rm video
 $ docker stop selenium && docker rm selenium
@@ -618,6 +618,8 @@ configs = [
     "selenium/standalone-edge:4.19.1-20240402", '{"browserName": "MicrosoftEdge"}'
 ]
 
+host-config-keys = ["Dns", "DnsOptions", "DnsSearch", "ExtraHosts", "Binds"]
+
 # URL for connecting to the docker daemon
 # Most simple approach, leave it as http://127.0.0.1:2375, and mount /var/run/docker.sock.
 # 127.0.0.1 is used because internally the container uses socat when /var/run/docker.sock is mounted 
@@ -628,7 +630,7 @@ configs = [
 # Linux: varies from machine to machine, please mount /var/run/docker.sock. If this does not work, please create an issue.
 url = "http://127.0.0.1:2375"
 # Docker image used for video recording
-video-image = "selenium/video:ffmpeg-6.1-20240402"
+video-image = "selenium/video:ffmpeg-7.0-20240402"
 
 # Uncomment the following section if you are running the node on a separate VM
 # Fill out the placeholders with appropriate values
@@ -637,6 +639,10 @@ video-image = "selenium/video:ffmpeg-6.1-20240402"
 #port = <port-from-node-machine>
 ```
 
+With the optional config key `host-config-keys` under section [docker] in a config.toml file (or CLI option --docker-host-config-keys). Users can specify a list of docker host configuration keys that should be passed to browser containers.
+
+Valid key names for Docker host config can be found in the Docker API [documentation](https://docs.docker.com/engine/api/latest/#tag/Container/operation/ContainerCreate) or via the command `docker inspect` the node-docker container.
+
 ### Execution with Hub & Node roles
 
 This can be expanded to a full Grid deployment, all components deployed individually. The overall
@@ -759,7 +765,7 @@ configs = [
 # Linux: varies from machine to machine, please mount /var/run/docker.sock. If this does not work, please create an issue.
 url = "http://127.0.0.1:2375"
 # Docker image used for video recording
-video-image = "selenium/video:ffmpeg-6.1-20240402"
+video-image = "selenium/video:ffmpeg-7.0-20240402"
 
 # Uncomment the following section if you are running the node on a separate VM
 # Fill out the placeholders with appropriate values

diff --git a/charts/selenium-grid/README.md b/charts/selenium-grid/README.md
@@ -305,7 +305,7 @@ For now, global configuration supported is:
 | `global.seleniumGrid.imageRegistry`             | `selenium`            | Distribution registry to pull images      |
 | `global.seleniumGrid.imageTag`                  | `4.19.1-20240402`     | Image tag for all selenium components     |
 | `global.seleniumGrid.nodesImageTag`             | `4.19.1-20240402`     | Image tag for browser's nodes             |
-| `global.seleniumGrid.videoImageTag`             | `ffmpeg-6.1-20240402` | Image tag for browser's video recorder    |
+| `global.seleniumGrid.videoImageTag`             | `ffmpeg-7.0-20240402` | Image tag for browser's video recorder    |
 | `global.seleniumGrid.imagePullSecret`           | `""`                  | Pull secret to be used for all images     |
 | `global.seleniumGrid.imagePullSecret`           | `""`                  | Pull secret to be used for all images     |
 | `global.seleniumGrid.affinity`                  | `{}`                  | Affinity assigned globally                |
@@ -844,7 +844,7 @@ This table contains the configuration parameters of the chart and their default
 | `videoRecorder.enabled`                       | `false`                                     | Enable video recorder for node                                                                                             |
 | `videoRecorder.imageRegistry`                 | `nil`                                       | Distribution registry to pull the image (this overwrites `.global.seleniumGrid.imageRegistry` value)                       |
 | `videoRecorder.imageName`                     | `video`                                     | Selenium video recorder image name                                                                                         |
-| `videoRecorder.imageTag`                      | `ffmpeg-6.1-20240402`                       | Image tag of video recorder                                                                                                |
+| `videoRecorder.imageTag`                      | `ffmpeg-7.0-20240402`                       | Image tag of video recorder                                                                                                |
 | `videoRecorder.imagePullPolicy`               | `IfNotPresent`                              | Image pull policy (see https://kubernetes.io/docs/concepts/containers/images/#updating-images)                             |
 | `videoRecorder.uploader.enabled`              | `false`                                     | Enable the uploader for videos                                                                                             |
 | `videoRecorder.uploader.destinationPrefix`    | ``                                          | Destination for uploading video file. It is following `rclone` config                                                      |

diff --git a/charts/selenium-grid/values.yaml b/charts/selenium-grid/values.yaml
@@ -11,7 +11,7 @@ global:
     # Image tag for browser's nodes
     nodesImageTag: 4.19.1-20240402
     # Image tag for browser's video recorder
-    videoImageTag: ffmpeg-6.1-20240402
+    videoImageTag: ffmpeg-7.0-20240402
     # Pull secret for all components, can be overridden individually
     imagePullSecret: ""
     # Log level for all components. Possible values describe here: https://www.selenium.dev/documentation/grid/configuration/cli_options/#logging
@@ -1066,7 +1066,7 @@ videoRecorder:
   # Image of video recorder
   imageName: video
   # Image of video recorder
-  # imageTag: ffmpeg-6.1-20240402
+  # imageTag: ffmpeg-7.0-20240402
   # Image pull policy (see https://kubernetes.io/docs/concepts/containers/images/#updating-images)
   imagePullPolicy: IfNotPresent
   # Image pull secret (see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/)

diff --git a/docker-compose-v3-video-upload.yml b/docker-compose-v3-video-upload.yml
@@ -35,7 +35,7 @@ services:
       - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
 
   chrome_video:
-    image: selenium/video:ffmpeg-6.1-20240402
+    image: selenium/video:ffmpeg-7.0-20240402
     depends_on:
       - chrome
     environment:
@@ -56,7 +56,7 @@ services:
       - RCLONE_CONFIG_S3_NO_CHECK_BUCKET=true
 
   edge_video:
-    image: selenium/video:ffmpeg-6.1-20240402
+    image: selenium/video:ffmpeg-7.0-20240402
     depends_on:
       - edge
     environment:
@@ -77,7 +77,7 @@ services:
       - RCLONE_CONFIG_S3_NO_CHECK_BUCKET=true
 
   firefox_video:
-    image: selenium/video:ffmpeg-6.1-20240402
+    image: selenium/video:ffmpeg-7.0-20240402
     depends_on:
       - firefox
     environment:

diff --git a/docker-compose-v3-video.yml b/docker-compose-v3-video.yml
@@ -34,7 +34,7 @@ services:
       - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
 
   chrome_video:
-    image: selenium/video:ffmpeg-6.1-20240402
+    image: selenium/video:ffmpeg-7.0-20240402
     volumes:
       - /tmp/videos:/videos
     depends_on:
@@ -44,7 +44,7 @@ services:
       - FILE_NAME=chrome_video.mp4
 
   edge_video:
-    image: selenium/video:ffmpeg-6.1-20240402
+    image: selenium/video:ffmpeg-7.0-20240402
     volumes:
       - /tmp/videos:/videos
     depends_on:
@@ -54,7 +54,7 @@ services:
       - FILE_NAME=edge_video.mp4
 
   firefox_video:
-    image: selenium/video:ffmpeg-6.1-20240402
+    image: selenium/video:ffmpeg-7.0-20240402
     volumes:
       - /tmp/videos:/videos
     depends_on: