PrimeHub
  • Introduction
  • Installation
  • Tiers and Licenses
  • End-to-End Tutorial
    • 1 - MLOps Introduction and Scoping the Project
    • 2 - Train and Manage the Model
    • 3 - Compare, Register and Deploy the Model
    • 4 - Build the Web Application
    • 5 - Summary
  • User Guide
    • User Portal
    • Notebook
      • Notebook Tips
      • Advanced Settings
      • PrimeHub Notebook Extension
      • Submit Notebook as Job
    • Jobs
      • Job Artifacts
      • Tutorial
        • (Part1) MNIST classifier training
        • (Part2) MNIST classifier training
        • (Advanced) Use Job Submission to Tune Hyperparameters
        • (Advanced) Model Serving by Seldon
        • Job Artifacts Simple Usecase
    • Models
      • Manage and Deploy Model
      • Model Management Configuration
    • Deployments
      • Pre-packaged servers
        • TensorFlow server
        • PyTorch server
        • SKLearn server
        • Customize Pre-packaged Server
        • Run Pre-packaged Server Locally
      • Package from Language Wrapper
        • Model Image for Python
        • Model Image for R
        • Reusable Base Image
      • Prediction APIs
      • Model URI
      • Tutorial
        • Model by Pre-packaged Server
        • Model by Pre-packaged Server (PHFS)
        • Model by Image built from Language Wrapper
    • Shared Files
    • Datasets
    • Apps
      • Label Studio
      • MATLAB
      • MLflow
      • Streamlit
      • Tutorial
        • Create Your Own App
        • Create an MLflow server
        • Label Dataset by Label Studio
        • Code Server
    • Group Admin
      • Images
      • Settings
    • Generate an PrimeHub API Token
    • Python SDK
    • SSH Server Feature
      • VSCode SSH Notebook Remotely
      • Generate SSH Key Pair
      • Permission Denied
      • Connection Refused
    • Advanced Tutorial
      • Labeling the data
      • Notebook as a Job
      • Custom build the Seldon server
      • PrimeHub SDK/CLI Tools
  • Administrator Guide
    • Admin Portal
      • Create User
      • Create Group
      • Assign Group Admin
      • Create/Plan Instance Type
      • Add InfuseAI Image
      • Add Image
      • Build Image
      • Gitsync Secret for GitHub
      • Pull Secret for GitLab
    • System Settings
    • User Management
    • Group Management
    • Instance Type Management
      • NodeSelector
      • Toleration
    • Image Management
      • Custom Image Guideline
    • Volume Management
      • Upload Server
    • Secret Management
    • App Settings
    • Notebooks Admin
    • Usage Reports
  • Reference
    • Jupyter Images
      • repo2docker image
      • RStudio image
    • InfuseAI Images List
    • Roadmap
  • Developer Guide
    • GitHub
    • Design
      • PrimeHub File System (PHFS)
      • PrimeHub Store
      • Log Persistence
      • PrimeHub Apps
      • Admission
      • Notebook with kernel process
      • JupyterHub
      • Image Builder
      • Volume Upload
      • Job Scheduler
      • Job Submission
      • Job Monitoring
      • Install Helper
      • User Portal
      • Meta Chart
      • PrimeHub Usage
      • Job Artifact
      • PrimeHub Apps
    • Concept
      • Architecture
      • Data Model
      • CRDs
      • GraphQL
      • Persistence Storages
      • Persistence
      • Resources Quota
      • Privilege
    • Configuration
      • How to configure PrimeHub
      • Multiple Jupyter Notebook Kernels
      • Configure SSH Server
      • Configure Job Submission
      • Configure Custom Image Build
      • Configure Model Deployment
      • Setup Self-Signed Certificate for PrimeHub
      • Chart Configuration
      • Configure PrimeHub Store
    • Environment Variables
Powered by GitBook
On this page
  • Enable SSH Server
  • Deploy Public key into JupyterHub
  • Practical Usecase - VSCode
  • Troubleshooting
  1. User Guide

SSH Server Feature

PreviousPython SDKNextVSCode SSH Notebook Remotely

Last updated 2 years ago

PrimeHub provides a feature of SSH Server that users are allowed to access into their own launched Notebook via SSH. A practical use-case is that users are able to use IDEs such as VSCode which has remote-ssh extension for the development remotely. In other words, it provides other possible development options for users who like to use rich-features IDEs instead.

Enable SSH Server

To activate SSH Server, administrators have to configure SSH Server of PrimeHub. Please contact administrators and see Configure SSH Server.

Before using this feature, you are required to have a public/private key pair, please go to SSH key generation to generate your own pair at local.

  1. Before starting a notebook, expand Show advanced settings and check Enable SSH Server.

  2. Hovering the cursor over the code block, copy the configuration by clicking the copy icon.

  3. Press Start Notebook to launch the JupyterHub.

  4. Go back to your local, edit the ~/.ssh/config with adding the copied configuration at your local. Make sure jupyter-<username> and ~/.ssh/id_rsa(private key) are correct according to your circumstance.

If you want to assign other private key, please change the path ~/.ssh/id_rsa in the configuration to the desired one. If your key requires passphrase, you may want to add into ssh-agent.

Deploy Public key into JupyterHub

After Notebook is launched,

In Notebook page, it shows the same instruction for the reference

  1. Drag-n-drop a public key (e.g. id_rsa.pub) from your local to the File Browser of the opened JupyterHub tab on browser.

  2. Open Terminal on Notebook, run the commands

    mkdir -p ~/.ssh
mv ~/id_rsa.pub ~/.ssh/authorized_keys

  3. Go back to your local, run the command for verification.

    ssh jupyter

    After SSH into the Notebook successfully, you should see the prompt:

    jovyan@jupyter-<your_username>:~$

Once the initial setup is completed, only step 1 is required for accessing Notebook via SSH.

Practical Usecase - VSCode

If you are familiar with VSCode, check our guide, VSCode + Remote-SSH.

Troubleshooting

If permission denied or connection refused occurs, please check our advices for troubleshooting.