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.

Sign up for GitHub

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 ssh info #340

Draft
wants to merge 5 commits into
base: develop
Choose a base branch
from
Draft

Update ssh info #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ee97896
updated getting ssh info docs
grallewellyn Sep 27, 2023
ac603a7
small wording changes for uploading an ssh key
grallewellyn Oct 18, 2023
eeba49c
added recommendation bit depth
grallewellyn Dec 7, 2023
f759c73
Merge branch 'develop' of github.com:MAAP-Project/maap-documentation …
grallewellyn Oct 1, 2024
81687c0
Merge branch 'develop' into update-ssh-info
grallewellyn Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/source/_static/ssh_1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/ssh_2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 11 additions & 6 deletions docs/source/system_reference_guide/ssh.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
Copy link
Collaborator

@wildintellect wildintellect Oct 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Are these instructions correct. While they work I thought the preferred way was to upload your public key to the gitlab instance and manage from there?

Should we link to more univeral instructions on generating a key? Do we need to suggest a minimum bit depth of 2048 (perhaps 4096 would be better)

The mounting instructions should come at the end. Also this doesn't mention use of SFTP (via SCP or other clients like Filezilla) for doing file transfers without mounts.


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not sure about the preferred way to upload your public key. I tried this method for uploading an ssh key to ops and it didn't work but it worked for a uwg member. These steps worked on DIT for me. I just tried uploading my ssh key to the maap gitlab instance and launching ops ade, but this still doesn't work
Screenshot 2023-10-18 at 10 30 53 AM

I just kept the same instructions on generating a key as before. How can we make it more universal? The instructions are for UNIX, UNIX-like and Windows

I am fine with suggesting 4096 for minimum bit depth

I am not sure the instructions for mounting or SFTP

Copy link
Collaborator

Choose a reason for hiding this comment

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

These instructions are pretty old. I feel like I copied at least some of this from Alexey's quickstart guide, and maybe some was in ReadtheDocs before that? I don't mind overhauling this a bit if we need to.

I think demonstrating easier ways to move files in/out of your workspace would be helpful.

I think that whatever we suggest in the docs could become the standard. I don't know anything about putting the public key into Gitlab. Maybe this is a good dev team topic to work out what we want to standardize on.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe we can discuss at hackathon on 10/25

Copy link
Collaborator

Choose a reason for hiding this comment

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

Any update? I know there were some recent fixes to the process by @bsatoriu @sujen1412

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bsatoriu thinks our minimum bit depth is 512, and also doesn't have a preference suggesting 2048 over 4096

Brian also fixed some bugs that are going to be released in January, I can test uploading my public key via the portal once these changes are released and then modify the docs from there (one of the bugs was uploading the public key to the MAAP portal)
Screenshot 2023-12-06 at 4 01 38 PM

Copy link
Collaborator

@wildintellect wildintellect Dec 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Min bit depth should be 2048, 1024 and lower are brute force hackable (I forget if it's both DSA and RSA or just one). Maybe just say recommended is 4096

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, just added bit depth recommendation

"## SSH into Workspace\n",
"\n",
"As an alternative to using the jupyter interface, you can SSH directly into the container that your workspace set up. In order to get the IP and port information, navigate to the command palette of the jupyter interface. Find the command `Display SSH Info`, which will display the information you need (you can easily search for SSH). Your public SSH key that you added to your account will be added to any workspace you create. If you did not upload an SSH key to your profile, you will not be able to SSH in and must use the jupyter interface.\n",
"As an alternative to using the jupyter interface, you can SSH directly into the container that your workspace set up. In order to get the IP and port information, navigate to the command palette of the jupyter interface. Find the command `Display SSH Info`, which will display the information you need (you can easily search for SSH). Your public SSH key that you added to your account will be added to any workspace you create. If you did not upload an SSH key to your profile, you will not be able to SSH in and must use the jupyter interface. See steps below for uploading an SSH key. \n",
"\n",
"![ssh workspace 1](../_static/ssh_1.png)\n",
"\n",
Expand All @@ -20,13 +20,13 @@
"source": [
"### Accessing MAAP workspaces over SSH\n",
"\n",
"If you would like to have your MAAP workspace mounted (via SSH) on your local computer, follow these steps. It is completely optional and if you do not know why you would want this, feel free to skip this part of the Getting Started Guide.\n",
"If you would like to have your MAAP workspace mounted (via SSH) on your local computer, follow these steps. It is completely optional and if you do not know why you would want this, feel free to skip this part.\n",
"\n",
"Basically, this works the same as on any unix-based system: You need to add your Public SSH key from your computer/laptop to the `~/.ssh/authorized_keys` file in MAAP, as described below.\n",
"\n",
"#### Generate a Public SSH Key\n",
"\n",
"First, you need an SSH key for your personal machine. Here are [example instructions for creating an SSH key](https://docs.oracle.com/en/cloud/cloud-at-customer/occ-get-started/generate-ssh-key-pair.html). Note that there are different instructions for Windows and unix-based systems (MacOS, Linux). The outcome of this will be a Public SSH key on your local computer.\n",
"First, you need an SSH key for your personal machine. Here are [example instructions for creating an SSH key](https://docs.oracle.com/en/cloud/cloud-at-customer/occ-get-started/generate-ssh-key-pair.html). Note that there are different instructions for Windows and unix-based systems (MacOS, Linux). We recommend 4096 bit depth. The outcome of this will be a Public SSH key on your local computer.\n",
"\n",
"#### Add the Public SSH Key to MAAP\n",
"\n",
Expand All @@ -45,7 +45,7 @@
"7. Repeat these steps to add more SSH keys from different machines.\n",
" - Note that, to see the `.ssh` folder from JupyterLab, you’ll need to temporarily rename it to `ssh`. The only way to do this is via the terminal — `mv .ssh ssh`. Don’t forget to rename it back to `.ssh` when you’re done!\n",
"\n",
"To access a MAAP workspace over SSH, you will need a workspace-specific IP address and port. You can find this by going to the JupyterLab commands menu — the 4th button in the left panel of the Jupyter interface; shows a looking glass over a list; alternatively, press Control + Shift + C (Command + Shift + C on Mac) — and search for “SSH”. You’ll see “Display SSH Info”. Click this button. A dialog box with the correct SSH command will appear.\n",
"To access a MAAP workspace over SSH, you will need a workspace-specific IP address and port. You can find this by going to View -> Activate Command Palette; alternatively, press Control + Shift + C (Command + Shift + C on Mac) — and search for \"Display SSH Info\". Click this button. A dialog box with the correct SSH command will appear.\n",
"\n",
"#### Uploading your public SSH key \n",
"\n",
Expand All @@ -66,7 +66,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3.11.1 64-bit",
"language": "python",
"name": "python3"
},
Expand All @@ -80,7 +80,12 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.8"
"version": "3.11.1"
},
"vscode": {
"interpreter": {
"hash": "5c7b89af1651d0b8571dde13640ecdccf7d5a6204171d6ab33e7c296e100e08a"
}
}
},
"nbformat": 4,
Expand Down