github.com/khulnasoft/cli@v0.0.0-20240402070845-01bcad7beefa/docs/reference/commandline/stack_deploy.md (about)

     1  # stack deploy
     2  
     3  <!---MARKER_GEN_START-->
     4  Deploy a new stack or update an existing stack
     5  
     6  ### Aliases
     7  
     8  `docker stack deploy`, `docker stack up`
     9  
    10  ### Options
    11  
    12  | Name                                                     | Type          | Default  | Description                                                                                       |
    13  |:---------------------------------------------------------|:--------------|:---------|:--------------------------------------------------------------------------------------------------|
    14  | [`-c`](#compose-file), [`--compose-file`](#compose-file) | `stringSlice` |          | Path to a Compose file, or `-` to read from stdin                                                 |
    15  | `-d`, `--detach`                                         | `bool`        | `true`   | Exit immediately instead of waiting for the stack services to converge                            |
    16  | `--prune`                                                |               |          | Prune services that are no longer referenced                                                      |
    17  | `-q`, `--quiet`                                          |               |          | Suppress progress output                                                                          |
    18  | `--resolve-image`                                        | `string`      | `always` | Query the registry to resolve image digest and supported platforms (`always`, `changed`, `never`) |
    19  | `--with-registry-auth`                                   |               |          | Send registry authentication details to Swarm agents                                              |
    20  
    21  
    22  <!---MARKER_GEN_END-->
    23  
    24  ## Description
    25  
    26  Create and update a stack from a `compose` file on the swarm.
    27  
    28  > **Note**
    29  >
    30  > This is a cluster management command, and must be executed on a swarm
    31  > manager node. To learn about managers and workers, refer to the
    32  > [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
    33  > documentation.
    34  
    35  ## Examples
    36  
    37  ### <a name="compose-file"></a> Compose file (--compose-file)
    38  
    39  The `deploy` command supports Compose file version `3.0` and above.
    40  
    41  ```console
    42  $ docker stack deploy --compose-file docker-compose.yml vossibility
    43  
    44  Ignoring unsupported options: links
    45  
    46  Creating network vossibility_vossibility
    47  Creating network vossibility_default
    48  Creating service vossibility_nsqd
    49  Creating service vossibility_logstash
    50  Creating service vossibility_elasticsearch
    51  Creating service vossibility_kibana
    52  Creating service vossibility_ghollector
    53  Creating service vossibility_lookupd
    54  ```
    55  
    56  The Compose file can also be provided as standard input with `--compose-file -`:
    57  
    58  ```console
    59  $ cat docker-compose.yml | docker stack deploy --compose-file - vossibility
    60  
    61  Ignoring unsupported options: links
    62  
    63  Creating network vossibility_vossibility
    64  Creating network vossibility_default
    65  Creating service vossibility_nsqd
    66  Creating service vossibility_logstash
    67  Creating service vossibility_elasticsearch
    68  Creating service vossibility_kibana
    69  Creating service vossibility_ghollector
    70  Creating service vossibility_lookupd
    71  ```
    72  
    73  If your configuration is split between multiple Compose files, e.g. a base
    74  configuration and environment-specific overrides, you can provide multiple
    75  `--compose-file` flags.
    76  
    77  ```console
    78  $ docker stack deploy --compose-file docker-compose.yml -c docker-compose.prod.yml vossibility
    79  
    80  Ignoring unsupported options: links
    81  
    82  Creating network vossibility_vossibility
    83  Creating network vossibility_default
    84  Creating service vossibility_nsqd
    85  Creating service vossibility_logstash
    86  Creating service vossibility_elasticsearch
    87  Creating service vossibility_kibana
    88  Creating service vossibility_ghollector
    89  Creating service vossibility_lookupd
    90  ```
    91  
    92  You can verify that the services were correctly created:
    93  
    94  ```console
    95  $ docker service ls
    96  
    97  ID            NAME                               MODE        REPLICAS  IMAGE
    98  29bv0vnlm903  vossibility_lookupd                replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
    99  4awt47624qwh  vossibility_nsqd                   replicated  1/1       nsqio/nsq@sha256:eeba05599f31eba418e96e71e0984c3dc96963ceb66924dd37a47bf7ce18a662
   100  4tjx9biia6fs  vossibility_elasticsearch          replicated  1/1       elasticsearch@sha256:12ac7c6af55d001f71800b83ba91a04f716e58d82e748fa6e5a7359eed2301aa
   101  7563uuzr9eys  vossibility_kibana                 replicated  1/1       kibana@sha256:6995a2d25709a62694a937b8a529ff36da92ebee74bafd7bf00e6caf6db2eb03
   102  9gc5m4met4he  vossibility_logstash               replicated  1/1       logstash@sha256:2dc8bddd1bb4a5a34e8ebaf73749f6413c101b2edef6617f2f7713926d2141fe
   103  axqh55ipl40h  vossibility_vossibility-collector  replicated  1/1       icecrime/vossibility-collector@sha256:f03f2977203ba6253988c18d04061c5ec7aab46bca9dfd89a9a1fa4500989fba
   104  ```
   105  
   106  ## Related commands
   107  
   108  * [stack ls](stack_ls.md)
   109  * [stack ps](stack_ps.md)
   110  * [stack rm](stack_rm.md)
   111  * [stack services](stack_services.md)
   112  * [stack config](stack_config.md)