Skip to Content

Types

Types shared by the IaC file kinds.

Types used by the file kinds, in name order.

AcmeChallengeEntry

An ACME challenge delegation, read-only: <name> CNAME <cname_target>.

cname_target

Type: string, required.

The platform name the CNAME points at.

name

Type: string, required.

The record name (_acme-challenge.<host>).

AppSpec

An application deployed within a project.

Optional fields follow one rule: leaving a key out of the file leaves the stored value alone.

auto_update

Type: boolean, optional.

Watch a public image for updates.

autoscaling

Type: AutoscalingSpec, optional.

Autoscaling configuration.

backup

Type: BackupSpec, optional.

The template (database) backup settings.

backup_policies

Type: list of BackupPolicySpec, optional.

A per-app backup policy.

build_size

Type: string, optional.

The build size tier slug.

connections

Type: list of ConnectionSpec, optional.

Connections from this app to other apps of the project.

cron_jobs

Type: list of CronJobSpec, optional.

A cron job of the app.

databases

Type: map of DatabaseSpec, optional.

Databases of a Postgres or ClickHouse app, with their groups and lease roles.

delete_data

Type: DeleteDataSpec, optional.

What a removal deletes along with the item; never exported.

deploy

Type: DeploySpec, optional.

The rollout settings.

domains

Type: list of DomainSpec, optional.

Domain routing rules.

egress

Type: EgressSpec, optional.

The app's own outbound mode and allowlist; no mode follows the project. Leaving the key out leaves the stored settings alone.

env

Type: map of EnvValue, optional.

Environment variables: plain values, refs to resource outputs ({from: bucket/uploads, output: endpoint}) or {external: true} keys whose value is set in A-Line.

gpu_count

Type: integer, optional, format uint32.

The gpu_count key.

health_path

Type: string, optional.

Health check path.

health_port

Type: integer, optional, format uint16.

The port health checks probe, if not the primary port.

http

Type: HttpSpec, optional.

HTTP settings; a partial mapping merges over the current settings.

iac_path

Type: string, optional.

Override path to a-line.yaml within the source repo.

iac_repo

Type: string, optional.

Repository reference for app-scoped IaC (e.g. "github.com/org/repo").

instances

Type: integer, optional, format uint32.

Instance count of a template that sizes by instances (postgres, valkey, clickhouse, ...), within the template's bounds; counted against the project quota. A stopped app keeps it for its next start.

isolation

Type: string, optional.

Runtime isolation: "standard" (default) or "sandboxed" (Kata where a pool offers it, else gVisor).

lease_files

Type: list of LeaseFile, optional.

Leased credentials mounted as files.

name

Type: string, required.

Application name (used as k8s resource name).

namespace_isolation

Type: string, optional.

Namespace isolation: "shared" (default, the project's namespace) or "dedicated" (a namespace of its own, whose Pod Security level follows this app alone). A dedicated app supports a subset of features: no template, domains, HTTP routes, workload namespace, connections, backups, borrowed volumes or ingress.from_apps.

pod

Type: PodSettings, optional.

Pod-spec overrides (resources, probes, sidecars, tolerations, ...). Leaving the key out leaves the stored value alone; only a file that sets pod can change it.

pool

Type: string, optional.

The node pool the app is pinned to; pool: null unpins it.

port

Type: integer, optional, format uint16.

Primary container port.

ports

Type: list of PortEntry, optional.

Every port the app listens on; the first is the primary port.

registry_credential

Type: string, optional.

A registry credential by name (granted to the link).

replica_mode

Type: string, optional.

The existing replica_mode values.

replicas

Type: integer, optional, format uint32.

Number of replicas (static).

require_kata

Type: boolean, optional.

Require Kata (no gVisor fallback); implies "sandboxed".

roles

Type: map of ValkeyRoleSpec, optional.

Lease roles of a Valkey app.

secrets

Type: list of string, optional.

Names of the environment's secret groups linked to the app; [] unlinks them all.

source

Type: SourceSpec, optional.

Where the container comes from: an image, a git build or a template. Leaving it out leaves an existing app's source alone; creating an app needs it.

storage_bindings

Type: list of StorageBindingSpec, optional.

A bucket bound to the app (granted to the link).

triggers

Type: TriggersSpec, optional.

What deploys the app.

volume_mounts

Type: list of VolumeMountSpec, optional.

The volume_mounts key: volumes of other apps of the project, mounted read-only.

volumes

Type: list of VolumeSpec, optional.

A persistent volume of the app.

workload_namespace

Type: WorkloadNamespaceSpec, optional.

The workload namespace's egress policy and quotas.

AutoExpandSpec

Volume auto-expansion.

increment_gb

Type: integer, optional, format uint32.

GiB added per grow (default 5).

max_size_gb

Type: integer, optional, format uint32.

Largest size in GiB (default unbounded).

threshold_percent

Type: integer, optional, format uint32.

Usage that triggers a grow (default 80).

AutoscalingSpec

Autoscaling configuration.

cooldown_seconds

Type: integer, optional, format uint32.

The cooldown_seconds key.

max

Type: integer, required, format uint32.

Maximum replicas.

min

Type: integer, required, format uint32.

Minimum replicas.

scale_to_zero

Type: boolean, optional.

Requires min: 0.

triggers

Type: list of ScalingTrigger, optional.

Scaling triggers.

BackupPolicySpec

A per-app backup policy.

backup_type

Type: string, optional.

The backup_type key.

compression

Type: string, optional.

The compression key.

enabled

Type: boolean, optional.

The enabled key.

name

Type: string, required.

The name key.

retention_count

Type: integer, optional, format uint32.

The retention_count key.

retention_days

Type: integer, optional, format uint32.

The retention_days key.

schedule

Type: string, optional.

The schedule key.

source

Type: BackupSource, required.

What a backup policy backs up: database or {volume: <name>}.

strategy

Type: string, optional.

A backup strategy by name (granted to the link).

targets

Type: list of BackupTargetSpec, optional.

One backup target bucket (granted to the link).

BackupSource

What a backup policy backs up: database or {volume: <name>}.

Type: string or object.

  • string: A named source (database).
  • object: A volume of the app, by name.

BackupSpec

Template backup settings.

compression

Type: string, optional.

The compression key.

enabled

Type: boolean, optional.

The enabled key.

retention_days

Type: integer, optional, format uint32.

The retention_days key.

schedule

Type: string, optional.

The schedule key.

BackupTargetSpec

One backup target bucket (granted to the link).

bucket

Type: string, required.

The bucket key.

primary

Type: boolean, optional.

The primary key.

BreakGlass

A static emergency login of a role.

login

Type: string, required.

The login's name (cluster-wide, like a group).

password_secret

Type: string, required.

The environment secret holding its password; until it has a value the login is left alone.

BucketSpec

A managed bucket.

default_backup

Type: boolean, optional.

Make this the tenant's default backup bucket (infra link only).

delete

Type: boolean, optional.

Tombstone: delete the bucket (held until confirmed).

domains

Type: list of string, optional.

Custom domains of the bucket; a present list is authoritative.

name

Type: string, required.

The bucket's name (the file stem in the infra link).

public_paths

Type: list of string, optional.

Folders and objects readable without credentials; a present list is authoritative.

quota_gb

Type: integer, optional, format uint64.

Quota in whole GB (1 GB = 1e9 bytes); absent leaves it as it is.

BuildSpec

Git build configuration for source-based apps.

branch

Type: string, optional.

Branch to build from.

context

Type: string, optional.

Build context path.

dockerfile

Type: string, optional.

Path to Dockerfile.

preset

Type: string, optional.

Framework preset (e.g. "nextjs", "remix").

repo

Type: string, optional, default "".

The GitHub repository, owner/name, reachable through one of the tenant's GitHub App installations.

Capabilities

Capabilities to add (baseline set only, and only with ALL dropped) and drop.

add

Type: list of string, optional.

Capabilities to add.

drop

Type: list of string, optional.

Capabilities to drop (ALL for all).

ChQuota

A quota over interval (design 4.2).

errors

Type: integer, optional, format uint64.

Failed queries per interval.

execution_time

Type: integer, optional, format uint64.

Seconds of query time per interval.

interval

Type: string, required.

The window the limits count over (1h, 1d).

queries

Type: integer, optional, format uint64.

Queries per interval.

read_rows

Type: integer, optional, format uint64.

Rows read per interval.

result_rows

Type: integer, optional, format uint64.

Result rows per interval.

ChSettings

The settings allow-list (design 4.2), as a settings profile.

max_execution_time

Type: integer, optional, format uint64.

Seconds one query may run.

max_memory_usage

Type: integer, optional, format uint64.

Bytes one query may use.

max_result_rows

Type: integer, optional, format uint64.

Rows one result may hold.

max_threads

Type: integer, optional, format uint64.

Threads one query may use (1-256).

readonly

Type: integer, optional, format uint64.

0 read-write, 1 read-only, 2 read-only but settings may change.

ClusterNetworkSpec

The cluster's address ranges (mirrors the API's ClusterNetworkSpec). Omitted ranges take the defaults at create and are not compared after.

node_cidr

Type: string, optional.

Node network, Hetzner only: 10.X.0.0/16 (default allocated).

pod_cidr

Type: string, optional.

Pod network, a private IPv4 CIDR (default 10.244.0.0/16).

service_cidr

Type: string, optional.

Service network, a private IPv4 CIDR (default 10.96.0.0/12).

ClusterSpec

Cluster infrastructure definition.

labels

Type: map of string, optional.

Cluster-level labels.

load_balancers

Type: list of LoadBalancerSpec, optional.

Load balancer definitions.

name

Type: string, required.

Cluster name (must be unique within tenant).

pools

Type: list of PoolSpec, optional, default [].

Node pool definitions.

provider

Type: string, required.

Cloud provider slug (e.g. "hetzner", "ovh", "libvirt").

region

Type: string, required.

Region slug (e.g. "fsn1", "nbg1").

ConnectionPort

One allowed port of a connection.

port

Type: integer, required, format uint16.

The port key.

protocol

Type: string, optional.

The protocol key.

ConnectionSpec

A connection to another app of the same project.

ports

Type: list of ConnectionPort, optional.

One allowed port of a connection.

to

Type: string, required.

The target app's name (same project only).

ContainerSecurity

The container security-context subset users may set.

allow_privilege_escalation

Type: boolean, optional.

Only false is accepted.

capabilities

Type: Capabilities, optional.

Capabilities to add and drop.

read_only_root_filesystem

Type: boolean, optional.

Mount the image filesystem read-only.

run_as_group

Type: integer, optional, format int64.

GID the process runs as.

run_as_non_root

Type: boolean, optional.

Refuse to start as root.

run_as_user

Type: integer, optional, format int64.

UID the process runs as.

seccomp_profile

Type: SeccompProfile, optional.

Seccomp profile.

ContentNegotiationSpec

The http.content_negotiation mapping (omitted keys take their defaults).

enabled

Type: boolean, optional.

Serve twins (default false).

markdown_tokens

Type: boolean, optional.

Send x-markdown-tokens, a token estimate made at deploy, with Markdown twins (default true).

types

Type: list of NegotiationType, optional.

The twin types served: markdown, json, yaml, text (default all of them).

Coop

Cross-Origin-Opener-Policy.

Type: "off" or "same_origin_allow_popups" or "same_origin".

  • "off": No COOP header.
  • "same_origin_allow_popups": same-origin-allow-popups: keeps OAuth and payment popups working.
  • "same_origin": same-origin: full isolation from cross-origin windows.

CountOrPercent

A count or a percentage (0, "25%").

Type: integer or string.

  • integer: An absolute count.
  • string: A percentage such as 25%.

CronJobSpec

A cron job of the app.

command

Type: list of string, required.

The command and its arguments.

concurrency_policy

Type: string, optional.

The concurrency_policy key.

cpu_limit

Type: string, optional.

The cpu_limit key.

failed_jobs_history

Type: integer, optional, format uint32.

The failed_jobs_history key.

image_override

Type: string, optional.

The image_override key.

memory_limit

Type: string, optional.

The memory_limit key.

name

Type: string, required.

The name key.

schedule

Type: string, required.

The schedule key.

successful_jobs_history

Type: integer, optional, format uint32.

The successful_jobs_history key.

suspended

Type: boolean, optional.

The suspended key.

timezone

Type: string, optional.

The timezone key.

CspMode

Whether the CSP is sent, and under which header.

Type: "off" or "report_only" or "enforce".

  • "off": No CSP header.
  • "report_only": Content-Security-Policy-Report-Only: violations are reported, nothing is blocked.
  • "enforce": Content-Security-Policy: violations are blocked.

CspPreset

Which CSP policy is sent.

Type: "basic" or "strict" or "custom".

  • "basic": CSP_BASIC.
  • "strict": CSP_STRICT.
  • "custom": The app's own csp_policy.

CsrfMode

Whether cross-site browser writes are refused.

Type: "off" or "report_only" or "enforce".

  • "off": No check: every request reaches the app.
  • "report_only": Requests that would be refused reach the app marked X-Aline-Csrf: would-block.
  • "enforce": Cross-site browser writes get a plain 403.

DatabaseSpec

One database of an app.

groups

Type: map of GroupSpec, optional.

NOLOGIN group roles, by Postgres name.

roles

Type: map of RoleSpec, optional.

Lease roles, by key.

DeleteDataSpec

What removals delete along with the item. Backups are never deleted with their app: they are kept until deleted explicitly.

buckets

Type: boolean, optional.

The buckets key.

DeploySpec

The rollout settings.

health_check_timeout

Type: integer, optional, format uint32.

The health_check_timeout key.

max_surge

Type: CountOrPercent, optional.

A count or a percentage (0, "25%").

max_unavailable

Type: CountOrPercent, optional.

A count or a percentage (0, "25%").

progress_deadline

Type: integer, optional, format uint32.

The progress_deadline key.

rollback_on_failure

Type: boolean, optional.

The rollback_on_failure key.

strategy

Type: string, optional.

rolling, recreate or safe_replace.

DeriveSpec

derive: on a key: exactly one of the fields. Sources are key names of the same environment (any group), never themselves derived.

egress_cidrs

Type: EgressCidrsSpec, optional.

Comma-separated CIDRs: the public address of every cluster node of this environment (IPv4 /32, IPv6 /64) plus the ranges in plus; recomputed as nodes come and go (an outbound allowlist).

public_key

Type: string, optional.

The public half (SPKI PEM) of this key's P-256 private key.

sha256

Type: string, optional.

Lowercase hex sha256 of this key's value.

template

Type: string, optional.

Text with ${KEY} references replaced by those keys' values.

DnsTarget

What a custom domain's DNS records point at.

Type: "a_records" or "cname".

  • "a_records": A/AAAA records at the load balancer addresses.
  • "cname": A CNAME to the app's platform host.

DomainEntry

A custom domain claim.

acme_challenges

Type: list of AcmeChallengeEntry, optional.

For reference: the ACME challenge CNAMEs the platform handed out under this domain (proxied hosts prove themselves over DNS-01). Written by an export and ignored by an import, which never moves or rotates a target: a re-import with it changes nothing.

name

Type: string, required.

Lowercase domain name.

scope

Type: string, required.

domain or host.

DomainSpec

Domain routing rule for an application.

behind_proxy

Type: boolean, optional.

Served through a CDN or reverse proxy (Cloudflare, Fastly, ...): the DNS check fetches the domain end to end instead of matching load balancer addresses. HTTP(S) custom domains only; absent leaves it as it is.

dns_target

Type: DnsTarget, optional.

What the domain's DNS points at; absent leaves it as it is.

domain

Type: string, optional, default "".

Domain name (e.g. "api.example.com"); empty for a generated entry.

generated

Type: GeneratedKind, optional.

A platform-generated hostname instead of a literal one: site (the app's HTTPS host) or srv (a TCP/UDP host, with protocol and port). The worker renders the name when applying.

path_prefix

Type: string, optional.

Path prefix for path-based routing.

port

Type: integer, optional, format uint16.

Backend port to route to.

protocol

Type: string, optional.

tcp or udp for a generated: srv entry.

strip_prefix

Type: boolean, optional.

Whether to strip the path prefix before forwarding.

tls

Type: TlsMode, optional.

true (default), false, passthrough (the app terminates TLS), or secret on a generated: srv TCP port.

tls_reload

Type: TlsReload, optional.

With tls: secret: restart (default) or live.

wildcard

Type: boolean, optional.

With tls: passthrough: route every name one or more labels below domain (never domain itself).

EgressCidrsSpec

derive: {egress_cidrs: ...}.

plus

Type: string, optional.

A key holding extra comma-separated CIDR ranges to include.

EgressNode

One port on the cluster's nodes the app may connect to.

port

Type: integer, required, format uint16.

The node port (1-65535).

protocol

Type: IngressProtocol, required.

tcp or udp.

EgressRuleSpec

One allowlist entry.

description

Type: string, optional.

Free text.

kind

Type: string, required.

fqdn or cidr.

port

Type: integer, optional, format int64.

1-65535; no port means all ports.

protocol

Type: string, optional.

tcp or udp; needs a port. No protocol means both.

value

Type: string, required.

The domain (optionally *.) or CIDR.

EgressSpec

Outbound settings of a project or an app.

mode

Type: string, optional.

public or isolated. A project without it is public; an app without it follows its project.

rules

Type: list of EgressRuleSpec, optional.

The scope's full allowlist (in isolated mode, the only reachable destinations; in public mode, informational).

EncodingSpec

How a random value is written out.

Type: "hex" or "base64" or "base64url".

  • "hex": Lowercase hex (the default).
  • "base64": Standard base64 with padding.
  • "base64url": URL-safe base64 without padding.

EnvValue

An env value: a literal (strings, numbers and booleans are stored as text), another resource's output (from and output), a database lease (from, lease, output), or external: true for a value set outside the repository.

Type: string or number or boolean or object or object or object.

  • string or number or boolean: A literal value.
  • object: Another resource's output.
  • object: A leased database credential: injected when the pod starts, never inlined.
  • object: Set outside the repository: never written or removed by a sync.

EnvironmentSpec

One environment.

name

Type: string, optional, default "".

The environment's name (the file stem), e.g. "prod".

ExecCheck

A command run inside the container.

command

Type: list of string, required.

Command.

ExtraContainer

An init container or sidecar.

args

Type: list of string, optional.

Arguments.

command

Type: list of string, optional.

Command.

env

Type: map of string, optional.

Plain values. Secrets go in secrets.

image

Type: string, required.

Image reference.

mounts

Type: list of Mount, optional.

Scratch volume mounts.

name

Type: string, required.

Name.

probes

Type: Probes, optional.

Sidecars only: liveness and readiness, each with its own check (and port); there is no platform default to fall back on.

resources

Type: Resources, optional.

Requests and limits.

secrets

Type: list of string, optional.

Secret groups (by name, in the app's environment) whose values this container alone gets as env; the app container never sees them. A value wins over a plain env entry of the same name. A group with no value yet adds nothing.

security

Type: ContainerSecurity, optional.

Security context.

FirewallProtocol

The protocol of a FirewallRule.

Type: "tcp" or "udp" or "both".

  • "tcp": TCP only.
  • "udp": UDP only.
  • "both": TCP and UDP.

FirewallRule

One opening of a pool firewall.

from

Type: list of FirewallSource, required.

Who may connect: anywhere, cluster (the private network, the KubeSpan mesh range, the pod network and every cluster node's addresses) or a CIDR.

ports

Type: list of integer, required.

Destination ports (1-65535).

protocol

Type: FirewallProtocol, optional, default "tcp".

tcp (default), udp or both.

FirewallSource

anywhere, cluster (the cluster's networks and node addresses) or a CIDR such as 192.0.2.0/24.

Type: string.

GenerateSpec

generate: on a key.

bytes

Type: integer, optional, format uint.

Random bytes, 16 to 512 (default 32).

encoding

Type: EncodingSpec, optional.

Encoding of the random bytes (default hex).

keypair

Type: KeypairSpec, optional.

Generate a private key of this type instead of random bytes.

rotate

Type: boolean, optional.

false refuses the rotate endpoint (e.g. an encryption key whose replacement would make stored data unreadable). Default true.

GeneratedKind

Which platform-generated hostname a generated: entry asks for.

Type: "site" or "srv".

  • "site": The app's HTTPS host under the temp URL domain.
  • "srv": A TCP/UDP host under the srv domain.

GroupSpec

A NOLOGIN group role (create-only unless adopt).

adopt

Type: boolean, optional.

Take over an existing unmanaged NOLOGIN role of this name instead of refusing it (group_exists). Login, superuser, CREATEROLE, CREATEDB, REPLICATION and pg_* roles are never adopted; BYPASSRLS only with bypass_rls.

bypass_rls

Type: boolean, optional.

BYPASSRLS.

HeaderSpec

One custom response header.

name

Type: string, required.

The header name.

value

Type: string, required.

The header value.

Hook

Exactly one of exec, http or sleep_seconds.

exec

Type: ExecCheck, optional.

Command check.

http

Type: HttpCheck, optional.

HTTP GET check.

sleep_seconds

Type: integer, optional, format int64.

Sleep this many seconds.

HttpCheck

An HTTP GET; the port defaults to the app's primary port.

path

Type: string, required.

Path.

port

Type: integer, optional, format int32.

Port; defaults to the app's primary port.

HttpSpec

The http mapping.

compression

Type: boolean, optional.

Compress responses.

content_negotiation

Type: ContentNegotiationSpec, optional.

Static sites only: answer extensionless pages with their Markdown, JSON, YAML or text twin (/about -> about.md) when the request's Accept prefers it over HTML.

coop

Type: Coop, optional.

Cross-Origin-Opener-Policy: off, same_origin_allow_popups or same_origin.

csp_mode

Type: CspMode, optional.

Content-Security-Policy: off, report_only or enforce.

csp_policy

Type: string, optional.

The custom CSP (preset custom); empty clears it.

csp_preset

Type: CspPreset, optional.

Which CSP: basic, strict or custom (csp_policy).

csp_report_uri

Type: string, optional.

HTTPS URL appended to the CSP as report-uri; empty clears it.

csrf_exempt_paths

Type: list of string, optional.

Path prefixes (/saml/acs) never checked (replaces the stored list; at most 20).

csrf_mode

Type: CsrfMode, optional.

Cross-site request protection: off, report_only or enforce.

csrf_trusted_origins

Type: list of string, optional.

Exact origins (https://www.example.com) whose browser writes pass (replaces the stored list; at most 20, no wildcards).

custom_headers

Type: list of HeaderSpec, optional.

Extra response headers (replaces the stored list).

header_frame_options

Type: boolean, optional.

X-Frame-Options: SAMEORIGIN.

header_nosniff

Type: boolean, optional.

X-Content-Type-Options: nosniff.

header_referrer_policy

Type: boolean, optional.

Referrer-Policy.

hsts

Type: boolean, optional.

Send Strict-Transport-Security.

hsts_include_subdomains

Type: boolean, optional.

HSTS includeSubDomains.

hsts_max_age

Type: integer, optional, format int64.

HSTS max-age, in seconds.

https_redirect

Type: boolean, optional.

Redirect plain HTTP to HTTPS.

max_body_bytes

Type: integer, optional, format int64.

Largest accepted request body, in bytes; null resets it to unlimited (the default).

permissions_policy

Type: PermissionsPolicyMode, optional.

Permissions-Policy: off, basic, strict or custom.

permissions_policy_custom

Type: string, optional.

The custom Permissions-Policy (mode custom); empty clears it.

www_redirect

Type: WwwRedirect, optional.

off, to_www or to_apex.

InfraClusterSpec

One cluster of an infra link.

auto_update

Type: string, optional.

off, patch or patch_minor.

environment

Type: string, optional.

The environment the cluster serves.

load_balancers

Type: list of InfraLoadBalancerSpec, optional.

A load balancer of the cluster.

maintenance_window

Type: MaintenanceWindowSpec, optional.

The cluster's maintenance window.

network

Type: ClusterNetworkSpec, optional.

The network key: the cluster's address ranges, fixed at create.

pools

Type: list of InfraPoolSpec, optional.

A node pool of the cluster.

provider

Type: string, optional.

The provider key.

region

Type: string, optional.

The region key.

InfraLoadBalancerSpec

A load balancer of the cluster.

name

Type: string, optional.

The name key: a named spec matches the LB of that name, so a type change resizes it in place; unnamed specs match by type and count.

type

Type: string, required.

The type key.

InfraPoolSpec

A node pool of the cluster.

autoscaling

Type: PoolAutoscalingSpec, optional.

Pool autoscaling. Omitted optional fields keep their stored value.

block_volume_gb

Type: integer, optional, format uint32.

The block_volume_gb key.

count

Type: integer, optional, format uint32.

The count key.

extensions

Type: list of string, optional.

The extensions key.

firewall

Type: PoolFirewall, optional.

The firewall key: a host ingress firewall (default block plus the listed rules and the platform-required ports). Only on reserved non-control-plane pools. Omitted keeps the stored firewall.

labels

Type: map of string, optional.

The labels key.

lb_target

Type: boolean, optional.

The lb_target key: the pool's nodes take traffic from the cluster load balancer. Defaults to off for reserved and build pools, on for the rest; an existing pool keeps its value when the key is absent.

max_hourly_price

Type: MoneyAmount, optional.

Highest hourly price accepted per node.

max_monthly_price

Type: MoneyAmount, optional.

Highest monthly price (hourly x 730) accepted per node.

max_setup_fee

Type: MoneyAmount, optional.

Highest setup fee accepted per node (credits; a number or decimal string). Omitted: the quote when the pool is created.

name

Type: string, required.

The name key.

node_type

Type: string, optional.

The node_type key.

options

Type: map of string, optional.

The options key: the machine family's option selections (e.g. ram: 64gb); only for a node_type that is a machine family.

provider

Type: string, optional.

The provider key: a pool at another provider than its cluster (only an OVH VPS pool on a Hetzner cluster, running workers or storage on local_path), set together with region and fixed after create. Omitted: the cluster's.

public_dns

Type: boolean, optional.

The public_dns key: TCP and UDP 53 open to the internet on this pool's nodes. Only on reserved pools.

public_ipv4

Type: boolean, optional.

The public_ipv4 key.

region

Type: string, optional.

The region key, set together with provider.

reserved

Type: boolean, optional.

The reserved key: only pinned apps run on the pool.

role

Type: string, optional.

The role key.

static_addresses

Type: list of StaticAddressSpec, optional.

The static_addresses key (Hetzner): a named Primary IP and an optional private IPv4 per node.

storage

Type: PoolStorageSpec, optional.

The pool's storage strategy.

unprivileged_port_start

Type: integer, optional, format uint16.

The unprivileged_port_start key: the nodes' net.ipv4.ip_unprivileged_port_start (1-1024), so a non-root host-network app may bind a lower port. Only on reserved pools. Omitted keeps the stored value (clear it in the console).

upgrade_group

Type: string, optional.

The upgrade_group key: pools sharing a group upgrade one node at a time across the group. Omitted keeps the stored group.

upgrade_strategy

Type: string, optional.

The upgrade_strategy key.

IngressProtocol

The transport of an ingress rule.

Type: "tcp" or "udp".

  • "tcp": TCP (the default).
  • "udp": UDP.

IngressRule

One allowed inbound port and its sources.

egress_port

Type: integer, optional, format uint16.

The app may also connect to this rule's CIDRs on this port, same protocol (e.g. a DNS primary sending NOTIFY to its secondaries on 53): added to the app's egress allowlist at each deploy. Needs CIDRs or from_nodes.

from_apps

Type: list of string, optional.

Apps of the same project whose pods may connect.

from_cidrs

Type: list of string, optional.

Private CIDRs (RFC 1918 / ULA) that may connect, e.g. other servers on the private network.

from_cidrs_env

Type: string, optional.

An env key (plain env or a secret-group key) whose value lists more private CIDRs or bare IPs, comma or space separated. Resolved at each deploy, so addresses that live in an inventory (a secret group) stay out of the app file; a missing or non-private value fails the deploy.

from_nodes

Type: boolean, optional.

The cluster's nodes may connect (Cilium entities host and remote-node), e.g. hostNetwork peers, which no CIDR source matches. With egress_port, the app may also connect to the nodes on it.

port

Type: integer, required, format uint16.

The container port.

protocol

Type: IngressProtocol, optional, default "tcp".

tcp (default) or udp.

KeyRingSpec

A key ring and its keys.

destroy

Type: boolean, optional.

Delete the ring. Needs "Allow destroy" switched on for the ring or the organization in the console, and the ring must hold no keys (destroy them first with destroy: true on each). Removing the file never deletes the ring.

keys

Type: map of KeySpec, optional.

The ring's keys by name. A key left out of this map stays as it is (it is reported as unmanaged), it is never destroyed.

name

Type: string, required.

The ring's name (the file stem): 1-63 letters, digits, '-' or '_', starting with a letter or digit.

KeySpec

One key of a ring. A field left out is left as it is.

destroy

Type: boolean, optional.

Schedule the whole key for destruction after destroy_delay. Needs "Allow destroy" switched on for the key, its ring or the organization in the console.

destroy_delay

Type: string, optional.

How long until a destroy: true key is destroyed: 24h to 30d, default 7d. It can be cancelled in the console until then.

labels

Type: map of string, optional.

Labels: at most 32 pairs, keys up to 63 characters, values up to 255. A present map replaces the stored labels.

purpose

Type: string, optional.

What the key is for: encrypt_decrypt (the default and only value).

rotation_period

Type: string, optional.

Automatic rotation period such as 90d, at least 1d (units d, h, m, s). Leaving it out keeps the current schedule.

KeypairSpec

A keypair type.

Type: "p256".

  • "p256": A P-256 (ECDSA) private key, PKCS#8 PEM; derive: {public_key: ...} gives its SPKI PEM public half.

LeaseFile

One lease_files: entry: the role's credentials as files under path.

from

Type: string, required.

The database app, as app/<name> (or app/<project>/<name>).

lease

Type: string, required.

<database>/<role>, or <role> for Valkey.

path

Type: string, required.

The directory the credential files are mounted at.

Lifecycle

Lifecycle hooks of the app container.

post_start

Type: Hook, optional.

Runs right after the container starts.

pre_stop

Type: Hook, optional.

Runs before the container is stopped.

LoadBalancerSpec

A load balancer attached to a cluster.

type

Type: string, required.

LB type slug (e.g. "lb11", "haproxy-small").

MaintenanceWindowSpec

The cluster's maintenance window.

days

Type: list of string, required.

Weekdays (mon .. sun).

duration_minutes

Type: integer, required, format uint32.

60 to 480.

start

Type: string, required.

Local start, HH:MM.

timezone

Type: string, required.

IANA time zone the start is in.

Medium

Where an emptyDir lives.

Type: "disk" or "memory".

  • "disk": Node disk.
  • "memory": RAM (tmpfs), counted as memory.

MoneyAmount

A credit amount: a number or a decimal string.

Type: number or string.

  • number: A number.
  • string: A decimal string.

Mount

A mount of a ScratchVolume.

path

Type: string, required.

Path.

read_only

Type: boolean, optional.

Mount read-only.

volume

Type: string, required.

Name of the scratch volume.

NegotiationType

A representation a page can be negotiated into.

Type: "markdown" or "json" or "yaml" or "text".

  • "markdown": text/markdown, from <page>.md.
  • "json": application/json, from <page>.json.
  • "yaml": application/yaml (also application/x-yaml, text/yaml), from <page>.yaml then <page>.yml.
  • "text": text/plain, from <page>.txt.

NetworkPolicySpec

A connection from this project to another project of the cluster.

direction

Type: string, optional, default "both".

Direction: both, or ingress (only this project reaches the target).

ports

Type: list of PortSpec, optional.

Allowed ports.

target

Type: string, required.

Target project name.

OnExpiry

What happens when a lease reaches its renew cap.

Type: "renew" or "reissue".

  • "renew": Extend the lease until max_ttl, then issue a new login.
  • "reissue": Issue a new login before every expiry.

PermissionRule

One permission rule of a credential definition.

Unset scope fields widen the rule: no schema means every schema of the database, no table every table of the schema, no columns every column.

columns

Type: list of string, optional.

Columns the privileges are limited to (read, insert and update only).

database

Type: string, optional.

Database (Postgres, ClickHouse). Defaults to the application's database.

key_pattern

Type: string, optional.

Key pattern (Valkey only), e.g. cache:*.

privileges

Type: list of Privilege, required.

Granted privileges.

row_filter

Type: string, optional.

Row filter expression (see row_filter for what is allowed).

schema

Type: string, optional.

Schema (Postgres only).

table

Type: string, optional.

Table.

PermissionsPolicyMode

Which Permissions-Policy is sent.

Type: "off" or "basic" or "strict" or "custom".

  • "off": No Permissions-Policy header.
  • "basic": PERMISSIONS_BASIC.
  • "strict": PERMISSIONS_STRICT.
  • "custom": The app's own permissions_policy_custom.

PodSettings

An app's pod settings. {} (all defaults) changes nothing.

annotations

Type: map of string, optional.

Extra pod annotations; platform annotations win.

args

Type: list of string, optional.

Replaces the image arguments.

command

Type: list of string, optional.

Replaces the image entrypoint.

egress_nodes

Type: list of EgressNode, optional.

Ports on the cluster's nodes the app may connect to (Cilium entities host and remote-node, which no egress CIDR matches), e.g. hostNetwork nameservers.

fs_group

Type: integer, optional, format int64.

Pod fsGroup; wins over the platform default for file secrets.

host_network

Type: boolean, optional.

Use the node's network (hostNetwork, cluster DNS kept). Needs the standard runtime and an app pinned to a reserved pool; the guardrails refuse it anywhere else.

ingress

Type: list of IngressRule, optional.

Who may reach the pods (see ingress); empty = the project baseline.

init_containers

Type: list of ExtraContainer, optional.

Containers that run to completion before the app starts.

labels

Type: map of string, optional.

Extra pod labels; platform labels win.

lifecycle

Type: Lifecycle, optional.

Container lifecycle hooks.

mounts

Type: list of Mount, optional.

Mounts of volumes into the app container.

probes

Type: Probes, optional.

Probe overrides, layered on the platform defaults.

resources

Type: Resources, optional.

Requests and limits of the app container.

security

Type: ContainerSecurity, optional.

Security context of the app container.

share_process_namespace

Type: boolean, optional.

Share one process namespace between the pod's containers.

sidecars

Type: list of ExtraContainer, optional.

Native sidecars (init containers with restartPolicy: Always).

sysctls

Type: list of Sysctl, optional.

Safe namespaced sysctls only (ignored under gVisor).

termination_grace_period_seconds

Type: integer, optional, format int64.

Seconds between SIGTERM and SIGKILL.

tolerations

Type: list of Toleration, optional.

Node-failure tolerations only (node.kubernetes.io/not-ready|unreachable).

topology_spread

Type: list of TopologySpread, optional.

Spread replicas across nodes or zones.

volumes

Type: list of ScratchVolume, optional.

Scratch volumes (emptyDir only).

zfs_recordsize

Type: string, optional.

ZFS recordsize of the app's volumes on a ZFS pool (16K to 128K). Only for the templates template_overrides lists, chosen before data is written: it cannot change for data already on the volume.

PoolAutoscalingSpec

Pool autoscaling. Omitted optional fields keep their stored value.

allow_scale_down

Type: boolean, optional.

Whether autoscaling may remove nodes.

enabled

Type: boolean, optional.

Whether autoscaling is on (default true).

max

Type: integer, required, format uint32.

The most nodes autoscaling adds.

min

Type: integer, required, format uint32.

The fewest nodes autoscaling leaves.

scale_down_cpu_percent

Type: integer, optional, format uint32.

Average CPU percent below which a node may be removed.

scale_down_memory_percent

Type: integer, optional, format uint32.

Average memory percent below which a node may be removed.

scale_up_cpu_percent

Type: integer, optional, format uint32.

Average CPU percent above which a node is added.

scale_up_memory_percent

Type: integer, optional, format uint32.

Average memory percent above which a node is added.

PoolFirewall

A pool's host ingress firewall (node_pools.firewall).

ingress

Type: list of FirewallRule, required.

What the nodes admit beside the platform-required ports; everything else is dropped.

PoolSpec

A node pool within a cluster.

count

Type: integer, required, format uint32.

Number of nodes in this pool.

labels

Type: map of string, optional.

Pool-level labels propagated to nodes.

name

Type: string, required.

Pool name (unique within cluster).

node_type

Type: string, required.

Node type slug (e.g. "cx22", "cx32").

reserved

Type: boolean, optional.

Reserve the pool's nodes for apps bound to it (worker/storage pools).

role

Type: string, required.

Node role: control_plane, worker, or hybrid.

storage_strategy

Type: string, optional.

Storage strategy: zfs_local, longhorn, local_path, or none.

system_extensions

Type: list of string, optional.

Talos system extensions to install on nodes in this pool.

PoolStorageSpec

The pool's storage strategy.

config

Type: any, optional.

The config key.

strategy

Type: string, required.

The strategy key.

PortCheck

A TCP or gRPC check; the port defaults to the app's primary port.

port

Type: integer, optional, format int32.

Port; defaults to the app's primary port.

PortEntry

One port of an app.

name

Type: string, optional.

The name key.

port

Type: integer, required, format uint16.

The port key.

protocol

Type: IngressProtocol, optional.

The protocol key: tcp (the default) or udp.

PortSpec

A port rule in a network policy.

end_port

Type: integer, optional, format uint16.

End port for range (optional).

port

Type: integer, required, format uint16.

Port number.

protocol

Type: string, optional, default "tcp".

Protocol: tcp or udp.

Privilege

A privilege a rule grants.

Type: "read" or "insert" or "update" or "delete" or "create" or "admin".

  • "read": Read rows (SELECT, Valkey read commands).
  • "insert": Insert rows (INSERT, Valkey write commands).
  • "update": Update rows (UPDATE / ALTER UPDATE, Valkey write commands).
  • "delete": Delete rows (DELETE / ALTER DELETE, Valkey DEL/UNLINK).
  • "create": Create objects (schemas/tables) in the scope.
  • "admin": Every privilege the engine can grant on the scope.

ProbeOverride

One probe: disabled, or at most one check plus timings. Unset parts keep the platform default (a startup probe has none, so it needs a check).

disabled

Type: boolean, optional.

Turn the probe off.

exec

Type: ExecCheck, optional.

Command check.

failure_threshold

Type: integer, optional, format int32.

Failures before the probe fails.

grpc

Type: PortCheck, optional.

gRPC health check.

http

Type: HttpCheck, optional.

HTTP GET check.

initial_delay_seconds

Type: integer, optional, format int32.

Seconds before the first check.

period_seconds

Type: integer, optional, format int32.

Seconds between checks.

success_threshold

Type: integer, optional, format int32.

Readiness only.

tcp

Type: PortCheck, optional.

TCP connect check.

timeout_seconds

Type: integer, optional, format int32.

Seconds before a check times out.

Probes

Probe overrides of the app container.

liveness

Type: ProbeOverride, optional.

Restarts the container when failing.

readiness

Type: ProbeOverride, optional.

Takes the pod out of routing when failing.

startup

Type: ProbeOverride, optional.

Holds the other probes until it passes.

ProjectEntry

A project of the bundle.

apps

Type: list of AppSpec, optional, default [].

Applications in this project.

buckets

Type: list of BucketSpec, optional.

Managed buckets this project's link manages. Leaving the key out leaves every bucket as it is; a present list is authoritative for the buckets the link owns (an entry removed from it stops being managed).

cluster

Type: string, optional.

The cluster the project runs on (a clusters/<name>.yaml stem or a cluster the tenant already has). Required on create when clusters are known; fixed while the project has apps.

display_name

Type: string, optional.

Human-readable display name.

egress

Type: EgressSpec, optional.

Outbound mode and allowlist. Leaving the key out leaves the stored settings alone; a present mapping replaces them (no mode means public).

environment

Type: string, optional.

The environment it lives in (by name; ignored on an environment import).

isolated

Type: boolean, optional.

Whether the project's apps are isolated from each other. Leaving the key out leaves the project as it is; a value switches it. Exported only when true.

name

Type: string, required.

Project name (becomes the k8s namespace).

network_policies

Type: list of NetworkPolicySpec, optional.

Network policies: connections from this project to other projects of the cluster. Leaving the key out leaves the stored connections alone; [] removes them all.

quotas

Type: QuotaSettings, optional.

The project's quota limits. Leaving the key out leaves the stored limits alone; {} removes them all.

storages

Type: list of StorageSpec, optional.

External storage connections this project's link manages (same rules as buckets).

ProjectSpec

A project (Kubernetes namespace) with its applications.

apps

Type: list of AppSpec, optional, default [].

Applications in this project.

buckets

Type: list of BucketSpec, optional.

Managed buckets this project's link manages. Leaving the key out leaves every bucket as it is; a present list is authoritative for the buckets the link owns (an entry removed from it stops being managed).

cluster

Type: string, optional.

The cluster the project runs on (a clusters/<name>.yaml stem or a cluster the tenant already has). Required on create when clusters are known; fixed while the project has apps.

display_name

Type: string, optional.

Human-readable display name.

egress

Type: EgressSpec, optional.

Outbound mode and allowlist. Leaving the key out leaves the stored settings alone; a present mapping replaces them (no mode means public).

isolated

Type: boolean, optional.

Whether the project's apps are isolated from each other. Leaving the key out leaves the project as it is; a value switches it. Exported only when true.

name

Type: string, required.

Project name (becomes the k8s namespace).

network_policies

Type: list of NetworkPolicySpec, optional.

Network policies: connections from this project to other projects of the cluster. Leaving the key out leaves the stored connections alone; [] removes them all.

quotas

Type: QuotaSettings, optional.

The project's quota limits. Leaving the key out leaves the stored limits alone; {} removes them all.

storages

Type: list of StorageSpec, optional.

External storage connections this project's link manages (same rules as buckets).

QuotaSettings

A project's quota limits; leaving it out is unlimited.

cpu

Type: string, optional.

Maximum total cpu requests, e.g. 4 or 2500m.

memory

Type: string, optional.

Maximum total memory requests, e.g. 8Gi.

pods

Type: integer, optional, format int32.

Maximum pods.

pvcs

Type: integer, optional, format int32.

Maximum persistent volume claims.

storage

Type: string, optional.

Maximum total claimed storage, e.g. 100Gi.

RecordEntry

One record set.

name

Type: string, required.

Absolute owner name inside the zone.

ttl

Type: integer, required, format uint32.

Time to live in seconds.

type

Type: string, required.

Record type.

values

Type: list of string, required.

Values in presentation form.

ResourceList

Kubernetes quantities, e.g. cpu: "500m", memory: "512Mi".

cpu

Type: string, optional.

CPU, e.g. 500m or 2.

ephemeral_storage

Type: string, optional.

Local scratch disk, e.g. 1Gi.

memory

Type: string, optional.

Memory, e.g. 512Mi.

Resources

Requests and limits.

limits

Type: ResourceList, optional.

Hard caps.

requests

Type: ResourceList, optional.

Guaranteed amounts.

RoleSpec

A lease role of one database.

break_glass

Type: BreakGlass, optional.

A static, blocked emergency login in the group (see break_glass).

bypass_rls

Type: boolean, optional.

BYPASSRLS on the group; implies set_role to it.

connection_limit

Type: integer, optional, format int32.

Connection limit of each login (1-500).

env_prefix

Type: string, optional.

Env key prefix for {{dynamic:}} users.

grants

Type: list of PermissionRule, optional.

Grants of the group; absent leaves them alone, [] revokes all.

inject

Type: string, optional.

Env injection for {{dynamic:}} users: url, individual or both.

max_ttl

Type: string, optional.

Renew cap from issue (default 30d).

member_of

Type: list of string, optional.

Groups of this database or allowed predefined roles.

on_expiry

Type: OnExpiry, optional.

Renew or reissue.

owner

Type: boolean, optional.

The group owns the database and its public schema.

pg_role

Type: string, optional.

Overrides the <db>_<role> group name (adopts an existing role).

quota

Type: ChQuota, optional.

ClickHouse quota of the group.

reassign_owned_from

Type: string, optional.

Owner roles only: an existing unmanaged role whose objects in the database move to this role's group (REASSIGN OWNED), once, before any lease of the database is issued. Superusers, pg_* and platform-managed roles are refused.

retire_reassigned_login

Type: boolean, optional.

With reassign_owned_from: retire that login first, in the same apply (NOLOGIN, no SUPERUSER, CREATEDB, CREATEROLE, REPLICATION or BYPASSRLS, its open sessions ended), so a static owner login such as the CNPG app superuser can be taken over and no longer connects. Owner-class: held for approval.

search_path

Type: list of string, optional.

search_path of each login in the database.

set_role

Type: string, optional.

The session role at login.

settings

Type: ChSettings, optional.

ClickHouse settings profile of the group.

static_login

Type: StaticLogin, optional.

ClickHouse only: a static, usable service login in the group (see static_login).

ttl

Type: string, optional.

Lease lifetime (default 1h).

view_definer

Type: string, optional.

ClickHouse only: a login-less user in the group that the group may name as DEFINER of its views, so a materialized view runs with the definer's rights and an INSERT-only writer never needs SELECT on the view's source (see view_definer).

ScalingTrigger

A scaling trigger (KEDA-based).

type

Type: string, required.

Trigger type (e.g. "http", "cpu", "memory", "cron").

SchemaVersion

Schema version of this file. Older supported versions are upgraded on load; exports write the latest. Schema: https://a-line.cloud/schemas/iac/v1.json

Type: 1 or "1".

ScratchVolume

An emptyDir volume.

medium

Type: Medium, optional, default "disk".

Disk or memory.

name

Type: string, required.

Name.

size_limit

Type: string, optional.

Size cap, e.g. 1Gi.

SeccompProfile

Seccomp profiles users may pick (PSA baseline forbids Unconfined).

Type: "runtime_default".

  • "runtime_default": The container runtime default profile.

SecretGroupSpec

One secret group.

description

Type: string, optional.

What the group is for; absent leaves the stored description.

environment

Type: string, required.

The environment the group belongs to (e.g. "prod").

keys

Type: map of SecretKeySpec, optional, default {}.

KEY -> {mount, env}: {} (or null) injects an env var named after the key, mount makes it a file at that path, mount plus env: true does both.

name

Type: string, optional.

The group's name (the file stem).

optional

Type: boolean, optional.

true: the whole group may stay unfilled (its feature is off until it is). The mgmt platform_secrets role then accepts a vault without it, while a group that is filled stays all-or-none. For the sync it is metadata: unfilled keys stay pending and never reach pods, and the link does not warn about them.

SecretKeySpec

How one key is injected.

derive

Type: DeriveSpec, optional.

The value is computed from other keys of the environment and recomputed when they change.

env

Type: boolean, optional.

With mount: also inject it as an env var (true).

generate

Type: GenerateSpec, optional.

The platform generates the value once, on the first apply ({}: 32 random bytes, hex). A stored value always wins; only the rotate endpoint replaces it.

keep_versions

Type: integer, optional, format int32.

How many replaced versions the secret keeps (1 to 100), each billed like the current value; older ones are destroyed. Left out: the stored setting stays (default 10).

mount

Type: string, optional.

Mount the value as a file at this absolute path.

write_only

Type: boolean, optional.

true: the value can be set, replaced or deleted but never read back (console, API); workloads still get it. One-way: dropping the flag from the file leaves the stored key write-only.

SeedSpec

source.seed: exactly one of sync: true or url.

sync

Type: boolean, optional.

Sync from the network with no seed (takes weeks).

url

Type: string, optional.

A public S3 link to a chain database (https://host/bucket/path); its keys go in the app's env (RCLONE_ACCESS_KEY_ID, ...).

SiteSettings

The user's settings for a site. An update replaces the whole object; unset fields fall back to detection.

build_command

Type: string, optional.

Command building the site.

install_command

Type: string, optional.

Command installing dependencies.

node_image

Type: string, optional.

Image the install and build commands run in, e.g. node:22-alpine (default node:lts-alpine).

output_dir

Type: string, optional.

Directory holding the built site, relative to the repository root.

spa_fallback

Type: boolean, optional.

Serve index.html for unknown paths.

SiteSourceSpec

Where a site is built from (a repo reached through the tenant's own installations).

branch

Type: string, optional.

The branch to build.

repo

Type: string, required.

owner/name or a GitHub repository URL.

SiteSpec

One static site of a linked project.

autoscaling

Type: AutoscalingSpec, optional.

Scale the site's server pods between min and max (at least 1) on cpu, memory or cron triggers, like an app's autoscaling; a site never scales to zero. Not together with replicas.

domains

Type: list of DomainSpec, optional.

Custom domains routed to the site, the same entries as an app's domains without port (the static server's is fixed); path_prefix defaults to /. When set, the list is the site's domains: one added in the console but missing here is removed by the sync. Left out, the site's domains are managed in the console.

http

Type: HttpSpec, optional.

The site's HTTP settings, the same keys as an app's http.

mode

Type: string, optional.

versioned (the default): every deploy is a new immutable version. live: one mutable file tree, revalidated on change.

replicas

Type: integer, optional, format uint32.

A fixed number of server pods, at least 1 (default 1). More than one keeps the site up through a node drain or a pod restart. Not together with autoscaling; setting it turns autoscaling off.

retain_versions

Type: integer, optional, format uint32.

How many versions a versioned site keeps, 1 to 100 (default 20).

settings

Type: SiteSettings, optional.

Build settings (install and build command, output directory, SPA fallback). A present mapping replaces all of them.

source

Type: SiteSourceSpec, optional.

The repository the site is built from. A site is created only from a git source.

SourceSpec

Where an app's container comes from.

git

Type: BuildSpec, optional.

Build from a GitHub repository.

image

Type: string, optional.

A prebuilt container image (e.g. "ghcr.io/org/app:1.2").

pin

Type: string, optional.

release: the image is applied once at creation, then owned by the release deploy (no drift, not locked). Only valid with image.

seed

Type: SeedSpec, optional.

How a subtensor-archive is seeded at create, unattended. Without it the archive waits for setup in the console (the upload has no IaC form). Ignored once the app exists.

template

Type: string, optional.

A managed template slug (e.g. "postgres", "valkey").

version

Type: string, optional.

The template version (e.g. "16"). Only valid with template.

StaticAddressSpec

One static address slot of a pool (node_pools.static_addresses[]).

additional_ip

Type: string, optional.

Label of the OVH Additional IP routed to the node's VPS (ovh pools). Ordered once under this label, parked on replacement, never deleted.

primary_ip

Type: string, optional.

Name of an existing Hetzner Primary IP the node is created with (hetzner pools).

primary_ipv6

Type: string, optional.

Name of a Hetzner Primary IPv6 (a /64) the node is created with beside primary_ip (hetzner pools): a stable IPv6 for the AAAA glue of a nameserver. Created on first use like primary_ip, never deleted. Unset: the server gets whatever IPv6 Hetzner assigns.

private_ip

Type: string, optional, format ipv4.

Fixed private IPv4 on the cluster network (RFC 1918).

StaticLogin

A static service login of a role.

login

Type: string, required.

The login's name (cluster-wide, like a group).

password_secret

Type: string, required.

The environment secret holding its password; until it has a value the login is left alone.

StorageBindingSpec

A bucket bound to the app (granted to the link).

bucket

Type: string, required.

The bucket key.

credential_mode

Type: string, optional.

The credential_mode key.

env_prefix

Type: string, optional.

The env_prefix key.

key_prefix

Type: string, optional.

The key_prefix key.

permission

Type: string, optional.

The permission key.

StorageCredentialsSpec

The secret group keys holding a storage's access key pair. Only key names: the values stay in the group and are read at apply time.

access_key_id

Type: string, required.

The group key whose value is the access key ID.

secret_access_key

Type: string, required.

The group key whose value is the secret access key.

secret_group

Type: string, required.

The environment secret group (secrets/<group>.yaml).

StorageSpec

An external storage connection. Its credentials are entered in the UI, or read from an environment secret group when credentials: is set.

bucket

Type: string, optional.

The provider's bucket.

credentials

Type: StorageCredentialsSpec, optional.

Where the access key pair lives: keys of a secret group of the project's environment (project links only). Set, the console cannot edit the credentials; absent, they are entered in the UI.

delete

Type: boolean, optional.

Tombstone: delete the connection (held until confirmed).

endpoint

Type: string, optional.

The S3 endpoint URL.

force_path_style

Type: boolean, optional.

Path-style addressing.

name

Type: string, required.

The connection's name (the file stem in the infra link).

path_prefix

Type: string, optional.

Key prefix inside the bucket.

provider_hint

Type: string, optional.

The provider, for the console: one of aws, r2, wasabi, minio, backblaze, hetzner or other.

region

Type: string, optional.

The region.

Sysctl

One pod sysctl.

name

Type: string, required.

Name.

value

Type: string, required.

Value.

TenantSection

Resources that belong to the organization, not to one project.

buckets

Type: list of BucketSpec, optional.

Managed buckets.

dns_zones

Type: list of ZoneEntry, optional.

Hosted zones.

domains

Type: list of DomainEntry, optional.

Custom domains.

key_rings

Type: list of KeyRingSpec, optional.

Key rings and their keys: names, rotation periods and labels only. Key material never leaves the key service, and an import never destroys (no destroy here).

storages

Type: list of StorageSpec, optional.

External storage connections (no credentials).

TlsMode

true (default): the platform terminates TLS. false: plain HTTP. passthrough: the app terminates TLS itself; the connection is routed by its SNI on 443. secret (generated srv TCP ports only): the platform's certificate is mounted into the app at /etc/aline/tls and the app terminates TLS itself. catch_all: a passthrough taking every SNI no other route of the cluster matches, except the platform's own hosts; lowest priority, PROXY protocol v2 header first; platform organization only, on its own clusters without custom-domain HTTPS routes.

Type: boolean or "passthrough" or "secret" or "catch_all".

TlsReload

How an app with a tls: secret port picks up a renewed certificate.

Type: "restart" or "live".

  • "restart": The platform restarts the app after a renewal (the default).
  • "live": The app re-reads the mounted files itself.

Toleration

A node-failure toleration (operator: Exists, effect: NoExecute).

key

Type: string, required.

Key.

toleration_seconds

Type: integer, optional, format int64.

Seconds to stay bound after the taint appears.

TopologyKey

What to spread over.

Type: "hostname" or "zone".

  • "hostname": Spread across nodes.
  • "zone": Spread across zones.

TopologySpread

A topology spread constraint over the app's own pods.

key

Type: TopologyKey, required.

Key.

max_skew

Type: integer, required, format int32.

Allowed pod-count difference (1-5).

when_unsatisfiable

Type: WhenUnsatisfiable, required.

What to do when the spread cannot be met.

TriggersSpec

What deploys the app.

github_environment

Type: string, optional.

The github_environment key.

on

Type: string, optional.

push, prerelease, release or manual (legacy tag reads as prerelease).

tag_pattern

Type: string, optional.

Only with a tag trigger (prerelease or release).

ValkeyRoleSpec

One roles.<name> entry of a Valkey app.

channels

Type: list of string, optional.

Pub/sub channel patterns.

commands

Type: list of string, optional.

Allowed categories and data commands.

deny_commands

Type: list of string, optional.

Denied categories and data commands.

enabled

Type: boolean, optional.

false turns every login of the role off (default on).

env_prefix

Type: string, optional.

Env key prefix for {{dynamic:}} users.

inject

Type: string, optional.

Env injection for {{dynamic:}} users: url, individual or both.

keys

Type: list of string, optional.

Read-write key patterns.

max_ttl

Type: string, optional.

Renew cap from issue (default 30d); past it the login is deleted.

on_expiry

Type: OnExpiry, optional.

Renew or reissue.

read_keys

Type: list of string, optional.

Read-only key patterns.

ttl

Type: string, optional.

Lease lifetime (default 1h).

write_keys

Type: list of string, optional.

Write-only key patterns.

VolumeMountSpec

A volume of another app of the project, mounted read-only.

from

Type: string, required.

app/volume: the owner app and its volume.

mount_path

Type: string, required.

Where the volume appears in this app.

read_only

Type: boolean, optional.

Borrowed volumes are read-only; false is refused.

VolumeSpec

A persistent volume of the app.

access_mode

Type: string, optional.

The access_mode key.

auto_expand

Type: AutoExpandSpec, optional.

Volume auto-expansion.

mount_path

Type: string, required.

The mount_path key.

name

Type: string, required.

The name key.

per_replica

Type: boolean, optional.

One volume for each replica (<name>-<app>-N) instead of one shared volume; the app runs as a StatefulSet. Single-node access only, no auto_expand and no backups.

read_only

Type: boolean, optional.

The read_only key.

rebuildable

Type: boolean, optional.

The data can be rebuilt from elsewhere (a DNS secondary's zone copy, a cache): when the node a per-replica copy lives on is gone, the platform drops that copy and the replica starts empty on a live node. Off by default: then the app waits and an operator is told.

replicas

Type: integer, optional, format uint32.

The replicas key.

size

Type: string, required.

e.g. 10Gi.

storage_class

Type: string, optional.

The storage_class key.

WhenUnsatisfiable

What the scheduler does when the spread cannot be met.

Type: "do_not_schedule" or "schedule_anyway".

  • "do_not_schedule": Leave pods pending.
  • "schedule_anyway": Schedule anyway, preferring the spread.

WorkloadNamespaceSpec

The workload namespace policy. Turning it on from a file (enabled: true, or settings on an app whose namespace is off) is held for an environment admin with step-up; enabled: false applies directly.

egress_allow_cidrs

Type: list of string, optional.

The egress_allow_cidrs key.

egress_allow_fqdns

Type: list of string, optional.

The egress_allow_fqdns key.

egress_internet

Type: boolean, optional.

The egress_internet key.

enabled

Type: boolean, optional.

The enabled key: false turns the namespace off; true (or any setting) on an app whose namespace is off asks to turn it on.

isolate_pods

Type: boolean, optional.

The isolate_pods key.

max_pod_seconds

Type: integer, optional, format uint32.

The max_pod_seconds key.

quota_cpu_millis

Type: integer, optional, format uint32.

The quota_cpu_millis key: CPU quota in millicores; omitted = no limit.

quota_memory_mib

Type: integer, optional, format uint32.

The quota_memory_mib key: Memory quota in MiB; omitted = no limit.

quota_pods

Type: integer, optional, format uint32.

The quota_pods key: Most pods at once; omitted = no limit.

runtime

Type: WorkloadRuntime, optional.

The runtime key (kata, or runc in dev environments only).

WorkloadRuntime

The runtime every pod in a workload namespace runs under.

Type: "kata" or "runc".

  • "kata": Kata Containers (a VM per pod): the only runtime outside dev.
  • "runc": Plain runc (no runtime class), for dev clusters without Kata.

WwwRedirect

Redirect between a host and its www. form.

Type: "off" or "to_www" or "to_apex".

  • "off": No redirect.
  • "to_www": example.com redirects to www.example.com.
  • "to_apex": www.example.com redirects to example.com.

ZoneEntry

A hosted DNS zone with its records.

name

Type: string, required.

Lowercase zone name.

records

Type: list of RecordEntry, optional, default [].

The record sets.

On this page