StackStorm / StackStorm/st2

(Feature request) Enable to set "ServerAliveInterval" configuration for ParamikoSSHClient

Open
#5,511 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stale
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

I hope ParamikoSSHClient would be expanded to be able to set following configurations from the SSH client's configuration file, which is specified at ssh_runner.ssh_config_file_path in the st2.conf.

  1. ServerAliveInterval
  2. ServerAliveCountMax (But, unfortunately, Paramiko hasn't implemented feature that is equivalent with this option yet, according to this issue)

These (especially for "ServerAliveInterval") are necessary for the use-case that is difficult to change the sshd configuration on the host(s) that core.remote targets and channel quality is not steady between them.

(Related PR: https://github.com/StackStorm/st2/pull/4661)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the ParamikoSSHClient implementation and the handling of ssh_runner.ssh_config_file_path, then review the related PR #4661 for prior context. Verify how ServerAliveInterval and the unavailable ServerAliveCountMax option are represented by Paramiko; done means the supported configuration can be read from the specified SSH client configuration file and covered by the project's relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
networking
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.