upgrade

type Applier struct {
	// contains filtered or unexported fields
}

type ApplyOptions struct {
	// EnvVars are additional or overriding environment variables to merge into
	// the upgraded workload's configuration.
	EnvVars map[string]string

	// Secrets are additional secret parameters (`<name>,target=<env>`) to merge
	// into the upgraded workload's configuration.
	Secrets []string

	// EnvVarValidator validates that required environment variables and secrets
	// are supplied for the candidate registry entry.
	EnvVarValidator runner.EnvVarValidator

	// VerifySetting controls image signature verification. Empty defaults to
	// retriever.VerifyImageWarn.
	VerifySetting string

	// CACertPath is an optional path to a CA certificate bundle used when
	// resolving the candidate image from a registry over TLS.
	CACertPath string
}

type CheckResult struct {
	// WorkloadName is the name of the workload that was checked.
	WorkloadName string `json:"workload_name"`

	// RegistryServer is the registry entry name the workload was sourced from.
	// Empty when the workload is not registry-sourced.
	RegistryServer string `json:"registry_server,omitempty"`

	// Status is the upgrade status for the workload.
	Status UpgradeStatus `json:"status"`

	// CurrentImage is the image reference the workload is currently running.
	CurrentImage string `json:"current_image,omitempty"`

	// CandidateImage is the image reference the registry currently reports.
	CandidateImage string `json:"candidate_image,omitempty"`

	// Reason provides additional context, primarily for StatusUnknown.
	Reason string `json:"reason,omitempty"`

	// EnvVarDrift describes environment variables the candidate registry entry
	// declares that differ from the workload's current configuration.
	EnvVarDrift *EnvVarDrift `json:"env_var_drift,omitempty"`

	// ConfigDrift describes posture differences (transport, permission profile)
	// between the workload and the candidate registry entry.
	ConfigDrift *ConfigDrift `json:"config_drift,omitempty"`
}

type Checker struct {
	// contains filtered or unexported fields
}

type ConfigDrift struct {
	// Transport is set when the candidate's transport differs from the
	// workload's current transport.
	Transport *StringChange `json:"transport,omitempty"`

	// PermissionProfile is set when the candidate's permission profile differs
	// from the workload's current profile.
	PermissionProfile *StringChange `json:"permission_profile,omitempty"`
}

type EnvVarDrift struct {
	// Added lists environment variables the candidate declares that the
	// workload does not currently supply (via plain env vars or secrets).
	Added []EnvVarInfo `json:"added,omitempty"`

	// Removed lists environment variables the workload supplies that the
	// candidate no longer declares. Populated on a best-effort basis; may be
	// empty even when removals exist (forward-compatible field).
	Removed []EnvVarInfo `json:"removed,omitempty"`
}

type EnvVarInfo struct {
	// Name is the environment variable name.
	Name string `json:"name"`

	// Description is the human-readable purpose of the variable.
	Description string `json:"description,omitempty"`

	// Required indicates whether the candidate marks the variable as required.
	Required bool `json:"required"`

	// Secret indicates whether the variable holds sensitive data.
	Secret bool `json:"secret,omitempty"`

	// Default is the candidate's default value. It is cleared (left empty)
	// whenever Secret is true: a secret env var's default could carry sensitive
	// data, and surfacing it in a drift report (which may be logged or returned
	// over the API) would leak it. Non-secret defaults are safe to display.
	Default string `json:"default,omitempty"`
}

type StringChange struct {
	From string `json:"from"`
	To   string `json:"to"`
}

type UpgradeStatus string