Cursor rule

1---
2description: Standards for Lagoon Docker Compose configuration
3globs: docker-compose.yml, docker-compose.*.yml
4---
5# Lagoon Docker Compose Standards
6 
7Ensures proper Docker Compose configuration for Lagoon deployments, following best practices and Lagoon-specific requirements.
8 
9<rule>
10name: lagoon_docker_compose_standards
11description: Enforce standards for Lagoon Docker Compose files
12filters:
13  - type: file_name
14    pattern: "^docker-compose(\\.\\w+)?\\.yml$"
15 
16actions:
17  - type: enforce
18    conditions:
19      - pattern: "services:\\s+\\w+:\\s+(?!.*labels:[\\s\\S]*lagoon)"
20        message: "Add Lagoon labels to service definitions for proper Lagoon integration"
21 
22      - pattern: "version:\\s*['\"]*2"
23        message: "Use Docker Compose format version 3 or higher for compatibility with modern Docker features"
24 
25      - pattern: "volumes:\\s+[^:]+:\\s+(?!.*delegated)"
26        message: "Use 'delegated' mount consistency for better performance on macOS development environments"
27        
28      - pattern: "services:\\s+\\w+:\\s+(?!.*restart:)"
29        message: "Define restart policy for services to ensure proper behavior during deployment"
30 
31  - type: suggest
32    message: |
33      ## Lagoon Docker Compose Best Practices:
34      
35      ### Service Configuration
36      - Define service types via labels (e.g., `lagoon.type: nginx`)
37      - Use proper image naming conventions (e.g., `amazeeio/nginx-drupal:latest`)
38      - Set appropriate environment variables using Lagoon variables
39      - Define health checks for critical services
40      - Configure proper networking with Lagoon defaults
41      - Set resource constraints appropriate for each environment
42      
43      ### Volume Configuration
44      - Use named volumes for persistent data
45      - Configure appropriate volume mounts with correct permissions
46      - Use 'delegated' mount consistency for macOS performance
47      - Avoid mounting the entire codebase when possible
48      
49      ### Build Configuration
50      - Use build arguments appropriately
51      - Define proper Dockerfile paths
52      - Use multi-stage builds for smaller images
53      
54      ### Example Service Configuration:
55```yaml
56      services:
57        nginx:
58          build:
59            context: .
60            dockerfile: nginx.dockerfile
61          labels:
62            lagoon.type: nginx
63            lagoon.persistent: /app/web/sites/default/files/
64          volumes:
65            - app:/app:delegated
66          depends_on:
67            - php
68          environment:
69            LAGOON_ROUTE: ${LAGOON_ROUTE:-http://project.docker.amazee.io}
70```
71 
72  - type: validate
73    conditions:
74      - pattern: "services:\\s+cli:\\s+(?!.*build:)"
75        message: "CLI service should have proper build configuration for Lagoon compatibility"
76 
77      - pattern: "services:\\s+\\w+:\\s+(?!.*depends_on:)"
78        message: "Define service dependencies for proper startup order and container relationships"
79 
80      - pattern: "networks:\\s+(?!.*default:)"
81        message: "Configure proper network settings for Lagoon compatibility and service communication"
82        
83      - pattern: "services:\\s+mariadb:\\s+(?!.*image:\\s+amazeeio\\/mariadb)"
84        message: "Use Lagoon-provided MariaDB image for compatibility with Lagoon environment"
85        
86      - pattern: "services:\\s+\\w+:\\s+environment:\\s+(?!.*\\$\\{LAGOON)"
87        message: "Use Lagoon environment variables with fallbacks for local development"
88 
89metadata:
90  priority: high
91  version: 1.1
92</rule>