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

[Task]: Udpate docs #14789

Open
1 task done
KevinMind opened this issue May 15, 2024 · 1 comment · May be fixed by mozilla/addons-server#22313
Open
1 task done

[Task]: Udpate docs #14789

KevinMind opened this issue May 15, 2024 · 1 comment · May be fixed by mozilla/addons-server#22313
Assignees
Labels
repository:addons-server Issue relating to addons-server

Comments

@KevinMind
Copy link
Contributor

KevinMind commented May 15, 2024

Description

Update mozilla.github.io/addons-server/topics/install/docker.html to reflect recent changes to the make files and docker compose structure.

Acceptance Criteria

  ### Acceptance Criteria
  - [ ] cover new environments
  - [ ] cover updating existing environments
  - [ ] cleaning environments
  - [ ] sharing data import/export
  - [ ] specifying a remote image.

Checks

  • If the issue is ready to work on, I have removed the "needs:info" label.

┆Issue is synchronized with this Jira Task

@KevinMind KevinMind added type:feature repository:addons-server Issue relating to addons-server labels May 15, 2024
@KevinMind
Copy link
Contributor Author

IT should be very fast once you've run it once or twice. I just ran it in 39 seconds.
make update_docker does

snapshot of data
run make up
restore data from the snapshot in step 1.
Otherwise they are the same.

TheOne
now I am confused. Does up stand for update or for up as in the opposite of down?
Is there are way to start/run the containers without updating the images?
eviljeff
/agree that make up is hella ambigious
TheOne
I think we need to come up with better make target names.
Today
kmeinhardt@kmeinhardt:mozilla.org
make up is like docker compose up with dependencies.

If you checkout the project fresh, and run docker compose up.. it will fail.

make up, adds the necessary files (version.json, .env) based on the local environment and your specifications so that docker compose up will not fail.

Additionally (after this pr lands) after your run make up once, running docker compose commands should behave the same whether run via make or directly on the shell.

TheOne
if you look at what make up does, it runs a command called make docker_compose_up if you want to JUST run the containers, that will do it. it just runs a docker compose up command with the right arguments.

"Fix makefile env variables definition" by KevinMind · Pull Request #22246 · mozilla/addons-server - GitHub
Fixes: #14787 Description The makefile env variables were not defined correctly, causing issues with the configuration of the containers. This pull request fixes the definition of the...
TheOne
I think we need to come up with better make target names.
I very much agree.

make docker up reads better to me. Like we should reorganize the make targets based on the "domain"

make docker (up|update|down|shell|clean)

make test (js|python|assets|etc)

make build (image|assets|locales)

TheOne
now I am confused. Does up stand for update or for up as in the opposite of down?
second one. There is a command for updating the docker compose project. The intended idea of make up is it is a "one shot" command for making the entire project "up". Like you just run that one command and everything that needs to happen will happen. ideally this is the command you run 99% of the time to make sure your environment is "up"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repository:addons-server Issue relating to addons-server
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants