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

Stop 'local' containers when starting 'dev' containers and vice versa #27

Closed
kdmccormick opened this issue Jan 28, 2022 · 4 comments
Closed
Assignees
Labels
enhancement Relates to new features or improvements to existing features

Comments

@kdmccormick
Copy link
Collaborator

kdmccormick commented Jan 28, 2022

Context

tutor local ... commands start one set of containers. tutor dev ... starts a different set. If someone tries to run both at the same time, they will find that one's ports conflict with the other's.

Because there is no tutor dev quickstart command, first time developers always need to:

  • first, provision with tutor local quickstart, then
  • stop local containers with tutor local stop, and
  • finally start dev containers with tutor tutor dev start.

The Tutor dev docs do call this out:

Once the local platform has been configured, you should stop it so that it does not interfere with the development environment:

 tutor local stop

but I worry that this will be an easily overlooked stumbling block for new users. I certainly messed this up the first time :P

Do we think that others would find this confusing too? Could we remove/mitigate this stumbling block by:

  • adding a tutor dev quickstart that spins up dev-mode containers, or
  • failing fast and loudly if one tries to start local/dev containers while the other set is already up?

Acceptance

Referencing @regisb's comment below:

  • Run tutor dev stop as part of tutor local start, and to run tutor local stop as part of tutor dev start.
  • Introduce tutor dev quickstart, analogous to tutor local quickstart. Update the docs.
@regisb
Copy link

regisb commented Feb 4, 2022

but I worry that this will be an easily overlooked stumbling block for new users. I certainly messed this up the first time :P

I also keep making that mistake 😅

adding a tutor dev quickstart that spins up dev-mode containers

Yes, we should do that.

failing fast and loudly if one tries to start local/dev containers while the other set is already up?

I think that a better approach would be to run tutor dev stop as part of tutor local start, and to run tutor local stop as part of tutor dev start. This is compatible with the first item above, which is that we need to add a dev quickstart command.

@kdmccormick kdmccormick changed the title As a developer, I do not want to run local and dev containers at the same time Help users prevent running 'dev' and 'local' containers simultaneously Feb 9, 2022
@kdmccormick kdmccormick added 2U-full enhancement Relates to new features or improvements to existing features and removed 1st-impressions labels Feb 9, 2022
@kdmccormick kdmccormick moved this from Ungroomed to Groomed in Tutor DevEnv Adoption (OLD BOARD) Feb 14, 2022
@kdmccormick kdmccormick moved this from Groomed to Next Up in Tutor DevEnv Adoption (OLD BOARD) Mar 1, 2022
@kdmccormick kdmccormick moved this from Next Up to Groomed in Tutor DevEnv Adoption (OLD BOARD) Mar 2, 2022
@kdmccormick
Copy link
Collaborator Author

kdmccormick commented Mar 29, 2022

I had started poking at the "stop local containers when starting dev containers, and vice versa" aspect of this in kdmccormick/tutor#3, but, as Régis and I had talked about, it'd be way easier to just implement this on top of the V1 Plugins branch.

@kdmccormick kdmccormick changed the title Help users prevent running 'dev' and 'local' containers simultaneously Stop 'local' containers when starting 'dev' containers and vice versa Mar 31, 2022
@kdmccormick kdmccormick moved this from Groomed to Blocked in Tutor DevEnv Adoption (OLD BOARD) Apr 11, 2022
@kdmccormick
Copy link
Collaborator Author

Blocked by #32

@kdmccormick kdmccormick moved this from Blocked to Groomed in Tutor DevEnv Adoption (OLD BOARD) Apr 18, 2022
@kdmccormick kdmccormick moved this from Groomed to In Progress in Tutor DevEnv Adoption (OLD BOARD) Apr 21, 2022
@kdmccormick kdmccormick moved this from In Progress to In Review in Tutor DevEnv Adoption (OLD BOARD) Apr 21, 2022
@kdmccormick
Copy link
Collaborator Author

Will be Resolved by overhangio/tutor#646

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Relates to new features or improvements to existing features
Projects
None yet
Development

No branches or pull requests

2 participants