Añadiendo Docker a Symfony

Docker + Symfony
Solucionex
26
Ene 24

Por defecto cuando creamos un nuevo proyecto de Symfony éste no viene preparado para usar docker y poder configurar un entorno de desarrollo de forma rápida. Una opción sería partir de una plantilla ya establecida como podría ser:

Cada una de estas opciones tiene sus particularidades por lo que recomiendo leer su respectiva documentación para saber cómo funcionan. En mi caso voy a utilizar la de dunglas/symfony-docker ya que está bastante extendida en el ecosistema además de que nos va a permitir usarla sobre un proyecto ya existente.

Montando el proyecto

Primero, nos clonamos el repositorio de symony-docker de esta manera:

git clone https://github.com/dunglas/symfony-docker.git symfony-docker

Una vez lo tengamos clonado borraremos el directorio .git para que no hay conflicto con el repositorio de nuestro proyecto.

rm -rf symfony-docker/.git

Ahora, copiamos los archivos del symfony-docker a nuestro proyecto:

cp -Rp symfony-docker/. symfony-7/

Añadimos el soporte de Symfony Flex para Docker:

composer config --json extra.symfony.docker 'true'

Volvemos a ejecutar las recetas para actualizar los archivos de docker relacionados en función de los paquetes que se estén usando.

rm symfony.lock
composer symfony:sync-recipes --force --verbose

¡OJO! Esto modificará configuraciones y archivos ya existentes por lo que deberemos compararlos usando un gestor de versiones y revertir los cambios que nos interesen.

Ahora compilamos la imagen de docker:

docker compose build --no-cache --pull

Una vez finalizado sólo faltaría encenderlo:

docker compose up -d

Podemos acceder a través de https://localhost

Añadiendo un Makefile

Para hacer más fácil la gestión de nuestra app vamos a añadir un Makefile. Al copiar los archivos del esqueleto de symfony-docker también nos hemos copiado una carpeta docs en la que se encuentran varios ficheros explicando el funcionamiento de la plantilla. Nos dirigimos al "makefile.md" y encontraremos el código necesario para nuestro Makefile.

# Executables (local)
DOCKER_COMP = docker compose
# Docker containers
PHP_CONT = $(DOCKER_COMP) exec php
# Executables
PHP      = $(PHP_CONT) php
COMPOSER = $(PHP_CONT) composer
SYMFONY  = $(PHP) bin/console
# Misc
.DEFAULT_GOAL = help
.PHONY        : help build up start down logs sh composer vendor sf cc test
## —— 🎵 🐳 The Symfony Docker Makefile 🐳 🎵 ——————————————————————————————————
help: ## Outputs this help screen
	@grep -E '(^[a-zA-Z0-9\./_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}{printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'
## —— Docker 🐳 ————————————————————————————————————————————————————————————————
build: ## Builds the Docker images
	@$(DOCKER_COMP) build --pull --no-cache
up: ## Start the docker hub in detached mode (no logs)
	@$(DOCKER_COMP) up --detach
start: build up ## Build and start the containers
down: ## Stop the docker hub
	@$(DOCKER_COMP) down --remove-orphans
logs: ## Show live logs
	@$(DOCKER_COMP) logs --tail=0 --follow
sh: ## Connect to the FrankenPHP container
	@$(PHP_CONT) sh
test: ## Start tests with phpunit, pass the parameter "c=" to add options to phpunit, example: make test c="--group e2e --stop-on-failure"
	@$(eval c ?=)
	@$(DOCKER_COMP) exec -e APP_ENV=test php bin/phpunit $(c)
## —— Composer 🧙 ——————————————————————————————————————————————————————————————
composer: ## Run composer, pass the parameter "c=" to run a given command, example: make composer c='req symfony/orm-pack'
	@$(eval c ?=)
	@$(COMPOSER) $(c)
vendor: ## Install vendors according to the current composer.lock file
vendor: c=install --prefer-dist --no-dev --no-progress --no-scripts --no-interaction
vendor: composer
## —— Symfony 🎵 ———————————————————————————————————————————————————————————————
sf: ## List all Symfony commands or pass the parameter "c=" to run a given command, example: make sf c=about
	@$(eval c ?=)
	@$(SYMFONY) $(c)
cc: c=c:c ## Clear the cache
cc: sf