Configure a SSH Gateway to Use Local IDEs

Cloudera Data Science Workbench relies on the SSH functionality of the local IDEs to connect to the SSH endpoint on your local machine created with the cdswctl client. Users establish an SSH endpoint on their machine with the cdswctl client. This endpoint acts as the bridge that connects the IDE on your machine and the Cloudera Data Science Workbench deployment.

Configure and Use a Local IDE

The specifics for how to configure a local IDE to work with Cloudera Data Science Workbench are dependent on the local IDE you want to use. The following steps are a high-level description of the steps a user must complete:

  1. Establish an SSH endpoint with the cdswctl Command Line Interface Client.
  2. Configure the local IDE to use Cloudera Data Science Workbench as the remote interpreter.
  3. Optionally, sync files with tools (like mutagen, SSHFS, or the functionality built into your IDE) from Cloudera Data Science Workbench to your local machine. Ensure that you adhere to IT policies.
  4. Edit the code in the local IDE and run the code interactively on Cloudera Data Science Workbench.
  5. Sync the files you edited locally to Cloudera Data Science Workbench.
  6. Use the Cloudera Data Science Workbench web UI to perform actions such as deploying a model that uses the code you edited.

You can see an end-to-end example for PyCharm configuration here: Configure PyCharm as a Local IDE.