Skip to content

Notebook SKU

During infrastructure setup, the administrator would have cloned compute and Jupyter notebook templates into our project. In this step, you will use the PaaS Admin portal to create and publish SKUs that will be made available to end users for self-service in the Developer Hub.

During the infrastructure setup step, the Org Administrator would have navigated to the "Template Catalog" and cloned the compute and Jupyter notebook templates into this project. In this step, you will use the PaaS Studio to create and publish a service profile (aka SKU) for Jupyter Notebooks that will be made immediately available to end users for self-service consumption via the Developer Hub.

You will create a Service Profile for a Jupyter Notebook that the user can deploy into a compute instance.

Overall Steps

Jupyter Notebook Service Profile

Let us now see how we can create a service profile for a Jupyter Notebook SKU. Our notebook needs to be deployed into a compute instance that the user will select during deployment.

  • Select Service Profiles and click on New Service Profile
  • Provide a unique name for the service
  • Select the environment template/version for the "Jupyter Notebook" from the dropdown (this would have been shared to your project by the admin)
  • For Service Type, select "notebook" (this will make sure that this gets tagged appropriately and will be displayed to the user under the Notebooks category)
  • Click to enable "Is compute required?"
  • Click on Save

Create New Service Profile for Notebook

User Input

Once the profile has been created, we have to decide what options we want to provide the end user.

  • Navigate to the "Input Settings" configuration section

  • Uncheck all checkboxes except for "Notebook Profile" under "Allow Override" (this ensures that the end user cannot change these settings)

  • Ensure "Rafay" is selected for "Ingress Domain"

  • In the "Ingress IP", enter the "Public IP" for the Kubernetes cluster's ingress controller

Input Settings

Info

For this exercise, for user convenience, the Rafay Platform will automatically setup DNS on a Rafay managed domain and point it to the IP address of the Kubernetes cluster.

Configure Outputs

The associated notebook template will automatically generate a number of output variables. Not all of them are useful for the end user. In the step below, we will configure and customize what we want to display to the end user after the notebook is deployed successfully.

  • Navigate to the "Output Settings" configuration section
  • Click "Add Output"

  • Enter"notebook_url" under "Name"

  • Click "Add Output"

  • Enter "token" under "Name"

Output Settings

  • Click "Save Changes

Review Notebook Profile

You should now have a published service profile for a Jupyter Notebook.

New Service Profile for Notebook

Admins can optionally check if the SKU is available for use by following the steps below.

  • In the left menu, click on Service Instances and click on New Service Instance
  • You should now see the newly created "notebook" SKU as an option.
  • Validate the input selectors presented to confirm if this is the expected experience for the end user.