alien_core/

stack_settings.rs

//!
//! Defines stack-level settings and management configurations for different cloud platforms.
//! These settings customize deployment behavior and cross-account/cross-tenant access patterns.

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::{KubernetesCloudReference, KubernetesClusterOwnership};

/// AWS management configuration extracted from stack settings
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct AwsManagementConfig {
    /// The managing AWS IAM role ARN that can assume cross-account roles
    pub managing_role_arn: String,
}

/// GCP management configuration extracted from stack settings
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct GcpManagementConfig {
    /// Linked source account metadata; never a direct target trust grant.
    pub service_account_email: String,
    /// Available on managers supporting customer-owned target federation.
    /// New GCP setup requires this capability; unaffected cloud metadata stays readable.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub federation_trust: Option<crate::GcpFederationTrust>,
}

/// Azure management configuration extracted from stack settings
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct AzureManagementConfig {
    /// The managing Azure Tenant ID for cross-tenant access
    pub managing_tenant_id: String,
    /// OIDC issuer URL trusted by the target-side managed identity.
    pub oidc_issuer: String,
    /// OIDC subject claim trusted by the target-side managed identity.
    pub oidc_subject: String,
}

/// Management configuration for different cloud platforms.
///
/// Platform-derived configuration for cross-account/cross-tenant access.
/// This is NOT user-specified - it's derived from the Manager's ServiceAccount.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "platform")]
pub enum ManagementConfig {
    /// AWS management configuration
    Aws(AwsManagementConfig),
    /// GCP management configuration  
    Gcp(GcpManagementConfig),
    /// Azure management configuration
    Azure(AzureManagementConfig),
    /// Kubernetes management configuration (minimal for now)
    Kubernetes,
}

/// Network configuration for the stack.
///
/// Controls how VPC/VNet networking is provisioned. Users configure this in
/// `StackSettings`; the Network resource itself is auto-generated by preflights.
///
/// ## Egress policy
///
/// Container cluster VMs are configured for egress based on the mode:
///
/// - `UseDefault` → VMs get ephemeral public IPs (no NAT is provisioned)
/// - `Create` → VMs use private IPs; Alien provisions a NAT gateway for outbound access
/// - `ByoVpc*` / `ByoVnet*` → no public IPs assigned; customer manages egress
///
/// For production workloads, use `Create`. For fast dev/test iteration, `UseDefault` is
/// sufficient. For environments with existing VPCs, use the appropriate `ByoVpc*` variant.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "type")]
pub enum NetworkSettings {
    /// Use the cloud provider's default VPC/network.
    ///
    /// Designed for fast dev/test provisioning. No isolated VPC is created, so there
    /// is nothing to wait for or clean up. VMs receive ephemeral public IPs for internet
    /// access — no NAT gateway is provisioned.
    ///
    /// - **AWS**: Discovers the account's default VPC. Subnets are public with auto-assigned IPs.
    /// - **GCP**: Discovers the project's `default` network and regional subnet. Instance
    ///   templates include an `AccessConfig` to assign an ephemeral external IP.
    /// - **Azure**: Azure has no default VNet, so one is created along with a NAT Gateway.
    ///   VMs stay private and use NAT for egress.
    ///
    /// Not recommended for production. Use `Create` instead.
    #[serde(rename = "use-default")]
    UseDefault,

    /// Create a new isolated VPC/VNet with a managed NAT gateway.
    ///
    /// All networking infrastructure is provisioned by Alien and cleaned up on delete.
    /// VMs use private IPs only; all outbound traffic routes through the NAT gateway.
    ///
    /// Recommended for production deployments.
    #[serde(rename = "create")]
    Create {
        /// VPC/VNet CIDR block. If not specified, auto-generated from stack ID
        /// to reduce conflicts (e.g., "10.{hash}.0.0/16").
        #[serde(skip_serializing_if = "Option::is_none")]
        cidr: Option<String>,

        /// Number of availability zones (default: 2).
        #[serde(default = "default_availability_zones")]
        availability_zones: u8,
    },

    /// Use an existing VPC (AWS).
    ///
    /// Alien validates the references but creates no networking infrastructure.
    /// The customer is responsible for routing and egress (NAT, proxy, VPN, etc.).
    #[serde(rename = "byo-vpc-aws")]
    ByoVpcAws {
        /// The ID of the existing VPC
        vpc_id: String,
        /// IDs of public subnets (required for public ingress)
        #[serde(deserialize_with = "crate::network_ids::deserialize_ids")]
        public_subnet_ids: Vec<String>,
        /// IDs of private subnets
        #[serde(deserialize_with = "crate::network_ids::deserialize_ids")]
        private_subnet_ids: Vec<String>,
        /// Optional security group IDs to use
        #[serde(default)]
        #[serde(deserialize_with = "crate::network_ids::deserialize_ids")]
        security_group_ids: Vec<String>,
    },

    /// Use an existing VPC (GCP).
    ///
    /// Alien validates the references but creates no networking infrastructure.
    /// The customer is responsible for routing and egress (Cloud NAT, proxy, VPN, etc.).
    #[serde(rename = "byo-vpc-gcp")]
    ByoVpcGcp {
        /// The name of the existing VPC network
        network_name: String,
        /// The name of the subnet to use
        subnet_name: String,
        /// The region of the subnet
        region: String,
    },

    /// Use an existing VNet (Azure).
    ///
    /// Alien validates the references but creates no networking infrastructure.
    /// The customer is responsible for routing and egress (NAT Gateway, proxy, VPN, etc.).
    #[serde(rename = "byo-vnet-azure")]
    ByoVnetAzure {
        /// The full resource ID of the existing VNet
        vnet_resource_id: String,
        /// Name of the public subnet within the VNet
        public_subnet_name: String,
        /// Name of the private subnet within the VNet
        private_subnet_name: String,
        /// Name of the dedicated classic Application Gateway subnet within the VNet.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        application_gateway_subnet_name: Option<String>,
        /// Name of the dedicated subnet that hosts Private Endpoints (e.g. for a
        /// Postgres Flexible Server). A Private Endpoint must not share the private
        /// subnet, which is already claimed by the Container Apps environment's
        /// `infrastructure_subnet_id`. Required only when the stack contains a
        /// Postgres resource; otherwise unused.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        private_endpoint_subnet_name: Option<String>,
    },
}

fn default_availability_zones() -> u8 {
    2
}

/// Most availability zones a created network can span. The AWS network gives each zone a
/// /20 public subnet from x.x.0.0 and a /20 private subnet from x.x.128.0 of the /16, so a
/// ninth zone would overlap the private range.
pub const MAX_CREATED_NETWORK_AVAILABILITY_ZONES: u8 = 8;

/// Deployment-time compute choices for Alien-managed compute pools.
///
/// Application source declares portable pool requirements. This settings
/// object stores the concrete choices made for one deployment, such as the
/// provider machine type and selected machine counts.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct ComputeSettings {
    /// Selected compute choices keyed by pool ID.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub pools: HashMap<String, ComputePoolSelection>,
    /// Per-replica resources selected within each container's declared ranges.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub containers: HashMap<String, ContainerResourceSelection>,
}

/// Deployment-time resource allocation for a container. Omitted fields use release defaults.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct ContainerResourceSelection {
    /// CPU allocation in vCPUs.
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "deserialize_selected_cpu"
    )]
    #[cfg_attr(feature = "openapi", schema(value_type = Option<f64>))]
    pub cpu: Option<serde_json::Number>,
    /// Memory allocation, using binary units such as Mi or Gi.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub memory: Option<String>,
    /// Persistent volume capacity per replica, in whole GiB. Omitted values
    /// use the release default. Existing volumes can only grow.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[serde(deserialize_with = "deserialize_selected_volume_size")]
    pub volume_size_gib: Option<u32>,
}

fn deserialize_selected_volume_size<'de, D: serde::Deserializer<'de>>(
    deserializer: D,
) -> std::result::Result<Option<u32>, D::Error> {
    // CloudFormation Number references arrive as strings in setup import JSON.
    match Option::<serde_json::Value>::deserialize(deserializer)? {
        None => Ok(None),
        Some(serde_json::Value::Number(number)) => number
            .as_u64()
            .and_then(|number| u32::try_from(number).ok())
            .map(Some)
            .ok_or_else(|| {
                serde::de::Error::custom("volumeSizeGib must be a whole positive capacity")
            }),
        Some(serde_json::Value::String(number)) => {
            number.parse().map(Some).map_err(serde::de::Error::custom)
        }
        Some(_) => Err(serde::de::Error::custom(
            "volumeSizeGib must be a whole positive capacity",
        )),
    }
}

fn deserialize_selected_cpu<'de, D: serde::Deserializer<'de>>(
    deserializer: D,
) -> std::result::Result<Option<serde_json::Number>, D::Error> {
    // CloudFormation returns Number parameter references as strings.
    match Option::<serde_json::Value>::deserialize(deserializer)? {
        None => Ok(None),
        Some(serde_json::Value::Number(number)) => Ok(Some(number)),
        Some(serde_json::Value::String(number)) => {
            number.parse().map(Some).map_err(serde::de::Error::custom)
        }
        Some(_) => Err(serde::de::Error::custom("CPU must be a number")),
    }
}

/// Failure-domain policy selected for a compute pool.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct FailureDomainSelection {
    /// Number of distinct failure domains across which new stateful replicas may be spread.
    pub spread: u8,
    /// Concrete provider domains selected during setup.
    /// Empty delegates deterministic selection to the provider setup implementation.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub selected_failure_domains: Vec<String>,
}

/// User-selected deployment settings for one compute pool.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "mode")]
pub enum ComputePoolSelection {
    /// Fixed number of machines.
    Fixed {
        /// Number of machines to run.
        machines: u32,
        /// Provider machine type selected for this deployment.
        #[serde(
            default,
            skip_serializing_if = "Option::is_none",
            deserialize_with = "deserialize_machine_override"
        )]
        machine: Option<String>,
        /// Optional failure-domain policy. Absence preserves the existing aggregate layout.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        failure_domains: Option<FailureDomainSelection>,
    },
    /// Autoscaling machine pool.
    Autoscale {
        /// Minimum machine count.
        min: u32,
        /// Maximum machine count.
        max: u32,
        /// Provider machine type selected for this deployment.
        #[serde(
            default,
            skip_serializing_if = "Option::is_none",
            deserialize_with = "deserialize_machine_override"
        )]
        machine: Option<String>,
        /// Optional failure-domain policy. Absence preserves the existing aggregate layout.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        failure_domains: Option<FailureDomainSelection>,
    },
}

fn deserialize_machine_override<'de, D: serde::Deserializer<'de>>(
    deserializer: D,
) -> std::result::Result<Option<String>, D::Error> {
    // CloudFormation represents its optional String parameters as empty strings.
    Ok(Option::<String>::deserialize(deserializer)?.filter(|machine| !machine.is_empty()))
}

impl ComputePoolSelection {
    /// Selected provider machine type, when this platform needs one.
    pub fn machine(&self) -> Option<&str> {
        match self {
            Self::Fixed { machine, .. } | Self::Autoscale { machine, .. } => machine.as_deref(),
        }
    }

    /// Selected failure-domain policy, if this deployment explicitly adopted one.
    pub fn failure_domains(&self) -> Option<&FailureDomainSelection> {
        match self {
            Self::Fixed {
                failure_domains, ..
            }
            | Self::Autoscale {
                failure_domains, ..
            } => failure_domains.as_ref(),
        }
    }

    /// Selected minimum machine count.
    pub fn min_size(&self) -> u32 {
        match self {
            Self::Fixed { machines, .. } => *machines,
            Self::Autoscale { min, .. } => *min,
        }
    }

    /// Selected maximum machine count.
    pub fn max_size(&self) -> u32 {
        match self {
            Self::Fixed { machines, .. } => *machines,
            Self::Autoscale { max, .. } => *max,
        }
    }

    /// Whether the selection has internally valid scale bounds.
    pub fn validate(&self) -> std::result::Result<(), String> {
        if self
            .failure_domains()
            .is_some_and(|selection| selection.spread == 0)
        {
            return Err("failure-domain spread must be at least one".to_string());
        }
        if self.failure_domains().is_some_and(|selection| {
            !selection.selected_failure_domains.is_empty()
                && selection.selected_failure_domains.len() != usize::from(selection.spread)
        }) {
            return Err("selected failure domains must match the requested spread".to_string());
        }
        if self.failure_domains().is_some_and(|selection| {
            selection.selected_failure_domains.len()
                != selection
                    .selected_failure_domains
                    .iter()
                    .collect::<std::collections::HashSet<_>>()
                    .len()
        }) {
            return Err("selected failure domains must be unique".to_string());
        }
        match self {
            Self::Fixed { machines, .. } => {
                if *machines == 0 {
                    return Err("fixed compute pools must select at least one machine".to_string());
                }
                if let Some(failure_domains) = self.failure_domains() {
                    if *machines < u32::from(failure_domains.spread) {
                        return Err(format!(
                            "fixed compute pool machines ({machines}) must be at least failure-domain spread ({})",
                            failure_domains.spread
                        ));
                    }
                }
            }
            Self::Autoscale { min, max, .. } => {
                if min > max {
                    return Err(format!(
                        "autoscaling compute pool minimum ({min}) cannot exceed maximum ({max})"
                    ));
                }
                if let Some(failure_domains) = self.failure_domains() {
                    let spread = u32::from(failure_domains.spread);
                    if *max < spread {
                        return Err(format!(
                            "autoscaling compute pool maximum ({max}) must be at least failure-domain spread ({spread})"
                        ));
                    }
                    if *min < spread {
                        return Err(format!(
                            "autoscaling compute pool minimum ({min}) must be at least failure-domain spread ({spread})"
                        ));
                    }
                }
            }
        }
        Ok(())
    }
}

/// Deployment model: how updates are delivered to the remote environment.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub enum DeploymentModel {
    /// Manager pushes updates via cross-account access.
    /// Available for AWS, GCP, Azure only.
    #[default]
    Push,
    /// Agent in remote environment pulls updates.
    /// Available for all platforms (AWS, GCP, Azure, Kubernetes, Local).
    Pull,
}

/// How updates are delivered to the deployment.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "kebab-case")]
pub enum UpdatesMode {
    /// Updates deploy automatically (default).
    #[default]
    Auto,
    /// Updates require explicit approval before deployment.
    ApprovalRequired,
}

/// How telemetry (logs, metrics, traces) is handled.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "kebab-case")]
pub enum TelemetryMode {
    /// No telemetry permissions. Data will not be collected.
    Off,
    /// Telemetry flows automatically (default).
    #[default]
    Auto,
    /// Telemetry requires explicit approval before collection begins.
    ApprovalRequired,
}

impl TelemetryMode {
    /// Returns true if telemetry is enabled (Auto or ApprovalRequired).
    pub fn is_enabled(&self) -> bool {
        !matches!(self, TelemetryMode::Off)
    }
}

/// How heartbeat health checks are handled.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "kebab-case")]
pub enum HeartbeatsMode {
    /// No heartbeat permissions. Health checks disabled.
    Off,
    /// Heartbeat enabled (default).
    #[default]
    On,
}

impl HeartbeatsMode {
    /// Returns true if heartbeat is enabled.
    pub fn is_enabled(&self) -> bool {
        matches!(self, HeartbeatsMode::On)
    }
}

/// Reachability of the deployment's public endpoints, fixed at setup.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub enum EndpointAccess {
    /// Endpoints are reachable from the internet.
    #[default]
    Internet,
    /// Endpoints are reachable only through the deployment network (AWS only).
    Private,
}

impl EndpointAccess {
    /// Serialized setup parameter value.
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Internet => "internet",
            Self::Private => "private",
        }
    }
}

/// Domain configuration for the stack.
///
/// When `custom_domains` is set, the specified resources use customer-provided
/// domains with supplied or managed certificates. Otherwise, Alien auto-generates domains.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct DomainSettings {
    /// Custom domain configuration per resource ID.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub custom_domains: Option<HashMap<String, CustomDomainConfig>>,
    /// Public endpoint DNS target selection for machines deployments.
    ///
    /// When omitted, machines deployments publish healthy machine public
    /// addresses directly. Use `LoadBalancer` when an external load balancer
    /// fronts the machines and Alien should publish a CNAME to that target.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub public_endpoint_target: Option<PublicEndpointTargetSettings>,
}

/// DNS target mode for public endpoints.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "mode")]
pub enum PublicEndpointTargetSettings {
    /// Publish DNS records directly to healthy machine public IP addresses.
    MachineAddresses,
    /// Publish a CNAME record to an external load balancer.
    #[serde(rename_all = "camelCase")]
    LoadBalancer {
        /// DNS name or URL for the external load balancer.
        cname_target: String,
    },
}

/// Custom domain configuration for a single resource.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct CustomDomainConfig {
    /// Fully qualified domain name for a supplied certificate.
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub domain: String,
    /// Hostnames keyed by endpoint name for a managed certificate.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub endpoints: HashMap<String, String>,
    /// Supplied certificate reference or managed issuance.
    pub certificate: CustomCertificateConfig,
}

/// Platform-specific certificate references for custom domains.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct CustomCertificateConfig {
    /// Issue and renew a certificate for the configured endpoint hostnames.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub managed: Option<ManagedCustomCertificateConfig>,
    /// AWS ACM certificate ARN
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub aws: Option<AwsCustomCertificateConfig>,
    /// GCP Certificate Manager certificate name
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub gcp: Option<GcpCustomCertificateConfig>,
    /// Azure Key Vault certificate ID
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub azure: Option<AzureCustomCertificateConfig>,
    /// Kubernetes TLS Secret reference for Secret-backed route profiles.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub kubernetes: Option<KubernetesCustomCertificateConfig>,
}

/// Managed certificate issuance settings.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct ManagedCustomCertificateConfig {}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct AwsCustomCertificateConfig {
    pub certificate_arn: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct GcpCustomCertificateConfig {
    pub certificate_name: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct AzureCustomCertificateConfig {
    pub key_vault_certificate_id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key_vault_resource_id: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct KubernetesCustomCertificateConfig {
    /// Existing TLS Secret containing `tls.crt` and `tls.key`.
    pub tls_secret_ref: KubernetesTlsSecretRef,
}

/// Kubernetes runtime substrate configuration.
///
/// This controls how setup chooses the cluster backing `Platform::Kubernetes`
/// deployments. When omitted, cloud-backed Kubernetes deployments default to a
/// managed cluster and generic/on-prem Kubernetes defaults to an external
/// cluster.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct KubernetesSettings {
    /// Cluster selection or creation settings.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub cluster: Option<KubernetesClusterSettings>,
    /// Public HTTPS exposure contract shared by setup, Helm, and runtime.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub exposure: Option<KubernetesExposureSettings>,
}

/// Kubernetes cluster setup settings.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct KubernetesClusterSettings {
    /// Whether Alien should create the cluster, use a setup-owned existing
    /// cluster, or bind to an external/on-prem cluster.
    pub ownership: KubernetesClusterOwnership,
    /// Namespace where the Alien chart and application resources run.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub namespace: Option<String>,
    /// Optional provider-specific cloud identity for existing clusters.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub cloud: Option<KubernetesCloudReference>,
}

/// Kubernetes public HTTPS exposure mode.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "mode")]
pub enum KubernetesExposureSettings {
    /// Do not create Alien-managed external routing.
    Disabled,
    /// Use Alien-generated DNS and Platform-managed certificate material.
    Generated {
        /// Runtime route profile to materialize.
        route: KubernetesRouteProfile,
        /// How managed certificate material reaches the route profile.
        certificate: KubernetesCertificateMode,
    },
    /// Use a customer hostname and customer-owned certificate reference.
    Custom {
        /// Hostname routed by the Kubernetes public endpoint.
        domain: String,
        /// Runtime route profile to materialize.
        route: KubernetesRouteProfile,
        /// Customer-owned certificate reference consumed by the route profile.
        certificate: KubernetesCertificateMode,
    },
    /// Give each named public endpoint a hostname below a customer-owned base domain.
    #[serde(rename_all = "camelCase")]
    CustomBaseDomain {
        /// DNS name without a wildcard or URL scheme, for example `app.example.com`.
        base_domain: String,
        /// Route profile shared by all public endpoints.
        route: KubernetesRouteProfile,
        /// One customer-owned certificate reference covering every endpoint hostname.
        certificate: KubernetesCertificateMode,
    },
}

/// Kubernetes route API selected for public endpoints.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "routeApi")]
pub enum KubernetesRouteProfile {
    /// `networking.k8s.io/v1` Ingress route profile.
    Ingress(KubernetesIngressRouteProfile),
    /// Gateway API `Gateway` + `HTTPRoute` route profile.
    Gateway(KubernetesGatewayRouteProfile),
}

/// Shared Ingress route profile values.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct KubernetesIngressRouteProfile {
    /// Route controller identifier, for example `eks.amazonaws.com/alb`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub controller: Option<String>,
    /// `spec.ingressClassName` for generated Ingresses.
    pub ingress_class_name: String,
    /// Labels applied to route objects.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub labels: HashMap<String, String>,
    /// Annotations applied to route objects.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub annotations: HashMap<String, String>,
    /// Provider-specific route options that are required by the selected class.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider: Option<KubernetesRouteProviderOptions>,
}

/// Shared Gateway API route profile values.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct KubernetesGatewayRouteProfile {
    /// Route controller identifier, for example a cloud Gateway controller.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub controller: Option<String>,
    /// GatewayClass selected for generated Gateways.
    pub gateway_class_name: String,
    /// Listener port, usually 443.
    pub listener_port: u16,
    /// Labels applied to route objects.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub labels: HashMap<String, String>,
    /// Annotations applied to route objects.
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub annotations: HashMap<String, String>,
    /// Provider-specific route options that are required by the selected class.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider: Option<KubernetesRouteProviderOptions>,
}

/// Provider-specific route options required by supported managed profiles.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "provider")]
pub enum KubernetesRouteProviderOptions {
    /// AWS ALB route options for EKS.
    #[serde(rename_all = "camelCase")]
    AwsAlb {
        /// Internet-facing or internal ALB scheme.
        scheme: String,
        /// ALB target type, usually `ip`.
        target_type: String,
        /// Optional ALB IP address type, such as `dualstack`.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        ip_address_type: Option<String>,
        /// Explicit subnet IDs when the profile cannot rely on controller discovery.
        #[serde(default, skip_serializing_if = "Vec::is_empty")]
        subnet_ids: Vec<String>,
    },
    /// GKE Gateway route options.
    #[serde(rename_all = "camelCase")]
    GkeGateway {
        /// Optional static address name for the Gateway frontend.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        static_address_name: Option<String>,
    },
    /// Azure Application Gateway for Containers route options.
    #[serde(rename_all = "camelCase")]
    AzureApplicationGatewayForContainers {
        /// Optional ALB namespace when using BYO Application Gateway resources.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        alb_namespace: Option<String>,
        /// Optional ALB name when using BYO Application Gateway resources.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        alb_name: Option<String>,
        /// Public or internal frontend exposure.
        frontend: String,
    },
}

/// Certificate publication or reference mode for Kubernetes public endpoints.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase", tag = "mode")]
pub enum KubernetesCertificateMode {
    /// Platform-managed cert imported into AWS ACM by the runtime.
    #[serde(rename_all = "camelCase")]
    ManagedAcmImport {
        /// ACM region. Defaults to the deployment region when omitted.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        region: Option<String>,
        /// Tags applied to runtime-imported ACM certificates.
        #[serde(default, skip_serializing_if = "HashMap::is_empty")]
        tags: HashMap<String, String>,
    },
    /// Customer-provided AWS ACM certificate ARN.
    #[serde(rename_all = "camelCase")]
    AwsAcmArn {
        /// Existing ACM certificate ARN.
        certificate_arn: String,
    },
    /// Platform-managed cert written to a Kubernetes TLS Secret.
    #[serde(rename_all = "camelCase")]
    ManagedTlsSecret {
        /// Secret name template. Runtime may substitute resource/deployment tokens.
        secret_name_template: String,
    },
    /// Customer-provided Kubernetes TLS Secret.
    TlsSecretRef(KubernetesTlsSecretRef),
    /// No TLS certificate should be configured by Alien.
    None,
}

/// Namespace-scoped Kubernetes TLS Secret reference.
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct KubernetesTlsSecretRef {
    /// Secret name.
    pub secret_name: String,
    /// Secret namespace. Defaults to the release namespace when omitted.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub namespace: Option<String>,
}

/// User-customizable deployment settings specified at deploy time.
///
/// These settings are provided by the customer via CloudFormation parameters,
/// Terraform attributes, CLI flags, or Helm values. They customize how the
/// deployment runs and what capabilities are enabled.
///
/// **Key distinction**: StackSettings is user-customizable, while ManagementConfig
/// is platform-derived (from the Manager's ServiceAccount).
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct StackSettings {
    /// Ongoing authority over infrastructure normally owned by setup. Automatic requires
    /// an explicit CLI setup grant; changing this setting alone never grants that authority.
    #[serde(default, skip_serializing_if = "is_manual_setup_management")]
    pub setup_management: SetupManagement,
    /// Provider quota identities whose preflight failures become visible warnings
    /// for this deployment. Checks still run; deploy-time provider limits still apply.
    /// Unknown identities are rejected. An empty list restores normal blocking.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub quota_warning_overrides: Vec<String>,

    /// Who can reach public endpoints. Private access requires AWS managed containers.
    /// This choice cannot change after setup; create a new deployment to change it.
    #[serde(default)]
    pub endpoint_access: EndpointAccess,

    /// Network configuration for the stack (VPC/VNet settings).
    /// If `None`, an isolated VPC with NAT is auto-created when the stack has resources
    /// that require networking (e.g., containers). Set explicitly to customize:
    /// `UseDefault` for the provider's default network (fast, dev/test only),
    /// `Create` for an isolated VPC with managed NAT (production), or `ByoVpc*`
    /// to reference an existing customer-managed VPC.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub network: Option<NetworkSettings>,

    /// Domain configuration (future).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub domains: Option<DomainSettings>,

    /// Kubernetes runtime substrate configuration.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub kubernetes: Option<KubernetesSettings>,

    /// Deployment-time compute selections for Alien-managed compute pools.
    ///
    /// This is where provider machine names such as EC2 instance types, GCE
    /// machine types, or Azure VM SKUs belong. Application source should
    /// declare portable requirements instead.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub compute: Option<ComputeSettings>,

    /// Exact externally managed endpoint URLs, keyed by resource ID and endpoint name.
    ///
    /// This is intended for adopted Machines deployments whose DNS and certificates remain
    /// customer-owned. The platform passes these URLs to the runtime without creating or
    /// replacing DNS records or certificates.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[cfg_attr(
        feature = "openapi",
        schema(value_type = Option<HashMap<String, HashMap<String, String>>>)
    )]
    pub public_endpoints: Option<crate::PublicEndpointUrls>,

    /// Deployment model: push (Manager) or pull (Agent).
    /// Default: Push.
    /// - Push: Manager drives updates. For cloud platforms, requires cross-account
    ///   credentials established during initial setup. For push-mode local
    ///   deployments (currently `alien dev`), the manager has direct access —
    ///   no bootstrap needed.
    /// - Pull: Agent in the target environment drives updates via polling.
    ///   Required for Kubernetes and remote local deployments.
    #[serde(default, skip_serializing_if = "is_default_deployment_model")]
    pub deployment_model: DeploymentModel,

    /// Deliver Kubernetes updates and reports as carried bundles instead of a live connection.
    /// The Operator still executes deployments with the pull model.
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub airgapped: bool,

    /// How updates are delivered.
    /// - auto: Updates deploy automatically (default)
    /// - approval-required: Updates wait for explicit approval
    #[serde(default, skip_serializing_if = "is_default_updates_mode")]
    pub updates: UpdatesMode,

    /// How telemetry (logs, metrics, traces) is handled.
    /// - off: No telemetry permissions
    /// - auto: Telemetry flows automatically (default)
    /// - approval-required: Telemetry waits for explicit approval
    #[serde(default, skip_serializing_if = "is_default_telemetry_mode")]
    pub telemetry: TelemetryMode,

    /// How heartbeat health checks are handled.
    /// - off: No heartbeat permissions
    /// - on: Heartbeat enabled (default)
    #[serde(default, skip_serializing_if = "is_default_heartbeats_mode")]
    pub heartbeats: HeartbeatsMode,

    /// External bindings for pre-existing infrastructure.
    /// Allows using existing resources (MinIO, Redis, shared Container Apps
    /// Environment, etc.) instead of having Alien provision them.
    /// Required for Kubernetes platform, optional for cloud platforms.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub external_bindings: Option<crate::ExternalBindings>,
}

/// Whether setup remains a separate administrator operation.
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Default)]
#[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
#[serde(rename_all = "camelCase")]
pub enum SetupManagement {
    /// Setup owns structural infrastructure changes and teardown.
    #[default]
    Manual,
    /// Alien continues managing setup infrastructure with permissions explicitly granted at setup.
    Automatic,
}

impl SetupManagement {
    /// Serialized setup parameter value.
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Manual => "manual",
            Self::Automatic => "automatic",
        }
    }
}

fn is_manual_setup_management(mode: &SetupManagement) -> bool {
    *mode == SetupManagement::Manual
}

fn is_default_deployment_model(model: &DeploymentModel) -> bool {
    *model == DeploymentModel::default()
}

fn is_default_updates_mode(mode: &UpdatesMode) -> bool {
    *mode == UpdatesMode::default()
}

fn is_default_telemetry_mode(mode: &TelemetryMode) -> bool {
    *mode == TelemetryMode::default()
}

fn is_default_heartbeats_mode(mode: &HeartbeatsMode) -> bool {
    *mode == HeartbeatsMode::default()
}

#[cfg(test)]
mod failure_domain_tests {
    use super::*;

    #[test]
    fn old_compute_selection_deserializes_without_topology() {
        let selection: ComputePoolSelection = serde_json::from_value(serde_json::json!({
            "mode": "fixed",
            "machines": 2,
            "machine": "m7i.xlarge"
        }))
        .expect("existing selection should deserialize");
        assert!(selection.failure_domains().is_none());
    }

    #[test]
    fn rejects_duplicate_concrete_failure_domains() {
        let selection = ComputePoolSelection::Fixed {
            machines: 2,
            machine: Some("m7i.xlarge".to_string()),
            failure_domains: Some(FailureDomainSelection {
                spread: 2,
                selected_failure_domains: vec!["us-west-2a".to_string(); 2],
            }),
        };
        assert_eq!(
            selection.validate(),
            Err("selected failure domains must be unique".to_string())
        );
    }

    #[test]
    fn fixed_pool_must_have_one_machine_per_failure_domain() {
        let invalid = ComputePoolSelection::Fixed {
            machines: 1,
            machine: None,
            failure_domains: Some(FailureDomainSelection {
                spread: 2,
                selected_failure_domains: Vec::new(),
            }),
        };
        assert_eq!(
            invalid.validate(),
            Err(
                "fixed compute pool machines (1) must be at least failure-domain spread (2)"
                    .to_string()
            )
        );

        let valid = ComputePoolSelection::Fixed {
            machines: 2,
            machine: None,
            failure_domains: Some(FailureDomainSelection {
                spread: 2,
                selected_failure_domains: Vec::new(),
            }),
        };
        assert_eq!(valid.validate(), Ok(()));
    }

    #[test]
    fn autoscaling_pool_bounds_must_cover_every_failure_domain() {
        let invalid_max = ComputePoolSelection::Autoscale {
            min: 1,
            max: 1,
            machine: None,
            failure_domains: Some(FailureDomainSelection {
                spread: 2,
                selected_failure_domains: Vec::new(),
            }),
        };
        assert_eq!(
            invalid_max.validate(),
            Err(
                "autoscaling compute pool maximum (1) must be at least failure-domain spread (2)"
                    .to_string()
            )
        );

        let invalid_min = ComputePoolSelection::Autoscale {
            min: 1,
            max: 3,
            machine: None,
            failure_domains: Some(FailureDomainSelection {
                spread: 2,
                selected_failure_domains: Vec::new(),
            }),
        };
        assert_eq!(
            invalid_min.validate(),
            Err(
                "autoscaling compute pool minimum (1) must be at least failure-domain spread (2)"
                    .to_string()
            )
        );

        let valid = ComputePoolSelection::Autoscale {
            min: 2,
            max: 2,
            machine: None,
            failure_domains: Some(FailureDomainSelection {
                spread: 2,
                selected_failure_domains: Vec::new(),
            }),
        };
        assert_eq!(valid.validate(), Ok(()));
    }

    #[test]
    fn machine_public_endpoints_round_trip_without_rewriting_urls() {
        let settings: StackSettings = serde_json::from_value(serde_json::json!({
            "publicEndpoints": {
                "loader": {
                    "api": "https://loader.compute.example.com",
                    "shares": "https://shares.compute.example.com",
                    "webhooks": "https://webhooks.compute.example.com"
                }
            }
        }))
        .expect("stack settings should deserialize");

        assert_eq!(
            serde_json::to_value(settings).expect("stack settings should serialize")
                ["publicEndpoints"]["loader"]["shares"],
            "https://shares.compute.example.com"
        );
    }

    #[test]
    fn custom_domains_preserve_managed_endpoint_names_and_supplied_certificates() {
        for config in [
            serde_json::json!({
                "endpoints": {
                    "api": "q7.m2x.example.com",
                    "shares": "*.q7.s9t.example.com",
                    "webhooks": "*.q7.w3h.example.com"
                },
                "certificate": {"managed": {}}
            }),
            serde_json::json!({
                "domain": "app.example.com",
                "certificate": {"aws": {"certificateArn": "arn:example"}}
            }),
        ] {
            let parsed: CustomDomainConfig = serde_json::from_value(config.clone())
                .expect("custom domain configuration should deserialize");
            assert_eq!(serde_json::to_value(parsed).unwrap(), config);
        }
    }
}