Stack schema reference

Schema reference for the stack section of a Ravion module definition, covering Terraform provisioning, source, backend, and workspace configuration.

Legend

Notation	Meaning
T[]	Array of T
map<string,T>	Object keyed by strings with T values
enum[a,b]	One of the listed values
A | B	One of several types
~template	Field accepts << ... >> template expressions

Stack

Stack configuration for provisioning this module

ModuleStack

Root stack block in module.yaml

type · enum · required

IaC stack type

Allowed values: terraform | opentofu

(templateable)

pipelines · StackPipelinesConfig · required

Configuration for all stack pipelines

See: StackPipelinesConfig

ravion_state_backend_workspace · string | null

The Ravion Cloud workspace name to use for state storage.

(templateable)

StackPipelinesConfig

Stack pipeline configuration

defaults · StackPipelineDefaults · required

Defaults applied to stack runs and merged into trigger run inputs.

See: StackPipelineDefaults

change · StackActionPipelineConfig · required

Configuration for stack change pipeline

See: StackActionPipelineConfig

destroy · StackActionPipelineConfig · required

Configuration for stack destroy pipeline

See: StackActionPipelineConfig

StackActionPipelineConfig

Pipeline configuration for a stack action

pipeline_id · string · required

Pipeline ID for this stack action

(minLen:1; templateable)

triggers · Pipeline.PipelineTrigger[]

Triggers that automatically start pipeline runs on webhook events.

See: Pipeline.PipelineTrigger

StackPipelineDefaults

Default stack pipeline run configuration

variant · string · required

Default variant used for stack-triggered runs

(minLen:1; templateable)

input · map<string,any | null>

Default input values merged into each trigger run variant

(templateable)

Pipeline.PipelineTrigger

Pipeline trigger definition.

Discriminated union. The type field selects which schema applies.

type value	Schema
schedule	Pipeline.SchedulePipelineTrigger
webhook	Pipeline.GenericPipelineTrigger
"webhook:github"	Pipeline.GithubPipelineTrigger
"webhook:gitlab"	Pipeline.GitlabPipelineTrigger

Pipeline.GenericPipelineTrigger

Pipeline trigger for generic webhooks.

id · string · required

Unique identifier for this trigger

enabled · boolean · default: "true"

Whether this trigger is active. Disabled triggers are not registered.

repo · string · required

Git repository in owner/repo or host/owner/repo format

(templateable)

filter · Pipeline.TriggerFilter

Filters to narrow which events trigger the pipeline

See: Pipeline.TriggerFilter

concurrency · Pipeline.ConcurrencyConfig

Concurrency configuration for runs started by this trigger.

See: Pipeline.ConcurrencyConfig

run · map<string,Pipeline.TriggerRunVariantConfig> · required

Maps variant IDs to run configuration — keys must match declared variant IDs.

See: Pipeline.TriggerRunVariantConfig

type · enum · required

Webhook type for generic webhook triggers.

Allowed values: webhook

Pipeline.GithubPipelineTrigger

Pipeline trigger for GitHub webhooks.

id · string · required

Unique identifier for this trigger

enabled · boolean · default: "true"

Whether this trigger is active. Disabled triggers are not registered.

repo · string · required

Git repository in owner/repo or host/owner/repo format

(templateable)

filter · Pipeline.TriggerFilter

Filters to narrow which events trigger the pipeline

See: Pipeline.TriggerFilter

concurrency · Pipeline.ConcurrencyConfig

Concurrency configuration for runs started by this trigger.

See: Pipeline.ConcurrencyConfig

run · map<string,Pipeline.TriggerRunVariantConfig> · required

Maps variant IDs to run configuration — keys must match declared variant IDs.

See: Pipeline.TriggerRunVariantConfig

type · enum · required

Webhook type — determines which events are supported.

Allowed values: webhook:github

event · enum · required

Webhook event type to listen for.

Allowed values: push | pull_request | pull_request_review | pull_request_review_comment | pull_request_review_thread | release | deployment

Pipeline.GitlabPipelineTrigger

Pipeline trigger for GitLab webhooks.

id · string · required

Unique identifier for this trigger

enabled · boolean · default: "true"

Whether this trigger is active. Disabled triggers are not registered.

repo · string · required

Git repository in owner/repo or host/owner/repo format

(templateable)

filter · Pipeline.TriggerFilter

Filters to narrow which events trigger the pipeline

See: Pipeline.TriggerFilter

concurrency · Pipeline.ConcurrencyConfig

Concurrency configuration for runs started by this trigger.

See: Pipeline.ConcurrencyConfig

run · map<string,Pipeline.TriggerRunVariantConfig> · required

Maps variant IDs to run configuration — keys must match declared variant IDs.

See: Pipeline.TriggerRunVariantConfig

type · enum · required

Webhook type — determines which events are supported.

Allowed values: webhook:gitlab

event · enum · required

Webhook event type to listen for.

Allowed values: push | merge_request | tag_push

Pipeline.SchedulePipelineTrigger

Pipeline trigger that starts runs on a cron schedule.

id · string · required

Unique identifier for this trigger

enabled · boolean · default: "true"

Whether this trigger is active. Disabled triggers are not registered.

type · enum · required

Trigger type for cron schedule triggers.

Allowed values: schedule

cron · string · required

Cron expression defining when the pipeline runs (UTC unless timezone is set).

timezone · string

IANA timezone for evaluating the cron expression. Defaults to UTC.

concurrency · Pipeline.ConcurrencyConfig

Concurrency configuration for runs started by this trigger.

See: Pipeline.ConcurrencyConfig

run · map<string,Pipeline.TriggerRunVariantConfig> · required

Maps variant IDs to run configuration — keys must match declared variant IDs.

See: Pipeline.TriggerRunVariantConfig

Pipeline.ConcurrencyConfig

Concurrency configuration for controlling parallel execution

key · string

Unique identifier for the concurrency scope Triggers, steps, and blocks with the same key share a concurrency limit By default, the same key in different pip…

(minLen:1)

scope · enum · default: "pipeline"

Where the concurrency key is shared Organization-scoped concurrency requires an explicit key

Allowed values: pipeline | organization

value · integer · default: "0"

Maximum concurrent executions allowed (0 means unlimited, 1 means sequential)

(format:int32,min:0)

behavior · enum · default: "queue"

Behavior when the concurrency limit is reached

Allowed values: queue | cancel-in-progress | skip

queue_size · integer

Maximum queue size when behavior is “queue” Only applies when behavior is “queue” Unset means unlimited queue depth 0 disables queueing when behavior is “queue”

(format:int32,min:0)

queue_overflow_discard · enum · default: "oldest"

Which items to discard when queue overflows Only applies when behavior is “queue” and queue_size > 0

Allowed values: oldest | newest

Pipeline.TriggerFilter

Trigger filter configuration

branch · string | null

Only trigger when this branch is pushed

(templateable)

tag · string | null

Only trigger when a tag matching this pattern is pushed

(templateable)

action · string | string[]

Only trigger for specific webhook actions.

(templateable)

paths · string[] | null

Only trigger when files in these paths are changed

(templateable)

payload · Pipeline.PayloadCondition[]

Filter by webhook payload fields using dot-notation paths.

See: Pipeline.PayloadCondition

Pipeline.TriggerRepo

Git repository identifier used by webhook triggers.

Type: string

Pipeline.TriggerRunVariantConfig

Per-variant run configuration for a trigger.

description · string | null

Description for the pipeline run created by this trigger variant

(templateable)

input · map<string,any | null>

Input overrides for this variant run

(templateable)

Pipeline.GithubWebhookEvent

GitHub webhook events that can trigger a pipeline

Allowed values:

• push
• pull_request
• pull_request_review
• pull_request_review_comment
• pull_request_review_thread
• release
• deployment

Pipeline.GitlabWebhookEvent

GitLab webhook events that can trigger a pipeline

Allowed values:

• push
• merge_request
• tag_push

Pipeline.ConcurrencyBehavior

Behavior when the concurrency limit is reached

Allowed values:

• queue
• cancel-in-progress
• skip

Pipeline.ConcurrencyScope

Scope used to share a concurrency limit

Allowed values:

• pipeline
• organization

Pipeline.QueueOverflowDiscard

Queue overflow discard strategy

Allowed values:

• oldest
• newest

Pipeline.PayloadCondition

Condition to check against a webhook payload field.

path · string · required

Dot-notation path to the payload field

equals · string | null

Exact string match

(templateable)

contains · string | null

Substring match

(templateable)

matches · string | null

Glob pattern match

(templateable)

one_of · string[] | null

Value must be one of these strings

(templateable)

not · Pipeline.PayloadConditionMatcher

Negated payload field matcher. The condition fails when this matcher is true.

See: Pipeline.PayloadConditionMatcher

Pipeline.PayloadConditionMatcher

Payload field matcher used by positive conditions and negated conditions.

equals · string | null

Exact string match

(templateable)

contains · string | null

Substring match

(templateable)

matches · string | null

Glob pattern match

(templateable)

one_of · string[] | null

Value must be one of these strings

(templateable)