Skip to content

Deploy Data Job through the Jupyter UI

Yoan Salambashev edited this page Nov 20, 2023 · 4 revisions

Learn How to Prepare and Deploy a Data Job using VDK in Jupyter Notebook UI

Time Commitment: About 5-10 minutes.

Prerequisites

Before you start with the deployment, please ensure you have the following:

Python VDK distribution installed
  • VDK: Ensure that the Versatile Data Kit is installed and properly configured.
  • Control Service: Essential for orchestrating the execution of Data Jobs.
  • vdk-jupyterlab-extension: This extension integrates VDK with JupyterLab.
  • vdk-notebook: Allows the execution of VDK jobs with notebooks.
  • vdk-ipython: Loads VDK functionalities into IPython environments, allowing enhanced interaction.
Developed Data Job
  • Ensure that you have created and developed a VDK Data Job ready for deployment.

Make sure to have all prerequisites in place to avoid any disruptions during the deployment process.

Deploying a Job

This page assumes you have already created a job both locally and in the cloud and have developed the job.

0. Preparation

  • Ensure your Data Job is in a production-ready state. This means tagging all production cells as VDK cells and untagging any you do not want to be ran during the Data Job execution through the side menu shown in the image.

Example of how to tag cells in Jupyter

1. Deploying the Data Job

  • Navigate to the Data Job Directory

  • From the menu bar at the top, open the VDK section and select the 'Deploy' option.

VDK dropdown menu

2. Filling Deployment Information

  • Enter your job name, team, and describe the latest change to the job in the 'Deployment reason' section.
  • The path should be configured automatically if you have navigated to the job directory.
  • Note the tick box which specifies that the job will be ran once before deployment to test the job end-to-end and verify it can pass successfully before deploying it to the cloud.

VDK Deploy menu

3. Monitoring Deployment Status

  • The previous step will generate this status dialog, informing you that the deploy operation is running.

Status dialog

  • Additionally, you can track the time the operation takes by the status button in the upper right corner.

Status button

4. Deployment Successful

  • The following dialog will appear when the job deployment request has been successful. Note that the job will require a few minutes to be fully deployed.

Deployment Success Dialog

Wrap-Up

Congratulations! You have successfully learned how to prepare and deploy a Data Job using VDK in Jupyter Notebook UI. Ensure that you continually revisit the deployment procedure and maintain the Data Job for optimal results and performances.

What's Next?

You should now be familiarized with how to deploy a developed Data Job to the Control Service through the Jupyter UI.

You can explore the VDK Examples list here.

Clone this wiki locally