BentoML admin deployment resource API

admin deployment resource

OpenAPI Specification

bentoml-admin-deployment-resource-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: yatai api server admin api v1 admin deployment resource API
  description: This is yatai api server.
  version: 1.0.0
tags:
- name: admin deployment resource
  description: admin deployment resource
paths:
  ? /api/admin/v1/organizations/{orgName}/clusters/{clusterName}/namespaces/{namespace}/deployments/{deploymentName}/status_records
  : get:
      tags:
      - admin deployment resource
      summary: List deployment status records in admin panel
      operationId: List deployment status records in admin panel
      parameters:
      - name: clusterName
        in: path
        required: true
        schema:
          type: string
      - name: deploymentName
        in: path
        required: true
        schema:
          type: string
      - name: namespace
        in: path
        required: true
        schema:
          type: string
      - name: orgName
        in: path
        required: true
        schema:
          type: string
      - name: count
        in: query
        schema:
          type: integer
          format: int32
      - name: q
        in: query
        schema:
          type: string
      - name: search
        in: query
        schema:
          type: string
          nullable: true
      - name: start
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schemasv2DeploymentStatusRecordListSchema'
components:
  schemas:
    V1SecretEnvSource:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        optional:
          type: boolean
          nullable: true
    ModelschemasDeploymentRoutingSchema:
      type: object
      properties:
        route_by:
          type: string
          nullable: true
        route_type:
          type: string
          nullable: true
        weights:
          type: object
          additionalProperties:
            type: integer
            format: int32
    V1GitRepoVolumeSource:
      type: object
      properties:
        directory:
          type: string
        repository:
          type: string
        revision:
          type: string
    V1LabelSelector:
      type: object
      properties:
        matchExpressions:
          type: array
          items:
            $ref: '#/components/schemas/V1LabelSelectorRequirement'
        matchLabels:
          type: object
          additionalProperties:
            type: string
    V1FlexVolumeSource:
      type: object
      properties:
        driver:
          type: string
        fsType:
          type: string
        options:
          type: object
          additionalProperties:
            type: string
        readOnly:
          type: boolean
        secretRef:
          $ref: '#/components/schemas/V1LocalObjectReference'
    ModelschemasEnvItemSchema:
      type: object
      properties:
        name:
          type: string
        stage:
          type: string
        value:
          type: string
    V1ServiceAccountTokenProjection:
      type: object
      properties:
        audience:
          type: string
        expirationSeconds:
          type: integer
          format: int64
          nullable: true
        path:
          type: string
    V1Affinity:
      type: object
      properties:
        nodeAffinity:
          $ref: '#/components/schemas/V1NodeAffinity'
        podAffinity:
          $ref: '#/components/schemas/V1PodAffinity'
        podAntiAffinity:
          $ref: '#/components/schemas/V1PodAntiAffinity'
    ModelschemasDeploymentManifest:
      type: object
      properties:
        dev:
          type: boolean
        replicas:
          type: object
          additionalProperties:
            type: integer
            format: int32
        routing:
          $ref: '#/components/schemas/ModelschemasDeploymentRoutingSchema'
        super_admin:
          type: boolean
    Schemasv2DeploymentTargetConfig:
      type: object
      properties:
        access_authorization:
          type: boolean
          nullable: true
        envs:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasEnvItemSchema'
        secrets:
          type: array
          items:
            type: string
        services:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ModelschemasDeploymentServiceConfig'
    V1KeyToPath:
      type: object
      properties:
        key:
          type: string
        mode:
          type: integer
          format: int32
          nullable: true
        path:
          type: string
    V1EmptyDirVolumeSource:
      type: object
      properties:
        medium:
          type: string
        sizeLimit:
          $ref: '#/components/schemas/ResourceQuantity'
    V1PhotonPersistentDiskVolumeSource:
      type: object
      properties:
        fsType:
          type: string
        pdID:
          type: string
    ModelschemasDeploymentTargetHPAConf:
      type: object
      properties:
        max_replicas:
          type: integer
          format: int32
          nullable: true
        min_replicas:
          type: integer
          format: int32
          nullable: true
        policy:
          $ref: '#/components/schemas/ModelschemasHPAPolicy'
    V1ClusterTrustBundleProjection:
      type: object
      properties:
        labelSelector:
          $ref: '#/components/schemas/V1LabelSelector'
        name:
          type: string
          nullable: true
        optional:
          type: boolean
          nullable: true
        path:
          type: string
        signerName:
          type: string
          nullable: true
    ModelschemasHPAPolicy:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasHPAMetric'
        scale_down_behavior:
          type: string
          nullable: true
        scale_down_stabilization_window:
          type: integer
          format: int32
          nullable: true
        scale_up_behavior:
          type: string
          nullable: true
        scale_up_stabilization_window:
          type: integer
          format: int32
          nullable: true
        scaling_strategy:
          type: string
          nullable: true
    V1DownwardAPIProjection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1DownwardAPIVolumeFile'
    V1DownwardAPIVolumeFile:
      type: object
      properties:
        fieldRef:
          $ref: '#/components/schemas/V1ObjectFieldSelector'
        mode:
          type: integer
          format: int32
          nullable: true
        path:
          type: string
        resourceFieldRef:
          $ref: '#/components/schemas/V1ResourceFieldSelector'
    V1LabelSelectorRequirement:
      type: object
      properties:
        key:
          type: string
        operator:
          type: string
        values:
          type: array
          items:
            type: string
    ModelschemasDeploymentServiceConfig:
      type: object
      properties:
        coldstart_timeout:
          type: integer
          format: int64
          nullable: true
        config_overrides:
          type: object
          additionalProperties: {}
        deployment_strategy:
          type: string
          nullable: true
        enable_image_builder_colocation:
          type: boolean
          nullable: true
        envs:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasEnvItemSchema'
        extras:
          $ref: '#/components/schemas/ModelschemasExtraDeploymentOverrides'
        instance_type:
          type: string
          nullable: true
        scaling:
          $ref: '#/components/schemas/ModelschemasDeploymentTargetHPAConf'
    V1SecretProjection:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1KeyToPath'
        optional:
          type: boolean
          nullable: true
    V1NodeSelectorTerm:
      type: object
      properties:
        matchExpressions:
          type: array
          items:
            $ref: '#/components/schemas/V1NodeSelectorRequirement'
        matchFields:
          type: array
          items:
            $ref: '#/components/schemas/V1NodeSelectorRequirement'
    V1PodCertificateProjection:
      type: object
      properties:
        certificateChainPath:
          type: string
        credentialBundlePath:
          type: string
        keyPath:
          type: string
        keyType:
          type: string
        maxExpirationSeconds:
          type: integer
          format: int32
          nullable: true
        signerName:
          type: string
    V1SecretKeySelector:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        key:
          type: string
        optional:
          type: boolean
          nullable: true
    ModelschemasBentoRequestOverrides:
      type: object
      properties:
        dockerConfigJsonSecretName:
          type: string
        downloaderContainerEnvFrom:
          type: array
          items:
            $ref: '#/components/schemas/V1EnvFromSource'
        imageBuildTimeout:
          type: integer
          format: int64
          nullable: true
        imageBuilderContainerResources:
          $ref: '#/components/schemas/V1ResourceRequirements'
        imageBuilderExtraContainerEnv:
          type: array
          items:
            $ref: '#/components/schemas/V1EnvVar'
        imageBuilderExtraPodMetadata:
          $ref: '#/components/schemas/V1alpha1ExtraPodMetadata'
        imageBuilderExtraPodSpec:
          $ref: '#/components/schemas/V1alpha1ExtraPodSpec'
    V1LocalObjectReference:
      type: object
      properties:
        name:
          type: string
    V1ManagedFieldsEntry:
      type: object
      properties:
        apiVersion:
          type: string
        fieldsType:
          type: string
        fieldsV1:
          $ref: '#/components/schemas/V1FieldsV1'
        manager:
          type: string
        operation:
          type: string
        subresource:
          type: string
        time:
          $ref: '#/components/schemas/V1Time'
    V1ConfigMapKeySelector:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        key:
          type: string
        optional:
          type: boolean
          nullable: true
    ModelschemasBentoRunnerSchema:
      type: object
      properties:
        models:
          type: array
          items:
            type: string
        name:
          type: string
        resource_config:
          $ref: '#/components/schemas/ModelschemasBentoRunnerResourceSchema'
        runnable_type:
          type: string
    V1ProjectedVolumeSource:
      type: object
      properties:
        defaultMode:
          type: integer
          format: int32
          nullable: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/V1VolumeProjection'
    V1DownwardAPIVolumeSource:
      type: object
      properties:
        defaultMode:
          type: integer
          format: int32
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1DownwardAPIVolumeFile'
    V1TypedObjectReference:
      type: object
      properties:
        apiGroup:
          type: string
          nullable: true
        kind:
          type: string
        name:
          type: string
        namespace:
          type: string
          nullable: true
    ModelschemasLabelItemSchema:
      type: object
      properties:
        key:
          type: string
        stage:
          type: string
        value:
          type: string
    ModelschemasExtraDeploymentOverrides:
      type: object
      properties:
        bento_function_overrides:
          $ref: '#/components/schemas/ModelschemasApiServerBentoFunctionOverrides'
        bento_request_overrides:
          $ref: '#/components/schemas/ModelschemasBentoRequestOverrides'
    ResourceQuantity:
      type: object
    V1CSIVolumeSource:
      type: object
      properties:
        driver:
          type: string
        fsType:
          type: string
          nullable: true
        nodePublishSecretRef:
          $ref: '#/components/schemas/V1LocalObjectReference'
        readOnly:
          type: boolean
          nullable: true
        volumeAttributes:
          type: object
          additionalProperties:
            type: string
    V1HostPathVolumeSource:
      type: object
      properties:
        path:
          type: string
        type:
          type: string
          nullable: true
    ModelschemasBentoManifestModelSchema:
      type: object
      properties:
        alias:
          type: string
        creation_time:
          type: string
        endpoint:
          type: string
        module:
          type: string
        registry:
          type: string
        tag:
          type: string
    V1TopologySpreadConstraint:
      type: object
      properties:
        labelSelector:
          $ref: '#/components/schemas/V1LabelSelector'
        matchLabelKeys:
          type: array
          items:
            type: string
        maxSkew:
          type: integer
          format: int32
        minDomains:
          type: integer
          format: int32
          nullable: true
        nodeAffinityPolicy:
          type: string
          nullable: true
        nodeTaintsPolicy:
          type: string
          nullable: true
        topologyKey:
          type: string
        whenUnsatisfiable:
          type: string
    V1SecretVolumeSource:
      type: object
      properties:
        defaultMode:
          type: integer
          format: int32
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1KeyToPath'
        optional:
          type: boolean
          nullable: true
        secretName:
          type: string
    V1AWSElasticBlockStoreVolumeSource:
      type: object
      properties:
        fsType:
          type: string
        partition:
          type: integer
          format: int32
        readOnly:
          type: boolean
        volumeID:
          type: string
    V1ConfigMapProjection:
      type: object
      properties:
        LocalObjectReference:
          $ref: '#/components/schemas/V1LocalObjectReference'
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1KeyToPath'
        optional:
          type: boolean
          nullable: true
    ModelschemasBentoManifestSchema:
      type: object
      properties:
        apis:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ModelschemasBentoApiSchema'
        bentoml_version:
          type: string
        dev:
          type: boolean
        entry_service:
          type: string
        envs:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasEnvItemSchema'
        image:
          $ref: '#/components/schemas/ModelschemasBentoImageInfoSchema'
        models:
          type: array
          items:
            type: string
        name:
          type: string
        runners:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasBentoRunnerSchema'
        schema:
          type: object
          additionalProperties: {}
        service:
          type: string
        services:
          type: array
          items:
            $ref: '#/components/schemas/ModelschemasBentoManifestServiceSchema'
        size_bytes:
          type: integer
          format: int32
        spec:
          type: integer
          format: int32
    V1alpha1MonitorExporterMountSpec:
      type: object
      properties:
        VolumeSource:
          $ref: '#/components/schemas/V1VolumeSource'
        path:
          type: string
        readOnly:
          type: boolean
    V1VolumeResourceRequirements:
      type: object
      properties:
        limits:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ResourceQuantity'
        requests:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ResourceQuantity'
    V1ResourceClaim:
      type: object
      properties:
        name:
          type: string
        request:
          type: string
    V1EphemeralVolumeSource:
      type: object
      properties:
        volumeClaimTemplate:
          $ref: '#/components/schemas/V1PersistentVolumeClaimTemplate'
    ModelschemasBentoApiSchema:
      type: object
      properties:
        doc:
          type: string
        input:
          type: string
        output:
          type: string
        route:
          type: string
    V1AzureFileVolumeSource:
      type: object
      properties:
        readOnly:
          type: boolean
        secretName:
          type: string
        shareName:
          type: string
    V1FieldsV1:
      type: object
    V1AzureDiskVolumeSource:
      type: object
      properties:
        cachingMode:
          type: string
          nullable: true
        diskName:
          type: string
        diskURI:
          type: string
        fsType:
          type: string
          nullable: true
        kind:
          type: string
          nullable: true
        readOnly:
          type: boolean
          nullable: true
    Schemasv2DeploymentStatusRecordListSchema:
      type: object
      properties:
        count:
          type: integer
          format: int32
        items:
          type: array
          items:
            $ref: '#/components/schemas/Schemasv2DeploymentStatusRecordSchema'
        start:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
    V1PodAffinityTerm:
      type: object
      properties:
        labelSelector:
          $ref: '#/components/schemas/V1LabelSelector'
        matchLabelKeys:
          type: array
          items:
            type: string
        mismatchLabelKeys:
          type: array
          items:
            type: string
        namespaceSelector:
          $ref: '#/components/schemas/V1LabelSelector'
        namespaces:
          type: array
          items:
            type: string
        topologyKey:
          type: string
    ModelschemasBentoRunnerResourceSchema:
      type: object
      properties:
        cpu:
          type: number
          format: double
          nullable: true
        custom_resources:
          type: object
          additionalProperties:
            type: number
            format: double
        nvidia_gpu:
          type: number
          format: double
          nullable: true
    V1NFSVolumeSource:
      type: object
      properties:
        path:
          type: string
        readOnly:
          type: boolean
        server:
          type: string
    V1QuobyteVolumeSource:
      type: object
      properties:
        group:
          type: string
        readOnly:
          type: boolean
        registry:
          type: string
        tenant:
          type: string
        user:
          type: string
        volume:
          type: string
    V1EnvVarSource:
      type: object
      properties:
        configMapKeyRef:
          $ref: '#/components/schemas/V1ConfigMapKeySelector'
        fieldRef:
          $ref: '#/components/schemas/V1ObjectFieldSelector'
        fileKeyRef:
          $ref: '#/components/schemas/V1FileKeySelector'
        resourceFieldRef:
          $ref: '#/components/schemas/V1ResourceFieldSelector'
        secretKeyRef:
          $ref: '#/components/schemas/V1SecretKeySelector'
    V1PodAffinity:
      type: object
      properties:
        preferredDuringSchedulingIgnoredDuringExecution:
          type: array
          items:
            $ref: '#/components/schemas/V1WeightedPodAffinityTerm'
        requiredDuringSchedulingIgnoredDuringExecution:
          type: array
          items:
            $ref: '#/components/schemas/V1PodAffinityTerm'
    Schemasv2DeploymentStatusRecordSchema:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
        deployment_revision:
          type: object
          properties:
            created_at:
              type: string
              format: date-time
            creator:
              type: object
              properties:
                application_status:
                  type: string
                avatar_url:
                  type: string
                created_at:
                  type: string
                  format: date-time
                deleted_at:
                  type: string
                  format: date-time
                  nullable: true
                email:
                  type: string
                first_name:
                  type: string
                from_sso:
                  type: boolean
                is_super_admin:
                  type: boolean
                labels:
                  type: array
                  items:
                    $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                last_name:
                  type: string
                name:
                  type: string
                perm:
                  type: string
                register_stage:
                  type: string
                resource_type:
                  type: string
                  enum:
                  - user
                  - organization
                  - cluster
                  - host_cluster
                  - bento_repository
                  - bento
                  - deployment
                  - deployment_revision
                  - model_repository
                  - model
                  - api_token
                uid:
                  type: string
                updated_at:
                  type: string
                  format: date-time
            deleted_at:
              type: string
              format: date-time
              nullable: true
            deployment:
              type: object
              properties:
                cluster:
                  type: object
                  properties:
                    created_at:
                      type: string
                      format: date-time
                    creator:
                      type: object
                      properties:
                        application_status:
                          type: string
                        avatar_url:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        deleted_at:
                          type: string
                          format: date-time
                          nullable: true
                        email:
                          type: string
                        first_name:
                          type: string
                        from_sso:
                          type: boolean
                        is_super_admin:
                          type: boolean
                        labels:
                          type: array
                          items:
                            $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                        last_name:
                          type: string
                        name:
                          type: string
                        perm:
                          type: string
                        register_stage:
                          type: string
                        resource_type:
                          type: string
                          enum:
                          - user
                          - organization
                          - cluster
                          - host_cluster
                          - bento_repository
                          - bento
                          - deployment
                          - deployment_revision
                          - model_repository
                          - model
                          - api_token
                        uid:
                          type: string
                        updated_at:
                          type: string
                          format: date-time
                    default_deployment_kube_namespace:
                      type: string
                    deleted_at:
                      type: string
                      format: date-time
                      nullable: true
                    description:
                      type: string
                    grafana_root_path:
                      type: string
                    host_cluster_display_name:
                      type: string
                    host_cluster_name:
                      type: string
                    is_first:
                      type: boolean
                    labels:
                      type: array
                      items:
                        $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                    multi_tenancy:
                      type: boolean
                    name:
                      type: string
                    organization_name:
                      type: string
                    provider:
                      type: string
                    resource_type:
                      type: string
                      enum:
                      - user
                      - organization
                      - cluster
                      - host_cluster
                      - bento_repository
                      - bento
                      - deployment
                      - deployment_revision
                      - model_repository
                      - model
                      - api_token
                    uid:
                      type: string
                    updated_at:
                      type: string
                      format: date-time
                created_at:
                  type: string
                  format: date-time
                creator:
                  type: object
                  properties:
                    application_status:
                      type: string
                    avatar_url:
                      type: string
                    created_at:
                      type: string
                      format: date-time
                    deleted_at:
                      type: string
                      format: date-time
                      nullable: true
                    email:
                      type: string
                    first_name:
                      type: string
                    from_sso:
                      type: boolean
                    is_super_admin:
                      type: boolean
                    labels:
                      type: array
                      items:
                        $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                    last_name:
                      type: string
                    name:
                      type: string
                    perm:
                      type: string
                    register_stage:
                      type: string
                    resource_type:
                      type: string
                      enum:
                      - user
                      - organization
                      - cluster
                      - host_cluster
                      - bento_repository
                      - bento
                      - deployment
                      - deployment_revision
                      - model_repository
                      - model
                      - api_token
                    uid:
                      type: string
                    updated_at:
                      type: string
                      format: date-time
                deleted_at:
                  type: string
                  format: date-time
                  nullable: true
                description:
                  type: string
                distributed:
                  type: boolean
                kube_namespace:
                  type: string
                labels:
                  type: array
                  items:
                    $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                manifest:
                  $ref: '#/components/schemas/ModelschemasDeploymentManifest'
                mode:
                  type: string
                  nullable: true
                name:
                  type: string
                resource_type:
                  type: string
                  enum:
                  - user
                  - organization
                  - cluster
                  - host_cluster
                  - bento_repository
                  - bento
                  - deployment
                  - deployment_revision
                  - model_repository
                  - model
                  - api_token
                status:
                  type: string
                  enum:
                  - unknown
                  - non-deployed
                  - running
                  - unhealthy
                  - failed
                  - deploying
                uid:
                  type: string
                updated_at:
                  type: string
                  format: date-time
                updater:
                  type: object
                  properties:
                    application_status:
                      type: string
                    avatar_url:
                      type: string
                    created_at:
                      type: string
                      format: date-time
                    deleted_at:
                      type: string
                      format: date-time
                      nullable: true
                    email:
                      type: string
                    first_name:
                      type: string
                    from_sso:
                      type: boolean
                    is_super_admin:
                      type: boolean
                    labels:
                      type: array
                      items:
                        $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                    last_name:
                      type: string
                    name:
                      type: string
                    perm:
                      type: string
                    register_stage:
                      type: string
                    resource_type:
                      type: string
                      enum:
                      - user
                      - organization
                      - cluster
                      - host_cluster
                      - bento_repository
                      - bento
                      - deployment
                      - deployment_revision
                      - model_repository
                      - model
                      - api_token
                    uid:
                      type: string
                    updated_at:
                      type: string
                      format: date-time
            labels:
              type: array
              items:
                $ref: '#/components/schemas/ModelschemasLabelItemSchema'
            name:
              type: string
            resource_type:
              type: string
              enum:
              - user
              - organization
              - cluster
              - host_cluster
              - bento_repository
              - bento
              - deployment
              - deployment_revision
              - model_repository
              - model
              - api_token
            status:
              type: string
              enum:
              - active
              - inactive
            targets:
              type: array
  

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bentoml/refs/heads/main/openapi/bentoml-admin-deployment-resource-api-openapi.yml