Răsfoiți Sursa

Update docs to add `--scale` argument to `compose create`

Signed-off-by: Laura Brehm <[email protected]>
Laura Brehm 2 ani în urmă
părinte
comite
a288332fbd

+ 9 - 8
docs/reference/compose_create.md

@@ -5,14 +5,15 @@ Creates containers for a service.
 
 ### Options
 
-| Name               | Type     | Default   | Description                                                                           |
-|:-------------------|:---------|:----------|:--------------------------------------------------------------------------------------|
-| `--build`          |          |           | Build images before starting containers.                                              |
-| `--force-recreate` |          |           | Recreate containers even if their configuration and image haven't changed.            |
-| `--no-build`       |          |           | Don't build an image, even if it's missing.                                           |
-| `--no-recreate`    |          |           | If containers already exist, don't recreate them. Incompatible with --force-recreate. |
-| `--pull`           | `string` | `missing` | Pull image before running ("always"\|"missing"\|"never")                              |
-| `--remove-orphans` |          |           | Remove containers for services not defined in the Compose file.                       |
+| Name               | Type          | Default   | Description                                                                                   |
+|:-------------------|:--------------|:----------|:----------------------------------------------------------------------------------------------|
+| `--build`          |               |           | Build images before starting containers.                                                      |
+| `--force-recreate` |               |           | Recreate containers even if their configuration and image haven't changed.                    |
+| `--no-build`       |               |           | Don't build an image, even if it's missing.                                                   |
+| `--no-recreate`    |               |           | If containers already exist, don't recreate them. Incompatible with --force-recreate.         |
+| `--pull`           | `string`      | `missing` | Pull image before running ("always"\|"missing"\|"never")                                      |
+| `--remove-orphans` |               |           | Remove containers for services not defined in the Compose file.                               |
+| `--scale`          | `stringArray` |           | Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present. |
 
 
 <!---MARKER_GEN_END-->

+ 11 - 0
docs/reference/docker_compose_create.yaml

@@ -67,6 +67,17 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: scale
+      value_type: stringArray
+      default_value: '[]'
+      description: |
+        Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false