Added actual data from docker compose file into docs. Added more robust yaml merging

Author: Slyke

docs/Custom.md

@@ -98,12 +98,16 @@ Custom services can be added in a similar way to overriding default settings for
 Firstly, put the following into `compose-override.yml`:
 ```
 services:
+  mosquitto:
+    ports:
+      - 1996:1996
+      - 9001:9001
   minecraft:
     image: itzg/minecraft-server
     ports:
       - "25565:25565"
     volumes:
-      - "./services/minecraft:/data"
+      - "./volumes/minecraft:/data"
     environment:
       EULA: "TRUE"
       TYPE: "PAPER"
@@ -123,8 +127,7 @@ services:
       - "4326:4326"
       - "4327:4327"
     volumes:
-      - "./rcon_data:/opt/rcon-web-admin/db"
-
+      - "./volumes/rcon_data:/opt/rcon-web-admin/db"
 secrets:
   db_password:
     file: ./db_password
@@ -148,46 +151,47 @@ Using the Mosquitto example above, the final `docker-compose.yml` file will look
 version: '3.6'
 services:
   mosquitto:
+    ports:
+    - 1996:1996
+    - 9001:9001
     container_name: mosquitto
     image: eclipse-mosquitto
     restart: unless-stopped
-    user: "1883"
-    ports:
-      - 1883:1883
-      - 9001:9001
+    user: '1883'
     volumes:
-      - ./volumes/mosquitto/data:/mosquitto/data
-      - ./volumes/mosquitto/log:/mosquitto/log
-      - ./volumes/mosquitto/pwfile:/mosquitto/pwfile
-      - ./services/mosquitto/mosquitto.conf:/mosquitto/config/mosquitto.conf
-      - ./services/mosquitto/filter.acl:/mosquitto/config/filter.acl
+    - ./volumes/mosquitto/data:/mosquitto/data
+    - ./volumes/mosquitto/log:/mosquitto/log
+    - ./services/mosquitto/mosquitto.conf:/mosquitto/config/mosquitto.conf
+    - ./services/mosquitto/filter.acl:/mosquitto/config/filter.acl
   minecraft:
     image: itzg/minecraft-server
     ports:
-      - "25565:25565"
+    - 25565:25565
     volumes:
-      - "./volumes/minecraft:/data"
+    - ./volumes/minecraft:/data
     environment:
-      EULA: "TRUE"
-      TYPE: "PAPER"
-      ENABLE_RCON: "true"
-      RCON_PASSWORD: "PASSWORD"
+      EULA: 'TRUE'
+      TYPE: PAPER
+      ENABLE_RCON: 'true'
+      RCON_PASSWORD: PASSWORD
       RCON_PORT: 28016
-      VERSION: "1.15.2"
-      REPLACE_ENV_VARIABLES: "TRUE"
-      ENV_VARIABLE_PREFIX: "CFG_"
-      CFG_DB_HOST: "http://localhost:3306"
-      CFG_DB_NAME: "IOTstack Minecraft"
-      CFG_DB_PASSWORD_FILE: "/run/secrets/db_password"
+      VERSION: 1.15.2
+      REPLACE_ENV_VARIABLES: 'TRUE'
+      ENV_VARIABLE_PREFIX: CFG_
+      CFG_DB_HOST: http://localhost:3306
+      CFG_DB_NAME: IOTstack Minecraft
+      CFG_DB_PASSWORD_FILE: /run/secrets/db_password
     restart: unless-stopped
   rcon:
     image: itzg/rcon
     ports:
-      - "4326:4326"
-      - "4327:4327"
+    - 4326:4326
+    - 4327:4327
     volumes:
-      - "./volumes/rcon_data:/opt/rcon-web-admin/db"
+    - ./volumes/rcon_data:/opt/rcon-web-admin/db
 secrets:
   db_password:
     file: ./db_password
 ```
+
+Do note that the order of the YAML keys is not guaranteed.

scripts/yaml_merge.py

@@ -27,13 +27,21 @@
   pathOutput = sys.argv[3]
 
   def mergeYaml(priorityYaml, defaultYaml):
-    if isinstance(priorityYaml, dict) and isinstance(defaultYaml, dict):
-      for k, v in defaultYaml.iteritems():
-        if k not in priorityYaml:
-          priorityYaml[k] = v
+    finalYaml = {}
+    if isinstance(defaultYaml, dict):
+      for dk, dv in defaultYaml.items():
+        if dk in priorityYaml:
+          finalYaml[dk] = mergeYaml(priorityYaml[dk], dv)
         else:
-          priorityYaml[k] = mergeYaml(priorityYaml[k], v)
-    return defaultYaml
+          finalYaml[dk] = dv
+      for pk, pv in priorityYaml.items():
+        if pk in finalYaml:
+          finalYaml[pk] = mergeYaml(finalYaml[pk], pv)
+        else:
+          finalYaml[pk] = pv
+    else:
+      finalYaml = defaultYaml
+    return finalYaml
 
   with open(r'%s' % pathTempDockerCompose) as fileTempDockerCompose:
     yamlTempDockerCompose = yaml.load(fileTempDockerCompose, Loader=yaml.SafeLoader)