0.0.0+develop

flytekitplugins.slurm.ssh_utils

Utilities of asyncssh connections.

Directory

Classes

Class Description
SSHConfig A customized version of SSHClientConnectionOptions, tailored to specific needs.
SlurmCluster A Slurm cluster instance is defined by a pair of (Slurm host, username).

Methods

Method Description
get_ssh_conn() Get an existing SSH connection or create a new one if needed.
ssh_connect() Make an SSH client connection.

Variables

Property Type Description
SLURM_PRIVATE_KEY str
T TypeVar

Methods

get_ssh_conn()

def get_ssh_conn(
    ssh_config: typing.Dict[str, typing.Union[str, typing.List[str], typing.Tuple[str, ...]]],
    slurm_cluster_to_ssh_conn: typing.Dict[flytekitplugins.slurm.ssh_utils.SlurmCluster, asyncssh.connection.SSHClientConnection],
) -> typing.Tuple[flytekitplugins.slurm.ssh_utils.SlurmCluster, asyncssh.connection.SSHClientConnection]

Get an existing SSH connection or create a new one if needed.

Parameter Type
ssh_config typing.Dict[str, typing.Union[str, typing.List[str], typing.Tuple[str, ...]]]
slurm_cluster_to_ssh_conn typing.Dict[flytekitplugins.slurm.ssh_utils.SlurmCluster, asyncssh.connection.SSHClientConnection]

ssh_connect()

def ssh_connect(
    ssh_config: typing.Dict[str, typing.Any],
) -> asyncssh.connection.SSHClientConnection

Make an SSH client connection.

Parameter Type
ssh_config typing.Dict[str, typing.Any]

flytekitplugins.slurm.ssh_utils.SSHConfig

A customized version of SSHClientConnectionOptions, tailored to specific needs.

This config is based on the official SSHClientConnectionOptions but includes only a subset of options, with some fields adjusted to be optional or required. For the official options, please refer to: https://asyncssh.readthedocs.io/en/latest/api.html#asyncssh.SSHClientConnectionOptions

Attributes: host (str): The hostname or address to connect to. username (Optional[str]): The username to authenticate as on the server. client_keys (Union[str, List[str], Tuple[str, …]]): File paths to private keys which will be used to authenticate the client via public key authentication. The default value is an empty tuple since client public key authentication is mandatory.

class SSHConfig(
    host: str,
    username: typing.Optional[str],
    client_keys: typing.Union[str, typing.List[str], typing.Tuple[str, ...]],
)
Parameter Type
host str
username typing.Optional[str]
client_keys typing.Union[str, typing.List[str], typing.Tuple[str, ...]]

Methods

Method Description
from_dict()
to_dict()

from_dict()

def from_dict(
    ssh_config: typing.Dict[str, typing.Any],
) -> ~T
Parameter Type
ssh_config typing.Dict[str, typing.Any]

to_dict()

def to_dict()

flytekitplugins.slurm.ssh_utils.SlurmCluster

A Slurm cluster instance is defined by a pair of (Slurm host, username).

Attributes: host (str): The hostname or address to connect to. username (Optional[str]): The username to authenticate as on the server.

class SlurmCluster(
    host: str,
    username: typing.Optional[str],
)
Parameter Type
host str
username typing.Optional[str]