mirror of
https://github.com/hanzo-ml/kuberay.git
synced 2026-10-30 19:48:47 +00:00
* Generate go clients and swagger files * Apply goimports in specific folders
330 lines
12 KiB
JSON
330 lines
12 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "cluster.proto",
|
|
"version": "version not set"
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "ClusterService"
|
|
}
|
|
],
|
|
"schemes": [
|
|
"http"
|
|
],
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"paths": {
|
|
"/apis/v1alpha1/clusters": {
|
|
"get": {
|
|
"summary": "Finds all Clusters. Supports pagination, and sorting on certain fields.",
|
|
"operationId": "ClusterService_ListCluster",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/protoListClustersResponse"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
"ClusterService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a new Cluster.",
|
|
"operationId": "ClusterService_CreateCluster",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/protoCluster"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"description": "The Cluster to be created.",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/protoCluster"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"ClusterService"
|
|
]
|
|
}
|
|
},
|
|
"/apis/v1alpha1/clusters/{id}": {
|
|
"get": {
|
|
"summary": "Finds a specific Cluster by ID.",
|
|
"operationId": "ClusterService_GetCluster",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/protoCluster"
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "The ID of the Cluster to be retrieved.",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"description": "The name of the Cluster to be retrieved.",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"ClusterService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes an cluster without deleting the cluster's runs and jobs. To\navoid unexpected behaviors, delete an cluster's runs and jobs before\ndeleting the cluster.",
|
|
"operationId": "ClusterService_DeleteCluster",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"properties": {}
|
|
}
|
|
},
|
|
"default": {
|
|
"description": "An unexpected error response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/googlerpcStatus"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "The ID of the cluster to be deleted.",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "name",
|
|
"description": "The name of the Cluster to be retrieved.",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"ClusterService"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"ClusterEnvironment": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DEV",
|
|
"TESTING",
|
|
"STAGING",
|
|
"PRODUCTION"
|
|
],
|
|
"default": "DEV",
|
|
"description": "Optional field."
|
|
},
|
|
"googlerpcStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protobufAny"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"protoCluster": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Required input field. Unique Cluster name provided by user."
|
|
},
|
|
"namespace": {
|
|
"type": "string",
|
|
"title": "Required input field. Cluster's namespace provided by user"
|
|
},
|
|
"user": {
|
|
"type": "string",
|
|
"description": "Required field. This field indicates the user who owns the cluster."
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"title": "Optional input field. Ray cluster version"
|
|
},
|
|
"environment": {
|
|
"$ref": "#/definitions/ClusterEnvironment"
|
|
},
|
|
"clusterSpec": {
|
|
"$ref": "#/definitions/protoClusterSpec",
|
|
"title": "Required field. This field indicates ray cluster configuration"
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output. The time that the Cluster created."
|
|
},
|
|
"deletedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output. The time that the Cluster deleted."
|
|
}
|
|
}
|
|
},
|
|
"protoClusterSpec": {
|
|
"type": "object",
|
|
"properties": {
|
|
"headGroupSpec": {
|
|
"$ref": "#/definitions/protoHeadGroupSpec",
|
|
"title": "The head group configuration"
|
|
},
|
|
"workerGroupSepc": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protoWorkerGroupSpec"
|
|
},
|
|
"title": "The worker group configurations"
|
|
}
|
|
}
|
|
},
|
|
"protoHeadGroupSpec": {
|
|
"type": "object",
|
|
"properties": {
|
|
"computeTemplate": {
|
|
"type": "string",
|
|
"title": "Optional. The computeTemplate of head node group"
|
|
},
|
|
"image": {
|
|
"type": "string",
|
|
"title": "Optional field. This field will be used to retrieve right ray container"
|
|
},
|
|
"serviceType": {
|
|
"type": "string",
|
|
"title": "Optional. The service type (ClusterIP, NodePort, Load balancer) of the head node"
|
|
},
|
|
"rayStartParams": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Optional. The ray start parames of head node group"
|
|
}
|
|
}
|
|
},
|
|
"protoListClustersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clusters": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/protoCluster"
|
|
},
|
|
"description": "A list of Clusters returned."
|
|
}
|
|
}
|
|
},
|
|
"protoWorkerGroupSpec": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupName": {
|
|
"type": "string",
|
|
"title": "Required. Group name of the current worker group"
|
|
},
|
|
"computeTemplate": {
|
|
"type": "string",
|
|
"title": "Optional. The computeTemplate of head node group"
|
|
},
|
|
"image": {
|
|
"type": "string",
|
|
"title": "Optional field. This field will be used to retrieve right ray container"
|
|
},
|
|
"replicas": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"title": "Required. Desired replicas of the worker group"
|
|
},
|
|
"minReplicas": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"title": "Optional. Min replicas of the worker group"
|
|
},
|
|
"maxReplicas": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"title": "Optional. Max replicas of the worker group"
|
|
},
|
|
"rayStartParams": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"title": "Optional. The ray start parames of worker node group"
|
|
}
|
|
}
|
|
},
|
|
"protobufAny": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typeUrl": {
|
|
"type": "string",
|
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"format": "byte",
|
|
"description": "Must be a valid serialized protocol buffer of the above specified type."
|
|
}
|
|
},
|
|
"description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
|
|
}
|
|
}
|
|
}
|