# Single source of truth for every deploy-time substitution in this repo. # # There are two substitution stages, and they use different delimiters on # purpose: # # {{ token }} creation-time. Resolved once by copier when a new service is # created (cli/src/core/service_creator.py). Never survives # into a committed file. # # @@token@@ deploy-time. Resolved on every deploy, per environment, by # agebd.subs. Lives in committed files. # # This file declares the deploy-time stage only. scripts/ci/check_subs.py # enforces that every @@token@@ in the repo is declared here, and that it # only appears in a path that actually gets rendered. # # 'local' is deliberately absent: it is a runtime mode for tests without EPICS # access (see agebd.enums.AGEBD_ENV), not a deploy target. environments: prod: agebd_env: prod agebd_env_suffix_upper: "" agebd_env_suffix_lower: "" dev: agebd_env: dev agebd_env_suffix_upper: "-DEV" agebd_env_suffix_lower: "-dev" # Every deploy-time token. Each environment above must define exactly the # tokens with source 'environment' -- adding one here without adding it to # every environment is a load-time error. tokens: agebd_env: source: environment description: >- Deployment environment name. Used in deploy paths and systemd units, e.g. /sls/bd/hla/dev/bin/start_service.sh. agebd_env_suffix_upper: source: environment description: >- Uppercase suffix appended to EPICS device names, e.g. AGEBD-TUNE-DEV. Used in IOC substitution files and Qt UI files. agebd_env_suffix_lower: source: environment description: >- Lowercase suffix appended to host names, e.g. sls-vserv-bd-01-dev. Used in IOC parameter files. ioc_port: source: registry description: >- IOC port for the service being deployed, read from config/services_registry.yml. # Where deploy-time tokens are allowed to live, as repo-root-relative globs. locations: # Rendered at deploy time by agebd.subs. A token here is resolved. render: - services/*/current/ioc - services/*/current/systemd - qt # Carry deploy-time tokens verbatim, because the copy they produce lands in # a render path. A token here is NOT resolved in place. passthrough: - templates - cli/tests/fixtures # The substitution machinery itself: code that renders, generates or # documents tokens. Naming a token here is expected; nothing is resolved. # These paths use {{ }} as their own template language (Ansible, copier), so # the leftover-delimiter check does not apply to them. references: - ansible/tasks/* - .gitea/scripts - cli/src/models - packages/agebd/src/agebd - packages/agebd/tests - scripts/ci - scripts/tests - config