From 3751c3074b03f6c27ce9d652059ccb27c394c7fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjam=C3=ADn=20Guzm=C3=A1n?= Date: Thu, 30 Mar 2023 08:49:33 -0600 Subject: [PATCH] Added docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Benjamín Guzmán --- docs/reference/compose_alpha.md | 1 + docs/reference/compose_alpha_viz.md | 18 ++++++ docs/reference/docker_compose_alpha.yaml | 2 + docs/reference/docker_compose_alpha_viz.yaml | 65 ++++++++++++++++++++ 4 files changed, 86 insertions(+) create mode 100644 docs/reference/compose_alpha_viz.md create mode 100644 docs/reference/docker_compose_alpha_viz.yaml diff --git a/docs/reference/compose_alpha.md b/docs/reference/compose_alpha.md index 1abd1e839..0aef6400f 100644 --- a/docs/reference/compose_alpha.md +++ b/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 | diff --git a/docs/reference/compose_alpha_viz.md b/docs/reference/compose_alpha_viz.md new file mode 100644 index 000000000..b76e86cd5 --- /dev/null +++ b/docs/reference/compose_alpha_viz.md @@ -0,0 +1,18 @@ +# docker compose alpha viz + + +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,
otherwise tab character '\t' will be used | + + + + diff --git a/docs/reference/docker_compose_alpha.yaml b/docs/reference/docker_compose_alpha.yaml index a8a83b6e7..612430f84 100644 --- a/docs/reference/docker_compose_alpha.yaml +++ b/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 diff --git a/docs/reference/docker_compose_alpha_viz.yaml b/docs/reference/docker_compose_alpha_viz.yaml new file mode 100644 index 000000000..c27c8a41d --- /dev/null +++ b/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 +