Struct UserInputs 

pub struct UserInputs { /* private fields */ }

User-provided configuration when creating an environment

This struct contains all fields that are provided by the user when creating an environment. These fields are immutable throughout the environment lifecycle and represent the user’s configuration choices.

Cross-Service Invariants

The following invariants are validated at construction time:

• Grafana requires Prometheus: If Grafana is enabled, Prometheus must also be enabled
• HTTPS requires TLS services: If HTTPS section is present, at least one service must have TLS
• TLS requires HTTPS: If any service has TLS, HTTPS section must be present

Examples

use torrust_tracker_deployer_lib::domain::{InstanceName, EnvironmentName, ProfileName};
use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig};
use torrust_tracker_deployer_lib::domain::environment::user_inputs::UserInputs;
use torrust_tracker_deployer_lib::domain::tracker::TrackerConfig;
use torrust_tracker_deployer_lib::domain::prometheus::PrometheusConfig;
use torrust_tracker_deployer_lib::domain::grafana::GrafanaConfig;
use torrust_tracker_deployer_lib::shared::Username;
use torrust_tracker_deployer_lib::adapters::ssh::SshCredentials;
use std::path::PathBuf;

let provider_config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("torrust-profile-production".to_string())?,
});
let ssh_credentials = SshCredentials::new(
    PathBuf::from("keys/prod_rsa"),
    PathBuf::from("keys/prod_rsa.pub"),
    Username::new("torrust".to_string())?,
);
let env_name = EnvironmentName::new("production".to_string())?;

// Create with defaults (includes Prometheus and Grafana)
let user_inputs = UserInputs::new(&env_name, provider_config, ssh_credentials, 22)?;

assert_eq!(user_inputs.name().as_str(), "production");
assert!(user_inputs.prometheus().is_some());
assert!(user_inputs.grafana().is_some());

Implementations

impl UserInputs

pub fn new( name: &EnvironmentName, provider_config: ProviderConfig, ssh_credentials: SshCredentials, ssh_port: u16, ) -> Result<Self, UserInputsError>

Creates a new UserInputs with auto-generated instance name and default services

Creates a UserInputs with default tracker configuration, Prometheus, and Grafana enabled. This is the standard setup for most deployments.

Arguments

• name - The validated environment name
• provider_config - Provider-specific configuration
• ssh_credentials - SSH credentials for connecting to instances
• ssh_port - SSH port for connecting to instances

Returns

A new UserInputs with:

• Auto-generated instance name: torrust-tracker-vm-{env_name}
• Default tracker configuration
• Prometheus and Grafana enabled (satisfies cross-service invariants)

Errors

This constructor with defaults cannot fail because the default configuration (Prometheus + Grafana, no HTTPS) always satisfies cross-service invariants.

Examples

use torrust_tracker_deployer_lib::domain::environment::{EnvironmentName, UserInputs};
use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig, Provider};
use torrust_tracker_deployer_lib::domain::ProfileName;
use torrust_tracker_deployer_lib::shared::Username;
use torrust_tracker_deployer_lib::adapters::ssh::SshCredentials;
use std::path::PathBuf;

let env_name = EnvironmentName::new("production".to_string())?;
let ssh_username = Username::new("torrust".to_string())?;
let ssh_credentials = SshCredentials::new(
    PathBuf::from("keys/prod_rsa"),
    PathBuf::from("keys/prod_rsa.pub"),
    ssh_username,
);
let provider_config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("torrust-profile-production".to_string())?,
});

let user_inputs = UserInputs::new(&env_name, provider_config, ssh_credentials, 22)?;

assert_eq!(user_inputs.instance_name().as_str(), "torrust-tracker-vm-production");
assert_eq!(user_inputs.provider(), Provider::Lxd);

pub fn with_tracker( name: &EnvironmentName, provider_config: ProviderConfig, ssh_credentials: SshCredentials, ssh_port: u16, tracker: TrackerConfig, prometheus: Option<PrometheusConfig>, grafana: Option<GrafanaConfig>, https: Option<HttpsConfig>, backup: Option<BackupConfig>, ) -> Result<Self, UserInputsError>

Creates a new UserInputs with custom tracker and service configuration

This constructor allows full control over all service configurations. Cross-service invariants are validated at construction time.

Arguments

• name - The validated environment name
• provider_config - Provider-specific configuration
• ssh_credentials - SSH credentials for connecting to instances
• ssh_port - SSH port for connecting to instances
• tracker - Tracker deployment configuration
• prometheus - Optional Prometheus configuration
• grafana - Optional Grafana configuration (requires Prometheus)
• https - Optional HTTPS/TLS configuration (requires TLS services)
• backup - Optional backup configuration

Errors

• GrafanaRequiresPrometheus if Grafana is configured without Prometheus
• HttpsSectionWithoutTlsServices if HTTPS section exists but no service uses TLS
• TlsServicesWithoutHttpsSection if a service uses TLS but HTTPS section is missing

pub fn name(&self) -> &EnvironmentName

Returns the environment name

pub fn instance_name(&self) -> &InstanceName

Returns the instance name

pub fn ssh_credentials(&self) -> &SshCredentials

Returns the SSH credentials

pub fn ssh_port(&self) -> u16

Returns the SSH port

pub fn tracker(&self) -> &TrackerConfig

Returns the tracker configuration

pub fn prometheus(&self) -> Option<&PrometheusConfig>

Returns the Prometheus configuration if enabled

pub fn grafana(&self) -> Option<&GrafanaConfig>

Returns the Grafana configuration if enabled

pub fn https(&self) -> Option<&HttpsConfig>

Returns the HTTPS configuration if enabled

pub fn backup(&self) -> Option<&BackupConfig>

Returns the backup configuration if enabled

pub fn provider(&self) -> Provider

Returns the provider type for this environment

Examples

use torrust_tracker_deployer_lib::domain::environment::{EnvironmentName, UserInputs};
use torrust_tracker_deployer_lib::domain::provider::{ProviderConfig, LxdConfig, Provider};
use torrust_tracker_deployer_lib::domain::ProfileName;
use torrust_tracker_deployer_lib::shared::Username;
use torrust_tracker_deployer_lib::adapters::ssh::SshCredentials;
use std::path::PathBuf;

let env_name = EnvironmentName::new("test".to_string())?;
let ssh_credentials = SshCredentials::new(
    PathBuf::from("keys/test_rsa"),
    PathBuf::from("keys/test_rsa.pub"),
    Username::new("torrust".to_string())?,
);
let provider_config = ProviderConfig::Lxd(LxdConfig {
    profile_name: ProfileName::new("test-profile".to_string())?,
});

let user_inputs = UserInputs::new(&env_name, provider_config, ssh_credentials, 22)?;
assert_eq!(user_inputs.provider(), Provider::Lxd);

pub fn provider_config(&self) -> &ProviderConfig

Returns a reference to the provider configuration

Use this to access provider-specific fields. For example:

if let Some(lxd_config) = user_inputs.provider_config().as_lxd() {
    println!("LXD profile: {}", lxd_config.profile_name.as_str());
}

Trait Implementations

impl Clone for UserInputs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserInputs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserInputs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UserInputs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.