Merge pull request #1910 from Gkrumbach07/crd-descriptions

add descriptions to accelerator profile crd
opendatahub-io · Oct 17, 2023 · 1c39077 · 1c39077
2 parents e286221 + 6ca5fde
commit 1c39077
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/manifests/crd/acceleratorprofiles.opendatahub.io.crd.yaml b/manifests/crd/acceleratorprofiles.opendatahub.io.crd.yaml
@@ -28,27 +28,36 @@ spec:
               properties:
                 displayName:
                   type: string
+                  description: "The display name of the accelerator profile."
                 enabled:
                   type: boolean
+                  description: "Indicates whether the accelerator profile is available for new resources."
                 identifier:
                   type: string
+                  description: "The resource identifier of the accelerator device. Example: nvidia.com/gpu"
                 description:
                   type: string
+                  description: "A short description of the accelerator profile."
                 tolerations:
                   type: array
+                  description: "Any number of Kubernetes toleration values that are added to resources when created or updated to this accelerator profile."
                   items:
                     type: object
                     required:
                       - key
                     properties:
                       key:
                         type: string
+                        description: "Taint key. Empty matches all keys."
                       operator:
                         type: string
+                        description: "Relationship with the value. Valid: 'Exists', 'Equal'. Defaults to 'Equal'."
                       value:
                         type: string
+                        description: "Tolerance value. If key is empty, use 'Exists' to match all values and keys."
                       effect:
                         type: string
+                        description: "Taint effect. Empty matches all effects. Allowed: 'NoSchedule', 'PreferNoSchedule', 'NoExecute'."
                       tolerationSeconds:
                         type: integer
-
+                        description: "Duration in seconds. If effect is 'NoExecute', specifies eviction time. Default is forever."