search

mozilla / addons

☂ Umbrella repository for Mozilla Addons ✨
Other
125 stars 41 forks source link

[Task]: Udpate docs #14789

Closed KevinMind closed 3 weeks ago

KevinMind commented 3 months ago

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

┆Issue is synchronized with this Jira Task

KevinMind commented 3 months ago

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: mozilla/addons#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"