Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated make file to deal with Docker Compose Compatibility Issues #3669

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

aslassi777
Copy link
Collaborator

@aslassi777 aslassi777 commented Sep 26, 2024

Resolves #3623

Docker compose command (with the dash) has been depreciated for mac users. To fix, per Mikey's proposed solution, I simply added a 2nd version of docker compose files to the make file to address mac users and correct the compose command used.

Before/After screenshots (if applicable)

N/A

Testing instructions

N/A

Things to check before submitting the PR
  • I've written a descriptive PR title.
  • I've added/updated comments for large or confusing blocks of code.
  • I've included before/after screenshots above.
  • I've asked for and included translations for any user facing text that was added or modified.
  • I've updated any logging. Clicks, keyboard presses, and other user interactions should be logged. If you're not sure how (or if you need to update the logging), ask Mikey. Then make sure the documentation on this wiki page is up to date for the logs you added/updated.
  • I've tested on mobile (only needed for validation page).

@misaugstad
Copy link
Member

@aslassi777 I thought that you had said during the meeting that you weren't even having an issue with the original Makefile on your Mac! Was there a misunderstanding? Do you have any more info on this change to the docker compose command?

@aslassi777
Copy link
Collaborator Author

@misaugstad I wasn't having any issues regarding the original make file, but I did notice that online on Docker forums and documentation that the original docker compose (with the dash) was going to be depreciated soon. I can try to find those forums and documentation again and post them here

@misaugstad
Copy link
Member

Gotcha. Is your own Docker fully up-to-date? It's important to mention in the PR that you hadn't actually been able to reproduce the issue! Did the new commands work for you even though the old ones weren't an issue?

And I just thought of this: Is there a way to detect that the OS that's running from the Makefile and then run different commands based on OS? This would def be preferred so that users don't have to remember to run the correct command, and it would work the same for anyone!

@aslassi777
Copy link
Collaborator Author

Yes, my docker is up to date, and I will make sure to mention that I couldn't replicate the issue in the PR. To be honest, the new commands did not change anything for me (still worked regardless).

There probably is a way to detect the OS in the makefile. I can probably look into that and see how that would work.

@jonfroehlich
Copy link
Member

FWIW, I also had to update my code on the Makeability Lab website to not use docker-compose anymore because the command has been removed (as of late 2023, I believe). Instead, it's just docker compse (note the space).

See: https://github.com/makeabilitylab/makeabilitylabwebsite/blob/master/run-docker-local-dev.sh

@misaugstad
Copy link
Member

Interesting! And I think that @jonfroehlich is running Windows? It may be that Linux is the odd one out, and support just happened to be removed for the old command in some versions of MacOS first... On Linux, maybe we just need to install the compose plugin or something?

Ooo also noticed this here. This link also has full instructions for installing Docker + Docker compose I believe:
Screenshot from 2024-09-26 10-27-59

@aslassi777
Copy link
Collaborator Author

Thanks @jonfroehlich! @misaugstad what do you think next steps are for this ticket based off this new information? should I still look into the OS detection for the makefile?

@misaugstad
Copy link
Member

@aslassi777 I just did some quick googling and quickly skimmed what I sent, so if you could read through the info that's out there write up what you think we should do, that would be great! My guess is that what needs to happen is that I need to rewrite the Linux dev env instructions to use the compose plugin, but I'm not sure!

And if the answer is to redo the Linux dev env instructions, I may just put this on hold for a week or two then, sine I have some big updates we're making and I don't want to be messing around with my dev env during that time :)

@aslassi777
Copy link
Collaborator Author

aslassi777 commented Sep 28, 2024

Yeah sounds good! @misaugstad I've looked through a few different sources, mainly this link (https://docs.docker.com/compose/install/) and I think that for now, it's not broken for mac users because Docker auto updated the compose command (although it may break soon in the future). For linux, I think as you mentioned there is a plug in to install but maybe not the best idea to interfere too much with that if you have some other updates to make. I think the best course of action here is probably to hold off on this, work on #3620 over the weekend/week and get back to this one next week after the updates are made.

@misaugstad
Copy link
Member

Okay note that the docker-compose command didn't work on my Macbook (running Docker Desktop 4.33.0, Enginge: 27.1.1, Compose: v2.29.1-desktop.1 on Sonoma 14.6.1). I just looked through that documentation and tried recreating the symlink, which worked for me!

Until we make the change, I think that what we need to do is add something to the Docker Troubleshooting wiki page about this issue, linking to the documentation you sent to say that replacing the symlink should fix the issue for now. Could you add that please?

@aslassi777
Copy link
Collaborator Author

aslassi777 commented Sep 30, 2024

@misaugstad sounds good, glad to hear recreating the symlink worked! i will add it to the docker troubleshooting wikipage; so do I just go on the relevant docker page and request to edit/request changes?

@misaugstad
Copy link
Member

Oh no! It's the Project Sidewalk docker troubleshooting page: https://github.com/ProjectSidewalk/SidewalkWebpage/wiki/Docker-Troubleshooting

It's linked in the dev env instructions in the README, but it sounds like you didn't have any issues with setup so you wouldn't have needed to use it!

@aslassi777
Copy link
Collaborator Author

thanks @misaugstad! i figured it was something internal but I just wanted to clarify since I thought you were mentioning the actual docker wiki. will update this

@aslassi777
Copy link
Collaborator Author

@misaugstad added to docker wiki troubleshoot page!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

make commands (like make dev) no longer working for Mac dev env
3 participants