Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 4.08 KB

local.md

File metadata and controls

105 lines (76 loc) · 4.08 KB
Raw

Development environment

Requirements

  • Docker and Docker compose
  • Make (BSD and GNU are supported)
  • Stonehenge

Installation

  • Make sure you have Stonehenge up and running
  • Clone the repository
  • Go to Git root
  • Start the project by running make up
  • Run make new to install site from scratch using existing configuration
  • Run make fresh to install site from existing dump.sql file or sync database from testing environment

Usage

Druidfi tools library provides generic (make) commands to ease the development process.

You can list available commands by running make help. Run make -n {command} to see actions behind the given command.

Docker compose

Compose profiles

Compose profiles are used to only run services that are actually needed. For example, there is no reason to start elasticsearch or artemis containers if your project is not using them.

Modify the value of COMPOSE_PROFILES environment variable from .env file or start the project with COMPOSE_RROFILES=your-profiles make up.

Currently available profiles:

  • queue: Apache Artemis queue service
  • search: ElasticSearch service
  • varnish: Varnish service. Provides varnish-yourproject.docker.so address.

Customizing docker-compose.yml

The default compose.yaml file is intended to be updated automatically from upstream and should have no customizations.

You can create a docker-compose.override.yml file to add or override existing features.

See https://docs.docker.com/compose/multiple-compose-files/merge/ for more information.

Installing site from existing database dump

By default, make fresh attempts to install site using dump.sql file in your Git root. If the dump.sql does not exist, the Database will be synced from your project's testing environment.

Syncing database from testing environment

Add/modify OC_PROJECT_NAME environment variable in your project's .env file. The value should be the same as the name shown in OpenShift project list, for example hki-kanslia-random-project.

Make sure you have no dump.sql in your Git root and run make fresh. The command will sync database dump from your testing environment.

Syncing database from production environment

The production environment can only be accessed through a VPN connection, meaning it's not possible to easily sync the database from production environment.

If you need a production database, you can sync the database from production to testing environment and re-run make fresh. See Syncing databases between OpenShift environments for more information.

The other option is to sync it using VPN and running the oc tool on your local machine. See:

Testing production setup on local

Modify your compose.yaml file with something like:

diff --git a/compose.yaml b/compose.yaml
--- a/compose.yaml
+++ b/compose.yaml
@@ -1,14 +1,13 @@
 services:
   app:
     container_name: "${COMPOSE_PROJECT_NAME}-app"
-    image: "${DRUPAL_IMAGE}"
+    build:
+      context: .
+      dockerfile: docker/openshift/Dockerfile
     hostname: "${COMPOSE_PROJECT_NAME}"
-    volumes:
-      - .:/app:delegated
     depends_on:
       - db
     environment:
-      WEBROOT: /app/public
+      SIMPLETEST_DB: mysql://drupal:drupal@db:3306/drupal
+      OPENSHIFT_BUILD_NAME: some-build-id

Disable preflight checks in docker/openshift/entrypoints/10-preflight.sh:

diff --git a/docker/openshift/entrypoints/10-preflight.sh b/docker/openshift/entrypoints/10-preflight.sh
--- a/docker/openshift/entrypoints/10-preflight.sh
+++ b/docker/openshift/entrypoints/10-preflight.sh
@@ -5,7 +5,7 @@
 if [ -f "../docker/openshift/preflight/preflight.php" ]; then
   echo "Running preflight checks ..."
   if ! php ../docker/openshift/preflight/preflight.php; then
-    exit 1
   fi
 fi

Run docker compose build and make stop up.