Use docker compose for development (#1894)

* docker compose working

* empty lines

* env and docs

* dockerfile

* host breaks locally

* cleanup instructions

* update env vars and docs

* extra space

Author: anthonyshull

.env.template

@@ -0,0 +1,28 @@
+# Example environment configuration file: copy to `.env` (this is git-ignored) and fill in any additional values you need.
+
+# ALGOLIA_APP_ID=
+# ALGOLIA_SEARCH_KEY=
+# ALGOLIA_WRITE_KEY=
+
+DRUPAL_ROOT=https://live-mbta.pantheonsite.io
+OPEN_TRIP_PLANNER_URL=http://otp2-local.mbtace.com
+RECAPTCHA_PUBLIC_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
+RECAPTCHA_PRIVATE_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
+
+# V3_API_KEY=
+V3_API_VERSION=2019-07-01
+V3_URL=https://api-dev.mbtace.com
+
+# You can optionally set a Redis host and port.
+# The default host is 127.0.0.1
+# If you're using Docker Compose, the host is 10.0.0.11
+# The default port is 6379
+# If you're using Redis for local development, the port is 30001
+# REDIS_HOST=
+# REDIS_PORT=
+
+# These credentials control access to resetting cache entries for the CMS.
+# You can set them to be whatever you want.
+# But, they'll need to match those on the Drupal side if you're doing CMS development.
+# BASIC_AUTH_USERNAME=
+# BASIC_AUTH_PASSWORD=

.envrc

@@ -0,0 +1,5 @@
+# Loads the .env file that is used by Docker Compose.
+dotenv
+
+# Gets AWS credentials from the AWS CLI configuration.
+$(aws configure export-credentials --format env)

.envrc.template

@@ -9,7 +9,7 @@ erl_crash.dump
 .ruby-version
 .vscode
 .elixir_ls
-.envrc
+.env
 
 # Elastic Beanstalk Files
 .elasticbeanstalk/*

.gitignore

@@ -1 +1 @@
-deploy/dotcom/Dockerfile
+deploy/dotcom/prod/Dockerfile

Dockerfile

@@ -124,7 +124,7 @@ Welcome to [Dotcom](https://www.notion.so/mbta-downtown-crossing/Dotcom-6aa7b0f0
 
 1. Set up required environment variables:
     ```
-    cp .envrc.template .envrc
+    cp .env.template .env
     ```
    Then uncomment the `V3_API_KEY` line and fill it in with the key you obtained
    in the first step. If you have [direnv] installed (recommended), it will automatically load
@@ -138,10 +138,16 @@ For details on environment configuration, including optional variables, see
 
 ## Running the Server
 
-You will need to have Redis running in cluster mode.
+The easiest way to develop MBTA dotcom is to use Docker Compose.
+
+```
+docker compose -f deploy/dev.yml up -d
+```
+
+This will set up Redis in cluster mode among other things.
+
+If you choose not to use Docker Compose, you'll still have to run Redis cluster.
 The easiest way to get it running is to download and compile it.
-But, we plan to Dockerize all of our dependencies in the near future.
-Until then:
 
 ```
 cd $HOME
@@ -158,13 +164,13 @@ When you're done with it:
 ```
 ./utils/create-cluster/create-cluster stop
 cd $HOME
-rm 7.2.tar.gz
+rm 7.2.4.tar.gz
 rm -rf redis-7.2.4
 ```
 
-Start the server with `mix phx.server`
+Start the server with `iex -S mix phx.server`
 
-Then, visit the site at http://localhost:4001/
+Then, visit the site at http://localhost:4001.
 
 ## Algolia
 

README.md

@@ -36,7 +36,7 @@ if config_env() == :dev do
   config :dotcom, DotcomWeb.Endpoint,
     # Binding to loopback ipv4 address prevents access from other machines.
     # Change to `ip: {0, 0, 0, 0}` to allow access from other machines.
-    http: [ip: {127, 0, 0, 1}, port: port],
+    http: [ip: {0, 0, 0, 0}, port: port],
     static_url: static_url
 
   config :dotcom,

config/runtime.exs

@@ -0,0 +1,109 @@
+version: "3"
+services:
+    dotcom:
+        build:
+            context: ../
+            dockerfile: ./deploy/dotcom/dev/Dockerfile
+        env_file:
+            - ../.env
+        depends_on:
+            - redis-cluster-init
+        environment:
+            - MIX_ENV=dev
+            - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
+            - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
+        expose:
+            - 4001
+        ports:
+            - 4001:4001
+            - 8090:8090
+        volumes:
+            - ../:/app
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.2
+    monitor:
+        build:
+            context: ../
+            dockerfile: ./deploy/monitor/Dockerfile
+        env_file:
+            - ../.env
+        command: node /home/runner/integration/monitor/all-health-checks.js
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.3
+    redis-cluster-init:
+        image: redis:7.2.4
+        command: redis-cli --cluster create 10.0.0.11:6379 10.0.0.12:6379 10.0.0.13:6379 10.0.0.14:6379 10.0.0.15:6379 10.0.0.16:6379 --cluster-replicas 1 --cluster-yes
+        depends_on:
+            redis-1: 
+                condition: service_healthy
+            redis-2: 
+                condition: service_healthy
+            redis-3: 
+                condition: service_healthy
+            redis-4: 
+                condition: service_healthy
+            redis-5: 
+                condition: service_healthy
+            redis-6: 
+                condition: service_healthy
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.10
+    redis-1: &redis
+        build:
+            context: ../
+            dockerfile: ./deploy/redis/Dockerfile
+        healthcheck:
+            test: [ "CMD", "redis-cli", "PING"]
+            timeout: 10s
+            interval: 3s
+            retries: 10
+        environment:
+            - CLUSTER_ANNOUNCE_IP=10.0.0.11
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.11
+    redis-2:
+        <<: *redis
+        environment:
+            - CLUSTER_ANNOUNCE_IP=10.0.0.12
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.12
+    redis-3:
+        <<: *redis
+        environment:
+            - CLUSTER_ANNOUNCE_IP=10.0.0.13
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.13
+    redis-4:
+        <<: *redis
+        environment:
+            - CLUSTER_ANNOUNCE_IP=10.0.0.14
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.14
+    redis-5:
+        <<: *redis
+        environment:
+            - CLUSTER_ANNOUNCE_IP=10.0.0.15
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.15
+    redis-6:
+        <<: *redis
+        environment:
+            - CLUSTER_ANNOUNCE_IP=10.0.0.16
+        networks:
+            redis_network:
+                ipv4_address: 10.0.0.16
+networks:
+    redis_network:
+        driver: bridge
+        ipam:
+            config:
+                - subnet: 10.0.0.0/8
+                  gateway: 10.0.0.1

deploy/dev.yml

@@ -0,0 +1,17 @@
+FROM hexpm/elixir:1.16.1-erlang-26.2.2-debian-buster-20240130
+
+RUN apt-get update && apt-get install -y curl git make build-essential inotify-tools
+RUN curl -fsSL https://deb.nodesource.com/setup_18.x | bash -
+RUN apt-get install -y nodejs
+
+WORKDIR /app
+
+COPY mix.exs .
+COPY mix.lock .
+COPY package.json .
+COPY assets/package.json ./assets/package.json
+
+RUN mix local.hex --force
+RUN mix local.rebar --force
+
+CMD mix deps.get && npm install && npm run build && mix phx.digest && npm install --ignore-scripts && mix phx.server