Cursor rule

1---
2description: Standards for Lagoon configuration files and deployment workflows
3globs: .lagoon.yml, .lagoon.*.yml
4---
5# Lagoon Configuration Standards
6 
7Ensures proper configuration and best practices for Lagoon deployment files, focusing on environment configuration, routes, tasks, and deployment workflows.
8 
9<rule>
10name: lagoon_yml_standards
11description: Enforce standards for Lagoon configuration files
12filters:
13  - type: file_extension
14    pattern: "\\.(yml|yaml)$"
15  - type: file_name
16    pattern: "^\\.lagoon(\\.\\w+)?\\.yml$"
17 
18actions:
19  - type: enforce
20    conditions:
21      - pattern: "environments:\\s*[\\w-]+:\\s*routes:\\s*-\\s*\\w+:\\s*-[^:]+:\\s*tls-acme:\\s*true"
22        message: "Ensure tls-acme is set to 'false' until DNS points to Lagoon to prevent certificate issuance failures"
23 
24      - pattern: "post-rollout:\\s*-\\s*run:\\s*command:\\s*drush(?!.*\\|\\|)"
25        message: "Wrap Drush commands in proper error handling using '|| exit 1' to ensure deployment fails on command errors"
26 
27      - pattern: "pre-rollout:\\s*-\\s*run:\\s*command:\\s*(?!.*if)"
28        message: "Add conditional checks for pre-rollout tasks to ensure they only run when necessary"
29 
30      - pattern: "cronjobs:\\s*-\\s*name:[^\\n]*\\n\\s*schedule:\\s*'\\*\\s*\\*'"
31        message: "Use 'M' or 'H' notation for randomized cron scheduling to prevent server load spikes"
32        
33      - pattern: "routes:\\s*-\\s*\\w+:\\s*-[^:]+:\\s*(?!.*redirects:)"
34        message: "Consider configuring redirects for routes to handle legacy URLs or domain migrations"
35 
36  - type: suggest
37    message: |
38      ## Lagoon Configuration Best Practices:
39      
40      ### Environment Configuration
41      - Use environment-specific configurations for different deployment targets
42      - Define environment types for proper resource allocation
43      - Configure environment variables specific to each environment
44      - Use environment-specific routes and domains
45      
46      ### Routes Configuration
47      - Configure routes with appropriate SSL settings
48      - Set up redirects for legacy URLs
49      - Configure proper insecure traffic handling (Allow or Redirect)
50      - Use wildcard domains for feature branch environments
51      
52      ### Tasks Configuration
53      - Implement proper pre-rollout tasks with error handling
54      - Configure post-rollout tasks with appropriate conditions
55      - Use conditional task execution based on environment
56      - Include database sync in PR environments
57      - Implement proper backup strategies before major changes
58      
59      ### Cron Configuration
60      - Use randomized cron schedules with 'M' and 'H' notation
61      - Set appropriate frequency for different tasks
62      - Ensure cron jobs have proper error handling
63      - Use descriptive names for cron jobs
64      
65      ### Example Configuration:
66```yaml
67      environments:
68        main:
69          cronjobs:
70            - name: drush-cron
71              schedule: '*/15 * * * *'
72              command: drush cron
73              service: cli
74          routes:
75            - nginx:
76              - example.com:
77                  tls-acme: true
78                  insecure: Redirect
79                  redirects:
80                    - www.example.com
81          tasks:
82            pre-rollout:
83              - run:
84                  name: Drush pre-update
85                  command: |
86                    if drush status --fields=bootstrap | grep -q "Successful"; then
87                      drush state:set system.maintenance_mode 1 -y
88                      drush cr
89                    fi
90                  service: cli
91            post-rollout:
92              - run:
93                  name: Drush post-update
94                  command: |
95                    drush updb -y || exit 1
96                    drush cr
97                    drush state:set system.maintenance_mode 0 -y
98                  service: cli
99```
100 
101  - type: validate
102    conditions:
103      - pattern: "environments:\\s*[\\w-]+:\\s*types:\\s*[^\\n]*"
104        message: "Define environment types for proper resource allocation and environment-specific configuration"
105 
106      - pattern: "tasks:\\s*(pre|post)-rollout:"
107        message: "Include both pre and post rollout tasks for robust deployments and proper application state management"
108 
109      - pattern: "routes:\\s*-\\s*\\w+:\\s*-[^:]+:\\s*insecure:\\s*(Allow|Redirect)"
110        message: "Configure proper insecure traffic handling to ensure secure access to your application"
111        
112      - pattern: "(?!.*backup-strategy:)"
113        message: "Consider implementing a backup strategy for critical environments to prevent data loss"
114        
115      - pattern: "cronjobs:\\s*-\\s*name:[^\\n]*\\n\\s*schedule:[^\\n]*\\n\\s*(?!.*service:)"
116        message: "Specify the service for cron jobs to ensure they run in the correct container"
117 
118metadata:
119  priority: critical
120  version: 1.1
121</rule>