Docker and Docker Compose support #34

zfletch · 2017-10-06T14:51:42Z

Add Docker and Docker Compose support by adding Dockerfiles and a docker-compose.yml.

The Docker setup is a little different for React/Webpacker apps and standard Rails app, so different files are copied depending on whether run with --webpack=react or not.

There’s a lot I don’t know about Webpacker and Docker, so it’s possible there are better ways to set it up.

Fixes #2

zfletch · 2017-10-06T14:53:46Z

gnarly.rb

+  copy_file "templates/Dockerfile-assets", "Dockerfile-assets"
+  copy_file "templates/.env.docker/.env.docker-webpack", ".env.docker"
+  copy_file "templates/.env.docker-assets", ".env.docker-assets"
+  copy_file "templates/docker-compose.yml/docker-compose-webpack.yml", "docker-compose.yml"


The way I organized the files that are different for React and non-React is:

templates/ file_name.extension/ file_name-standard.extension file_name-webpack.extension

I think this is reasonable, but I could change it if there's already a standard in place.

Granted, this is not reflected in the current directory structure of templates (as it started off flat), but I've been thinking of modifying it to group related elements together, like having a directory for ci, db, style, etc.

Perhaps we could start that by having a directory templates/docker that all of the docker files in this diff live in? Other than that, I'm fine with your organization.

I think it makes sense to group the files, and to do that in another PR so the locations of all the files are consistent. I also think before doing that it would be good to figure out #16 since testing that everything works with and without Docker and with and without React takes a long time

Fair enough. #16 has been my white whale since starting the project. I agree with your thoughts though.

zfletch · 2017-10-06T14:58:45Z

templates/.env.docker-assets

@@ -0,0 +1 @@
+WEBPACKER_DEV_SERVER_HOST=0.0.0.0


Using environment variables to configure the Webpack Dev server is a new feature merged just a few days ago. Previously you had to change the config/webpacker.yml file.

You still can't use command line arguments, because why would you need to use command line arguments when you can just edit a yaml file?

zfletch · 2017-10-06T15:03:19Z

templates/docker-compose.yml/docker-compose-standard.yml

+    image: postgres:9.6.5
+  web:
+    build: .
+    command: bash -c 'rm -f tmp/pids/server.pid && bundle exec rails s --port 3000 --binding 0.0.0.0'


The reason for the rm -f code is to avoid A server is already running. Check /app/tmp/pids/server.pid. errors when running docker-compose up. See this Docker Compose issue.

I looked at how some other applications solve the problem, and it looks like this works. Quoting mbarnett commenting on this pull request, linked from the GitHub issue:

Hacky, but what are you gonna do ¯\(ツ)/¯

Smart. I'm still manually using docker-compose run web bash to run this when necessary.

You should be able to delete it locally by running rm tmp/pids/server.pid if you have volumes: - .:/app in your docker-compose.yml

kevin-j-m · 2017-10-06T15:19:37Z

templates/.env.docker-assets

@@ -0,0 +1 @@
+WEBPACKER_DEV_SERVER_HOST=0.0.0.0


Given the convention you have, should this be in the .env.docker directory?

There are three .env files involved: .env.docker/.env-docker-standard, .env.docker/.env-docker-webpack, and .env-docker-assets.

The first two are copied as .env.docker in the created application. They need to have different values for the Webpack and non-Webpack cases.

The third one is copied as .env.docker-assets in the created application, but it's only copied when --webpack=react is passed in.

kevin-j-m · 2017-10-06T15:22:24Z

templates/docker-compose.yml/docker-compose-standard.yml

+    image: postgres:9.6.5
+  web:
+    build: .
+    command: bash -c 'rm -f tmp/pids/server.pid && bundle exec rails s --port 3000 --binding 0.0.0.0'


Smart. I'm still manually using docker-compose run web bash to run this when necessary.

kevin-j-m · 2017-10-06T15:24:53Z

templates/docker-compose.yml/docker-compose-standard.yml

+version: '3'
+services:
+  db:
+    image: postgres:9.6.5


Why are we targeting a specific release? Or, I guess I could see wanting to tie it to a specific release, but why not the latest (10)?

Update: Postgres 10 literally came out yesterday, so, that's a perfectly reasonable explanation as to why.

It probably makes more sense here not to target a particular version of Postgres. I copied this from another project.

I guess it depends on if we want to standardize/lock in on a particular version until we all agree to upgrade, like a ruby version update. However, I'm not sure how much we should really care about what version of backing services we're using if we're targeting AWS RDS/Heroku?

Maybe @ngmaloney would have a better opinion on this than I would.

Once we create an application, it might make sense, but I don't think we want to be updating this repo every time a new version of Postgres comes out.

kevin-j-m · 2017-10-06T15:38:19Z

templates/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.4.2
+


I'm assuming you've tested this w/spinning up a postgres DB with some data in it and such with it working fine?

I only ask because EEC's Dockerfile has some stuff about setting up keys for postgres, which I can't claim to understand why it's needed, but figured I'd toss it out there.

I'm not sure if what that code is for or whether it's currently necessary in EEC Web. I commented it out locally and was able to build and run the app successfully.

kevin-j-m · 2017-10-06T15:39:47Z

templates/Dockerfile

+ADD Gemfile /app/Gemfile
+ADD Gemfile.lock /app/Gemfile.lock
+RUN bundle install
+


Have you tried running acceptance tests with this? Again, just basing on EEC's file having various lines for chrome-driver setup.

I haven't tested Chrome driver. I think there's potentially enough work getting that running that it should be a separate issue.

kevin-j-m · 2017-10-06T15:47:32Z

gnarly.rb

+  copy_file "templates/Dockerfile-assets", "Dockerfile-assets"
+  copy_file "templates/.env.docker/.env.docker-webpack", ".env.docker"
+  copy_file "templates/.env.docker-assets", ".env.docker-assets"
+  copy_file "templates/docker-compose.yml/docker-compose-webpack.yml", "docker-compose.yml"


Granted, this is not reflected in the current directory structure of templates (as it started off flat), but I've been thinking of modifying it to group related elements together, like having a directory for ci, db, style, etc.

Perhaps we could start that by having a directory templates/docker that all of the docker files in this diff live in? Other than that, I'm fine with your organization.

kevin-j-m · 2017-10-06T15:50:25Z

README.md

+
+```sh
+docker-compose up
+```


Thanks for the documentation. This has led me to create #35 to handle separately - which basically says we should take all this information and populate it in the README of the projects we're creating from this template as well, along with other setup info.

kevin-j-m · 2017-10-06T15:54:41Z

templates/Dockerfile-assets

+
+ADD package.json /app/package.json
+ADD yarn.lock /app/yarn.lock
+RUN yarn install


Perhaps this file should only be the above 3 lines (as everything else looks the same as the Dockerfile).

Then we could copy over Dockerfile twice - once for web, and another for assets. For the assets version, we can then use insert_into_file "Dockerfile-assets", before: " \ADD . /app\n" do...end, reading in and inserting these 3 lines here.

That way, if we need to change anything here, like the ruby version, we only have to do it once and it'll be used by both files for future apps generated from the template.

I think there could be a lot if churn in this file. In theory you shouldn't really need Ruby to run the development.

The way Rails and Webpacker is currently written, you have to have the full Rails app installed with all of its gems in order to call the dev server, which is a wrapper around a JavaScript library.

This makes a lot of sense when you're running the server locally -- you already have Rails and everything installed, but it doesn't work as well with Docker Compose. I can imagine a future where this could be changed to a nodejs image that doesn't have to know anything about Rails, but Webpacker is something I'm not that familiar with. At this point I don't know enough to know whether having the files completely separate or not will end up being easier to manage.

Fair enough. Let's keep this as-is for now, get some experience with using it on new projects/various updates, and figure out what feels best in terms of managing it over time.

What's here is simple (in a good way) and that may very well be best.

Add Docker and Docker Compose support by adding `Dockerfile`s and a `docker-compose.yml`. The Docker setup is a little different for React/Webpacker apps and standard Rails app, so different files are copied depending on whether run with `--webpack=react` or not.

kevin-j-m

Thank you for adding this in. This'll be super helpful for all of our future projects!

zfletch commented Oct 6, 2017

View reviewed changes

zfletch force-pushed the docker branch from 503e2eb to e836492 Compare October 6, 2017 15:04

zfletch changed the title ~~docker and docker compose support~~ Docker and Docker Compose support Oct 6, 2017

kevin-j-m reviewed Oct 6, 2017

View reviewed changes

zfletch force-pushed the docker branch from e836492 to c5e3c6c Compare October 6, 2017 17:36

kevin-j-m approved these changes Oct 6, 2017

View reviewed changes

zfletch merged commit 8de5d13 into master Oct 6, 2017

zfletch deleted the docker branch October 6, 2017 19:11

zfletch mentioned this pull request Oct 9, 2017

ChromeDriver with Docker #36

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker and Docker Compose support #34

Docker and Docker Compose support #34

zfletch commented Oct 6, 2017 •

edited

Loading

zfletch Oct 6, 2017 •

edited

Loading

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017 •

edited

Loading

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017 •

edited

Loading

zfletch Oct 6, 2017 •

edited

Loading

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017

kevin-j-m Oct 6, 2017

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017

kevin-j-m Oct 6, 2017

kevin-j-m Oct 6, 2017

kevin-j-m Oct 6, 2017

zfletch Oct 6, 2017

kevin-j-m Oct 6, 2017

kevin-j-m left a comment

		@@ -0,0 +1 @@
		WEBPACKER_DEV_SERVER_HOST=0.0.0.0

		@@ -0,0 +1 @@
		WEBPACKER_DEV_SERVER_HOST=0.0.0.0

Docker and Docker Compose support #34

Docker and Docker Compose support #34

Conversation

zfletch commented Oct 6, 2017 • edited Loading

zfletch Oct 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zfletch Oct 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zfletch Oct 6, 2017 • edited Loading

Choose a reason for hiding this comment

zfletch Oct 6, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevin-j-m left a comment

Choose a reason for hiding this comment

zfletch commented Oct 6, 2017 •

edited

Loading

zfletch Oct 6, 2017 •

edited

Loading

zfletch Oct 6, 2017 •

edited

Loading

zfletch Oct 6, 2017 •

edited

Loading

zfletch Oct 6, 2017 •

edited

Loading