-
-
Notifications
You must be signed in to change notification settings - Fork 170
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
base: master
Are you sure you want to change the base?
Conversation
docs/source/troubleshooting/ssh.rst
Outdated
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this 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?
@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 |
There was a problem hiding this comment.
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
:
.. code-block:: ini | |
.. code-block:: ssh-config |
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. 👍
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
We are using sphinx which uses pygments. pygments does not support ssh-config format. github/linguist does, but that does not help us.
|
No description provided.