Docker compose #859

sharkySharks · 2019-02-06T22:15:39Z

Description

This pull request adds the ability run PWA inside of a docker container with a secure https protocol.

Related Issue

Closes #734

Motivation and Context

Containerizing PWA will allow for more CI configuration in the future and help towards a more platform agnostic development environment. So far the setup script in this PR will only work on Mac, but in the future the hope is to get this working on Windows Docker as well.

How Has This Been Tested?

Manually.

To check this out, follow the instructions under the docs draft file

Proposed Labels for Change Type/Package

FEATURE
pwa-buildpack, venia-concept, pwa-devdocs

Checklist:

I have read the CONTRIBUTING document.
I have linked an issue to this PR.
I have indicated the change type and relevant package(s).
I have updated the documentation accordingly.
I have added tests to cover my changes. - not sure the best testing approach for this but open to suggestions.
All new and existing tests passed.
All CI checks are green (linting, build/deploy, etc).
At least one core contributor has approved this PR.

vercel · 2019-02-06T22:15:45Z

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

docker/README.md

+* add a custom domain, configured in `.env.docker`, to the host system's `/etc/hosts` file
+* generate a self-signed ssl/tls certificate and trust the certificate in the system keychain
+* run `docker-compose build` to build the container network
+* run `docker-compose up` to start the container running PWA at the customer domain with https


docker/README.md

+* run `docker-compose build` to build the container network
+* run `docker-compose up` to start the container running PWA at the customer domain with https
+
+After `docker/run-docker` is executed from the root of the repository, the default confgiuration will have the PWA application running at `https://pwa-docker.local`.


lerna.json

@@ -1,11 +1,7 @@
 {


now.json

@@ -5,5 +5,6 @@
        "node": "10.x.x"
    },
    "public": true,
-    "version": 1
+    "version": 1,
+    "type": "npm"


sharkySharks · 2019-02-06T23:49:36Z

packages/pwa-buildpack/src/WebpackTools/PWADevServer.js

+        to PWADevServer configuration options.
+        
+        More options for this feature are described in documentation.
+        `;


changes above are from running prettier

That's odd...what version of Prettier?

i don't have prettier globally on my computer so this is coming from the repo, I can change it back and try it again. Not sure why this triggered in the first place.

sharkySharks · 2019-02-07T23:15:48Z

packages/pwa-buildpack/src/WebpackTools/PWADevServer.js

-            host: '0.0.0.0',
-            port: await portscanner.findAPortNotInUse(10000),
+            host: config.host || '0.0.0.0',
+            port: config.port || (await portscanner.findAPortNotInUse(10000)),


maybe these values should just be checked against process.env values rather than messing with them in webpack.config.js

bbatsche · 2019-02-08T20:40:55Z

Since .local is typically used for mDNS, should we default use one of the four TLDs reserved for development and testing: https://en.wikipedia.org/wiki/Top-level_domain#Reserved_domains ?

brendanfalkowski · 2019-02-08T20:48:01Z

When Google steamrolled .dev I think .test became the standard practice. I use that even though I hate it.

sharkySharks · 2019-02-08T20:51:56Z

@bbatsche great point. I'm for either .localhost since that is where it is being served in the container and mapped in /etc/hosts, or possibly .test. My only hesitation about the latter is that it is not being staged for testing per say, but maybe that is what it will be used for ultimately.

sharkySharks · 2019-02-08T21:35:55Z

well that's disconcerting, the now deploy does not fail the check if there are 500 errors from the now server...

sirugh · 2019-02-11T17:29:49Z

docker/run-docker

+  docker-compose build
+
+  message "Starting Docker network and containers"
+  message "You may see some warnings that @magento/venia-drivers could not be \n resolved. This is normal and not an error."


I think this is going to be resolved with #881.

removed since this has been merged now

sharkySharks

Comments from group review

docker/run-docker

+
+main () {
+  # copy environment variables to .env in root for docker-compose to consume for build
+  cp ./docker/.env.docker $ENVFILE 


sharkySharks · 2019-02-11T17:26:27Z

docker/run-docker

+  -config $OpenSSLConf
+
+  # add the certificate to the system keychain and trust the certificate
+  sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain ./docker/certs/$DOMAIN.crt


look into adding this to the login keychain rather than the system keychain

looked into adding the cert to the login keychain and while I successfully added it to the login keychain file and it was present in the keychain access gui the cert was not being trusted by the browser. despite a lot of google searching I could not get this to work in the login keychain.

The OSX security CLI is so weird and poorly documented that I think it's not even supposed to be public API. OH well!

…proxy

vercel bot temporarily deployed to staging February 6, 2019 22:19 Inactive

sharkySharks commented Feb 6, 2019

View reviewed changes

lerna.json

@@ -1,11 +1,7 @@

{

This comment was marked as resolved.

Sign in to view

sharkySharks commented Feb 6, 2019

View reviewed changes

now.json

@@ -5,5 +5,6 @@

"node": "10.x.x"

},

"public": true,

"version": 1

"version": 1,

"type": "npm"

This comment was marked as outdated.

Sign in to view

This comment was marked as outdated.

Sign in to view

sharkySharks commented Feb 6, 2019

View reviewed changes

sirugh added enhancement New feature or request pkg:pwa-buildpack pkg:venia-concept pkg:pwa-devdocs labels Feb 7, 2019

sharkySharks force-pushed the docker-compose branch from f485bde to 7966261 Compare February 7, 2019 23:09

vercel bot temporarily deployed to staging February 7, 2019 23:09 Inactive

sharkySharks commented Feb 7, 2019

View reviewed changes

sharkySharks force-pushed the docker-compose branch from 7966261 to 17d4a6a Compare February 8, 2019 20:20

vercel bot temporarily deployed to staging February 8, 2019 20:20 Inactive

vercel bot temporarily deployed to staging February 8, 2019 21:06 Inactive

vercel bot had a problem deploying to staging February 8, 2019 21:24 Failure

sharkySharks force-pushed the docker-compose branch from 610b587 to d76f721 Compare February 8, 2019 21:29

vercel bot temporarily deployed to staging February 8, 2019 21:29 Inactive

sharkySharks force-pushed the docker-compose branch 2 times, most recently from 3a9988e to 3d1bdf0 Compare February 8, 2019 21:55

vercel bot temporarily deployed to staging February 8, 2019 21:55 Inactive

sirugh reviewed Feb 11, 2019

View reviewed changes

sharkySharks commented Feb 11, 2019

View reviewed changes

sharkySharks force-pushed the docker-compose branch from 3d1bdf0 to 9e6d2f2 Compare February 13, 2019 18:45

sharkySharks and others added 21 commits March 19, 2019 10:36

add environment variables and setup script

95d0fd6

add command to setup script to add host to hostfile

bc9f8ed

Convert build to yarn/babel and fix webpack publicPath build output

f1048ad

add automation for certificate generation to the docker setup script

cc541f1

prettier and linting fixes

7a35e6c

add docs and minor file clean up

92d5153

refactor env vars in webpack.config and pwadevserver files

c2f8ac1

update custom domain to reserved DNS label .localhost

3f972f1

adjust docker setup script to include environment clean up

a0e9854

Adding setup script support for Windows users

8cb13b1

Add command line argument support to bypass setup prompts

abb8029

error handle if the build fails then docker should not start

be6242e

resolve issue with publicPath and public asset serving through nginx …

35c4c17

…proxy

give adduser group full permissions of app directory

ac1769b

add volume mounts to edit files on host with hot reloading

d16490f

move cert creation to devcert in separate script

6bc962e

add polling to watch options for guaranteed recompile

0325d14

refactor PWADevServer configuration

bc91d42

update docs and disable service workers by default

328f694

replace hard coded host name and .env file path with variables

70feb69

add polling to ensure hot reloading

77e3b4d

sharkySharks force-pushed the docker-compose branch from 840b87d to 3f77ee8 Compare March 19, 2019 16:33

vercel bot deployed to staging March 19, 2019 16:33 View deployment

update configs to include changes to validate-magento-pwa-queries script

47389e9

sharkySharks force-pushed the docker-compose branch from 3f77ee8 to 47389e9 Compare March 19, 2019 16:38

vercel bot deployed to staging March 19, 2019 16:38 View deployment

sharkySharks removed the hold On hold until another condition is fulfilled. label Mar 19, 2019

supernova-at approved these changes Mar 19, 2019

View reviewed changes

supernova-at merged commit 3f23f06 into develop Mar 19, 2019

supernova-at deleted the docker-compose branch March 19, 2019 21:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker compose #859

Docker compose #859

sharkySharks commented Feb 6, 2019 •

edited

Loading

vercel bot commented Feb 6, 2019

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as outdated.

This comment was marked as outdated.

sharkySharks Feb 6, 2019

zetlen Feb 14, 2019

sharkySharks Feb 14, 2019

sharkySharks Feb 7, 2019

bbatsche commented Feb 8, 2019

brendanfalkowski commented Feb 8, 2019

sharkySharks commented Feb 8, 2019 •

edited

Loading

sharkySharks commented Feb 8, 2019

sirugh Feb 11, 2019

sharkySharks Feb 13, 2019

sharkySharks left a comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

sharkySharks Feb 11, 2019

sharkySharks Feb 13, 2019

zetlen Feb 14, 2019

Docker compose #859

Docker compose #859

Conversation

sharkySharks commented Feb 6, 2019 • edited Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Proposed Labels for Change Type/Package

Checklist:

vercel bot commented Feb 6, 2019

This comment was marked as outdated.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as outdated.

This comment was marked as outdated.

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

bbatsche commented Feb 8, 2019

brendanfalkowski commented Feb 8, 2019

sharkySharks commented Feb 8, 2019 • edited Loading

sharkySharks commented Feb 8, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sharkySharks left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sharkySharks commented Feb 6, 2019 •

edited

Loading

sharkySharks commented Feb 8, 2019 •

edited

Loading