mirror of https://github.com/docker/compose.git
				
				
				
			add new bridge commands documentation
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
This commit is contained in:
		
							parent
							
								
									024f8ebdc5
								
							
						
					
					
						commit
						9a9227ce64
					
				|  | @ -12,6 +12,7 @@ Define and run multi-container applications with Docker | ||||||
| | Name                            | Description                                                                             | | | Name                            | Description                                                                             | | ||||||
| |:--------------------------------|:----------------------------------------------------------------------------------------| | |:--------------------------------|:----------------------------------------------------------------------------------------| | ||||||
| | [`attach`](compose_attach.md)   | Attach local standard input, output, and error streams to a service's running container | | | [`attach`](compose_attach.md)   | Attach local standard input, output, and error streams to a service's running container | | ||||||
|  | | [`bridge`](compose_bridge.md)   | Convert compose files into another model                                                | | ||||||
| | [`build`](compose_build.md)     | Build or rebuild services                                                               | | | [`build`](compose_build.md)     | Build or rebuild services                                                               | | ||||||
| | [`commit`](compose_commit.md)   | Create a new image from a service container's changes                                   | | | [`commit`](compose_commit.md)   | Create a new image from a service container's changes                                   | | ||||||
| | [`config`](compose_config.md)   | Parse, resolve and render compose file in canonical format                              | | | [`config`](compose_config.md)   | Parse, resolve and render compose file in canonical format                              | | ||||||
|  |  | ||||||
|  | @ -0,0 +1,22 @@ | ||||||
|  | # docker compose bridge | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_START--> | ||||||
|  | Convert compose files into another model | ||||||
|  | 
 | ||||||
|  | ### Subcommands | ||||||
|  | 
 | ||||||
|  | | Name                                                   | Description                                                                  | | ||||||
|  | |:-------------------------------------------------------|:-----------------------------------------------------------------------------| | ||||||
|  | | [`convert`](compose_bridge_convert.md)                 | Convert compose files to Kubernetes manifests, Helm charts, or another model | | ||||||
|  | | [`transformations`](compose_bridge_transformations.md) | Manage transformation images                                                 | | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ### Options | ||||||
|  | 
 | ||||||
|  | | Name        | Type   | Default | Description                     | | ||||||
|  | |:------------|:-------|:--------|:--------------------------------| | ||||||
|  | | `--dry-run` | `bool` |         | Execute command in dry run mode | | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_END--> | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,17 @@ | ||||||
|  | # docker compose bridge convert | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_START--> | ||||||
|  | Convert compose files to Kubernetes manifests, Helm charts, or another model | ||||||
|  | 
 | ||||||
|  | ### Options | ||||||
|  | 
 | ||||||
|  | | Name                     | Type          | Default | Description                                                                          | | ||||||
|  | |:-------------------------|:--------------|:--------|:-------------------------------------------------------------------------------------| | ||||||
|  | | `--dry-run`              | `bool`        |         | Execute command in dry run mode                                                      | | ||||||
|  | | `-o`, `--output`         | `string`      | `out`   | The output directory for the Kubernetes resources                                    | | ||||||
|  | | `--templates`            | `string`      |         | Directory containing transformation templates                                        | | ||||||
|  | | `-t`, `--transformation` | `stringArray` |         | Transformation to apply to compose model (default: docker/compose-bridge-kubernetes) | | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_END--> | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,22 @@ | ||||||
|  | # docker compose bridge transformations | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_START--> | ||||||
|  | Manage transformation images | ||||||
|  | 
 | ||||||
|  | ### Subcommands | ||||||
|  | 
 | ||||||
|  | | Name                                                 | Description                    | | ||||||
|  | |:-----------------------------------------------------|:-------------------------------| | ||||||
|  | | [`create`](compose_bridge_transformations_create.md) | Create a new transformation    | | ||||||
|  | | [`list`](compose_bridge_transformations_list.md)     | List available transformations | | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | ### Options | ||||||
|  | 
 | ||||||
|  | | Name        | Type   | Default | Description                     | | ||||||
|  | |:------------|:-------|:--------|:--------------------------------| | ||||||
|  | | `--dry-run` | `bool` |         | Execute command in dry run mode | | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_END--> | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,15 @@ | ||||||
|  | # docker compose bridge transformations create | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_START--> | ||||||
|  | Create a new transformation | ||||||
|  | 
 | ||||||
|  | ### Options | ||||||
|  | 
 | ||||||
|  | | Name           | Type     | Default | Description                                                                 | | ||||||
|  | |:---------------|:---------|:--------|:----------------------------------------------------------------------------| | ||||||
|  | | `--dry-run`    | `bool`   |         | Execute command in dry run mode                                             | | ||||||
|  | | `-f`, `--from` | `string` |         | Existing transformation to copy (default: docker/compose-bridge-kubernetes) | | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_END--> | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,20 @@ | ||||||
|  | # docker compose bridge transformations list | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_START--> | ||||||
|  | List available transformations | ||||||
|  | 
 | ||||||
|  | ### Aliases | ||||||
|  | 
 | ||||||
|  | `docker compose bridge transformations list`, `docker compose bridge transformations ls` | ||||||
|  | 
 | ||||||
|  | ### Options | ||||||
|  | 
 | ||||||
|  | | Name            | Type     | Default | Description                                | | ||||||
|  | |:----------------|:---------|:--------|:-------------------------------------------| | ||||||
|  | | `--dry-run`     | `bool`   |         | Execute command in dry run mode            | | ||||||
|  | | `--format`      | `string` | `table` | Format the output. Values: [table \| json] | | ||||||
|  | | `-q`, `--quiet` | `bool`   |         | Only display transformer names             | | ||||||
|  | 
 | ||||||
|  | 
 | ||||||
|  | <!---MARKER_GEN_END--> | ||||||
|  | 
 | ||||||
|  | @ -6,6 +6,7 @@ pname: docker | ||||||
| plink: docker.yaml | plink: docker.yaml | ||||||
| cname: | cname: | ||||||
|     - docker compose attach |     - docker compose attach | ||||||
|  |     - docker compose bridge | ||||||
|     - docker compose build |     - docker compose build | ||||||
|     - docker compose commit |     - docker compose commit | ||||||
|     - docker compose config |     - docker compose config | ||||||
|  | @ -40,6 +41,7 @@ cname: | ||||||
|     - docker compose watch |     - docker compose watch | ||||||
| clink: | clink: | ||||||
|     - docker_compose_attach.yaml |     - docker_compose_attach.yaml | ||||||
|  |     - docker_compose_bridge.yaml | ||||||
|     - docker_compose_build.yaml |     - docker_compose_build.yaml | ||||||
|     - docker_compose_commit.yaml |     - docker_compose_commit.yaml | ||||||
|     - docker_compose_config.yaml |     - docker_compose_config.yaml | ||||||
|  |  | ||||||
|  | @ -0,0 +1,29 @@ | ||||||
|  | command: docker compose bridge | ||||||
|  | short: Convert compose files into another model | ||||||
|  | long: Convert compose files into another model | ||||||
|  | pname: docker compose | ||||||
|  | plink: docker_compose.yaml | ||||||
|  | cname: | ||||||
|  |     - docker compose bridge convert | ||||||
|  |     - docker compose bridge transformations | ||||||
|  | clink: | ||||||
|  |     - docker_compose_bridge_convert.yaml | ||||||
|  |     - docker_compose_bridge_transformations.yaml | ||||||
|  | inherited_options: | ||||||
|  |     - option: dry-run | ||||||
|  |       value_type: bool | ||||||
|  |       default_value: "false" | ||||||
|  |       description: Execute command in dry run mode | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | deprecated: false | ||||||
|  | hidden: false | ||||||
|  | experimental: false | ||||||
|  | experimentalcli: false | ||||||
|  | kubernetes: false | ||||||
|  | swarm: false | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,59 @@ | ||||||
|  | command: docker compose bridge convert | ||||||
|  | short: | | ||||||
|  |     Convert compose files to Kubernetes manifests, Helm charts, or another model | ||||||
|  | long: | | ||||||
|  |     Convert compose files to Kubernetes manifests, Helm charts, or another model | ||||||
|  | usage: docker compose bridge convert | ||||||
|  | pname: docker compose bridge | ||||||
|  | plink: docker_compose_bridge.yaml | ||||||
|  | options: | ||||||
|  |     - option: output | ||||||
|  |       shorthand: o | ||||||
|  |       value_type: string | ||||||
|  |       default_value: out | ||||||
|  |       description: The output directory for the Kubernetes resources | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  |     - option: templates | ||||||
|  |       value_type: string | ||||||
|  |       description: Directory containing transformation templates | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  |     - option: transformation | ||||||
|  |       shorthand: t | ||||||
|  |       value_type: stringArray | ||||||
|  |       default_value: '[]' | ||||||
|  |       description: | | ||||||
|  |         Transformation to apply to compose model (default: docker/compose-bridge-kubernetes) | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | inherited_options: | ||||||
|  |     - option: dry-run | ||||||
|  |       value_type: bool | ||||||
|  |       default_value: "false" | ||||||
|  |       description: Execute command in dry run mode | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | deprecated: false | ||||||
|  | hidden: false | ||||||
|  | experimental: false | ||||||
|  | experimentalcli: false | ||||||
|  | kubernetes: false | ||||||
|  | swarm: false | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,29 @@ | ||||||
|  | command: docker compose bridge transformations | ||||||
|  | short: Manage transformation images | ||||||
|  | long: Manage transformation images | ||||||
|  | pname: docker compose bridge | ||||||
|  | plink: docker_compose_bridge.yaml | ||||||
|  | cname: | ||||||
|  |     - docker compose bridge transformations create | ||||||
|  |     - docker compose bridge transformations list | ||||||
|  | clink: | ||||||
|  |     - docker_compose_bridge_transformations_create.yaml | ||||||
|  |     - docker_compose_bridge_transformations_list.yaml | ||||||
|  | inherited_options: | ||||||
|  |     - option: dry-run | ||||||
|  |       value_type: bool | ||||||
|  |       default_value: "false" | ||||||
|  |       description: Execute command in dry run mode | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | deprecated: false | ||||||
|  | hidden: false | ||||||
|  | experimental: false | ||||||
|  | experimentalcli: false | ||||||
|  | kubernetes: false | ||||||
|  | swarm: false | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,36 @@ | ||||||
|  | command: docker compose bridge transformations create | ||||||
|  | short: Create a new transformation | ||||||
|  | long: Create a new transformation | ||||||
|  | usage: docker compose bridge transformations create [OPTION] PATH | ||||||
|  | pname: docker compose bridge transformations | ||||||
|  | plink: docker_compose_bridge_transformations.yaml | ||||||
|  | options: | ||||||
|  |     - option: from | ||||||
|  |       shorthand: f | ||||||
|  |       value_type: string | ||||||
|  |       description: | | ||||||
|  |         Existing transformation to copy (default: docker/compose-bridge-kubernetes) | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | inherited_options: | ||||||
|  |     - option: dry-run | ||||||
|  |       value_type: bool | ||||||
|  |       default_value: "false" | ||||||
|  |       description: Execute command in dry run mode | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | deprecated: false | ||||||
|  | hidden: false | ||||||
|  | experimental: false | ||||||
|  | experimentalcli: false | ||||||
|  | kubernetes: false | ||||||
|  | swarm: false | ||||||
|  | 
 | ||||||
|  | @ -0,0 +1,47 @@ | ||||||
|  | command: docker compose bridge transformations list | ||||||
|  | aliases: docker compose bridge transformations list, docker compose bridge transformations ls | ||||||
|  | short: List available transformations | ||||||
|  | long: List available transformations | ||||||
|  | usage: docker compose bridge transformations list | ||||||
|  | pname: docker compose bridge transformations | ||||||
|  | plink: docker_compose_bridge_transformations.yaml | ||||||
|  | options: | ||||||
|  |     - option: format | ||||||
|  |       value_type: string | ||||||
|  |       default_value: table | ||||||
|  |       description: 'Format the output. Values: [table | json]' | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  |     - option: quiet | ||||||
|  |       shorthand: q | ||||||
|  |       value_type: bool | ||||||
|  |       default_value: "false" | ||||||
|  |       description: Only display transformer names | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | inherited_options: | ||||||
|  |     - option: dry-run | ||||||
|  |       value_type: bool | ||||||
|  |       default_value: "false" | ||||||
|  |       description: Execute command in dry run mode | ||||||
|  |       deprecated: false | ||||||
|  |       hidden: false | ||||||
|  |       experimental: false | ||||||
|  |       experimentalcli: false | ||||||
|  |       kubernetes: false | ||||||
|  |       swarm: false | ||||||
|  | deprecated: false | ||||||
|  | hidden: false | ||||||
|  | experimental: false | ||||||
|  | experimentalcli: false | ||||||
|  | kubernetes: false | ||||||
|  | swarm: false | ||||||
|  | 
 | ||||||
		Loading…
	
		Reference in New Issue