BentoML host_clusters API

host_clusters

OpenAPI Specification

bentoml-host-clusters-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: yatai api server admin api v1 host_clusters API
  description: This is yatai api server.
  version: 1.0.0
tags:
- name: host_clusters
  description: host_clusters
paths:
  /api/admin/v1/host_clusters:
    get:
      tags:
      - host_clusters
      summary: List host clusters
      operationId: List host clusters
      parameters:
      - 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/Schemasv1HostClusterListSchema'
    post:
      tags:
      - host_clusters
      summary: Create host cluster
      operationId: Create host cluster
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Create Host ClusterInput'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  config:
                    type: string
                    nullable: true
                  created_at:
                    type: string
                    format: date-time
                  default:
                    type: boolean
                  deleted_at:
                    type: string
                    format: date-time
                    nullable: true
                  description:
                    type: string
                  display_name:
                    type: string
                  grafana_root_path:
                    type: string
                  kube_config:
                    type: string
                    nullable: true
                  labels:
                    type: array
                    items:
                      $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                  name:
                    type: string
                  resource_instances:
                    type: array
                    items:
                      type: object
                      properties:
                        config:
                          type: string
                          nullable: true
                        created_at:
                          type: string
                          format: date-time
                        deleted_at:
                          type: string
                          format: date-time
                          nullable: true
                        description:
                          type: string
                        display_name:
                          type: string
                        labels:
                          type: array
                          items:
                            $ref: '#/components/schemas/ModelschemasLabelItemSchema'
                        lago_id:
                          type: string
                        name:
                          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
                  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
components:
  schemas:
    ModelschemasHostClusterConfigSchema:
      type: object
      properties:
        image_builder_pod_eks_role_arn:
          type: string
        provider:
          type: string
        region:
          type: string
        resource_instance_names:
          type: array
          items:
            type: string
        standby_instances:
          type: object
          additionalProperties:
            type: integer
            format: int32
    ModelschemasLabelItemSchema:
      type: object
      properties:
        key:
          type: string
        stage:
          type: string
        value:
          type: string
    Schemasv1HostClusterListSchema:
      type: object
      properties:
        count:
          type: integer
          format: int32
        items:
          type: array
          items:
            type: object
            properties:
              config:
                type: string
                nullable: true
              created_at:
                type: string
                format: date-time
              default:
                type: boolean
              deleted_at:
                type: string
                format: date-time
                nullable: true
              description:
                type: string
              display_name:
                type: string
              grafana_root_path:
                type: string
              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
              uid:
                type: string
              updated_at:
                type: string
                format: date-time
        start:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
    Create Host ClusterInput:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/ModelschemasHostClusterConfigSchema'
        default:
          type: boolean
        description:
          type: string
        display_name:
          type: string
        kube_config:
          type: string
        name:
          type: string
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: X-YATAI-API-TOKEN