This is a template repo and it can be utilized using the following pattern.
[GitHub Documentation] git-from-template
- Go to https://github.com/aviumlabs/drupal-compose
- Select Use this template
- Select Create a new repository
Repository name: <project_name>
Description: project_description
Public
- Select 'Create repository from template'
Generating your repository...
gh repo create <application-name> -c -d "Application description" --private/public \
-p aviumlabs/drupal-compose
cd
Created repository <github_userid><application_name> on GitHub
Cloning into '<application_name>'...
Note: When dedicing on an application name, use - instead of _ when separating words. Experienced some weird behavior with Docker Desktop and docker compose exec when the project has an _ in the application name.
When the application is launched with the prepare script and the application name contains an _ , the docker compose exec command will not work. Restarting the docker environment resolves the issue, but it's not a good first time user experience.
After creating a new project, there is an included script for creating the environment and database secret files.
./prepare -i [-k]
.\setup.ps1 -Init
This deployment supports both docker container services and docker kubernetes and choosing which to run is up to you. The prepare script preconfigures both deployment types:
- specifying only -i to the deploy script will also start the docker services if docker is running
- specifying both -i and -k will prevent the docker services from starting automatically and allows you to decide which deployment to run
Once the Drupal services are running, please see the docs/runtime-guide.md for further information on configuring the Drupal instance.
To run docker services in the background:
docker compose up -d
To run docker services in the foreground:
docker compose up
To stop an individual service:
docker compose stop [drupal, db]
To start an individual service:
docker compose start [drupal, db]
To view the the logs of a background service:
docker logs -f <running_container_name>
To list the current running containers:
docker compose ps
or
docker container ls
To list all containers:
docker container ls -a
This repository includes support for running in the included Kubernetes environment in Docker.
To deploy against Kubernetes, the k8s/drupal-deployment.yaml file must be updated first. Under volumes > custom-modules, update the path setting to a local directory for developing Drupal custom modules.
In order to prevent the dynamic persistent volumes from being deleted, the PersistentVolumeClaims reside in the k8s/pvc directory.
When running the deployment for the first time, include the recursive flag (-R):
kubectl apply -R -f k8s
Now the delete command can be safely run to stop running pods.
To remove docker kubernetes:
kubectl delete -f k8s
On consecutive deployments, run apply without the recursive flag:
kubectl apply -f k8s
This solution for preventing the deletion of the dynamic persistent volumes is only a partial solution. The PVs will not survive a Docker Desktop shutdown or an OS restart/shutdown.
| CONTAINER ID | IMAGE | ... | NAMES |
|---|---|---|---|
| nnn | aviumlabs/drupal:latest-bookworm | ... | <...drupal-1 |
| nnn | postgres:16.2-alpine3.19 | ... | <...db-1 |
| CONTAINER ID | IMAGE | ... | NAMES |
|---|---|---|---|
| nnn | aviumlabs/nginx-drupal-proxy:latest-alpine | ... | <...www-1 |
| nnn | aviumlabs/drupal:latest-alpine | ... | <...drupal-1 |
| nnn | postgres:16.2-alpine3.19 | ... | <...db-1 |
| CONTAINER ID | IMAGE | ... | NAMES |
|---|---|---|---|
| nnn | drupal:10.2.5-php8.3-apache-bookworm | ... | <...drupal-1 |
| nnn | postgres:16.2-alpine3.19 | ... | <...db-1 |
- Drupal image: aviumlabs/drupal:latest-bookworm
- PostgreSQL image: postgres:16.3-alpine3.20
- Traefik image: traefik:v3.0
docker compose exec drupal composer require '<module>'
kubectl exec <pod_name> -- composer require '<module>'