-
Notifications
You must be signed in to change notification settings - Fork 12
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
Create a containerize environment for development workflow #86
Conversation
created 2 separate template conf and pass an env var MODE from .env to docker to run.sh for the nginx config
name of react and not containers was wrong
I was getting with nginx container the following error:
00d0912 have fixed it but still the backend doesn't reach mongo DB |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good for now.
solving the issues that make docker compose
not run properly and i'll approve this 👌
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Last commit introduces two errors 🤔
This PR will stay idle for a while because we'll be working on two major changes that'll affect it:
|
This merge is needed to bring recent DB local containerization iScsc#92 to this branch
I simply refactor each service config attributes order the order I chose is arbitrary but seems logical - [A|B] means A OR B, because they are mutually exclusive ```yml services: <service name>: depends_on: [build|image]: networks: restart: env_file: ports: volumes: ```
Will do this evening 🚒 |
…format This log_format named 'main' isn't used anyway so it is useless, I keep those lines commented anyway for a later PR where I'll properly set the logging in dev and prod mode
@atxr tks! |
Thanks to b0ab27d, everything is working on my side! |
Remove env-cmd call in npm 'start' script --> handle by docker compose Add nginx dev config (see commit body) Took the one before [https](8087def) was introduced It was introduced with [dev and prod mode](f20a338) Add backend dev Dockerfile Add frontend dev Dockerfile Add dev docker compose Separate dev and prod mode for the nginx template created 2 separate template conf and pass an env var MODE from .env to docker to run.sh for the nginx config Update shared volumes in docker compose dev to only share source code Fix nginx container error because targets not found name of react and not containers was wrong Remove commented dead config from nginx conf dev template Add explicit logging config to nginx conf dev template Adapt docker-compose-dev.yml to local containerized DB Refactor docker-compose-dev.yml to be easier to understand I simply refactor each service config attributes order the order I chose is arbitrary but seems logical - [A|B] means A OR B, because they are mutually exclusive ```yml services: <service name>: depends_on: [build|image]: networks: restart: env_file: ports: volumes: ``` Remove a useless tabulation in docker-compose-dev.yml Refactor docker-compose.yml the same way than docker-compose-dev.yml I simply refactor each service config attributes order the order I chose is arbitrary but seems logical - [A|B] means A OR B, because they are mutually exclusive ```yml services: <service name>: depends_on: [build|image]: networks: restart: env_file: ports: volumes: ``` Set the frontend's `proxy` with env var instead of hardcoded value remove the hardcoded value of `proxy` in package.json the frontend fails to reach the backend in container because thanks to docker networks the backend exists at `node-app[-dev]:$NODE_PORT` from the frontend container, not at `localhost:$NODE_PORT` add http-proxy-middleware to package.json and create a ./frontend/src/setupProxy.js to configure the proxy following [react tutorial](https://create-react-app.dev/docs/proxying-api-requests-in-development/#configuring-the-proxy-manually) PS: the changes in `package-lock.json` seems to come from the fact that the newly installed package shares dependencies with other and they ahve different needs over these shared dependencies Update .env.example Fix nginx container crash because it can't access to logs folder git addugit addu I keep these lines commented because I want to add logging withb it iScsc#10 Configure MongoDB port through additional flags to pass to mongod in conatiner Fix non persistent DB by mounting the right volume in the container Run prettier Specify read-write permissions on mounted volumes Remove containers restart option in dev mode Fix database container (iScsc#95) * Fix non persistent DB by mounting the right volume in the container * Configure MongoDB port through additional flags to pass to mongod in conatiner * Run prettier * Add mongodb folder to gitignore * Set bitnami/mongodb version tag to latest pros and cons have been discussed here: iScsc#95 (comment) Improve DB_PORT passing to MongoDB I just better read the doc https://hub.docker.com/r/bitnami/mongodb/ search for MONGODB_PORT_NUMBER Write a first version of README about dev mode containerized Add setup-db-folder.sh script Update README with DB folder setup and clean it Add an important waning about mongodb folder permissions to README Fix setup-db-folder.sh script Update bitnami mongoDB used image to latest Remove restart attribute in docker compose dev, useless in dev mode Update GH Action to exclude mongodb folder from prettier checking Run prettier Try a prettier GH Action fix Armor nginx run script against unexpected MODE value leading to conf template not found Fix variables wrongly substituted in nginx dev conf and comment logs format This log_format named 'main' isn't used anyway so it is useless, I keep those lines commented anyway for a later PR where I'll properly set the logging in dev and prod mode Improve setup database script
Had to try twice to make it work, but with the help of @ctmbl to clean and re-install everything it is working, so I'm going to suppose it was an error on my side. Anyway thanks for the scripts and the updated Good to go for me then 🚀 |
* Add Node development environment (#86 still not merged) Remove env-cmd call in npm 'start' script --> handle by docker compose Add nginx dev config (see commit body) Took the one before [https](8087def) was introduced It was introduced with [dev and prod mode](f20a338) Add backend dev Dockerfile Add frontend dev Dockerfile Add dev docker compose Separate dev and prod mode for the nginx template created 2 separate template conf and pass an env var MODE from .env to docker to run.sh for the nginx config Update shared volumes in docker compose dev to only share source code Fix nginx container error because targets not found name of react and not containers was wrong Remove commented dead config from nginx conf dev template Add explicit logging config to nginx conf dev template Adapt docker-compose-dev.yml to local containerized DB Refactor docker-compose-dev.yml to be easier to understand I simply refactor each service config attributes order the order I chose is arbitrary but seems logical - [A|B] means A OR B, because they are mutually exclusive ```yml services: <service name>: depends_on: [build|image]: networks: restart: env_file: ports: volumes: ``` Remove a useless tabulation in docker-compose-dev.yml Refactor docker-compose.yml the same way than docker-compose-dev.yml I simply refactor each service config attributes order the order I chose is arbitrary but seems logical - [A|B] means A OR B, because they are mutually exclusive ```yml services: <service name>: depends_on: [build|image]: networks: restart: env_file: ports: volumes: ``` Set the frontend's `proxy` with env var instead of hardcoded value remove the hardcoded value of `proxy` in package.json the frontend fails to reach the backend in container because thanks to docker networks the backend exists at `node-app[-dev]:$NODE_PORT` from the frontend container, not at `localhost:$NODE_PORT` add http-proxy-middleware to package.json and create a ./frontend/src/setupProxy.js to configure the proxy following [react tutorial](https://create-react-app.dev/docs/proxying-api-requests-in-development/#configuring-the-proxy-manually) PS: the changes in `package-lock.json` seems to come from the fact that the newly installed package shares dependencies with other and they ahve different needs over these shared dependencies Update .env.example Fix nginx container crash because it can't access to logs folder git addugit addu I keep these lines commented because I want to add logging withb it #10 Configure MongoDB port through additional flags to pass to mongod in conatiner Fix non persistent DB by mounting the right volume in the container Run prettier Specify read-write permissions on mounted volumes Remove containers restart option in dev mode Fix database container (#95) * Fix non persistent DB by mounting the right volume in the container * Configure MongoDB port through additional flags to pass to mongod in conatiner * Run prettier * Add mongodb folder to gitignore * Set bitnami/mongodb version tag to latest pros and cons have been discussed here: #95 (comment) Improve DB_PORT passing to MongoDB I just better read the doc https://hub.docker.com/r/bitnami/mongodb/ search for MONGODB_PORT_NUMBER Write a first version of README about dev mode containerized Add setup-db-folder.sh script Update README with DB folder setup and clean it Add an important waning about mongodb folder permissions to README Fix setup-db-folder.sh script Update bitnami mongoDB used image to latest Remove restart attribute in docker compose dev, useless in dev mode Update GH Action to exclude mongodb folder from prettier checking Run prettier Try a prettier GH Action fix Armor nginx run script against unexpected MODE value leading to conf template not found Fix variables wrongly substituted in nginx dev conf and comment logs format This log_format named 'main' isn't used anyway so it is useless, I keep those lines commented anyway for a later PR where I'll properly set the logging in dev and prod mode Improve setup database script * Update docker-compose-dev.yml for a flask backend * Update backend/Dockerfile.dev to a python image running flask * Fix FLASK_RUN_PORT env var name * Update nginx conf to proxy to the flask app * Fix flaks container not accessible from outside the container * Update lasting wrong NODE_PORT var in .env.example Co-authored-by: Alexandre Tullot <alexandre.tullot@protonmail.com> --------- Co-authored-by: Alexandre Tullot <alexandre.tullot@protonmail.com>
Solves README.md conflicts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am honnestly not qualified and have no idea of how to configure a docker-compose.yml
file. I have no idea how it is constructed and as it has to be merged quickly, I have a plain confidence in what you have written ! Same thing for the nginx
-related files.
For the Dockerfile
, this looks good to me ! Same for bash scripts, I just have one or two questions.
Finally, the README.md is very clear. I just add a suggestion because I was wondering myself how to check the status for a second and I would have love not to think about it and blindly copy the command right from the README.md
!
Thanks a lot for the amazing PR. That will ease a lot the deployment !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✔️
Close #64
This PR adds
Dockerfile
s anddocker-compose
file as well as a nginx conf template for development mode.The main differences with the prod mode are:
What solutions I chose
node_modules
are in the image, so they don't overlap with one that could exists on home system, also we don't share the whole frontend and backend folder so localnode_modules
don't overlap with containerized oneWhat still needs to be done/doesn't satisfy me
docker-compose-dev.yml
) --> tested well on fc1c601MODE=$MODE ./run_nginx.sh
innginx/Dockerfile
isn't really beautiful I'd sayAppendices
(1)
(2)