Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit 1e1cb7b

Browse files
cintnguyensarina
authored andcommitted
docs: replaced dev.down with dev.remove-containers
1 parent aa96c34 commit 1e1cb7b

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/devstack_interface.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Useful Commands and Summary
5151

5252
Especially if you are running devstack after a few days of break, you will likely want to use ``make dev.pull.<service>`` before this using this command.
5353

54-
Also see below at ``dev.stop`` and ``dev.down`` for opposite counterparts of this command
54+
Also see below at ``dev.stop`` and ``dev.remove-containers`` for opposite counterparts of this command
5555

5656
Variations:
5757

@@ -70,15 +70,15 @@ Useful Commands and Summary
7070
Variation:
7171
+ ``make dev.stop.<service>`` will only stop the specified container
7272

73-
- ``dev.down``: stops and removes all running containers as well as any networks that were created. Next time you use dev.up.<service> to bring up containers, your containers have reverted back to the pulled image.
73+
- ``dev.remove-containers``: stops and removes all running containers as well as any networks that were created. Next time you use dev.up.<service> to bring up containers, your containers have reverted back to the pulled image.
7474

7575
Note: This will not affect content of the databases.
7676

77-
When to use: use this command only if you are okay with removing any changes you might have made to your containers. You will likely want to use ``make dev.stop`` instead of ``make dev.down``.
77+
When to use: use this command only if you are okay with removing any changes you might have made to your containers. You will likely want to use ``make dev.stop`` instead of ``make dev.remove-containers``.
7878

7979
Variation:
8080

81-
+ ``make dev.down.<service>`` will stop and remove only the specified container.
81+
+ ``make dev.remove-containers.<service>`` will stop and remove only the specified container.
8282

8383
Note: This will only bring down <service>'s container and not its dependencies.
8484

docs/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The default devstack services can be run by following the steps below.
120120
121121
To stop a service, use ``make dev.stop.<service>``, and to both stop it
122122
and remove the container (along with any changes you have made
123-
to the filesystem in the container) use ``make dev.down.<service>``.
123+
to the filesystem in the container) use ``make dev.remove-containers.<service>``.
124124

125125
After the services have started, if you need shell access to one of the
126126
services, run ``make dev.shell.<service>``. For example to access the

docs/workflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If you want to pull down just the images for one service but not its dependencie
5252
Database backups
5353
~~~~~~~~~~~~~~~~
5454

55-
You can routinely create backups of your local databases. To create a backup, use ``make dev.backup``. When you want to restore you database to the backup, run ``make dev.restore``. Warning, this will restore all your databases. You might have to cycle the database containers off and on using ``make dev.down.<database service name>`` and ``make dev.up.<database service name>``.
55+
You can routinely create backups of your local databases. To create a backup, use ``make dev.backup``. When you want to restore you database to the backup, run ``make dev.restore``. Warning, this will restore all your databases. You might have to cycle the database containers off and on using ``make dev.remove-containers.<database service name>`` and ``make dev.up.<database service name>``.
5656

5757
Comprehensive backup
5858
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)