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

doc: moving the recommended variant of down command to top #695

Merged
jinder1s merged 4 commits into from
Mar 16, 2021
Merged

doc: moving the recommended variant of down command to top #695

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89551b2
doc: moving the recommended variant of down command to top
Mar 4, 2021
f7f9ae8
squash: formatting
Mar 4, 2021
7802925
squash: grammer
Mar 4, 2021
a977a74
squash: also improving stop docs
Mar 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions docs/devstack_interface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,24 @@ Useful Commands and Summary

+ ``make dev.up.without-deps.<service>`` will only bring up the <service> container

- ``dev.stop.<service>``: only stops the container. This does not remove the container or the networks it has created
- ``dev.stop``: Stops all running containers. This does not remove the containers or the networks they had created

When to use: When you are pausing your work on this container/devstack and you want to pick back up from where you left off. Next time you use dev.up to bring up containers, you should be able to mostly pick back up from where you started.
When to use: When you are pausing your work on devstack and you want to pick back up from where you left off. Next time you use dev.up.<service> to bring up containers, you should be able to mostly pick back up from where you started.

- ``dev.down.<service>``: stops the specified container and also removes the stopped containers as well as any networks that were created. Next time you use dev.up to bring up container, your container have reverted back to the pulled image.
Variation:
+ ``make dev.stop.<service>`` will only stop the specified container

- ``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.

Note: This will not affect content of the databases.

Note: This will only bring down <service>'s container and not its dependencies.
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``.

Variation:

When to use: use this command only if you are okay with removing any changes you might have made to the container
+ ``make dev.down.<service>`` will stop and remove only the specified container.

Variation: ``make dev.down`` will stop all your containers
Note: This will only bring down <service>'s container and not its dependencies.

- ``dev.shell.<service>``: used to enter the shell of the specified service container.

Expand Down