Reference

Concise lookups for jobs, metadata, and configuration keys.

Jenkins Jobs (Folders)

  • QA-Application-Templates/ — template CRUD and sync.

  • QA-Environments/ — create, deploy, update, stop, delete, backup, validate.

  • QA-System/ — shared-library sync and maintenance.

Metadata (meta.json)

Stored under /var/jenkins_home/qa-data/envs/<env>/:

  • services: list of templates in the environment.

  • status: configured | deployed | stopped.

  • runner: agent label used for deployment.

  • ttl: time-to-live value (e.g., 1w).

  • created_at, created_by: audit fields.

Storage Paths

  • Master: /var/jenkins_home/qa-data/envs/<env>/ — rendered Compose, env files, metadata.

  • Agents: /opt/qa-envs/<env>/ — runnable Compose stack + backups.

Useful Commands

  • Compose config validation (agent):

cd /opt/qa-envs/<env> && docker compose config --quiet

  • Backup restoration (agent):

cp docker-compose.yml.backup-* docker-compose.yml
docker compose up -d

  • Cleanup stray temp dirs (master):

find /var/jenkins_home/qa-data/envs/ -type d -name "*@tmp" -exec rm -rf {} +

Health Check Patterns

  • Increase interval, timeout, retries, start_period for slow-starting services.

  • Use CMD-SHELL when commands require env expansion (e.g., $MYSQL_USER).

Variable Substitution

  • Template syntax: ${VAR:-default} inside YAML and env files.

  • Precedence: template defaults < environment .env < per-service .env.