Docker refactor ready for AWS

.dockerignore

@@ -0,0 +1,29 @@
+.DS_Store
+.coveragerc
+.devcontainer
+.editorconfig
+.env
+.env.example
+.environment
+.git
+.github
+.gitignore
+.nvmrc
+.platform
+.platform.app.yaml
+.prettierrc.json
+.vscode
+Dockerfile
+README.md
+babel.config.json
+database_dumps
+docker-compose.yml
+docs
+fabfile.py
+gunicorn.conf.py
+lint-requirements.txt
+media
+mkdocs.yml
+node_modules
+platformsh-cli
+setup.cfg

.env.example

@@ -1,4 +1,3 @@
-DATABASE_URL=postgres://postgres:@db:5432/postgres
 DATABASE_ENGINE=django.db.backends.postgresql
 DATABASE_NAME=postgres
 DATABASE_USER=postgres

.github/workflows/docker-build.yml

@@ -0,0 +1,47 @@
+name: Docker
+
+on:
+  schedule:
+    - cron: '44 6 * * *'
+  push:
+    branches:
+      - main
+      - develop
+      - feature/aws-migration # TEMP
+    tags:
+      - v*
+
+env:
+  IMAGE_NAME: ds-wagtail
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+      - uses: hadolint/[email protected]
+        with:
+          dockerfile: Dockerfile
+      - name: Build image
+        run: docker build --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}" --platform=linux/amd64 .
+      - name: Log in to registry
+        # This is where you will update the personal access token to GITHUB_TOKEN
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin
+      - name: Push image
+        run: |
+          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
+          # Change all uppercase to lowercase
+          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
+          # Strip git ref prefix from version
+          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+          # Strip "v" prefix from tag name
+          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+          # Use Docker `latest` tag convention
+          [ "$VERSION" == "main" ] && VERSION=latest
+          echo IMAGE_ID=$IMAGE_ID
+          echo VERSION=$VERSION
+          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
+          docker push $IMAGE_ID:$VERSION

.gitignore

@@ -13,16 +13,7 @@ __pycache__
 .DS_Store
 
 # Ignore the contents of template/static/ but keep the directory
-templates/static/*
-!templates/static/.gitkeep
-
-templates/static/css/*
-!templates/static/css
-!templates/static/css/.gitkeep
-
-templates/static/css/libraries/*
-!templates/static/css/libraries
-!templates/static/css/libraries/.gitkeep
+templates/static
 
 # Allow images within static
 !templates/static/images

.nvmrc

@@ -1 +1 @@
-v16
+v18.16

Dockerfile

@@ -1,7 +1,17 @@
-FROM python:3.11
-LABEL maintainer="[email protected]"
+# Generate static assets (CSS and JavaScript)
+FROM node:18.16 AS staticassets
+WORKDIR /home
+COPY package.json package-lock.json webpack.config.js ./
+RUN npm install
+COPY scripts ./scripts
+COPY sass ./sass
+RUN npm run compile
+
+
+
 
-ARG POETRY_HOME=/opt/poetry
+
+FROM python:3.11
 
 EXPOSE 8000
 
@@ -23,11 +33,8 @@ ENV \
 
 WORKDIR /app
 
-# Upgrade pip
-RUN pip install --upgrade pip
-
-# Install poetry as per official guidance:
-# https://github.com/python-poetry/poetry#installation
+# Install poetry
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 RUN curl -sSL "https://install.python-poetry.org" | python -
 
 # Add poetry's bin directory to PATH
@@ -36,14 +43,18 @@ ENV PATH="$POETRY_HOME/bin:$PATH"
 # Copy files used by poetry
 COPY pyproject.toml poetry.lock ./
 
+# Install Python dependencies AND the 'etna' app
+RUN poetry install
+
+# Copy the executable
+COPY bash/run.sh bash/run-dev.sh bash/
+RUN chmod +x bash/run.sh bash/run-dev.sh
+
 # Copy application code
 COPY . .
 
-# Load shortcuts
-RUN cp ./bash/bashrc.sh /root/.bashrc
-
-# Install Python dependencies AND the 'etna' app
-RUN poetry install
+# Copy static assets
+COPY --from=staticassets /home/templates/static/css/dist/etna.css /home/templates/static/css/dist/etna.css.map templates/static/css/dist/
+COPY --from=staticassets /home/templates/static/scripts templates/static/scripts
 
-# Do nothing forever (use 'exec' to resuse the container)
-CMD tail -f /dev/null
+CMD ["./bash/run.sh"]

README.md

@@ -27,90 +27,53 @@ Convenience commands have been added to `fabfile.py` to help you interact with t
 Once installed, you can type `fab -l` to see a list of available commands.
 
 
-### 1. Build Docker containers
+### 1. Build and start Docker containers
 
-```console
-$ fab build
-```
-
-### 2. Start Docker containers
-
-```console
-$ fab start
-```
-
-### 3. Start a shell session with the 'web' container
-
-```console
-$ fab sh
-```
-
-### 5. Apply database migrations
-
-```console
-$ python manage.py migrate
+```sh
+fab start
 ```
 
-### 6. Run the 'development' web server
+This command takes care of the following:
 
-```console
-$ python manage.py runserver 0.0.0.0:8000
-```
+1. Building all of the necessary Docker containers
+1. Starting all of the necessary Docker containers
+2. Installing any new python dependencies
+3. Applying any new database migrations
+4. Starting the Django development server
 
-### 7. Access the site
+### 2. Access the site
 
 <http://127.0.0.1:8000>
 
-**Note: compiled CSS is not included and therefore needs to be built initially, and after each git pull. See the "Working with SASS/CSS section**
+### 3. Create a Django user for yourself
 
-### 8. Create a Django user for yourself
-
-```console
-$ python manage.py createsuperuser
+```sh
+python manage.py createsuperuser
 ```
 
-### 9. Access the Wagtail admin
+### 4. Access the Wagtail admin
 
 Navigate to the admin URL in your browser, and sign in using the username/password combination you chose in the previous step.
 
 <http://127.0.0.1:8000/admin/>
 
-## Quick start with `fab run`
-
-While it's handy to be able to access 'web' via a shell and interact with Django directly, sometimes all you want is to view the site in a web browser. In these cases, you can use:
-
-```console
-$ fab run
-```
-
-This command takes care of the following:
-
-1. Starting all of the necessary Docker containers
-2. Installing any new python dependencies
-3. Applying any new database migrations
-4. Starting the Django development server
-
-You can then access the site in your browser as usual:
-
-<http://127.0.0.1:8000>
-
 ## Linux / OSX
 If you are running a Unix based operating system, these alias commands may be useful to you to run inside the Docker container.
 
 Running the development server:
 
-``` console
-$ djrun
+``` sh
+djrun
 ```
 Run migrations:
 
-```console
-$ dj migrate
+```sh
+dj migrate
 ```
 Create a super user:
 
-```console
-$ dj createsuperuser
+```sh
+dj createsuperuser
 ```
 
 ## Issues with your local environment?

bash/bashrc.sh

@@ -3,3 +3,7 @@
 alias dj="python manage.py"
 alias djrun="python manage.py runserver 0.0.0.0:8000"
 alias djtest="python manage.py test --settings=config.settings.dev"
+
+export NVM_DIR="$HOME/.nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
+[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion

bash/dev-watch.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+export NVM_DIR="$HOME/.nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"
+nvm install
+npm install
+npm run dev:css &
+npm run dev:js &

bash/run-dev.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+chmod a+x bash/dev-watch.sh
+./bash/dev-watch.sh &
+poetry run python manage.py collectstatic --no-input
+poetry run python manage.py migrate
+poetry run python manage.py runserver 0.0.0.0:8000

bash/run.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+poetry run python manage.py collectstatic --no-input
+poetry run python manage.py migrate
+poetry run gunicorn config.wsgi:application --capture-output --workers 3 --threads 3 --log-level=DEBUG -b 0.0.0.0:8080

config/settings/base.py

@@ -247,7 +247,7 @@
 STATICFILES_STORAGE = "django.contrib.staticfiles.storage.ManifestStaticFilesStorage"
 
 STATIC_ROOT = os.path.join(BASE_DIR, "static")
-STATIC_URL = "/static/"
+STATIC_URL = "static/"
 
 MEDIA_ROOT = os.path.join(BASE_DIR, "media")
 MEDIA_URL = "/media/"

config/settings/production.py

@@ -1,10 +1,20 @@
+import os
+
 from .base import *  # noqa: F401
 
-DEBUG = False
+# TODO: Temporary until the static files can be served via S3 or a CDN
+DEBUG = True
 
 # Ensure that certificates are always checked by Kong client in production
 KONG_CLIENT_VERIFY_CERTIFICATES = True
 
+# TODO: Generate SECRET_KEY
+SECRET_KEY = os.getenv("SECRET_KEY", "")
+# Need to get the IP of the load balancer or reverse proxy
+ALLOWED_HOSTS = ["*"]
+STATICFILES_STORAGE = "django.contrib.staticfiles.storage.ManifestStaticFilesStorage"
+STATIC_ROOT = "/app/static"
+
 try:
     from .local import *  # noqa: F401
 except ImportError:

docker-compose.yml

@@ -1,33 +1,40 @@
 version: '3'
 
 services:
+
   db:
+    container_name: db
     image: postgres:12.0
     ports:
-     - "5432:5432"
+      - 5432:5432
     volumes:
-     - ./database_dumps:/app/database_dumps
+      - ./database_dumps:/app/database_dumps
+
   web:
+    container_name: web
     platform: linux/amd64
     build: .
     volumes:
       - ./:/app
+      - ./bash/bashrc.sh:/root/.bashrc
     depends_on:
-     - db
+      - db
     ports:
-     - 8000:8000 # runserver
-     - 8001:8001 # mkdocs serve
-    # Closely match prod server
-    # command: pipenv run gunicorn config.wsgi:application --bind 0.0.0.0:8000 --timeout 3600 --workers 3 --reload --capture-output
-    # Server for better debugging output
-    command: tail -f /dev/null  # do nothing forever. Use fab sh to run the django server
+      - 8000:8000
+    command: sh bash/run-dev.sh
     restart: on-failure
     init: true
     stdin_open: true
     tty: true
     env_file:
       - .env
+    environment:
+      - DATABASE_HOST=db
+      - DATABASE_NAME=postgres
+      - DATABASE_USER=postgres
+
   cli:
+    container_name: cli
     platform: linux/amd64
     build: platformsh-cli
     volumes: