Skip to content

Commit 80c1827

Browse files
DOCSP-36053 Add a warning to docker compose mode on experimental status (#263)
* DOCSP-36053 Add a warning to docker compose mode on experimental status * Apply suggestions from code review Co-authored-by: corryroot <[email protected]> --------- Co-authored-by: corryroot <[email protected]>
1 parent 388437e commit 80c1827

File tree

2 files changed

+25
-14
lines changed

2 files changed

+25
-14
lines changed

snooty.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,10 @@ value = """\
130130
new set of CLI commands for our new Data Lake functionality, we \
131131
will reach out to you to prevent any interruption of service.\
132132
"""
133+
134+
[[banners]]
135+
targets = ["atlas-cli-deploy-docker.txt"]
136+
variant = "warning"
137+
value = """\
138+
Creating Local Atlas Deployments with Docker Compose is available as an experimental feature. The feature and the corresponding documentation might change at any time during the experiment.\
139+
"""

source/atlas-cli-deploy-docker.txt

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -110,23 +110,27 @@ deployment with `Docker Compose <https://docs.docker.com/compose/>`__.
110110

111111
.. step:: Create a ``docker-compose.yaml`` file.
112112

113-
Create the ``docker-compose.yaml`` file in the same directory
114-
that you run Docker Compose from.
113+
a. Create the ``docker-compose.yaml`` file in the same directory
114+
that you run Docker Compose from.
115115

116-
**Example:**
116+
**Example:**
117117

118-
.. code-block:: sh
118+
.. code-block:: sh
119+
:linenos:
119120

120-
services:
121-
mongo:
122-
image: mongodb/atlas
123-
privileged: true
124-
command: |
125-
/bin/bash -c "atlas deployments setup --type local --port 27778 --bindIpAll --username root --password root --force && tail -f /dev/null"
126-
volumes:
127-
- /var/run/docker.sock:/var/run/docker.sock
128-
ports:
129-
- 27778:27778
121+
services:
122+
mongo:
123+
image: mongodb/atlas
124+
privileged: true
125+
command: |
126+
/bin/bash -c "atlas deployments setup --type local --port 27778 --bindIpAll --username root --password {your-password} --force && tail -f /dev/null"
127+
volumes:
128+
- /var/run/docker.sock:/var/run/docker.sock
129+
ports:
130+
- 27778:27778
131+
132+
#. Replace the ``{your-password}`` variable in the example with your
133+
password and save the file.
130134

131135
To learn more about the available options, see
132136
:ref:`atlas-deployments-setup`.

0 commit comments

Comments
 (0)