StackStorm / StackStorm/st2

Add pty Support for core.remote Action

Open
#5,826 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I want to be able to request a pty for the core.remote action. I can not currently get a pty through the core.remote though ssh config changes due to paramiko not honoring OpenSSH config files.

I also tried using the ssh_runner's use_ssh_config and ssh_config_file_path with RequestTTY force. This lead me to realize that the OpenSSH config was not honored through the remote shell runner either.

So I propose that we could add something to the args of run of paramiko_ssh to be passed to Line 406 so that we can then call this method with a force_pty argument.

This is my first time looking to contribute to this project so I apologize if I am missing something quite obvious here.

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

Start in st2common/st2common/runners/paramiko_ssh.py around lines 379 and 406, then trace how the core.remote action passes arguments to the SSH runner. Confirm how the requested pty option should flow through the runner and verify that core.remote can request a pty despite the OpenSSH configuration limitation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.