H2h2o
NotebookEngineProfileService

Creates a new NotebookEngineProfile.

post/v1/{parent}/notebookEngineProfiles

Request

Path parameters

parentstring required

Workspace resource name. Format: workspaces/{workspace}

Authorization may require the following permission on the profile's parent workspace:

  • actions/enginemanager/notebookEngineProfiles/CREATE

Query parameters

notebookEngineProfileIdstring required

Specify the NotebookEngineProfile ID, which will become a part of the NotebookEngineProfile resource name.

It must:

  • contain 1-63 characters
  • contain only lowercase alphanumeric characters or hyphen ('-')
  • start with an alphabetic character
  • end with an alphanumeric character

This matches a regular expression: ^a-z?$

Request body

namestring
displayNamestring

Optional. Human-readable name.

priorityinteger

Optional. Priority of the NotebookEngineProfile. Lower value means higher priority. Priority is NOT a unique value (any two NotebookEngineProfiles can have the same priority value).

enabledboolean

Optional. When set to true, the NotebookEngineProfile is enabled and can be used in NotebookEngine. When set to false, the NotebookEngineProfile is disabled and cannot be used in any NotebookEngine.

assignedOidcRolesEnabledboolean

Optional. When set to true, the assigned_oidc_roles field is verified when a user uses this profile.

assignedOidcRolesstring[]

Optional. List of OIDC roles assigned to this NotebookEngineProfile.

When profile has assigned some OIDC roles and verification of this list is enabled (assigned_oidc_roles_enabled=true), then this profile can be used only by users who have assigned at least one role from this list.

Example 1: assigned_oidc_roles = ["role1", "role2"]. This profile can be used only by users who have assigned either role1 or role2.

Example 2 (special case): assigned_oidc_roles = []. Empty list means that the profile has not assigned any OIDC role, therefore this profile cannot be used by any user.

maxRunningEnginesinteger nullable

Optional. Maximum number of NotebookEngines per user that can be running when using this NotebookEngineProfile.

yamlPodTemplateSpecstring

When specified, then it is applied for each NotebookEngine that uses this profile. PodTemplateSpec describes what will be applied on top of a regular Notebook pod before it is created. This template is merged into Notebook default pod using StrategicMergePatch method (it overrides the default pod). More info about StrategicMergePatch: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/

Example YAML value (custom annotation applied for each Notebook pod): metadata: annotations: custom-key: custom-value

An empty string "" means unset (no PodTemplateSpec is applied).

yamlGpuTolerationsstring

When specified, then it is applied for each NotebookEngine that uses this profile. GPUTolerations sets Notebook's pod.spec.tolerations in case NotebookEngine has GPU > 0. This will override any tolerations defined in yaml_pod_template_spec.PodSpec.Tolerations field.

Example YAML value (two GPU tolerations applied for each Notebook pod):

  • key: "dedicated" operator: "Equal" value: "gpu" effect: "NoSchedule"
  • key: "key2" operator: "Equal" value: "value2" effect: "NoSchedule"

An empty string "" means unset: the pod's tolerations are left untouched. An empty list "[]" explicitly clears the pod's tolerations. The literal "null" is not allowed.

createTimestring date-time

Output only. Time when the NotebookEngineProfile was created.

updateTimestring date-time nullable

Output only. Time when the NotebookEngineProfile was last updated.

creatorstring

Output only. Name of entity that created the NotebookEngineProfile.

updaterstring

Output only. Name of entity that last updated the NotebookEngineProfile.

creatorDisplayNamestring

Output only. Human-readable name of entity that created the NotebookEngineProfile.

updaterDisplayNamestring

Output only. Human-readable name of entity that last updated the NotebookEngineProfile.

storageClassNamestring

Optional. Name of the storage class used by NotebookEngine when using this profile. When unset, the default storage class of the k8s cluster will be used.

gpuResourceNamestring

Non-empty default. K8s GPU resource name. For example: nvidia.com/gpu or amd.com/gpu. When unset, server will choose a default value.

syncGitRepositoryEnabledboolean

Optional. Enables syncing of the git repository when NotebookEngine is created.

gitRepositorystring

Optional. The git repository to sync.

gitRefstring

Optional. The git revision (branch, tag, or hash) to check out. If not specified, this defaults to "HEAD" (of the upstream repo's default branch).

gitDirectoryNamestring

Optional. The name of the directory in the user's home folder, where the Git repo is synced into. Defaults to "Example".

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.