Jupyter Ui

Learn about configurations >

• affinity-options | string

  Default: []

  The Affinity configurations that are selectable by users in the New Notebook UI when creating a Notebook. Input is in JSON/YAML in the format defined by Kubeflow in: https://github.com/kubeflow/kubeflow/blob/master/components/crud-web-apps/jupyter/manifests/base/configs/spawner_ui_config.yaml Each item in the list should have keys:

  • configKey: an arbitrary key for the configuration
  • displayName: the name to be shown in the UI
  • affinity: the affinity configuration, as defined by Kubernetes: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/

• affinity-options-default | string

  The Affinity options that is selected by default in the New Notebook UI when creating a Notebook. This must be one of the configKey values from the affinity-options config. Leave as an empty string to select no affinity by default

• backend-mode | string

  Default: production

  Which mode out of development or production the backend server should use

• default-poddefaults | string

  Default: ["access-ml-pipeline"]

  The PodDefaults that are selected by default in the New Notebook UI when creating a new Notebook. Inputs is a JSON/YAML list of the names of the PodDefaults. The New Notebook UI will always show all PodDefaults available to the user - this only defines which PodDefaults are selected by default.

• gpu-number-default | int

  The number of GPUs that are selected by default in the New Notebook UI when creating a Notebook.

• gpu-vendors | string

  Default: [{"limitsKey": "nvidia.com/gpu", "uiName": "NVIDIA"}, {"limitsKey": "amd.com/gpu", "uiName": "AMD"}, {"limitsKey": "habana.ai/gaudi", "uiName": "Intel Gaudi"}]

  The GPU vendors that are selectable by users in the New Notebook UI when creating a Notebook. Input is in JSON/YAML in the format defined by Kubeflow in: https://github.com/kubeflow/kubeflow/blob/master/components/crud-web-apps/jupyter/manifests/base/configs/spawner_ui_config.yaml Each item in the list should have keys:

  • limitsKey: the key that corresponds to the GPU vendor resource in Kubernetes
  • uiName: the name to be shown in the UI

• gpu-vendors-default | string

  The GPU vendor that is selected by default in the New Notebook UI when creating a Notebook. This must be one of the limitsKey values from the gpu-vendors config. Leave as an empty string to select no GPU vendor by default

• jupyter-images | string

  List of image options for Jupyter Notebooks. You can see the current default values in the following yaml: https://github.com/canonical/notebook-operators/blob/main/charms/jupyter-ui/src/default-jupyter-images.yaml To update the default images, follow https://documentation.ubuntu.com/charmed-kubeflow/how-to/manage/configure-notebook-page/#configure-images-list

• port | int

  Default: 5000

  HTTP port

• rstudio-images | string

  List of image options for RStudio. You can see the current default values, values in the following yaml: https://github.com/canonical/notebook-operators/blob/main/charms/jupyter-ui/src/default-rstudio-images.yaml To update the default images, follow https://documentation.ubuntu.com/charmed-kubeflow/how-to/manage/configure-notebook-page/#configure-images-list

• secure-cookies | boolean

  Whether cookies should require HTTPS

• tolerations-options | string

  Default: []

  The Toleration configurations that are selectable by users in the New Notebook UI when creating a Notebook. Input is in JSON/YAML in the format defined by Kubeflow in: https://github.com/kubeflow/kubeflow/blob/master/components/crud-web-apps/jupyter/manifests/base/configs/spawner_ui_config.yaml Each item in the list should have keys:

  • groupKey: an arbitrary key for the configuration
  • displayName: the name to be shown in the UI
  • tolerations: a list of Kubernetes tolerations, as defined in: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/

• tolerations-options-default | string

  The Tolerations configuration that is selected by default in the New Notebook UI when creating a Notebook. This must be one of the groupKey values from the tolerations-options config. Leave as an empty string to select no tolerations configuration by default

• ui | string

  Default: default

  Which UI to use

• url-prefix | string

  Default: /jupyter

  URL prefix for HTTP requests

• vscode-images | string

  List of image options for VSCode. You can see the current default values, values in the following yaml: https://github.com/canonical/notebook-operators/blob/main/charms/jupyter-ui/src/default-vscode-images.yaml To update the default images, follow https://documentation.ubuntu.com/charmed-kubeflow/how-to/manage/configure-notebook-page/#configure-images-list