docs(jsonnet): add missing jsonnet.docker.compose configuration prope…

…rties
inetum-orleans · Feb 23, 2021 · 5941a46 · 5941a46
1 parent 4c4b3ff
commit 5941a46
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 14 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -32,20 +32,26 @@ configuration settings, please check the documentation of related feature.
     *ddb.yml*
 
     ```yaml
-    docker:
-      disabled_services: ['python']
+    jsonnet:
+      docker:
+        compose:
+          excluded_services: ['python']
     ```
 
     *ddb.local.yml*
     ```yaml
-    docker:
-      disabled_services: []
+    jsonnet:
+      docker:
+        compose:
+          excluded_services: []
     ```
 
     *effective configuration (ddb config)*
     ```yaml
-    docker:
-      disabled_services: []
+    jsonnet:
+      docker:
+        compose:
+          excluded_services: []
     ```
 
     As you can see lists are overriden by default too.
@@ -75,22 +81,28 @@ configuration settings, please check the documentation of related feature.
     *ddb.yml*
 
     ```yaml
-    docker:
-      disabled_services: ['python']
+    jsonnet:
+      docker:
+        compose:
+          excluded_services: ['python']
     ```
 
     *ddb.local.yml*
     ```yaml
-    docker:
-      disabled_services:
-        merge: append_if_missing
-        value: ['gunicorn']
+    jsonnet:
+      docker:
+        compose:
+          excluded_services:
+            merge: append_if_missing
+            value: ['gunicorn']
     ```
 
     *effective configuration (ddb config)*
     ```yaml
-    docker:
-      disabled_services: ['python', 'gunicorn']
+    jsonnet:
+      docker:
+        compose:
+          excluded_services: ['python', 'gunicorn']
     ```
 
 !!! info "Configuration and environment variables"

diff --git a/docs/features/jsonnet.md b/docs/features/jsonnet.md
@@ -46,6 +46,16 @@ Run `ddb configure` to evaluate templates and generate target files.
         | `virtualhost` | *VirtualHost* | `ddb.VirtualHost()` defaults. |
         | `xdebug` | *XDebug* | `ddb.XDebug()` defaults. |
 
+!!! summary "Docker Compose configuration (prefixed with `jsonnet.docker.compose.`)"
+    === "Simple"
+        | Property | Type | Description |
+        | :---------: | :----: | :----------- |
+        | `project_name` | string | Docker compose project name |
+        | `network_name` | string | Docker compose network name |
+        | `version` | string<br>`3.7` | YAML File version to use  |
+        | `excluded_services` | string[]<br>`[]` | Services to exclude (Block list). |
+        | `included_services` | string[]<br>`[]` | Services to include (Allow list). |
+
 !!! summary "Docker Networks configuration (prefixed with `jsonnet.docker.networks`)"
     === "Simple"
         | Property | Type | Description |