deploy

type AutoDiscoveryConfig struct {
	ScanDepth     int  `yaml:"depth" json:"depth" default:"0"`                       // ScanDepth is the maximum depth of subdirectories to scan for docker-compose files
	Enabled       bool `yaml:"enabled" json:"enabled" default:"false"`               // Enabled enables autodiscovery of services to deploy in the working directory
	Delete        bool `yaml:"delete" json:"delete" default:"false"`                 // Delete removes obsolete auto-discovered deployments that are no longer present in the repository
	RemoveVolumes bool `yaml:"remove_volumes" json:"remove_volumes" default:"false"` // RemoveVolumes removes the volumes of an auto-discovered deployment when it is deleted
	RemoveImages  bool `yaml:"remove_images" json:"remove_images" default:"true"`    // RemoveImages removes the images of an auto-discovered deployment when it is deleted
}

type AutoDiscoveryOrigin struct {
	// WorkingDirectory is the directory the auto-discovery config scans, relative to the source root.
	WorkingDirectory string
	// Reference is the reference the auto-discovery config scans.
	Reference string
	// RepositoryURL is the repository the auto-discovery config scans. Empty means the job's own source.
	RepositoryURL string
	// WebhookEventFilter is the webhook event filter of the auto-discovery config. Nested configs can
	// override the filter of a discovered deployment, so it is kept separately.
	WebhookEventFilter string
	// Revision is the Git revision the deployment was discovered in. Empty if unknown.
	Revision string
	// MirrorDir is the Git mirror Revision was resolved in. Empty if Revision is.
	MirrorDir string
	// Settings are the auto-discovery settings of the config.
	Settings AutoDiscoveryConfig
}

type BuildConfig struct {
	Args           map[string]string `yaml:"args" json:"args"`                                         // BuildArgs is a map of build-time arguments to pass to the build process
	ForceImagePull bool              `yaml:"force_image_pull" json:"force_image_pull" default:"false"` // ForceImagePull always attempt to pull a newer version of the image
	Quiet          bool              `yaml:"quiet" json:"quiet" default:"false"`                       // Quiet suppresses the build output
	NoCache        bool              `yaml:"no_cache" json:"no_cache" default:"false"`                 // NoCache disables the use of the cache when building images
}

type Config struct {
	Name               string            `yaml:"name" json:"name" doco:"allowOverride"`                                // Name of the docker-compose deployment / stack
	Source             config.SourceType `yaml:"source" json:"source" default:"git"`                                   // Source selects the deployment source backend (git or oci)
	Version            string            `yaml:"version" json:"version" default:"doco.v1" doco:"allowOverride"`        // Version declares the deployment config schema/artifact version for OCI-backed deployments
	RepositoryUrl      config.GitUrl     `yaml:"repository_url" json:"repository_url" default:"" validate:"gitUrl"`    // RepositoryUrl is the Git clone URL of the repository to deploy
	WebhookEventFilter string            `yaml:"webhook_filter" json:"webhook_filter" default:"" doco:"allowOverride"` // WebhookEventFilter is a regular expression to whitelist deployment triggers based on the webhook event payload (e.g., branch like "^refs/heads/main$" or "main", tag like "^refs/tags/v[0-9]+\.[0-9]+\.[0-9]+$" or "v[0-9]+\.[0-9]+\.[0-9]+")
	Reference          string            `yaml:"reference" json:"reference" default:""`                                // Reference is the Git reference to the deployment, e.g., refs/heads/main, main, refs/tags/v1.0.0 or v1.0.0
	WorkingDirectory   string            `yaml:"working_dir" json:"working_dir" default:"." doco:"allowOverride"`      // WorkingDirectory is the working directory for the deployment
	Context            string            `yaml:"context" json:"context" default:"" doco:"allowOverride"`               // Context is the Docker context to use for this deployment (empty uses the default Docker context)
	ComposeFiles       []string          ``                                                                            // ComposeFiles is the list of docker-compose files to use
	/* 157-byte string literal not displayed */
	Environment          map[string]string                        `yaml:"environment" json:"environment" doco:"allowOverride"`                                    // Environment is a map of environment variables to use for variable interpolation in the compose files
	EnvFiles             []string                                 `yaml:"env_files" json:"env_files" default:"[\".env\"]" doco:"allowOverride"`                   // EnvFiles is the list of dotenv files to use for variable interpolation
	RemoveOrphans        bool                                     `yaml:"remove_orphans" json:"remove_orphans" default:"true" doco:"allowOverride"`               // RemoveOrphans removes containers for services not defined in the Compose file
	PruneImages          bool                                     `yaml:"prune_images" json:"prune_images" default:"true" doco:"allowOverride"`                   // PruneImages removes images that are no longer used by any service
	Swarm                SwarmConfig                              `yaml:"swarm" json:"swarm" doco:"allowOverride"`                                                // Swarm contains Docker Swarm-specific deployment settings
	WaitRunningJobs      bool                                     `yaml:"wait_running_jobs" json:"wait_running_jobs" default:"true" doco:"allowOverride"`         // WaitRunningJobs waits for currently running scheduled job containers/services to finish before deployment
	ForceRecreate        bool                                     `yaml:"force_recreate" json:"force_recreate" default:"false" doco:"allowOverride"`              // ForceRecreate forces the recreation/redeployment of containers even if the configuration has not changed
	ForceImagePull       bool                                     `yaml:"force_image_pull" json:"force_image_pull" default:"false" doco:"allowOverride"`          // ForceImagePull always pulls the latest version of the image tags you've specified if a newer version is available
	Timeout              int                                      `yaml:"timeout" json:"timeout" default:"180" doco:"allowOverride"`                              // Timeout is the time in seconds to wait for the deployment to finish before timing out
	BuildOpts            BuildConfig                              `yaml:"build" json:"build" doco:"allowOverride"`                                                // BuildOpts is the build options for the deployment
	GitDepth             int                                      `yaml:"git_depth" json:"git_depth" default:"0"`                                                 // GitDepth limits the number of commits to fetch. 0 means use global GIT_CLONE_DEPTH. A positive value overrides the global setting.
	Destroy              DestroyConfig                            `yaml:"destroy" json:"destroy" doco:"allowOverride"`                                            // Destroy configures destruction of the deployment and related resources
	Profiles             []string                                 `yaml:"profiles" json:"profiles" default:"[]" doco:"allowOverride"`                             // Profiles is a list of profiles to use for the deployment, e.g., ["dev", "prod"]. See https://docs.docker.com/compose/how-tos/profiles/
	ExternalSecrets      map[string]secrettypes.ExternalSecretRef `yaml:"external_secrets" json:"external_secrets" doco:"allowOverride"`                          // ExternalSecrets maps env vars to legacy string references or structured references (e.g. webhook store_ref/remote_ref).
	ExternalSecretsFiles []string                                 `yaml:"external_secrets_files" json:"external_secrets_files" default:"[]" doco:"allowOverride"` // ExternalSecretsFiles is a list of YAML files, each holding a map of env var name to external secret reference (same shape as ExternalSecrets). Files are merged first, then ExternalSecrets entries are applied on top (inline wins on key collision).
	AutoDiscovery        AutoDiscoveryConfig                      `yaml:"auto_discovery" json:"auto_discovery"`                                                   // AutoDiscovery configures autodiscovery of services to deploy in the working directory
	Reconciliation       ReconciliationConfig                     `yaml:"reconciliation" json:"reconciliation" doco:"allowOverride"`                              // Reconciliation is the configuration for the reconciliation feature
	Oci                  config.OciTrustPolicyOverride            `yaml:"oci" json:"oci" doco:"allowOverride"`                                                    // Oci allows per-target overrides for OCI signature verification policy
	Internal             struct {
		File                          string                                   `yaml:"-"` // File is the path to the deployment configuration file
		ConfigTarget                  string                                   `yaml:"-"` // ConfigTarget is the target suffix from the deployment config filename (e.g., "nas" for .doco-cd.nas.yml)
		Environment                   map[string]string                        // Environment stores environment variables for variable interpolation in the compose project
		ExternalSecretsFromFiles      map[string]secrettypes.ExternalSecretRef // ExternalSecretsFromFiles accumulates entries loaded from ExternalSecretsFiles across local and remote loads, merged into ExternalSecrets by MergeExternalSecretsFromFiles
		Hash                          string                                   `yaml:"-"`          // Hash is a hash of the Config struct
		OciTrustPolicyOverrideTrusted bool                                     `yaml:"-" json:"-"` // true only for trusted config sources (e.g. POLL_CONFIG inline deployments)
		ConfigSourceFilesLoaded       bool                                     `yaml:"-" json:"-"` // Config-source env and external-secret files have been loaded
		ConfigSourceRevision          string                                   `yaml:"-" json:"-"` // Immutable revision containing this deployment config
		ConfigSourceWorkingDir        string                                   `yaml:"-" json:"-"` // Host path to the config source artifact
		AutoDiscoveryOrigin           *AutoDiscoveryOrigin                     `yaml:"-" json:"-"` // Auto-discovery config that discovered this config, nil if it was not discovered
	} `json:"-"` // Internal holds internal configuration values that are not set by the user
}

type DestroyConfig struct {
	Enabled       bool `yaml:"enabled" json:"enabled" default:"false"`              // Enabled removes the deployment and all its resources from the Docker host
	RemoveVolumes bool `yaml:"remove_volumes" json:"remove_volumes" default:"true"` // RemoveVolumes removes the volumes used by the deployment (always enabled in docker swarm mode)
	RemoveImages  bool `yaml:"remove_images" json:"remove_images" default:"true"`   // RemoveImages removes the images used by the deployment (currently not supported in docker swarm mode)
	RemoveRepoDir bool `yaml:"remove_dir" json:"remove_dir" default:"false"`        // Deprecated: RemoveRepoDir is ignored because the source directory is shared by all stacks of a repository
}

type DiscoverySnapshot struct {
	RepositoryRoot string
	MirrorDir      string
	Revision       string
	Reference      string
}

type GitOptions struct {
	SSHPrivateKey           string
	SSHPrivateKeyPassphrase string
	GitAccessToken          string
	SkipTLSVerification     bool
	HttpProxy               transport.ProxyOptions
	GitCloneSubmodules      bool
	GitCloneDepth           int
	SourceURL               string
	// PrimaryReference overrides the reference known to resolve to primaryRevision.
	// Empty uses the job's reference. A config-source artifact's commit hash
	// identifies its content when the branch that supplied it is unknown.
	PrimaryReference string
	// DiscoverySnapshot restores only deployments discovered in the recorded source and reference.
	// When set, discovery reads this snapshot without resolving or fetching any references.
	DiscoverySnapshot *DiscoverySnapshot
	// SourceBaseDir is the directory every source's store lives under (DATA_MOUNT_PATH).
	// Auto-discovery of a config that names its own repository_url needs it to place that repository's store beside the
	// others, since repoRoot is a published artifact directory and nothing about that path leads back to the shared root.
	SourceBaseDir string
}

type ReconciliationConfig struct {
	Enabled        bool     `yaml:"enabled" json:"enabled" default:"true"`               // Enabled enables the reconciliation feature
	Events         []string `yaml:"events" json:"events" default:"[\"unhealthy\"]"`      // Events is the list of Docker container actions that trigger reconciliation
	RestartTimeout int      `yaml:"restart_timeout" json:"restart_timeout" default:"10"` // RestartTimeout is the timeout in seconds to wait before killing a container during a restart
	RestartSignal  string   `yaml:"restart_signal" json:"restart_signal" default:""`     // RestartSignal is the signal sent to stop containers during a restart. If not set, the default of the Docker daemon is used (SIGTERM).
	RestartLimit   int      `yaml:"restart_limit" json:"restart_limit" default:"5"`      // RestartLimit suppresses further unhealthy-triggered restarts after this many restarts in the configured window. Set to 0 to disable suppression.
	RestartWindow  int      `yaml:"restart_window" json:"restart_window" default:"300"`  // RestartWindow is the time window in seconds used with RestartLimit.
}

type SwarmConfig struct {
	Enabled         *bool `yaml:"enabled,omitempty" json:"enabled,omitempty"`                   // Enabled explicitly selects Swarm deployment mode. When unset, the Docker context determines the mode.
	ConfigRetention *int  `yaml:"config_retention,omitempty" json:"config_retention,omitempty"` // ConfigRetention is the number of old Swarm config revisions to keep per resource (excluding the active one). -1 disables automatic pruning. If unset, global DOCKER_SWARM_CONFIG_RETENTION is used.
	SecretRetention *int  `yaml:"secret_retention,omitempty" json:"secret_retention,omitempty"` // SecretRetention is the number of old Swarm secret revisions to keep per resource (excluding the active one). -1 disables automatic pruning. If unset, global DOCKER_SWARM_SECRET_RETENTION is used.
}