DeploymentPlan
@aurorajs.dev/catalyst-cli / deploy/domain/model / DeploymentPlan
Interface: DeploymentPlan
Section titled “Interface: DeploymentPlan”Defined in: deploy/domain/model.ts:53
Fully resolved plan for deploying a single target in a single environment.
Built by src/deploy/domain/plan-builder.ts from the project’s
aurora.yaml, the active environment, CLI flags, env vars, and file-based
secrets (plan-resolver.ts). Every provider port receives data derived
from one of these plans.
Properties
Section titled “Properties”database?
Section titled “database?”
optionaldatabase?:object
Defined in: deploy/domain/model.ts:55
Database provisioning config. Omitted when the target has no DB.
name:
string
password
Section titled “password”password:
string
type:
DatabaseType
user:
string
dir:
string
Defined in: deploy/domain/model.ts:62
Working directory on the server (e.g. /httpdocs).
dnsRecordType
Section titled “dnsRecordType”dnsRecordType:
DnsRecordType
Defined in: deploy/domain/model.ts:63
dnsValue?
Section titled “dnsValue?”
optionaldnsValue?:string
Defined in: deploy/domain/model.ts:65
DNS target value. Defaults to the server host when omitted.
dnsZone
Section titled “dnsZone”dnsZone:
string
Defined in: deploy/domain/model.ts:67
DNS zone that owns the record (the registrable parent domain).
domain
Section titled “domain”domain:
string
Defined in: deploy/domain/model.ts:69
Fully qualified domain this deployment serves.
dotEnv?
Section titled “dotEnv?”
optionaldotEnv?:string
Defined in: deploy/domain/model.ts:71
Plaintext .env content, if resolved. Sensitive.
dotEnvEnc?
Section titled “dotEnvEnc?”
optionaldotEnvEnc?:string
Defined in: deploy/domain/model.ts:73
Encrypted .env.{env}.enc content produced by SOPS.
envConfiguration?
Section titled “envConfiguration?”
optionalenvConfiguration?:string
Defined in: deploy/domain/model.ts:75
Frontend-only: Angular configuration name. Defaults to env name.
environment
Section titled “environment”environment:
string
Defined in: deploy/domain/model.ts:77
Environment slug (dev, qa, prod, …).
ftpLogin
Section titled “ftpLogin”ftpLogin:
string
Defined in: deploy/domain/model.ts:78
ftpPassword
Section titled “ftpPassword”ftpPassword:
string
Defined in: deploy/domain/model.ts:79
nginxDirectives?
Section titled “nginxDirectives?”
optionalnginxDirectives?:string
Defined in: deploy/domain/model.ts:81
Extra Nginx directives to inject in the vhost, if any.
oauthPrivateKey?
Section titled “oauthPrivateKey?”
optionaloauthPrivateKey?:string
Defined in: deploy/domain/model.ts:83
OAuth private key (backend targets that require JWT signing).
oauthPublicKey?
Section titled “oauthPublicKey?”
optionaloauthPublicKey?:string
Defined in: deploy/domain/model.ts:85
OAuth public key (verification half of the pair above).
pleskSshUser
Section titled “pleskSshUser”pleskSshUser:
string
Defined in: deploy/domain/model.ts:87
Plesk SSH user for operations that require shell access.
project
Section titled “project”project:
object
Defined in: deploy/domain/model.ts:88
email?
Section titled “email?”
optionalemail?:string
name:
string
repo:
string
owner/repo slug used by the CI/CD adapter.
secretPrefix
Section titled “secretPrefix”secretPrefix:
string
Defined in: deploy/domain/model.ts:95
Prefix applied to every CI/CD secret/variable name (ENV_TARGET_...).
server
Section titled “server”server:
object
Defined in: deploy/domain/model.ts:96
host:
string
plan:
string
Hosting plan identifier, provider-specific.
skipCicd
Section titled “skipCicd”skipCicd:
boolean
Defined in: deploy/domain/model.ts:102
If true, skip the CI/CD phase for this target.
skipDns
Section titled “skipDns”skipDns:
boolean
Defined in: deploy/domain/model.ts:104
If true, skip DNS upsert.
skipHosting
Section titled “skipHosting”skipHosting:
boolean
Defined in: deploy/domain/model.ts:106
If true, skip hosting provisioning (subscription, SSL, etc.).
skipSsh
Section titled “skipSsh”skipSsh:
boolean
Defined in: deploy/domain/model.ts:108
If true, do not install SSH keys on the server.
sopsAgeKey?
Section titled “sopsAgeKey?”
optionalsopsAgeKey?:string
Defined in: deploy/domain/model.ts:110
SOPS age key used to decrypt dotEnvEnc. Sensitive.
startupFile
Section titled “startupFile”startupFile:
string
Defined in: deploy/domain/model.ts:112
Node.js entry file. Auto-detected from package.json main.
target
Section titled “target”target:
DeployTarget
Defined in: deploy/domain/model.ts:113