Switch to s3fs so we can have multiple instances #223

cmc333333 · 2018-04-16T20:29:37Z

Drupal writes "optimized" css/js to the "public" file system, which defaults to the local disk. This is problematic when we have multiple instances, as the files will only be written to the disk of one. It'd also be an issue between deployments/restages, except that we clear caches on the first instance.

Unfortunately, flysystem doesn't override the "public" filesystem, so it couldn't be used to store those files in s3. s3fs can, however, with enough configuration. Notably, it requires apache be configured to proxy s3 files, which requires some extra lifting in our system config.

This PR switches to the s3fs module, handles the apache configs, turns on optimized css/js and bumps up our instance count. It's working in cloud.gov, but I'd really appreciate another test of the Docker version (remember to docker-compose build).

This PR's probably easiest to review changeset by changeset, but let me know if a walkthrough'd be better.

s3fs will allow us to host our "public" files (e.g. compressed CSS/JS) on S3, a feature flysystem lacks. We need this so that those files are saved between deployments (and across instances). This removes S3 from the docker-compose config so that the s3fs config is only set when in cloud.gov (or mimicking locally). Generated twig files are no longer stored in the "public" dir (as that'd touch S3), so we ignore them in a gitignore.

The s3fs module will _store_ generated CSS/JS files in S3, but Drupal will still generate URLs assuming they're hosted on the same server. s3fs' solution is to have apache proxy those requests. Unfortunately, we won't know what the bucket/region is until we're within the cloud.gov environment; this resolves that by modifying the htaccess file at bootstrap. This also updates our Dockerfile to include apache's rewrites & proxies (requiring developers run docker-compose build). Similarly, we tweak the cloud.gov apache configuration to include the proxy_http module. Note that we can't use Apache's ProxyPass directive, as our host names are too long. See https://unix.stackexchange.com/questions/420615/proxypass-worker-hostname-too-long

Now that we can!

Now that S3 is properly configured, we can bump up our number of instances.

fureigh · 2018-04-19T20:35:07Z

.gitignore

@@ -17,6 +17,7 @@ core
 vendor

 # Ignore local versions of modules.
+storage


Given that this has to do with Twig, not a module, I suggest either changing the comment or giving this its own comment and (one-line) section.

fureigh · 2018-04-19T20:45:07Z

.bp-config/httpd/extra/httpd-modules.conf

+#LoadModule version_module modules/mod_version.so
+#LoadModule proxy_connect_module modules/mod_proxy_connect.so
+#LoadModule proxy_ftp_module modules/mod_proxy_ftp.so
+LoadModule proxy_http_module modules/mod_proxy_http.so


Let's move this one to the top (with the other enabled modules).

cmc333333 · 2018-04-19T20:45:39Z

.bp-config/httpd/extra/httpd-modules.conf

@@ -0,0 +1,114 @@
+LoadModule authz_core_module modules/mod_authz_core.so


Add comment explaining where this file came from.

cmc333333 · 2018-04-19T20:46:33Z

.bp-config/httpd/extra/httpd-modules.conf

+LoadModule deflate_module modules/mod_deflate.so
+LoadModule headers_module modules/mod_headers.so
+
+#LoadModule authn_file_module modules/mod_authn_file.so


Remove commented ones and comment that the new one has been turned on.

cmc333333 · 2018-04-19T20:47:10Z

.docker/Dockerfile

@@ -13,6 +13,8 @@ RUN apt-get update &&\
    rm -rf /var/lib/apt/lists/* &&\
    rm -rf /var/cache/apt/*

+RUN a2enmod rewrite proxy proxy_http


Mention needing docker-compose build.

fureigh

Left a few comments, but all looks good! Thanks for doing this!

@fureigh

Thanks for the suggestions, @fureigh!

fureigh · 2018-04-20T17:41:00Z

@cmc333333 I'm running into a couple of issues locally. Here's the primary one:

I ran docker-compose build and docker-compose up and got this:

web_1       |  [ERROR] An error occurred while trying to write the config file: "Unable to    
web_1       |          install the <em class="placeholder">s3fs</em> module since it does     
web_1       |          not exist."

So far I've confirmed that s3fs is present in both composer.json and composer.lock. I didn't immediately spot any clues in docker-compose logs but am taking a closer look.

Also, in case this is related: When I ran docker-compose build, the terminal output included the following:

To activate the new configuration, you need to run:
  service apache2 restart

I'm getting a "command not found" error for service; presumably that's a local shell config issue, so I'll proceed accordingly.

fureigh · 2018-04-20T17:56:47Z

@cmc333333 noticed that settings.cf.php hadn't come through quite right. chmod a+w web/sites/default and then re-checking-out that file got it running locally! 🎉

I'm still testing locally, but we may end up needing to change (and subsequently revert) some file permissions in bootstrap.sh. For security reasons, we wouldn't want that directory to be writable in any non-local environment.

fureigh · 2018-04-20T22:47:20Z

Upon further consideration: because the permissions issue is an artifact of local development (Drupal's install script helpfully removing writability from certain files), I'll leave bootstrap.sh alone and try sorting it out in a Git hook or two instead. No need for that to hold up a merge of this pull request.

In the meantime, I've confirmed that this is working on staging. We'll want to turn on the page cache too (/admin/config/development/performance), but it makes sense to handle that in a separate pull request.

Now testing mimicking locally.

fureigh · 2018-04-20T23:14:42Z

Beautiful! I was able to access remotely cached CSS and JS files via localhost without any issues. Thanks for all of your work on this, @cmc333333! I say rebase and .

fureigh · 2018-04-20T23:34:40Z

One more note: because /web/.htaccess does get rewritten to include the actual environment variables, there's a danger of a developer accidentally committing those values to the repo. Worth thinking about how to guard against that (rather than relying on individuals' git hygiene).

cmc333333 · 2018-04-23T14:49:32Z

Thanks @fureigh ! Added a note about committing secrets and we can expand if desired.

@fureigh

Thanks for the suggestion @fureigh

CM Lubinski added 4 commits April 16, 2018 15:50

Turn on JS and CSS compression.

f8a8216

Now that we can!

Bump to two instances.

eac9f55

Now that S3 is properly configured, we can bump up our number of instances.

cmc333333 requested a review from fureigh April 16, 2018 20:29

cmc333333 mentioned this pull request Apr 16, 2018

[WIP] Bump instance count to 2. #184

Closed

fureigh self-assigned this Apr 19, 2018

fureigh reviewed Apr 19, 2018

View reviewed changes

cmc333333 commented Apr 19, 2018

View reviewed changes

fureigh reviewed Apr 19, 2018

View reviewed changes

Better commentary for apache modules, gitignore.

8725a9e

Thanks for the suggestions, @fureigh!

fureigh mentioned this pull request Apr 20, 2018

Ensure that git pull can reliably retrieve all settings files #227

Open

5 tasks

fureigh approved these changes Apr 20, 2018

View reviewed changes

cmc333333 merged commit 474f23a into master Apr 23, 2018

Add note warning about config exports with secrets.

6159924

Thanks for the suggestion @fureigh

fureigh deleted the s3fs branch April 23, 2018 17:46

cmc333333 mentioned this pull request Apr 25, 2018

Multiple instances + CSS/JS aggregation #183

Closed

2 tasks

fureigh mentioned this pull request Apr 25, 2018

Update to Drupal 8.5.3 #230

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to s3fs so we can have multiple instances #223

Switch to s3fs so we can have multiple instances #223

cmc333333 commented Apr 16, 2018

fureigh Apr 19, 2018

fureigh Apr 19, 2018 •

edited

Loading

cmc333333 Apr 19, 2018

cmc333333 Apr 19, 2018

cmc333333 Apr 19, 2018

fureigh left a comment

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

cmc333333 commented Apr 23, 2018

		@@ -0,0 +1,114 @@
		LoadModule authz_core_module modules/mod_authz_core.so

Switch to s3fs so we can have multiple instances #223

Switch to s3fs so we can have multiple instances #223

Conversation

cmc333333 commented Apr 16, 2018

fureigh Apr 19, 2018

Choose a reason for hiding this comment

fureigh Apr 19, 2018 • edited Loading

Choose a reason for hiding this comment

cmc333333 Apr 19, 2018

Choose a reason for hiding this comment

cmc333333 Apr 19, 2018

Choose a reason for hiding this comment

cmc333333 Apr 19, 2018

Choose a reason for hiding this comment

fureigh left a comment

Choose a reason for hiding this comment

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

fureigh commented Apr 20, 2018

cmc333333 commented Apr 23, 2018

fureigh Apr 19, 2018 •

edited

Loading