Struct SshCredentials 

pub struct SshCredentials {
    pub ssh_priv_key_path: PathBuf,
    pub ssh_pub_key_path: PathBuf,
    pub ssh_username: Username,
}

SSH credentials for remote instance authentication.

Contains the static SSH authentication information that is known at program startup, before any instances are provisioned.

Fields

ssh_priv_key_path: PathBuf

Path to the SSH private key file for remote connections.

This key will be used by the SSH client to authenticate with remote instances created during deployment. The corresponding public key should be authorized on the target instances.

ssh_pub_key_path: PathBuf

Path to the SSH public key file for remote connections.

This public key will be used for authorization on target instances during the deployment process, typically injected into cloud-init configurations or authorized_keys files.

ssh_username: Username

Username for SSH connections to remote instances.

This username will be used when establishing SSH connections to deployed instances. Common values include “ubuntu”, “root”, or “torrust”.

Implementations

impl SshCredentials

pub fn new( ssh_priv_key_path: PathBuf, ssh_pub_key_path: PathBuf, ssh_username: Username, ) -> Self

Creates new SSH credentials with the provided parameters.

use torrust_tracker_deployer_lib::adapters::ssh::SshCredentials;
let credentials = SshCredentials::new(
    PathBuf::from("/home/user/.ssh/deploy_key"),
    PathBuf::from("/home/user/.ssh/deploy_key.pub"),
    Username::new("ubuntu").unwrap(),
);

Trait Implementations

impl Clone for SshCredentials

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 SshCredentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SshCredentials

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SshCredentials

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SshCredentialsConfig> for SshCredentials

type Error = CreateConfigError

The type returned in the event of a conversion error.

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

Performs the conversion.