Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation on bastion ssh configs to use the proxycommand values #965

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

eedgar
Copy link

@eedgar eedgar commented Mar 9, 2020

No description provided.

ssh_config_file_path = /home/stanley/.ssh/config
ssh_config_file_path = /root/.ssh/config

Make sure your ssh config is in the same account as user running the st2action process. If root is running
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may wish to point out that for many users this will be Stanley. CC @armab

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was testing against the docker-stackstorm checkout... if prod is running the daemon than changing the owner for all files to stanley makes sense. You may want to still include that the docker all in run runs as root or keep it running as the staction command owner.

docs/source/troubleshooting/ssh.rst Outdated Show resolved Hide resolved
Copy link
Member

@arm4b arm4b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initially this looks like a SSH troubleshooting doc.

Wouldn't it be better to include anything related to custom bastion SSH config in a separated sub-topic or even another page?

@punkrokk Do you think we have a better place for such configuration example?

@punkrokk
Copy link
Member

@armab I'm not opposed to this. Let's see what happens with the PR (StackStorm/st2#4881) and then we can update and make it happen.


This is a sample ssh config that is known to work with bastion forwarding.

.. code-block:: ini
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub's Linguist project supports syntax highlighting for SSH (client) configs, but you have to mark it as ssh-config:

Suggested change
.. code-block:: ini
.. code-block:: ssh-config

SSH (client) config coloring screenshot

And while you are at it, could you also fix this for line 160?

Leave line 84 alone though, since /etc/st2/st2.conf is just an INI file and is correctly marked as such. 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just pushed a fix for this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah. We can't use ssh-config because this Sphinx uses pygments, not GitHub's linguist. So ini is the way to go.

@cognifloyd
Copy link
Member

I just reworded some of the prose about bastion forwarding. Hopefully it fits better in the troubleshooting section now. If not, I'm not sure where else it might go.
@armab and @punkrokk What do you think, is this good to merge now?

We are using sphinx which uses pygments. pygments does not support
ssh-config format. github/linguist does, but that does not help us.
@CLAassistant
Copy link

CLAassistant commented May 11, 2022

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ eedgar
✅ cognifloyd
❌ LindsayHill
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants