Browse Source

Added docs

Signed-off-by: Benjamín Guzmán <[email protected]>
Benjamín Guzmán 2 years ago
parent
commit
3751c3074b

+ 1 - 0
docs/reference/compose_alpha.md

@@ -8,6 +8,7 @@ Experimental commands
 | Name                                  | Description                                                                                          |
 |:--------------------------------------|:-----------------------------------------------------------------------------------------------------|
 | [`dry-run`](compose_alpha_dry-run.md) | EXPERIMENTAL - Dry run command allow you to test a command without applying changes                  |
+| [`viz`](compose_alpha_viz.md)         | EXPERIMENTAL - Generate a graphviz graph from your compose file                                      |
 | [`watch`](compose_alpha_watch.md)     | EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated |
 
 

+ 18 - 0
docs/reference/compose_alpha_viz.md

@@ -0,0 +1,18 @@
+# docker compose alpha viz
+
+<!---MARKER_GEN_START-->
+EXPERIMENTAL - Generate a graphviz graph from your compose file
+
+### Options
+
+| Name                 | Type  | Default | Description                                                                                        |
+|:---------------------|:------|:--------|:---------------------------------------------------------------------------------------------------|
+| `--image`            |       |         | Include service's image name in output graph                                                       |
+| `--indentation-size` | `int` | `1`     | Number of tabs or spaces to use for indentation                                                    |
+| `--networks`         |       |         | Include service's attached networks in output graph                                                |
+| `--ports`            |       |         | Include service's exposed ports in output graph                                                    |
+| `--spaces`           |       |         | If given, space character ' ' will be used to indent,<br>otherwise tab character '\t' will be used |
+
+
+<!---MARKER_GEN_END-->
+

+ 2 - 0
docs/reference/docker_compose_alpha.yaml

@@ -5,9 +5,11 @@ pname: docker compose
 plink: docker_compose.yaml
 cname:
     - docker compose alpha dry-run
+    - docker compose alpha viz
     - docker compose alpha watch
 clink:
     - docker_compose_alpha_dry-run.yaml
+    - docker_compose_alpha_viz.yaml
     - docker_compose_alpha_watch.yaml
 deprecated: false
 experimental: false

+ 65 - 0
docs/reference/docker_compose_alpha_viz.yaml

@@ -0,0 +1,65 @@
+command: docker compose alpha viz
+short: EXPERIMENTAL - Generate a graphviz graph from your compose file
+long: EXPERIMENTAL - Generate a graphviz graph from your compose file
+usage: docker compose alpha viz [OPTIONS]
+pname: docker compose alpha
+plink: docker_compose_alpha.yaml
+options:
+    - option: image
+      value_type: bool
+      default_value: "false"
+      description: Include service's image name in output graph
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: indentation-size
+      value_type: int
+      default_value: "1"
+      description: Number of tabs or spaces to use for indentation
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: networks
+      value_type: bool
+      default_value: "false"
+      description: Include service's attached networks in output graph
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: ports
+      value_type: bool
+      default_value: "false"
+      description: Include service's exposed ports in output graph
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: spaces
+      value_type: bool
+      default_value: "false"
+      description: |-
+        If given, space character ' ' will be used to indent,
+        otherwise tab character '\t' will be used
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+deprecated: false
+experimental: false
+experimentalcli: true
+kubernetes: false
+swarm: false
+