nvidia.com_dynamomodels.yaml

# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.16.4
    helm.sh/resource-policy: keep
  name: dynamomodels.nvidia.com
spec:
  group: nvidia.com
  names:
    kind: DynamoModel
    listKind: DynamoModelList
    plural: dynamomodels
    shortNames:
      - dm
    singular: dynamomodel
  scope: Namespaced
  versions:
    - additionalPrinterColumns:
        - description: Base model name
          jsonPath: .spec.baseModelName
          name: BaseModel
          type: string
        - description: Model type
          jsonPath: .spec.modelType
          name: Type
          type: string
        - description: Ready endpoints
          jsonPath: .status.readyEndpoints
          name: Ready
          type: integer
        - description: Total endpoints
          jsonPath: .status.totalEndpoints
          name: Total
          type: integer
        - jsonPath: .metadata.creationTimestamp
          name: Age
          type: date
      name: v1alpha1
      schema:
        openAPIV3Schema:
          description: DynamoModel is the Schema for the dynamo models API
          properties:
            apiVersion:
              description: |-
                APIVersion defines the versioned schema of this representation of an object.
                Servers should convert recognized schemas to the latest internal value, and
                may reject unrecognized values.
                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
              type: string
            kind:
              description: |-
                Kind is a string value representing the REST resource this object represents.
                Servers may infer this from the endpoint the client submits requests to.
                Cannot be updated.
                In CamelCase.
                More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
              type: string
            metadata:
              type: object
            spec:
              description: DynamoModelSpec defines the desired state of DynamoModel
              properties:
                baseModelName:
                  description: |-
                    BaseModelName is the base model identifier that matches the service label
                    This is used to discover endpoints via headless services
                  type: string
                modelName:
                  description: ModelName is the full model identifier (e.g., "meta-llama/Llama-3.3-70B-Instruct-lora")
                  type: string
                modelType:
                  default: base
                  description: ModelType specifies the type of model (e.g., "base", "lora", "adapter")
                  enum:
                    - base
                    - lora
                    - adapter
                  type: string
                source:
                  description: Source specifies the model source location (only applicable for lora model type)
                  properties:
                    uri:
                      description: |-
                        URI is the model source URI
                        Supported formats:
                        - S3: s3://bucket/path/to/model
                        - HuggingFace: hf://org/model@revision_sha
                      type: string
                  required:
                    - uri
                  type: object
              required:
                - baseModelName
                - modelName
              type: object
            status:
              description: DynamoModelStatus defines the observed state of DynamoModel
              properties:
                conditions:
                  description: Conditions represents the latest available observations of the model's state
                  items:
                    description: Condition contains details for one aspect of the current state of this API Resource.
                    properties:
                      lastTransitionTime:
                        description: |-
                          lastTransitionTime is the last time the condition transitioned from one status to another.
                          This should be when the underlying condition changed.  If that is not known, then using the time when the API field changed is acceptable.
                        format: date-time
                        type: string
                      message:
                        description: |-
                          message is a human readable message indicating details about the transition.
                          This may be an empty string.
                        maxLength: 32768
                        type: string
                      observedGeneration:
                        description: |-
                          observedGeneration represents the .metadata.generation that the condition was set based upon.
                          For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
                          with respect to the current state of the instance.
                        format: int64
                        minimum: 0
                        type: integer
                      reason:
                        description: |-
                          reason contains a programmatic identifier indicating the reason for the condition's last transition.
                          Producers of specific condition types may define expected values and meanings for this field,
                          and whether the values are considered a guaranteed API.
                          The value should be a CamelCase string.
                          This field may not be empty.
                        maxLength: 1024
                        minLength: 1
                        pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
                        type: string
                      status:
                        description: status of the condition, one of True, False, Unknown.
                        enum:
                          - "True"
                          - "False"
                          - Unknown
                        type: string
                      type:
                        description: type of condition in CamelCase or in foo.example.com/CamelCase.
                        maxLength: 316
                        pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
                        type: string
                    required:
                      - lastTransitionTime
                      - message
                      - reason
                      - status
                      - type
                    type: object
                  type: array
                endpoints:
                  description: Endpoints is the current list of all endpoints for this model
                  items:
                    description: EndpointInfo represents a single endpoint (pod) serving the model
                    properties:
                      address:
                        description: Address is the full address of the endpoint (e.g., "http://10.0.1.5:9090")
                        type: string
                      podName:
                        description: PodName is the name of the pod serving this endpoint
                        type: string
                      ready:
                        description: |-
                          Ready indicates whether the endpoint is ready to serve traffic
                          For LoRA models: true if the POST /loras request succeeded with a 2xx status code
                          For base models: always false (no probing performed)
                        type: boolean
                    required:
                      - address
                      - ready
                    type: object
                  type: array
                readyEndpoints:
                  description: ReadyEndpoints is the count of endpoints that are ready
                  type: integer
                totalEndpoints:
                  description: TotalEndpoints is the total count of endpoints
                  type: integer
              required:
                - readyEndpoints
                - totalEndpoints
              type: object
          type: object
      served: true
      storage: true
      subresources:
        status: {}