Skip to main content

Module config

Module config 

Source
Expand description

SSH configuration and management

This module provides the SshConfig struct which encapsulates all the information needed to establish an SSH connection to a remote host, including credentials and target host socket address.

§Key Components

  • Connection configuration combining credentials and target host socket address
  • Socket address management (IP address and port) for remote instances
  • Integration with SSH credentials for authentication

The connection configuration is used by SSH clients to establish secure connections for remote command execution.

Structs§

SshConfig
SSH connection configuration for a specific remote instance.
SshConnectionConfig
SSH connection behavior configuration

Constants§

DEFAULT_CONNECT_TIMEOUT_SECS
Default SSH connection timeout in seconds
DEFAULT_MAX_RETRY_ATTEMPTS
Default maximum number of connection retry attempts. Set to 60 to allow up to 300 seconds total wait time (60 attempts × 5 second interval). Cloud-init provisioning (user creation, SSH key injection) can take over 3 minutes on some providers and small machines, so a 5-minute budget is used as the default.
DEFAULT_RETRY_INTERVAL_SECS
Default retry interval in seconds
DEFAULT_RETRY_LOG_FREQUENCY
Default retry log frequency (log every N attempts)
DEFAULT_SSH_PORT
Default SSH port number.