diff --git a/docs/source/_static/ssh_1.png b/docs/source/_static/ssh_1.png index c7f48699..3480e369 100644 Binary files a/docs/source/_static/ssh_1.png and b/docs/source/_static/ssh_1.png differ diff --git a/docs/source/_static/ssh_2.png b/docs/source/_static/ssh_2.png index b30fc6e9..ca1dcd23 100644 Binary files a/docs/source/_static/ssh_2.png and b/docs/source/_static/ssh_2.png differ diff --git a/docs/source/system_reference_guide/ssh.ipynb b/docs/source/system_reference_guide/ssh.ipynb index ff3763c6..5d5df61d 100644 --- a/docs/source/system_reference_guide/ssh.ipynb +++ b/docs/source/system_reference_guide/ssh.ipynb @@ -6,7 +6,7 @@ "source": [ "## 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", @@ -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", @@ -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", @@ -66,7 +66,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3", + "display_name": "Python 3.11.1 64-bit", "language": "python", "name": "python3" }, @@ -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,