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

response to Hera ticket #376

Closed
wants to merge 5 commits into from
Closed

response to Hera ticket #376

wants to merge 5 commits into from

Conversation

elisabethpatterson
Copy link
Contributor

This is the first step in a fix to the Port Tunnelling instructions. This PR adds a small item. Second step will be to move a block of text from here to the Connections section.

josh-eisinger
josh-eisinger previously approved these changes Feb 5, 2025
Copy link
Contributor

@josh-eisinger josh-eisinger left a comment

Choose a reason for hiding this comment

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

My comment is pretty trivial, so, unless some other issue comes up, I'm fine for that conversation to be closed out and for this change to go in as-is...


In the steps below, replace First.Last with your own HPC username, and
XXXXX with the unique Local Port Number assigned to you when you log
in to your specified HPC system (Hera/Jet). Use the word "localhost"
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we only be listing Hera & Jet when this is part of the main site FAQ?

Copy link
Contributor

Choose a reason for hiding this comment

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

This was one of the concerns but leaving it too generic also can be problematic. I am ok with leaving it out. Alternatively we can do something like:

"... specified HPC system (Hera/Jet/etc)?

Before you perform the first step, close all current sessions on the
HPC where system you are trying to connect. Once the first session has
been opened with port forwarding, any further connections (login via
ssh, copy via scp) will work as expected. You are running these
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd recommend putting ssh and scp in double tick-marks so they appear as commands

**1. Find your local port number**

To find your unique local port number, log onto your specified HPC
system (Hera/Jet). Make a note of this number - once you've recorded
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, this is the primary site FAQ -- I don't think we should explicitly be referencing only Hera/Jet.


.. code-block:: shell

ssh -m [email protected] -L1234e:localhost:12345 [email protected]
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we be putting an explicit hera reference here? Or can we follow similar logic to the https://docs.rdhpcs.noaa.gov/connecting/index.html page (and possibly link to the https://docs.rdhpcs.noaa.gov/connecting/index.html#bastion-hostnames table?)


.. code-block:: shell

ssh -L12345:localhost:12345 [email protected]
Copy link
Contributor

Choose a reason for hiding this comment

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

Again, explicit hera reference.


.. code-block:: shell

ssh -X -L12345:localhost:12345 [email protected]
Copy link
Contributor

Choose a reason for hiding this comment

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

Hera

Note that objects emphasized in this figure should be unique to your
configuration:

.. image:: /images/linux_xfer2.png
Copy link
Contributor

Choose a reason for hiding this comment

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

This image has a "real" user name (Nikki.Ivie) -- should probably be First.Last (and maybe just do a code snippet rather than an image?)

**Local Client Window #2**

Once the session is open, you can use this forwarded port
for data transfers, as long as this ssh window is kept open. After the
Copy link
Contributor

Choose a reason for hiding this comment

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

That 2nd sentence is also a repeat from earlier. Do we need it again here?

**Configuration**

Enter host information to configure an SSH Terminal Session. The
example below defines a session to Jet via the Boulder Bastion:
Copy link
Contributor

Choose a reason for hiding this comment

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

The image doesn't actually show a Jet connection -- it has a blank host name.


* Find and record your Local Host number.

.. image:: /images/linux_xfer1.png
Copy link
Contributor

Choose a reason for hiding this comment

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

This is duplicated from above. Can we restructure this so we don't have repeated info?

@elisabethpatterson
Copy link
Contributor Author

Superceeded by #386 and #LFS-1

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.

3 participants