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