Skip to content

Commit 3751c30

Browse files
BenjaminGuzmanndeloof
authored andcommitted
Added docs
Signed-off-by: Benjamín Guzmán <[email protected]>
1 parent 2bc6a45 commit 3751c30

File tree

4 files changed

+86
-0
lines changed

4 files changed

+86
-0
lines changed

docs/reference/compose_alpha.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Experimental commands
88
| Name | Description |
99
|:--------------------------------------|:-----------------------------------------------------------------------------------------------------|
1010
| [`dry-run`](compose_alpha_dry-run.md) | EXPERIMENTAL - Dry run command allow you to test a command without applying changes |
11+
| [`viz`](compose_alpha_viz.md) | EXPERIMENTAL - Generate a graphviz graph from your compose file |
1112
| [`watch`](compose_alpha_watch.md) | EXPERIMENTAL - Watch build context for service and rebuild/refresh containers when files are updated |
1213

1314

docs/reference/compose_alpha_viz.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# docker compose alpha viz
2+
3+
<!---MARKER_GEN_START-->
4+
EXPERIMENTAL - Generate a graphviz graph from your compose file
5+
6+
### Options
7+
8+
| Name | Type | Default | Description |
9+
|:---------------------|:------|:--------|:---------------------------------------------------------------------------------------------------|
10+
| `--image` | | | Include service's image name in output graph |
11+
| `--indentation-size` | `int` | `1` | Number of tabs or spaces to use for indentation |
12+
| `--networks` | | | Include service's attached networks in output graph |
13+
| `--ports` | | | Include service's exposed ports in output graph |
14+
| `--spaces` | | | If given, space character ' ' will be used to indent,<br>otherwise tab character '\t' will be used |
15+
16+
17+
<!---MARKER_GEN_END-->
18+

docs/reference/docker_compose_alpha.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ pname: docker compose
55
plink: docker_compose.yaml
66
cname:
77
- docker compose alpha dry-run
8+
- docker compose alpha viz
89
- docker compose alpha watch
910
clink:
1011
- docker_compose_alpha_dry-run.yaml
12+
- docker_compose_alpha_viz.yaml
1113
- docker_compose_alpha_watch.yaml
1214
deprecated: false
1315
experimental: false
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
command: docker compose alpha viz
2+
short: EXPERIMENTAL - Generate a graphviz graph from your compose file
3+
long: EXPERIMENTAL - Generate a graphviz graph from your compose file
4+
usage: docker compose alpha viz [OPTIONS]
5+
pname: docker compose alpha
6+
plink: docker_compose_alpha.yaml
7+
options:
8+
- option: image
9+
value_type: bool
10+
default_value: "false"
11+
description: Include service's image name in output graph
12+
deprecated: false
13+
hidden: false
14+
experimental: false
15+
experimentalcli: false
16+
kubernetes: false
17+
swarm: false
18+
- option: indentation-size
19+
value_type: int
20+
default_value: "1"
21+
description: Number of tabs or spaces to use for indentation
22+
deprecated: false
23+
hidden: false
24+
experimental: false
25+
experimentalcli: false
26+
kubernetes: false
27+
swarm: false
28+
- option: networks
29+
value_type: bool
30+
default_value: "false"
31+
description: Include service's attached networks in output graph
32+
deprecated: false
33+
hidden: false
34+
experimental: false
35+
experimentalcli: false
36+
kubernetes: false
37+
swarm: false
38+
- option: ports
39+
value_type: bool
40+
default_value: "false"
41+
description: Include service's exposed ports in output graph
42+
deprecated: false
43+
hidden: false
44+
experimental: false
45+
experimentalcli: false
46+
kubernetes: false
47+
swarm: false
48+
- option: spaces
49+
value_type: bool
50+
default_value: "false"
51+
description: |-
52+
If given, space character ' ' will be used to indent,
53+
otherwise tab character '\t' will be used
54+
deprecated: false
55+
hidden: false
56+
experimental: false
57+
experimentalcli: false
58+
kubernetes: false
59+
swarm: false
60+
deprecated: false
61+
experimental: false
62+
experimentalcli: true
63+
kubernetes: false
64+
swarm: false
65+

0 commit comments

Comments
 (0)