Struct EnvironmentParams 

pub struct EnvironmentParams {
    pub environment_name: EnvironmentName,
    pub instance_name: InstanceName,
    pub provider_config: ProviderConfig,
    pub ssh_credentials: SshCredentials,
    pub ssh_port: u16,
    pub tracker_config: TrackerConfig,
    pub prometheus_config: Option<PrometheusConfig>,
    pub grafana_config: Option<GrafanaConfig>,
    pub https_config: Option<HttpsConfig>,
    pub backup_config: Option<BackupConfig>,
}

Parameters for creating a new Environment aggregate

This value object contains all validated domain objects needed to construct an Environment<Created> aggregate. It serves as a “factory input” pattern, grouping related parameters into a single, self-documenting type.

Field Categories

• Identity: environment_name, instance_name
• Infrastructure: provider_config, ssh_credentials, ssh_port
• Application: tracker_config
• Observability: prometheus_config, grafana_config
• Security: https_config

Invariants

All fields are pre-validated domain types. Cross-field validation (e.g., Grafana requires Prometheus) happens in Environment::create().

Fields

environment_name: EnvironmentName

Validated environment name (e.g., “production”, “staging”)

instance_name: InstanceName

Validated instance name for the VM/container

Either user-provided or auto-generated as torrust-tracker-vm-{env_name}

provider_config: ProviderConfig

Provider-specific configuration (LXD, Hetzner, etc.)

ssh_credentials: SshCredentials

SSH credentials for remote access to the deployed instance

ssh_port: u16

SSH port for remote connections (typically 22)

tracker_config: TrackerConfig

Tracker application configuration

prometheus_config: Option<PrometheusConfig>

Optional Prometheus monitoring configuration

grafana_config: Option<GrafanaConfig>

Optional Grafana dashboard configuration

Note: Requires prometheus_config to be set (validated in Environment::create())

https_config: Option<HttpsConfig>

Optional HTTPS/TLS configuration for secure endpoints

backup_config: Option<BackupConfig>

Optional backup service configuration

Implementations

impl EnvironmentParams

pub fn new( environment_name: EnvironmentName, instance_name: InstanceName, provider_config: ProviderConfig, ssh_credentials: SshCredentials, ssh_port: u16, tracker_config: TrackerConfig, prometheus_config: Option<PrometheusConfig>, grafana_config: Option<GrafanaConfig>, https_config: Option<HttpsConfig>, backup_config: Option<BackupConfig>, ) -> Self

Creates a new EnvironmentParams instance

This constructor is primarily used in domain tests. In production, EnvironmentParams is typically constructed via TryFrom conversion from a configuration DTO in the application layer.

Arguments

• environment_name - Validated environment name
• instance_name - Validated instance name
• provider_config - Provider configuration
• ssh_credentials - SSH access credentials
• ssh_port - SSH port number
• tracker_config - Tracker application configuration
• prometheus_config - Optional Prometheus configuration
• grafana_config - Optional Grafana configuration
• https_config - Optional HTTPS configuration
• backup_config - Optional backup configuration

Trait Implementations

impl Clone for EnvironmentParams

fn clone(&self) -> EnvironmentParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EnvironmentParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TryFrom<EnvironmentCreationConfig> for EnvironmentParams

fn try_from(config: EnvironmentCreationConfig) -> Result<Self, Self::Error>

Converts DTO configuration to validated domain parameters

This performs all validation and type conversion from string-based DTO fields to strongly-typed domain objects.

Validation

• Environment name must follow naming rules
• Instance name (if provided) must follow instance naming rules
• Provider config must be valid (e.g., valid profile name for LXD)
• SSH username must follow Linux username requirements
• SSH key files must exist and be accessible
• SSH key paths must be absolute

Instance Name Auto-Generation

If instance_name is not provided in the configuration, it will be auto-generated using the format: torrust-tracker-vm-{env_name}

Errors

Returns CreateConfigError if any validation fails. All error variants implement .help() with detailed troubleshooting guidance.

type Error = CreateConfigError

The type returned in the event of a conversion error.