Skip to content

Template Configuration»

This document provides comprehensive reference for writing template YAML configurations. Templates use a YAML-based configuration format that defines infrastructure, inputs, and deployment behavior.

Template Body Structure»

The template body uses YAML format with the templateSchema. Here's a minimal example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
inputs:
  - id: environment
    name: Environment
    type: select
    options:
      - dev
      - staging
      - prod
  - id: app_name
    name: Application Name
    type: short_text

stacks:
  - key: main
    name: ${{ inputs.app_name }}-${{ inputs.environment }}
    vcs:
      reference:
        value: main
        type: branch
      repository: my-infrastructure
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

Important

Templates use the templateSchema which requires the stacks array format (not a single stack object). Each stack must have a unique key field, and VCS configuration uses the reference structure with value and type fields.

Note: The space field is NOT allowed in Template schema stack definitions. Space assignment is handled at the template deployment level, not in the blueprint YAML.

Templating Restrictions

The following fields cannot use template expressions (${{ }}):

  • Stack keys (/stacks/*/key) - Must be static strings
  • Stack dependencies (/stacks/*/depends_on/*) - Must be static references
  • All VCS fields (/stacks/*/vcs/**) - Including repository, provider, namespace, reference.value, reference.type, etc.
  • Input definitions (/inputs/**) - Including id, name, type, options, default, etc.

Templating is allowed in fields like name, description, labels, autodeploy, environment variables, vendor configuration, and most other stack settings.

Input Types»

Templates support various input types to collect information from users:

Type Description Use Case
short_text Single-line text input Names, identifiers, short values
long_text Multi-line text area Descriptions, configurations, scripts
secret Masked sensitive input Passwords, API keys, tokens
number Integer input Counts, port numbers, limits
float Decimal number input Percentages, ratios, measurements
boolean Checkbox Feature toggles, flags
select Dropdown with options Predefined choices like environments

Input Definition»

Each input is defined with the following properties:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
inputs:
  - id: app_name              # Unique identifier for this input
    name: Application Name     # Display name shown to users
    description: The name of your application  # Optional help text
    type: short_text          # Input type
    default: my-app           # Optional default value
    validations:              # Optional validation rules
      required: true
      min_length: 3
      max_length: 20
      pattern: "^[a-zA-Z0-9-]+$"

Input Properties»

  • id (required): Unique identifier used to reference the input in template expressions
  • name (required): Human-readable display name shown in the deployment form
  • description (optional): Help text explaining what the input is for
  • type (required): Input type (see table above)
  • default (optional): Default value if user doesn't provide one
  • validations (optional): Validation rules to enforce
  • options (required for select): Array of allowed values for select inputs

Input Validations»

Templates support validation rules to ensure users provide valid data:

String Validation»

1
2
3
4
5
6
validations:
  required: true              # Field must be filled
  min_length: 3              # Minimum character count
  max_length: 50             # Maximum character count
  length_equal: 10           # Exact character count required
  pattern: "^[a-z-]+$"       # Regular expression pattern

Number Validation»

1
2
3
4
5
6
7
8
validations:
  required: true              # Field must be filled
  greater_than: 0            # Value must be greater than
  greater_than_or_equal: 1   # Value must be >=
  less_than: 100             # Value must be less than
  less_than_or_equal: 99     # Value must be <=
  not_equal: 50              # Value cannot equal
  step: 2                    # Increment step (for integers)

Boolean Validation»

1
2
validations:
  required: true              # Field must be filled (cannot be null)

Select Validation»

1
2
3
4
5
6
7
type: select
options:                      # List of allowed values
  - dev
  - staging
  - prod
validations:
  required: true              # User must select a value

Using Template Variables»

Template variables can be referenced throughout your configuration using the ${{ }} syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
inputs:
  - id: environment
    name: Environment
    type: select
    options:
      - dev
      - prod

stacks:
  - key: main
    name: app-${{ inputs.environment }}
    description: '${{ inputs.environment == "prod" ? "Production" : "Development" }} environment'
    labels:
      - Environment/${{ inputs.environment }}
    vcs:
      reference:
        value: main
        type: branch
      repository: my-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"
    environment:
      variables:
        - name: ENV
          value: ${{ inputs.environment }}
        - name: DEBUG
          value: '${{ inputs.environment == "dev" }}'

Variable Syntax»

  • Reference inputs: ${{ inputs.input_id }}
  • Use context variables: ${{ context.property }}
  • Use maps: ${{ maps[inputs.env].property }}
  • Apply CEL expressions: ${{ inputs.name.lowerAscii() }}

Templating Restrictions»

Warning

Not all fields support templating. The following paths cannot use ${{ }} expressions:

Structural Fields (must be static): - stacks.*.key - Stack identifiers must be deterministic - stacks.*.depends_on.* - Dependencies must be known at parse time

VCS Configuration (must be static): - stacks.*.vcs.repository - Repository name - stacks.*.vcs.provider - Provider type (GITHUB, GITLAB, etc.) - stacks.*.vcs.namespace - Organization/namespace - stacks.*.vcs.reference.value - Branch/tag/SHA value - stacks.*.vcs.reference.type - Reference type (branch/tag/sha) - stacks.*.vcs.project_root - Project root path

Input Definitions (must be static): - inputs.*.id - Input identifiers - inputs.*.name - Input display names - inputs.*.type - Input types - inputs.*.options - Select options - inputs.*.default - Default values - inputs.*.validations - Validation rules

Why these restrictions? These fields define the template's structure and must be deterministic at parse time. VCS fields determine which repository to use, so they cannot depend on runtime inputs.

What CAN be templated? Most other fields including name, description, labels, autodeploy, autoretry, administrative, environment variables, vendor settings, hooks, schedules, and attachments.

Context Variables»

Templates provide built-in context variables for dynamic values:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
stacks:
  - key: main
    name: app-${{ context.random_string }}
    description: Created at ${{ string(context.time) }}
    labels:
      - owner/${{ context.user.login }}
    vcs:
      reference:
        value: main
        type: branch
      repository: my-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"
    environment:
      variables:
        - name: DEPLOYMENT_ID
          value: "${{ context.random_uuid }}"

Available Context Properties»

Property Type Description
context.deployment.created_at Timestamp Creation date of deployment
context.deployment.name String Name of deployment
context.deployment.slug String Slug of deployment
context.time Timestamp UTC time of deployment
context.random_string String Random 6-character string
context.random_number Number Random number (0-1000000)
context.random_uuid String Random UUID
context.user.login String User's login name
context.user.name String User's full name
context.user.account String Account subdomain

Stack Configuration»

Templates can configure all stack settings using the templateSchema:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
stacks:
  - key: main
    name: ${{ inputs.stack_name }}
    description: My application stack
    labels:
      - app/${{ inputs.app_name }}
      - env/${{ inputs.environment }}

    # Behavioral settings
    administrative: false
    autodeploy: true
    autoretry: false

    # VCS configuration (template schema format)
    vcs:
      reference:
        value: main
        type: branch  # Options: branch, tag, sha
      repository: my-repo
      provider: GITHUB
      namespace: my-org
      project_root: terraform/
      project_globs:
        - "modules/**"

    # Vendor configuration
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"
        workspace: ${{ inputs.environment }}
        workflow_tool: OPEN_TOFU  # Options: TERRAFORM_FOSS, OPEN_TOFU, CUSTOM

    # Environment configuration
    environment:
      variables:
        - name: ENVIRONMENT
          value: ${{ inputs.environment }}
        - name: APP_NAME
          value: ${{ inputs.app_name }}
        - name: API_KEY
          value: ${{ inputs.api_key }}
          secret: true

      mounted_files:
        - path: config.json
          content: |
            {
              "environment": "${{ inputs.environment }}",
              "features": {
                "feature_a": ${{ inputs.enable_feature_a }}
              }
            }
          secret: false

    # Attachments
    attachments:
      contexts:
        - id: my-context-id
          priority: 1
      policies:
        - my-policy-id
      clouds:
        aws:
          id: my-aws-integration-id
          read: true
          write: true

Note

Templates use the templateSchema format. Key differences from the Blueprint schema: - Must use stacks array (not a single stack object) - Each stack requires a unique key field - VCS configuration uses reference.value and reference.type instead of direct branch, tag, or sha fields - See the Template Schema Reference section for complete details

For complete stack configuration options, refer to the Stack Configuration documentation.

Multiple Stacks»

Templates can create multiple stacks in a single deployment:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
inputs:
  - id: app_name
    name: Application Name

stacks:
  - key: frontend
    name: ${{ inputs.app_name }}-frontend
    vcs:
      reference:
        value: main
        type: branch
      repository: frontend-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

  - key: backend
    name: ${{ inputs.app_name }}-backend
    depends_on:
      - frontend
    vcs:
      reference:
        value: main
        type: branch
      repository: backend-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

Note

When using multiple stacks, each stack must have a unique key field for dependency management.

Stack Dependencies»

You can create dependencies between stacks using the depends_on field or stack_dependency_references:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
stacks:
  - key: database
    name: ${{ inputs.app_name }}-db
    vcs:
      reference:
        value: main
        type: branch
      repository: database-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

  - key: application
    name: ${{ inputs.app_name }}-app
    depends_on:
      - database
    environment:
      stack_dependency_references:
        - name: DB_CONNECTION_STRING
          from_stack: database
          output: connection_string
    vcs:
      reference:
        value: main
        type: branch
      repository: app-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

Dependency Features»

  • depends_on: Ensures stacks are created in order
  • stack_dependency_references: Pass outputs from one stack to another as environment variables
  • Multiple dependencies can be specified
  • Prevents circular dependencies

Template Engine»

Templates use the same template engine as Blueprints, based on Google CEL. The implementation is available on GitHub.

Supported Functions»

CEL supports various built-in functions:

  • String operations: contains, startsWith, endsWith, matches, replace, lowerAscii, upperAscii, split, join
  • Operators: *, /, -, +, ==, !=, <, <=, >, >=, &&, ||, !, ?:
  • Type conversions: string(), int(), bool()

CEL Expression Examples»

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
inputs:
  - id: app_name
    name: Application Name
  - id: environment
    name: Environment
    type: select
    options:
      - dev
      - prod

stacks:
  - key: main
    # String manipulation
    name: ${{ inputs.app_name.lowerAscii().replace(" ", "-") }}-${{ inputs.environment }}

    # Conditional logic
    description: '${{ inputs.environment == "prod" ? "Production environment" : "Development environment" }}'

    # Boolean conditions
    autodeploy: ${{ inputs.environment != 'prod' }}
    administrative: ${{ inputs.environment == 'prod' }}

    # String operations
    labels:
      - '${{ inputs.environment.upperAscii() }}'
      - app/${{ inputs.app_name.lowerAscii() }}

    vcs:
      reference:
        value: main
        type: branch
      repository: my-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

YAML Syntax Validity»

Reserved YAML characters (:, ?, >, |) within CEL expressions require quotes:

1
2
3
4
5
# Invalid - YAML parsing error
name: ${{ condition ? "yes" : "no" }}

# Valid - quoted expression
name: '${{ condition ? "yes" : "no" }}'

Maps»

Maps allow you to preconfigure specific values and enable deterministic value selection:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
inputs:
  - id: env
    name: Environment
    type: select
    options:
      - prod
      - dev

maps:
  prod:
    stack_name: production-app
    description: Production environment
    instance_count: 5
    manage_state: true
  dev:
    stack_name: development-app
    description: Development environment
    instance_count: 1
    manage_state: false

stacks:
  - key: main
    name: ${{ maps[inputs.env].stack_name }}
    description: ${{ maps[inputs.env].description }}
    vcs:
      reference:
        value: main
        type: branch
      repository: my-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: ${{ maps[inputs.env].manage_state }}
        version: "1.5.0"
    environment:
      variables:
        - name: INSTANCE_COUNT
          value: "${{ maps[inputs.env].instance_count }}"

Note

Maps cannot reference inputs in their definitions, and inputs cannot reference maps.

Map Use Cases»

  • Environment-specific configurations
  • Predefined resource sizes (small, medium, large)
  • Regional settings
  • Tier-based configurations (bronze, silver, gold)

Schedules»

Templates support scheduling for drift detection and scheduled tasks:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
inputs:
  - id: enable_drift_detection
    name: Enable Drift Detection
    type: boolean
  - id: enable_reconcile
    name: Enable Auto-Reconcile
    type: boolean
    default: false

stacks:
  - key: main
    name: scheduled-stack
    vcs:
      reference:
        value: main
        type: branch
      repository: my-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"
    schedules:
      # Drift detection
      drift:
        cron:
          - "0 2 * * *"  # Run daily at 2 AM
        reconcile: ${{ inputs.enable_reconcile }}
        ignore_state: false
        timezone: UTC

      # Scheduled tasks
      tasks:
        - command: "terraform plan"
          cron:
            - "0 0 * * 0"  # Weekly on Sunday at midnight
          timezone: UTC
        - command: "echo 'Health check'"
          cron:
            - "0 */6 * * *"  # Every 6 hours
          timezone: UTC

Schedule Types»

Drift Detection:

  • Automatically check for configuration drift
  • Option to reconcile differences automatically
  • Configurable cron schedule
  • Can ignore state file changes

Scheduled Tasks:

  • Run arbitrary commands on a schedule
  • Support for multiple scheduled tasks
  • Each task has its own cron schedule
  • Timezone configuration per task

Hooks»

Templates support lifecycle hooks for custom actions:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
stacks:
  - key: main
    name: hooked-stack
    vcs:
      reference:
        value: main
        type: branch
      repository: my-repo
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"
    hooks:
      init:
        before: ["echo", "Initializing..."]
        after: ["echo", "Initialization complete"]

      plan:
        before: ["echo", "Planning changes..."]
        after: ["./notify-team.sh", "${{ inputs.environment }}"]

      apply:
        before: ["echo", "Applying changes..."]
        after: ["echo", "Deployment complete"]

      destroy:
        before: ["echo", "Destroying resources..."]
        after: ["echo", "Resources destroyed"]

      run:
        after: ["./cleanup.sh"]

Hook Types»

  • init: Run before/after initialization
  • plan: Run before/after planning
  • apply: Run before/after applying changes
  • destroy: Run before/after destroying resources
  • run: Run after any run completes

Hook Best Practices»

  1. Keep hooks simple: Complex logic belongs in the repository
  2. Use for notifications: Alert teams about deployments
  3. Validate inputs: Check prerequisites before operations
  4. Cleanup: Remove temporary files after runs

Best Practices»

Input Design»

Good input design:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
inputs:
  - id: app_name
    name: Application Name
    description: A unique name for your application (lowercase, hyphens allowed)
    type: short_text
    validations:
      required: true
      min_length: 3
      max_length: 30
      pattern: "^[a-z0-9-]+$"

  - id: environment
    name: Environment
    description: Select the target environment for deployment
    type: select
    options:
      - dev
      - staging
      - prod
    default: dev

Bad input design:

1
2
3
4
5
6
7
8
inputs:
  - id: x
    name: X
    type: short_text

  - id: env
    name: Env
    type: short_text  # Should be select with options

Template Structure»

  1. Organize inputs logically: Group related inputs together
  2. Use descriptive IDs: Make input IDs clear and meaningful
  3. Provide defaults: Set sensible defaults for optional inputs
  4. Add descriptions: Help users understand what each input does
  5. Validate thoroughly: Use validation rules to prevent errors

Variable Usage»

  1. Use maps for complex logic: Instead of many conditional expressions
  2. Keep expressions simple: Complex logic can be hard to debug
  3. Quote when needed: Remember YAML special character rules
  4. Use context variables: For unique identifiers and timestamps

Security»

  1. Mark secrets: Always use secret: true for sensitive values
  2. Validate inputs: Prevent injection attacks with pattern validation
  3. Least privilege: Configure minimal required permissions
  4. Audit hooks: Review hook commands for security issues

Examples»

Simple Web Application»

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
inputs:
  - id: app_name
    name: Application Name
    type: short_text
    validations:
      required: true
      pattern: "^[a-z0-9-]+$"

  - id: environment
    name: Environment
    type: select
    options:
      - dev
      - prod
    default: dev

stacks:
  - key: main
    name: ${{ inputs.app_name }}-${{ inputs.environment }}
    autodeploy: ${{ inputs.environment == 'dev' }}

    vcs:
      reference:
        value: main
        type: branch
      repository: web-app-template
      provider: GITHUB

    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

    environment:
      variables:
        - name: ENVIRONMENT
          value: ${{ inputs.environment }}
        - name: APP_NAME
          value: ${{ inputs.app_name }}

Multi-Stack Application with Dependencies»

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
inputs:
  - id: app_name
    name: Application Name
    type: short_text
    validations:
      required: true

stacks:
  - key: database
    name: ${{ inputs.app_name }}-db
    vcs:
      reference:
        value: main
        type: branch
      repository: postgres-template
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

  - key: backend
    name: ${{ inputs.app_name }}-api
    depends_on:
      - database
    environment:
      stack_dependency_references:
        - name: DATABASE_URL
          from_stack: database
          output: connection_string
    vcs:
      reference:
        value: main
        type: branch
      repository: api-template
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

  - key: frontend
    name: ${{ inputs.app_name }}-web
    depends_on:
      - backend
    environment:
      stack_dependency_references:
        - name: API_URL
          from_stack: backend
          output: api_endpoint
    vcs:
      reference:
        value: main
        type: branch
      repository: frontend-template
      provider: GITHUB
    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

Environment-Based Configuration with Maps»

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
inputs:
  - id: app_name
    name: Application Name
    type: short_text

  - id: environment
    name: Environment
    type: select
    options:
      - dev
      - staging
      - prod

maps:
  dev:
    instance_type: t3.micro
    instance_count: 1
    autodeploy: true
    backup_enabled: false
  staging:
    instance_type: t3.small
    instance_count: 2
    autodeploy: true
    backup_enabled: true
  prod:
    instance_type: t3.medium
    instance_count: 3
    autodeploy: false
    backup_enabled: true

stacks:
  - key: main
    name: ${{ inputs.app_name }}-${{ inputs.environment }}
    autodeploy: ${{ maps[inputs.environment].autodeploy }}

    vcs:
      reference:
        value: main
        type: branch
      repository: app-template
      provider: GITHUB

    vendor:
      terraform:
        manage_state: true
        version: "1.5.0"

    environment:
      variables:
        - name: INSTANCE_TYPE
          value: ${{ maps[inputs.environment].instance_type }}
        - name: INSTANCE_COUNT
          value: "${{ maps[inputs.environment].instance_count }}"
        - name: BACKUP_ENABLED
          value: "${{ maps[inputs.environment].backup_enabled }}"

Schema»

The up-to-date schema of a Blueprint is available through a GraphQL query for authenticated users:

1
2
3
{
  templateSchema
}

Tip

Remember that there are multiple ways to interact with Spacelift. You can use the GraphQL API, the CLI, the Terraform Provider, or the web UI.

For simplicity, here is the current schema, but it might change in the future:

Click to expand 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Blueprint",
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/definitions/inputs"
        },
        "maps": {
            "$ref": "#/definitions/maps"
        },
        "stacks": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/stack"
            }
        }
    },
    "additionalProperties": false,
    "required": ["stacks"],
    "definitions": {
        "maps": {
            "type": "object",
            "additionalProperties": {
                "type": "object",
                "additionalProperties": {
                    "oneOf": [
                        {
                            "type": "string"
                        },
                        {
                            "type": "number"
                        },
                        {
                            "type": "boolean"
                        }
                    ]
                }
            }
        },
        "inputs": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/input"
            }
        },
        "input": {
            "type": "object",
            "oneOf": [
                {
                    "additionalProperties": false,
                    "required": [
                        "id",
                        "name"
                    ],
                    "properties": {
                        "id": {
                            "type": "string"
                        },
                        "name": {
                            "type": "string"
                        },
                        "description": {
                            "type": "string"
                        },
                        "default": {
                            "oneOf": [
                                {
                                    "type": "string"
                                },
                                {
                                    "type": "number"
                                },
                                {
                                    "type": "boolean"
                                }
                            ]
                        },
                        "validations": {
                            "$ref": "#/definitions/string_validations"
                        },
                        "type": {
                            "type": "string",
                            "enum": [
                                "short_text",
                                "long_text",
                                "secret"
                            ]
                        }
                    }
                },
                {
                    "additionalProperties": false,
                    "required": [
                        "id",
                        "name",
                        "type"
                    ],
                    "properties": {
                        "id": {
                            "type": "string"
                        },
                        "name": {
                            "type": "string"
                        },
                        "description": {
                            "type": "string"
                        },
                        "default": {
                            "oneOf": [
                                {
                                    "type": "string"
                                },
                                {
                                    "type": "number"
                                },
                                {
                                    "type": "boolean"
                                }
                            ]
                        },
                        "validations": {
                            "$ref": "#/definitions/number_validations"
                        },
                        "type": {
                            "type": "string",
                            "enum": [
                                "number",
                                "float"
                            ]
                        }
                    }
                },
                {
                    "additionalProperties": false,
                    "required": [
                        "id",
                        "name",
                        "type"
                    ],
                    "properties": {
                        "id": {
                            "type": "string"
                        },
                        "name": {
                            "type": "string"
                        },
                        "description": {
                            "type": "string"
                        },
                        "default": {
                            "oneOf": [
                                {
                                    "type": "string"
                                },
                                {
                                    "type": "number"
                                },
                                {
                                    "type": "boolean"
                                }
                            ]
                        },
                        "type": {
                            "type": "string",
                            "enum": [
                                "boolean"
                            ]
                        }
                    }
                },
                {
                    "additionalProperties": false,
                    "required": [
                        "id",
                        "name",
                        "type",
                        "options"
                    ],
                    "properties": {
                        "id": {
                            "type": "string"
                        },
                        "name": {
                            "type": "string"
                        },
                        "description": {
                            "type": "string"
                        },
                        "default": {
                            "oneOf": [
                                {
                                    "type": "string"
                                },
                                {
                                    "type": "number"
                                },
                                {
                                    "type": "boolean"
                                }
                            ]
                        },
                        "type": {
                            "type": "string",
                            "enum": [
                                "select"
                            ]
                        },
                        "options": {
                            "type": "array",
                            "minItems": 1,
                            "items": {
                                "type": "string"
                            }
                        }
                    }
                }
            ]
        },
        "stack": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "name",
                "vcs",
                "vendor",
                "key"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "minLength": 1
                },
                "description": {
                    "type": "string"
                },
                "labels": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "administrative": {
                    "type": "boolean"
                },
                "autodeploy": {
                    "type": "boolean"
                },
                "autoretry": {
                    "type": "boolean"
                },
                "runner_image": {
                    "type": "string"
                },
                "secret_masking_enabled": {
                    "type": "boolean"
                },
                "worker_pool": {
                    "type": "string"
                },
                "attachments": {
                    "$ref": "#/definitions/attachment"
                },
                "environment": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "mounted_files": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/mounted_file"
                            }
                        },
                        "variables": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/variable"
                            }
                        },
                        "stack_dependency_references": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/dependency_reference"
                            }
                        }
                    }
                },
                "hooks": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "apply": {
                            "$ref": "#/definitions/before_after_hook"
                        },
                        "init": {
                            "$ref": "#/definitions/before_after_hook"
                        },
                        "plan": {
                            "$ref": "#/definitions/before_after_hook"
                        },
                        "perform": {
                            "$ref": "#/definitions/before_after_hook"
                        },
                        "destroy": {
                            "$ref": "#/definitions/before_after_hook"
                        },
                        "run": {
                            "$ref": "#/definitions/after_hook"
                        }
                    }
                },
                "schedules": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "drift": {
                            "$ref": "#/definitions/drift_detection_schedule"
                        },
                        "tasks": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/task_schedule"
                            }
                        }
                    }
                },
                "vcs": {
                    "type": "object",
                    "oneOf": [
                        {
                            "additionalProperties": false,
                            "required": [
                                "reference",
                                "provider",
                                "repository"
                            ],
                            "properties": {
                                "reference": {
                                    "$ref": "#/definitions/git_reference"
                                },
                                "project_root": {
                                    "type": "string"
                                },
                                "project_globs": {
                                    "type": "array",
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "provider": {
                                    "type": "string",
                                    "enum": [
                                        "GITHUB",
                                        "GITLAB",
                                        "BITBUCKET_DATACENTER",
                                        "BITBUCKET_CLOUD",
                                        "GITHUB_ENTERPRISE",
                                        "SHOWCASE",
                                        "AZURE_DEVOPS"
                                    ]
                                },
                                "id": {
                                    "type": "string",
                                    "description": "The id of the VCS provider."
                                },
                                "namespace": {
                                    "type": "string"
                                },
                                "repository": {
                                    "type": "string",
                                    "minLength": 1,
                                    "description": "The name of the repository."
                                }
                            }
                        },
                        {
                            "additionalProperties": false,
                            "required": [
                                "reference",
                                "provider",
                                "repository_url"
                            ],
                            "properties": {
                                "reference": {
                                    "$ref": "#/definitions/git_reference"
                                },
                                "project_root": {
                                    "type": "string"
                                },
                                "project_globs": {
                                    "type": "array",
                                    "items": {
                                        "type": "string"
                                    }
                                },
                                "provider": {
                                    "type": "string",
                                    "enum": [
                                        "RAW_GIT"
                                    ]
                                },
                                "repository": {
                                    "type": "string",
                                    "description": "The name of the repository. If not provided, it'll be extracted from the repository_url."
                                },
                                "namespace": {
                                    "type": "string",
                                    "description": "The namespace of the repository. If not provided, it'll be extracted from the repository_url."
                                },
                                "repository_url": {
                                    "type": "string",
                                    "minLength": 1,
                                    "description": "The URL of the repository. This is only used for the 'RAW_GIT' provider."
                                }
                            }
                        }
                    ]
                },
                "vendor": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "ansible": {
                            "$ref": "#/definitions/ansible_vendor"
                        },
                        "cloudformation": {
                            "$ref": "#/definitions/cloudformation_vendor"
                        },
                        "kubernetes": {
                            "$ref": "#/definitions/kubernetes_vendor"
                        },
                        "pulumi": {
                            "$ref": "#/definitions/pulumi_vendor"
                        },
                        "terraform": {
                            "$ref": "#/definitions/terraform_vendor"
                        },
                        "terragrunt": {
                            "$ref": "#/definitions/terragrunt_vendor"
                        }
                    }
                },
                "depends_on": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "minLength": 1
                    }
                },
                "key": {
                    "type": "string"
                }
            }
        },
        "attachment": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "contexts": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/context"
                    }
                },
                "clouds": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "aws": {
                            "$ref": "#/definitions/aws_attachment"
                        },
                        "azure": {
                            "$ref": "#/definitions/azure_attachment"
                        }
                    }
                },
                "policies": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "roles": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/role_binding"
                    }
                }
            }
        },
        "aws_attachment": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "id",
                "read",
                "write"
            ],
            "properties": {
                "id": {
                    "type": "string"
                },
                "read": {
                    "type": "boolean"
                },
                "write": {
                    "type": "boolean"
                }
            }
        },
        "azure_attachment": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "id",
                "read",
                "write",
                "subscription_id"
            ],
            "properties": {
                "id": {
                    "type": "string"
                },
                "read": {
                    "type": "boolean"
                },
                "write": {
                    "type": "boolean"
                },
                "subscription_id": {
                    "type": "string"
                }
            }
        },
        "context": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "id"
            ],
            "properties": {
                "id": {
                    "type": "string"
                },
                "priority": {
                    "type": "integer",
                    "minimum": 0
                }
            }
        },
        "role_binding": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "role_id",
                "space_id"
            ],
            "properties": {
                "role_id": {
                    "type": "string"
                },
                "space_id": {
                    "type": "string"
                }
            }
        },
        "mounted_file": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "path",
                "content"
            ],
            "properties": {
                "path": {
                    "type": "string"
                },
                "content": {
                    "type": "string"
                },
                "description": {
                    "type": "string"
                },
                "secret": {
                    "type": "boolean"
                }
            }
        },
        "dependency_reference": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "name",
                "from_stack",
                "output"
            ],
            "properties": {
                "name": {
                    "type": "string"
                },
                "from_stack": {
                    "type": "string"
                },
                "output": {
                    "type": "string"
                },
                "trigger_always": {
                    "type": "boolean"
                }
            }
        },
        "variable": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "name",
                "value"
            ],
            "properties": {
                "name": {
                    "type": "string"
                },
                "value": {
                    "type": "string"
                },
                "description": {
                    "type": "string"
                },
                "secret": {
                    "type": "boolean"
                }
            }
        },
        "after_hook": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "after": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "minLength": 1
                }
            }
        },
        "before_after_hook": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "before": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "minLength": 1
                },
                "after": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "minLength": 1
                }
            }
        },
        "drift_detection_schedule": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "cron",
                "reconcile"
            ],
            "properties": {
                "cron": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/cron_schedule",
                        "maxLength": 1
                    }
                },
                "reconcile": {
                    "type": "boolean"
                },
                "ignore_state": {
                    "type": "boolean"
                },
                "timezone": {
                    "type": "string"
                }
            }
        },
        "task_schedule": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "command"
            ],
            "oneOf": [
                {
                    "required": [
                        "command",
                        "cron"
                    ]
                },
                {
                    "required": [
                        "command",
                        "timestamp_unix"
                    ]
                }
            ],
            "properties": {
                "command": {
                    "type": "string",
                    "minLength": 1
                },
                "cron": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/cron_schedule",
                        "minLength": 1
                    }
                },
                "timestamp_unix": {
                    "type": "number",
                    "minimum": 1600000000
                },
                "timezone": {
                    "type": "string"
                }
            }
        },
        "cron_schedule": {
            "type": "string",
            "pattern": "^(\\*|\\d+|\\d+-\\d+|\\d+\\/\\d+|\\*\\/\\d+|\\d+(,\\d+)+)(\\s+(\\*|\\d+|\\d+-\\d+|\\d+\\/\\d+|\\*\\/\\d+|\\d+(,\\d+)+)){4}$"
        },
        "ansible_vendor": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "playbook"
            ],
            "properties": {
                "playbook": {
                    "type": "string",
                    "minLength": 1
                }
            }
        },
        "cloudformation_vendor": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "entry_template_file",
                "template_bucket",
                "stack_name",
                "region"
            ],
            "properties": {
                "entry_template_file": {
                    "type": "string",
                    "minLength": 1
                },
                "template_bucket": {
                    "type": "string",
                    "minLength": 1
                },
                "stack_name": {
                    "type": "string",
                    "minLength": 1
                },
                "region": {
                    "type": "string",
                    "minLength": 1
                }
            }
        },
        "kubernetes_vendor": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "namespace"
            ],
            "properties": {
                "namespace": {
                    "type": "string",
                    "minLength": 1
                }
            }
        },
        "pulumi_vendor": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "stack_name",
                "login_url"
            ],
            "properties": {
                "stack_name": {
                    "type": "string",
                    "minLength": 1
                },
                "login_url": {
                    "type": "string",
                    "minLength": 1
                }
            }
        },
        "terraform_vendor": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "manage_state"
            ],
            "properties": {
                "version": {
                    "type": "string"
                },
                "workspace": {
                    "type": "string"
                },
                "use_smart_sanitization": {
                    "type": "boolean"
                },
                "manage_state": {
                    "type": "boolean"
                },
                "workflow_tool": {
                    "type": "string",
                    "enum": [
                        "TERRAFORM_FOSS",
                        "CUSTOM",
                        "OPEN_TOFU"
                    ]
                }
            }
        },
        "terragrunt_vendor": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "terraform_version": {
                    "type": "string"
                },
                "terragrunt_version": {
                    "type": "string"
                },
                "use_run_all": {
                    "type": "boolean"
                },
                "use_smart_sanitization": {
                    "type": "boolean"
                },
                "terragrunt_tool": {
                    "type": "string",
                    "enum": [
                        "TERRAFORM_FOSS",
                        "OPEN_TOFU",
                        "MANUALLY_PROVISIONED"
                    ]
                }
            }
        },
        "string_validations": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "required": {
                    "type": "boolean"
                },
                "min_length": {
                    "type": "integer",
                    "minimum": 0
                },
                "max_length": {
                    "type": "integer",
                    "minimum": 0
                },
                "length_equal": {
                    "type": "integer",
                    "minimum": 0
                },
                "pattern": {
                    "type": "string"
                }
            }
        },
        "number_validations": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "required": {
                    "type": "boolean"
                },
                "greater_than": {
                    "type": "number"
                },
                "greater_than_or_equal": {
                    "type": "number"
                },
                "less_than": {
                    "type": "number"
                },
                "less_than_or_equal": {
                    "type": "number"
                },
                "not_equal": {
                    "type": "number"
                },
                "step": {
                    "type": "integer"
                }
            }
        },
        "git_reference": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "value",
                "type"
            ],
            "properties": {
                "value": {
                    "type": "string",
                    "minLength": 1,
                    "description": "The git reference value (branch name, tag name, or commit SHA)."
                },
                "type": {
                    "type": "string",
                    "enum": [
                        "branch",
                        "tag",
                        "sha"
                    ],
                    "description": "The type of git reference: 'branch', 'tag', or 'sha'."
                }
            }
        }
    }
}

TemplateSchema Key Differences»

Templates use the templateSchema format, which has important differences from the original Blueprint schema:

Required Changes»

Aspect Original Blueprint Schema Template Schema
Stack Definition Single stack object OR stacks array Only stacks array (required)
Stack Key Not required Each stack must have unique key field
VCS Reference Direct fields: branch, tag, sha Structured: reference.value and reference.type
Space Field Required space field in stack NOT allowed (assigned at deployment)
Stack Limit Max 5 stacks Max 10 stacks

VCS Configuration Comparison»

Original Blueprint Schema:

1
2
3
4
vcs:
  branch: main           # Direct field
  repository: my-repo
  provider: GITHUB

Template Schema:

1
2
3
4
5
6
vcs:
  reference:
    value: main          # Can be branch name, tag, or SHA
    type: branch         # Must specify: "branch", "tag", or "sha"
  repository: my-repo
  provider: GITHUB

Reference Types»

The reference.type field accepts three values:

  • branch: Use a branch name (e.g., main, develop)
  • tag: Use a git tag (e.g., v1.0.0)
  • sha: Use a specific commit SHA (e.g., abc123def456)

Tip

When a template version is published, it's automatically pinned to the current commit SHA of the specified branch/tag, ensuring deterministic deployments.

Available Stack Properties»

The templateSchema supports the following stack-level properties:

Property Type Description
key string Required. Unique identifier for the stack (used in dependencies)
name string Required. Stack display name (can be templated)
description string Optional description (can be templated)
labels array Optional labels for categorization (can be templated)
administrative boolean Mark stack as administrative (can be templated)
autodeploy boolean Enable automatic deployment on VCS changes (can be templated)
autoretry boolean Enable automatic retry on failure (can be templated)
vcs object Required. VCS configuration (cannot be templated)
vendor object Required. Infrastructure tool configuration (Terraform, Pulumi, etc.)
environment object Environment variables and mounted files (can be templated)
attachments object Contexts, policies, and cloud integrations
hooks object Lifecycle hooks (init, plan, apply, destroy)
schedules object Drift detection and scheduled tasks (supports drift and tasks only)
depends_on array Stack dependencies (cannot be templated)
runner_image string Custom runner image
worker_pool string Worker pool ID
secret_masking_enabled boolean Enable secret masking in logs

Note

Property names in Template schema are case-sensitive and use lowercase without underscores for boolean flags (e.g., autodeploy, not auto_deploy). Some properties from the original Blueprint schema are not available in Template schema.