Add documentation about available Docker images for Extender (#488)

* Add documentation about available Docker images for Extender and how to use it. * Review fixes. Add ru translation for document.
defold · Nov 4, 2024 · c085c46 · c085c46
1 parent 253ce34
commit c085c46
Show file tree

Hide file tree

Showing 3 changed files with 101 additions and 0 deletions.
diff --git a/docs/en/en.json b/docs/en/en.json
@@ -1677,6 +1677,10 @@
                     {
                         "path": "/manuals/extender-local-setup",
                         "name": "Setup local build server"
+                    },
+                    {
+                        "path": "/manuals/extender-docker-iamges",
+                        "name": "Avaialble Docker images to run Extender"
                     }
                 ]
             }

diff --git a/docs/en/manuals/extender-docker-images.md b/docs/en/manuals/extender-docker-images.md
@@ -0,0 +1,46 @@
+---
+title: Available Docker images
+brief: Document described available Docker images and Defold versions that used it
+---
+
+# Available Docker images
+Below is the list of all avaialble Docker images in public Registry. The images can be used to run Extender in environment with old SDKs that are no longer supported.
+
+|SDK               |Image tag                                                                                              |Platform name (in Extender's config) |Defold version that used image |
+|------------------|-------------------------------------------------------------------------------------------------------|-------------------------------------|-------------------------------|
+|Linux latest      |europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-linux-env:latest         |linux-latest                         |All Defold versions            |
+|Android NDK25     |europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-android-ndk25-env:latest |android-ndk25                        |Since 1.4.3                    |
+|Emscripten 2.0.11 |europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-2011-env:latest    |emsdk-2011                           |Until 1.7.0                    |
+|Emscripten 3.1.55 |europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-3155-env:latest    |emsdk-3155                           |[1.8.0-1.9.3]                  |
+|Emscripten 3.1.65 |europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-3165-env:latest    |emsdk-3165                           |Since 1.9.4                    |
+|Winsdk 2019       |europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-winsdk-2019-env:latest   |winsdk-2019                          |Until 1.6.1                    |
+|Winsdk 2022       |europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-winsdk-2022-env:latest   |winsdk-2022                          |Since 1.6.2                    |
+
+# How to use old Docker images
+To use old environment you should go through following steps:
+1. Modify `docker-compose.yml` from Extender's repository [link](https://github.com/defold/extender/blob/dev/server/docker/docker-compose.yml). Need to add one more definition of service with necessary Docker image. For example, if we want to use Docker image that contains Emscripten 2.0.11 we need to add following service definition:
+    ```yml
+    emscripten_2011-dev:
+        image: europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-2011-env:latest
+        extends:
+        file: common-services.yml
+        service: remote_builder
+        profiles:
+        - all
+        - web
+        networks:
+        default:
+            aliases:
+            - emsdk-2011
+    ```
+    Important fields are:
+    * **profiles** - list of profiles that triggers service start. Profile names passed via `--profile <profile_name>` argument to `docker compose` command.
+    * **networks** - list of networks that should used by Docker container. For running Extender used network with name `default`. Important to set service network aliases (it will be used in later Extender's configuration).
+2. Add definition of remote builder in [application-local-dev-app.yml](https://github.com/defold/extender/blob/dev/server/configs/application-local-dev-app.yml) in `extender.remote-builder.platforms` section. In our example it will looks like:
+    ```yml
+        emsdk-2011:
+            url: http://emsdk-2011:9000
+            instanceId: emsdk-2011
+    ```
+    Url should be in following format: `http://<service_network_alias>:9000`, where `service_network_alias` - network alias from step 1. 9000 - standard port for Extender (can be different if you are using custom Extender configuration).
+3. Run local Extender as it described in [How to run local Extender with preconfigured artifacts](/manuals/extender-local-setup#how-to-run-local-extender-with-preconfigured-artifacts).
diff --git a/docs/ru/manuals/extender-docker-images.md b/docs/ru/manuals/extender-docker-images.md
@@ -0,0 +1,51 @@
+---
+title: Доступные образы Docker
+brief: Документ описывает доступные образы Docker и версии Defold, которые их используют
+---
+
+# Доступные образы Docker
+
+Ниже представлен список всех доступных Docker-образов в публичном реестре. Эти образы можно использовать для запуска Extender в среде с устаревшими SDK, которые больше не поддерживаются.
+
+| SDK               | Тег образа                                                                                                   | Название платформы (в конфигурации Extender)| Версия Defold, использовавшая образ |
+|-------------------|--------------------------------------------------------------------------------------------------------------|---------------------------------------------|-------------------------------------|
+| Linux latest      | europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-linux-env:latest               | linux-latest                                | Все версии Defold                   |
+| Android NDK25     | europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-android-ndk25-env:latest       | android-ndk25                               | Начиная с 1.4.3                     |
+| Emscripten 2.0.11 | europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-2011-env:latest          | emsdk-2011                                  | До 1.7.0                            |
+| Emscripten 3.1.55 | europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-3155-env:latest          | emsdk-3155                                  | [1.8.0-1.9.3]                       |
+| Emscripten 3.1.65 | europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-3165-env:latest          | emsdk-3165                                  | Начиная с 1.9.4                     |
+| Winsdk 2019       | europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-winsdk-2019-env:latest         | winsdk-2019                                 | До 1.6.1                            |
+| Winsdk 2022       | europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-winsdk-2022-env:latest         | winsdk-2022                                 | Начиная с 1.6.2                     |
+
+# Как использовать старые образы Docker
+
+Для использования старой среды выполните следующие шаги:
+
+1. Измените `docker-compose.yml` из репозитория Extender [ссылка](https://github.com/defold/extender/blob/dev/server/docker/docker-compose.yml). Необходимо добавить ещё одно определение сервиса с нужным образом Docker. Например, если мы хотим использовать Docker-образ, содержащий Emscripten 2.0.11, нужно добавить следующее определение сервиса:
+    ```yml
+    emscripten_2011-dev:
+        image: europe-west1-docker.pkg.dev/extender-426409/extender-public-registry/extender-emsdk-2011-env:latest
+        extends:
+        file: common-services.yml
+        service: remote_builder
+        profiles:
+        - all
+        - web
+        networks:
+        default:
+            aliases:
+            - emsdk-2011
+    ```
+    Важные поля:
+    - **profiles** — список профилей, при которых запускается сервис. Названия профилей передаются через аргумент `--profile <profile_name>` команде `docker compose`.
+    - **networks** — список сетей, которые должны использоваться контейнером Docker. Для работы Extender используется сеть с именем `default`. Важно задать сетевые алиасы сервиса (они будут использоваться позже в конфигурации Extender).
+
+2. Добавьте определение удаленного билдера в [application-local-dev-app.yml](https://github.com/defold/extender/blob/dev/server/configs/application-local-dev-app.yml) в секции `extender.remote-builder.platforms`. В нашем примере это будет выглядеть так:
+    ```yml
+        emsdk-2011:
+            url: http://emsdk-2011:9000
+            instanceId: emsdk-2011
+    ```
+    URL должен быть в формате `http://<service_network_alias>:9000`, где `service_network_alias` — это сетевой алиас из шага 1. Порт 9000 является стандартным для Extender (может отличаться, если вы используете пользовательскую конфигурацию Extender).
+
+3. Запустите локальный Extender, как описано в [Как запустить локальный Extender с предварительно настроенными артефактами](/manuals/extender-local-setup#how-to-run-local-extender-with-preconfigured-artifacts).