H2h2o
H2OEngineProfileService

Updates a H2OEngineProfile.

patch/v1/{h2oEngineProfile.name}

Request

Path parameters

h2oEngineProfile.namestring required

Output only. Resource name. Format: workspaces//h2oEngineProfiles/

Query parameters

updateMaskstring required

Required. The list of paths referencing which fields to update. Update mask must be non-empty.

Allowed field paths are:

  • display_name
  • priority
  • disabled
  • assigned_oidc_roles
  • max_running_engines
  • node_count_constraint
  • cpu_constraint
  • gpu_constraint
  • memory_bytes_constraint
  • max_idle_duration_constraint
  • max_running_duration_constraint
  • yaml_pod_template_spec
  • yaml_gpu_tolerations
  • gpu_resource_name
  • java_classpath
  • java_options
  • h2o_options

Paths are case sensitive (must match exactly).

To update all allowed fields, specify exactly one path with value "*".

Request body

displayNamestring

Optional. Human-readable name.

priorityinteger

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

enabledboolean

Optional. When set to true, the H2OEngineProfile is enabled and can be used in an H2OEngine. When set to false, the H2OEngineProfile is disabled and cannot be used in any H2OEngine.

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 H2OEngineProfile.

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 H2OEngines per user that can be running when using this H2OEngineProfile.

yamlPodTemplateSpecstring

When specified, then it is applied for each H2OEngine that uses this profile. PodTemplateSpec describes what will be applied on top of a regular H2O pod before it is created. This template is merged into H2O 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 H2O 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 H2OEngine that uses this profile. GPUTolerations sets H2O's pod.spec.tolerations in case H2OEngine 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 H2O 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 H2OEngineProfile was created.

updateTimestring date-time nullable

Output only. Time when the H2OEngineProfile was last updated.

creatorstring

Output only. Name of entity that created the H2OEngineProfile.

updaterstring

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

creatorDisplayNamestring

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

updaterDisplayNamestring

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

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.

javaClasspathstring

Optional. Extra Java classpath for H2OEngine.

javaOptionsstring
h2oOptionsstring

Response

A successful response.

Changes

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