{ "openapi": "3.0.0", "info": { "description": "API to interact and manage the lifecycle of your machine learning models\ndeployed through Seldon Deploy.", "title": "Seldon Deploy API", "version": "v1alpha1" }, "paths": { "/applicationlogs": { "post": { "operationId": "ReadApplicationLogs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationLogsParams" } } }, "description": "ApplicationLogs", "required": true }, "responses": { "200": { "$ref": "#/components/responses/ApplicationLogsResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "summary": "Read application container logs from elastic search.", "tags": [ "ApplicationLogs" ] } }, "/cluster": { "get": { "description": "Read the cluster info", "operationId": "ReadCluster", "responses": { "200": { "$ref": "#/components/responses/ClusterInfoResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Environment" ] } }, "/healthcheck": { "get": { "description": "Read the healthcheck", "operationId": "ReadHealthCheck", "responses": { "200": { "$ref": "#/components/responses/HealthCheckResponse" } }, "tags": [ "Environment" ] } }, "/namespaces/{namespace}/experiments/{name}/gitdiff": { "get": { "description": "Read the git diff for an experiment", "operationId": "ReadExperimentGitDiff", "parameters": [ { "description": "Hash", "in": "query", "name": "hash", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitDiffResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/experiments/{name}/gitlogs": { "get": { "description": "Read the git commits for an experiment", "operationId": "ReadExperimentGitLogs", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitLogsResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/gitdiffs": { "get": { "description": "Read the git diffs from hashes", "operationId": "ReadGitDiffs", "parameters": [ { "description": "Hashes is an array of git commit hashes to get diffs for", "in": "query", "name": "hashes", "required": true, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitDiffsResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/gitops-status": { "get": { "description": "Read the GitOps status", "operationId": "ReadGitOpsStatus", "parameters": [ { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/models": { "post": { "description": "Create a Seldon Model", "operationId": "CreateModel", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Model" }, "responses": { "200": { "$ref": "#/components/responses/SeldonModelResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "409": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Models" ] } }, "/namespaces/{namespace}/models/{name}": { "delete": { "description": "Delete the specified Seldon Model", "operationId": "DeleteModel", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Models" ] }, "get": { "description": "Read the specified Seldon Model", "operationId": "ReadModel", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonModelResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Models" ] }, "put": { "description": "Update the specified Seldon Model", "operationId": "UpdateModel", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Model" }, "responses": { "200": { "$ref": "#/components/responses/SeldonModelResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Models" ] } }, "/namespaces/{namespace}/models/{name}/gitdiff": { "get": { "description": "Read the git diff for a model", "operationId": "ReadModelGitDiff", "parameters": [ { "description": "Hash", "in": "query", "name": "hash", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitDiffResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/models/{name}/gitlogs": { "get": { "description": "Read the git commits for a model", "operationId": "ReadModelGitLogs", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitLogsResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/pipelines": { "get": { "description": "list objects of kind Seldon Pipelines", "operationId": "ListPipelines", "parameters": [ { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonPipelineListResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "404": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] }, "post": { "description": "Create a Seldon Pipeline", "operationId": "CreatePipeline", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Pipeline" }, "responses": { "200": { "$ref": "#/components/responses/SeldonPipelineResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "409": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] } }, "/namespaces/{namespace}/pipelines/{name}": { "delete": { "description": "Delete the specified Seldon Pipeline", "operationId": "DeletePipeline", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] }, "get": { "description": "Read the specified Seldon Pipeline", "operationId": "ReadPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonPipelineResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] }, "put": { "description": "Update the specified Seldon Pipeline", "operationId": "UpdatePipeline", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Pipeline" }, "responses": { "200": { "$ref": "#/components/responses/SeldonPipelineResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] } }, "/namespaces/{namespace}/pipelines/{name}/batchjobs": { "get": { "description": "Read the pipeline batch jobs", "operationId": "ListPipelineBatchJobs", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Limit of items returned in one response", "in": "query", "name": "limit", "schema": { "type": "string" } }, { "description": "Requested page", "in": "query", "name": "Page", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/BatchJobsListResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "BatchJobs" ] }, "post": { "description": "Create the pipeline batch jobs", "operationId": "CreatePipelineBatchJob", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchJobDefinition" }, "responses": { "200": { "$ref": "#/components/responses/BatchJobPostResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "BatchJobs" ] } }, "/namespaces/{namespace}/pipelines/{name}/batchjobs/{jobName}": { "get": { "description": "Get details on the pipeline batch job", "operationId": "GetPipelineBatchJob", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "JobName identifies a job name", "in": "path", "name": "jobName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/BatchJobGetResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "BatchJobs" ] } }, "/namespaces/{namespace}/pipelines/{name}/experiment": { "delete": { "description": "Delete Seldon Pipeline Experiment Pipelines", "operationId": "DeletePipelineExperiment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "404": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] }, "get": { "description": "Read Seldon Pipeline Experiment", "operationId": "GetPipelineExperiment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonExperimentResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "404": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] }, "post": { "description": "Create a Seldon Pipeline Experiment", "operationId": "CreatePipelineExperiment", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Experiment" }, "responses": { "200": { "$ref": "#/components/responses/SeldonExperimentResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] }, "put": { "description": "Update the specified Seldon Pipeline Experiment", "operationId": "UpdatePipelineExperiment", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Experiment" }, "responses": { "200": { "$ref": "#/components/responses/SeldonExperimentResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "409": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] } }, "/namespaces/{namespace}/pipelines/{name}/experiment/canary": { "delete": { "description": "Delete the specified Seldon Pipeline Canary", "operationId": "RemoveCanary", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] }, "post": { "description": "Create the specified Seldon Pipeline Canary experiment", "operationId": "CreateCanaryExperiment", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Weight of the traffic directed to the canary pipeline, between 0 and 100", "in": "query", "name": "weight", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] }, "put": { "description": "Promote the specified Seldon Pipeline Canary", "operationId": "PromoteCanary", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] } }, "/namespaces/{namespace}/pipelines/{name}/experiment/shadow": { "delete": { "description": "Delete the specified Seldon Pipeline Shadow", "operationId": "RemoveShadow", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] }, "post": { "description": "Create the specified Seldon Pipeline Shadow experiment", "operationId": "CreateShadowExperiment", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] }, "put": { "description": "Promote the specified Seldon Pipeline Shadow", "operationId": "PromoteShadow", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Experiments" ] } }, "/namespaces/{namespace}/pipelines/{name}/explain": { "post": { "description": "Create Seldon Pipeline explanation", "operationId": "ExplainSeldonPipeline", "parameters": [ { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ExplainSeldonPipelineExplaindata" }, "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Explain" ] } }, "/namespaces/{namespace}/pipelines/{name}/explainer": { "delete": { "description": "Read the specified Seldon Pipeline Explainer", "operationId": "DeletePipelineExplainer", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] }, "get": { "description": "Read the specified Seldon Pipeline Explainer", "operationId": "ReadPipelineExplainer", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonModelResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] }, "post": { "description": "Read the specified Seldon Pipeline Explainer", "operationId": "CreatePipelineExplainer", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Model" }, "responses": { "200": { "$ref": "#/components/responses/SeldonModelResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] }, "put": { "description": "Update the specified Seldon Pipeline Explainer", "operationId": "UpdatePipelineExplainer", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/Model" }, "responses": { "200": { "$ref": "#/components/responses/SeldonModelResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] } }, "/namespaces/{namespace}/pipelines/{name}/gitdiff": { "get": { "description": "Read the git diff for a pipeline", "operationId": "ReadPipelineGitDiff", "parameters": [ { "description": "Hash", "in": "query", "name": "hash", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitDiffResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/pipelines/{name}/gitlogs": { "get": { "description": "Read the git commits for a pipeline", "operationId": "ReadPipelineGitLogs", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitLogsResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/pipelines/{name}/loadtestjobs": { "get": { "description": "List Pipeline load test jobs", "operationId": "ListLoadtestPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "LoadtestJobs" ] }, "post": { "description": "Create Pipeline load test", "operationId": "CreateLoadtestPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/CreateLoadtestPipeline" }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "LoadtestJobs" ] } }, "/namespaces/{namespace}/pipelines/{name}/loadtestjobs/{jobName}": { "delete": { "description": "Delete Pipeline load test jobs", "operationId": "DeleteLoadtestPipeline", "parameters": [ { "description": "JobName identifies a job name", "in": "path", "name": "jobName", "required": true, "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "LoadtestJobs" ] } }, "/namespaces/{namespace}/pipelines/{name}/models": { "get": { "description": "List objects of kind Seldon Models within a Pipeline", "operationId": "ListPipelineModels", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonModelListResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "404": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Pipelines" ] } }, "/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector": { "get": { "description": "List the specified Seldon Pipeline Drift Detector", "operationId": "ListDriftDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorListResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] }, "post": { "description": "Create the specified Seldon Pipeline Drift Detector", "operationId": "CreateDriftDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DetectorConfigData" }, "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] } }, "/namespaces/{namespace}/pipelines/{name}/monitor/drift-detector/{detectorName}": { "delete": { "description": "Read the specified Seldon Pipeline Drift Detector", "operationId": "DeleteDriftDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] }, "get": { "description": "Read the specified Seldon Pipeline Drift Detector", "operationId": "ReadDriftDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] } }, "/namespaces/{namespace}/pipelines/{name}/monitor/featuredistributions": { "post": { "description": "Get the specified Seldon Deployment predictions feature distribution", "operationId": "SeldonPipelineFeatureDistributions", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DeploymentFeatureData" }, "responses": { "200": { "$ref": "#/components/responses/FeatureDistResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Monitor" ] } }, "/namespaces/{namespace}/pipelines/{name}/monitor/featurestatistics": { "post": { "description": "Get the specified Seldon Deployment predictions feature statistics", "operationId": "SeldonPipelineFeatureStatistics", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DeploymentFeatureData" }, "responses": { "200": { "$ref": "#/components/responses/FeatureStatResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Monitor" ] } }, "/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector": { "get": { "description": "List the specified Seldon Pipeline Outlier Detector", "operationId": "ListOutlierDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorListResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] }, "post": { "description": "Create the specified Seldon Pipeline Outlier Detector", "operationId": "CreateOutlierDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DetectorConfigData" }, "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] } }, "/namespaces/{namespace}/pipelines/{name}/monitor/outlier-detector/{detectorName}": { "delete": { "description": "Read the specified Seldon Pipeline Outlier Detector", "operationId": "DeleteOutlierDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] }, "get": { "description": "Read the specified Seldon Pipeline Outlier Detector", "operationId": "ReadOutlierDetectorSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] } }, "/namespaces/{namespace}/pipelines/{name}/predictcurl": { "put": { "description": "Read the specified Seldon Pipeline predict curl", "operationId": "ReadPredictCurlSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ReadPredictCurlSeldonPipelinePrediction" }, "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Predict" ] } }, "/namespaces/{namespace}/pipelines/{name}/predictfile": { "post": { "description": "Create Seldon Pipeline prediction", "operationId": "PredictFileSeldonPipeline", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PredictFileSeldonPipeline" }, "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Predict" ] } }, "/namespaces/{namespace}/seldondeployments": { "get": { "description": "list objects of kind Seldon Deployment", "operationId": "ListSeldonDeployments", "parameters": [ { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonDeploymentListResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "404": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "SeldonDeployments" ] }, "post": { "description": "Create a Seldon Deployment", "operationId": "CreateSeldonDeployment", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/SeldonDeployment" }, "responses": { "200": { "$ref": "#/components/responses/SeldonDeploymentResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "SeldonDeployments" ] } }, "/namespaces/{namespace}/seldondeployments/{name}": { "delete": { "description": "Delete the specified Seldon Deployment", "operationId": "DeleteSeldonDeployment", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "SeldonDeployments" ] }, "get": { "description": "Read the specified Seldon Deployment", "operationId": "ReadSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/SeldonDeploymentResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "SeldonDeployments" ] }, "put": { "description": "Update the specified Seldon Deployment", "operationId": "UpdateSeldonDeployment", "parameters": [ { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/SeldonDeployment" }, "responses": { "200": { "$ref": "#/components/responses/SeldonDeploymentResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "403": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "SeldonDeployments" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/batchjobs": { "get": { "description": "Read the seldondeployment's batch jobs", "operationId": "ListSeldonDeploymentBatchJobs", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Limit of items returned in one response", "in": "query", "name": "limit", "schema": { "type": "string" } }, { "description": "Requested page", "in": "query", "name": "Page", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/BatchJobsListResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "BatchJobs" ] }, "post": { "description": "Create the seldondeployment's batch jobs", "operationId": "CreateSeldonDeploymentBatchJob", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/BatchJobDefinition" }, "responses": { "200": { "$ref": "#/components/responses/BatchJobPostResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "BatchJobs" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/batchjobs/{jobName}": { "get": { "description": "Get details on the seldondeployment's batch job", "operationId": "GetDeploymentBatchJob", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "JobName identifies a job name", "in": "path", "name": "jobName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/BatchJobGetResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "BatchJobs" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/explain": { "post": { "description": "Create Seldon Deployment explanation", "operationId": "ExplainSeldonDeployment", "parameters": [ { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ExplainSeldonPipelineExplaindata" }, "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Explain" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/gitdiff": { "get": { "description": "Read the git diff for a Seldon deployment", "operationId": "ReadSeldonDeploymentGitDiff", "parameters": [ { "description": "Hash", "in": "query", "name": "hash", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitDiffResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/gitlogs": { "get": { "description": "Read the git commits for a Seldon deployment", "operationId": "ReadSeldonDeploymentGitLogs", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/GitLogsResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/gitrestore": { "post": { "description": "Restore the git commit", "operationId": "SeldonDeploymentGitRestore", "parameters": [ { "description": "Hash", "in": "query", "name": "hash", "schema": { "type": "string" } }, { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/gitrevert": { "post": { "description": "Revert the git commit", "operationId": "SeldonDeploymentGitRevert", "parameters": [ { "description": "Hash", "in": "query", "name": "hash", "schema": { "type": "string" } }, { "description": "Action", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Message", "in": "query", "name": "message", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "GitOps" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs": { "get": { "description": "List Seldon Deployment load test jobs", "operationId": "ListLoadtestSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "LoadtestJobs" ] }, "post": { "description": "Create Seldon Deployment load test", "operationId": "CreateLoadtestSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/CreateLoadtestPipeline" }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "LoadtestJobs" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/loadtestjobs/{jobName}": { "delete": { "description": "Delete Seldon Deployment load test jobs", "operationId": "DeleteLoadtestSeldonDeployment", "parameters": [ { "description": "JobName identifies a job name", "in": "path", "name": "jobName", "required": true, "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "LoadtestJobs" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector": { "get": { "description": "Read the specified Seldon Deployment Drift Detector", "operationId": "ListDriftDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorListResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] }, "post": { "description": "Create the specified Seldon Deployment Drift Detector", "operationId": "CreateDriftDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DetectorConfigData" }, "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/drift-detector/{detectorName}": { "delete": { "description": "Read the specified Seldon Deployment Drift Detector", "operationId": "DeleteDriftDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] }, "get": { "description": "Read the specified Seldon Deployment Drift Detector", "operationId": "ReadDriftDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "DriftDetector" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/featuredistributions": { "post": { "description": "Get the specified Seldon Deployment predictions feature distribution", "operationId": "SeldonDeploymentFeatureDistributions", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DeploymentFeatureData" }, "responses": { "200": { "$ref": "#/components/responses/FeatureDistResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Monitor" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/featurestatistics": { "post": { "description": "Get the specified Seldon Deployment predictions feature statistics", "operationId": "SeldonDeploymentFeatureStatistics", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DeploymentFeatureData" }, "responses": { "200": { "$ref": "#/components/responses/FeatureStatResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Monitor" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server": { "get": { "description": "Read the specified Seldon Deployment Metrics Server", "operationId": "ListMetricsServerSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorListResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "MetricsServer" ] }, "post": { "description": "Create the specified Seldon Deployment Metrics Server", "operationId": "CreateMetricsServerSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DetectorConfigData" }, "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "MetricsServer" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/metrics-server/{detectorName}": { "delete": { "description": "Read the specified Seldon Deployment Metrics Server", "operationId": "DeleteMetricsServerSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "MetricsServer" ] }, "get": { "description": "Read the specified Seldon Deployment Metrics Server", "operationId": "ReadMetricsServerSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "MetricsServer" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector": { "get": { "description": "Read the specified Seldon Deployment Outlier Detector", "operationId": "ListOutlierDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorListResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] }, "post": { "description": "Create the specified Seldon Deployment Outlier Detector", "operationId": "CreateOutlierDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/DetectorConfigData" }, "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/monitor/outlier-detector/{detectorName}": { "delete": { "description": "Read the specified Seldon Deployment Outlier Detector", "operationId": "DeleteOutlierDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] }, "get": { "description": "Read the specified Seldon Deployment Outlier Detector", "operationId": "ReadOutlierDetectorSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Detector Name", "in": "path", "name": "detectorName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/DetectorResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "OutlierDetector" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/predict": { "post": { "description": "Create Seldon Deployment prediction", "operationId": "PredictSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ReadPredictCurlSeldonPipelinePrediction" }, "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Predict" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/predictcurl": { "put": { "description": "Read the specified Seldon Deployment predict curl", "operationId": "ReadPredictCurlSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/ReadPredictCurlSeldonPipelinePrediction" }, "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Predict" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/predictfile": { "post": { "description": "Create Seldon Deployment prediction", "operationId": "PredictFileSeldonDeployment", "parameters": [ { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/PredictFileSeldonPipeline" }, "responses": { "200": { "$ref": "#/components/responses/GenericResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "Predict" ] } }, "/namespaces/{namespace}/seldondeployments/{name}/resources": { "get": { "description": "list objects of kind resource for Seldon Deployment", "operationId": "ListSeldonDeploymentResources", "parameters": [ { "description": "Component differentiates between types of model (e.g. predictor, explainer... etc)", "in": "query", "name": "component", "schema": { "type": "string" } }, { "description": "Name identifies a resource", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ResourceListResponse" }, "400": { "$ref": "#/components/responses/ErrorDefault" }, "405": { "$ref": "#/components/responses/ErrorDefault" }, "424": { "$ref": "#/components/responses/ErrorDefault" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "KubernetesResources" ] } }, "/namespaces/{namespace}/seldondeployments/validate": { "get": { "description": "Validate the given Seldon Deployment", "operationId": "ValidateSeldonDeployment", "parameters": [ { "description": "Namespace provides a logical grouping of resources", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/SeldonDeployment" }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "500": { "$ref": "#/components/responses/ErrorDefault" } }, "tags": [ "SeldonDeployments" ] } }, "/user": { "get": { "description": "Read the request user", "operationId": "ReadUser", "responses": { "200": { "$ref": "#/components/responses/UserResponse" } }, "tags": [ "Environment" ] } }, "/version": { "get": { "description": "Read the version", "operationId": "ReadVersion", "responses": { "200": { "$ref": "#/components/responses/VersionResponse" } }, "tags": [ "Environment" ] } }, "/model/metadata": { "get": { "summary": "List Model Metadata entries.", "description": "List takes several parameters that are present in the Model Metadata and tries to list all metadata entries that match all supplied fields. To filter by `tags` or `metrics` you can use a map as a query parameter. For example: `?tags[key]=value`.", "operationId": "ModelMetadataService_ListModelMetadata", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ModelMetadataListResponse" } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "URI", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "version", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "artifactType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "UNKNOWN", "CUSTOM", "TENSORFLOW", "SKLEARN", "XGBOOST", "MLFLOW", "PYTORCH", "ONNX", "TENSORRT", "ALIBI_EXPLAIN", "ALIBI_DETECT", "HUGGINGFACE", "MLSERVER_PYTHON", "TRITON_PYTHON" ], "default": "UNKNOWN" } }, { "name": "taskType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "modelType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "query", "description": "For more complex queries where other logical operators like OR, NOT, etc.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "description": "Optional. The maximum number of Folders to return in the response.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "Optional. A pagination token returned from a previous call to `List`\nthat indicates where this listing should continue from.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "listMask", "description": "Optional. Can be used to specify which fields of Model you wish to return in the response.\nIf left empty all fields will be returned.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "project", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "orderBy", "description": "Based on https://cloud.google.com/apis/design/design_patterns#sorting_order\n\nThe order in which to return the model metadata. The string value should follow SQL syntax: comma separated list of fields. The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. Valid field names include: uri, name, version, project, artifact_type, task_type.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "defaultProtocol", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PROTOCOL_UNKNOWN", "PROTOCOL_SELDON", "PROTOCOL_TENSORFLOW", "PROTOCOL_V2" ], "default": "PROTOCOL_UNKNOWN" } } ], "tags": [ "ModelMetadataService" ] }, "delete": { "summary": "Delete a Model Metadata entry.", "operationId": "ModelMetadataService_DeleteModelMetadata", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ModelMetadataDeleteResponse" } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "URI", "description": "The URI for the storage bucket containing the model, or the URI to the docker image for custom models. It must be a valid URI as defined in RFC 3986, and must not exceed 200 characters.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "project", "description": "The project that this model belongs to.", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "ModelMetadataService" ] }, "post": { "summary": "Create a Model Metadata entry.", "operationId": "ModelMetadataService_CreateModelMetadata", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ModelMetadataCreateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "$ref": "#/components/requestBodies/v1Model" }, "tags": [ "ModelMetadataService" ] }, "put": { "summary": "Update a Model Metadata entry.", "operationId": "ModelMetadataService_UpdateModelMetadata", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ModelMetadataUpdateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "$ref": "#/components/requestBodies/v1Model" }, "tags": [ "ModelMetadataService" ] } }, "/model/metadata/runtime": { "get": { "summary": "List Runtime Metadata for all deployments associated with a model.", "operationId": "ModelMetadataService_ListRuntimeMetadataForModel", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1RuntimeMetadataListResponse" } } } }, "204": { "description": "No Content", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "ModelURI", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "DeploymentUID", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "DeploymentName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "DeploymentNamespace", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "DeploymentStatus", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Running", "Stopped", "Unknown" ], "default": "Running" } }, { "name": "PredictorName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "NodeName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "description": "Optional. The maximum number of Folders to return in the response.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageToken", "description": "Optional. A pagination token returned from a previous call to `List`\nthat indicates where this listing should continue from.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "listMask", "description": "Optional. Can be used to specify which fields of RuntimeMetadata you wish to return in the response.\nIf left empty all fields will be returned.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "deploymentType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "UndefinedDeploymentType", "SeldonDeployment", "SeldonModel", "KnativeDetector" ], "default": "UndefinedDeploymentType" } } ], "tags": [ "ModelMetadataService" ] } }, "/iam/groups": { "get": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List all groups. The caller must have `read` permission on `system/iam`.", "operationId": "PermissionManagementService_GetGroups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetGroupsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "PermissionManagementService" ] }, "post": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Create a group. The caller must have `write` permission on `system/iam`.", "operationId": "PermissionManagementService_CreateGroup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateGroupResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateGroupRequest" } } }, "required": true }, "tags": [ "PermissionManagementService" ] } }, "/iam/groups/{groupName}/members": { "get": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List all members of a group. The caller must have `read` permission on `system/iam`.", "operationId": "PermissionManagementService_GetGroupMembers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetGroupMembersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "groupName", "description": "The name of the group for which to get members.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] } }, "/iam/groups/{name}": { "delete": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Delete a group. The caller must have `write` permission on `system/iam`.", "operationId": "PermissionManagementService_DeleteGroup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeleteGroupResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "name", "description": "The name of the group to be deleted.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] } }, "/iam/policy": { "delete": { "summary": "Delete an authorization policy. The user must have `grant` permissions on the resource in the policy.", "operationId": "PermissionManagementService_DeletePolicy", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeletePolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "users", "description": "The user IDs from which to revoke the given resource/action permission.", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "groups", "description": "The groups from which to revoke the given resource/action permission.", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "action", "description": "The action part of the resource/action permission to revoke.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "resource", "description": "The resource part of the resource/action permission to revoke.", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] }, "post": { "summary": "Create an authorization policy. The user must have `grant` permissions on the resource in the policy.", "operationId": "PermissionManagementService_CreatePolicy", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreatePolicyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1Policy" } } }, "required": true }, "tags": [ "PermissionManagementService" ] } }, "/iam/policy/permissions": { "get": { "summary": "List all permissions associated with the given users and groups. A regular user will be able to see only their permissions and the permissions of their groups. A user with `read` permission on `system/iam` can see all permissions.", "operationId": "PermissionManagementService_GetPermissions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetPermissionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "users", "description": "The user IDs for which to list permission.", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "groups", "description": "The groups for which to list permission.", "in": "query", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "callerPermissions", "description": "If true will list the permissions of the user making the request. All users have permissions to check their permissions.", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "tags": [ "PermissionManagementService" ] } }, "/iam/policy/targets": { "get": { "summary": "List all users and groups who have access to the given resource/action pair. The user calling this endpoint must have `grant` access to the given resource.", "operationId": "PermissionManagementService_GetPolicyTargets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetPolicyTargetsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "action", "description": "The action a target should be able to perform on the given resource.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "resource", "description": "The resource a target should have access to.", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] } }, "/iam/users": { "get": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List users. The caller must have `read` permission on `system/iam`.", "operationId": "PermissionManagementService_GetUsers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetUsersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "username", "description": "The username of the user to fetch. It must consist of only letters, numbers, underscores, and dashes, and be at most 30 characters.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "email", "description": "The email of the user to fetch. It must be a valid email.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] }, "post": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Create a user. The caller must have `write` permission on `system/iam`.", "operationId": "PermissionManagementService_CreateUser", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateUserResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateUserRequest" } } }, "required": true }, "tags": [ "PermissionManagementService" ] } }, "/iam/users/{username}": { "delete": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Delete a user. The caller must have `write` permission on `system/iam`.", "operationId": "PermissionManagementService_DeleteUser", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeleteUserResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "username", "description": "The username of the user to be deleted.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] } }, "/iam/users/{username}/groups": { "get": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. List all groups of a user. The caller must have `read` permission on `system/iam`.", "operationId": "PermissionManagementService_GetUserGroups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetUserGroupsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "username", "description": "The name of the user for who to get groups.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] } }, "/iam/users/{username}/groups/{group}": { "delete": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Delete user from a group. The caller must have `write` permission on `system/iam`.", "operationId": "PermissionManagementService_DeleteUserFromGroup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeleteUserFromGroupResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "username", "description": "The name of the user to be removed from a group.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "group", "description": "The name of the group from which to remove a user.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] }, "put": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Add user to a group. The caller must have `write` permission on `system/iam`.", "operationId": "PermissionManagementService_AddUserToGroup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AddUserToGroupResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "username", "description": "The name of the user to be added to a group.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "group", "description": "The name of the group to which to add a user.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] } }, "/iam/users/{username}/resetPassword": { "post": { "summary": "Endpoint is available only when user management is enabled configured - refer to the docs for how to do this. Sends an email to the user with a link to reset their password. The caller must have `write` permission on `system/iam`.", "operationId": "PermissionManagementService_ResetUserPassword", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ResetUserPasswordResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "username", "description": "The username of the user to be deleted.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "PermissionManagementService" ] } }, "/alerting/alerts": { "get": { "summary": "List currently firing alerts.", "operationId": "AlertingService_ListAlerts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ListAlertsResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "tags": [ "AlertingService" ] } }, "/alerting/test": { "post": { "summary": "Triggers a test alert to check alerting workflow.", "operationId": "AlertingService_TriggerTestAlert", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TriggerTestAlertResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Set to true if you wish to test Prometheus -> Alertmanager connection\nFalse sends an alert payload directly to Alertmanager, skipping Prometheus metrics/alert flow", "required": true }, "tags": [ "AlertingService" ] } }, "/secrets/{namespace}/bucket/gcs/{remote}": { "post": { "summary": "Creates a GCS bucket secret according to specified parameters.", "operationId": "SecretsService_CreateGCSBucketSecret", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateGCSBucketSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace to create secret in.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "remote", "description": "The remote name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length. The created secret will be named {remote}-bucket-envvars or {remote}-bucket-params, for Core 1 or Core 2, respectively.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secretVersion", "description": "The version of the secret to use (CORE_V1 or CORE_V2). Default value is CORE_V1", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "CORE_1", "CORE_2" ], "default": "CORE_1" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "The GCS account credentials to populate the secret. See documentation for how to generate this." } } }, "required": true }, "tags": [ "SecretsService" ] } }, "/secrets/{namespace}/bucket/rclone/{remote}": { "post": { "summary": "Creates a generic rclone bucket secret according to specified parameters.", "operationId": "SecretsService_CreateRcloneBucketSecret", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateRcloneBucketSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace to create secret in.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "remote", "description": "The remote name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length. The created secret will be named {remote}-bucket-envvars or {remote}-bucket-params, for Core 1 or Core 2, respectively.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "description": "The format for the secret. Must be one of (env_var, config_param). env_var formats the secret as environment variables, each with a key and a value. env_var is suitable for Seldon Core v1 and Argo Workflows. config_param formats the secret to be compatible with Rclone's HTTP API. config_param is suitable for Seldon Core v2.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "env_var", "config_param" ], "default": "env_var" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1RcloneConfig" } } }, "required": true }, "tags": [ "SecretsService" ] } }, "/secrets/{namespace}/bucket/s3/{remote}": { "post": { "summary": "Creates a S3 bucket secret according to specified parameters.", "operationId": "SecretsService_CreateS3BucketSecret", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateS3BucketSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace to create secret in.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "remote", "description": "The remote name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length. The created secret will be named {remote}-bucket-envvars or {remote}-bucket-params, for Core 1 or Core 2, respectively.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secretVersion", "description": "The version of the secret to use (CORE_1 or CORE_2). Default value is CORE_1", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "CORE_1", "CORE_2" ], "default": "CORE_1" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1S3Credentials" } } }, "required": true }, "tags": [ "SecretsService" ] } }, "/secrets/{namespace}/registry/{name}": { "post": { "summary": "Creates a registry secret according to specified parameters.", "operationId": "SecretsService_CreateRegistrySecret", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1CreateRegistrySecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace to create secret in.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "description": "The secret name must contain only lowercase letters, digits or dashes, must start and end with a lowercase letter or digit and must be no more than 30 characters in length.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "The raw json docker credentials config." } } }, "required": true }, "tags": [ "SecretsService" ] } }, "/secrets/{namespace}/{secretType}": { "get": { "summary": "Lists the names and metadata of secrets used by Seldon Deploy.", "operationId": "SecretsService_ListSecrets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ListSecretsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace to list secrets in.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secretType", "description": "The secret type, can be one of (`bucket`, `registry`) or `all` to list all secrets used by Seldon Deploy.", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "all", "bucket", "registry" ] } }, { "name": "bucketSecretFormat", "description": "Optional filter for the format of bucket secrets. Only applicable when `secret_type` is `bucket.`", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "env_var", "config_param" ], "default": "env_var" } }, { "name": "pageSize", "description": "Optional The maximum number of Secrets to return in the response.", "in": "query", "required": false, "schema": { "type": "string", "format": "int64" } }, { "name": "pageToken", "description": "Optional pagination token returned from a previous call to List that indicates where this listing should continue from.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "description": "Optional search string for secrets.", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "SecretsService" ] } }, "/secrets/{namespace}/{secretType}/{name}": { "delete": { "summary": "Deletes the specified secret.", "operationId": "SecretsService_DeleteSecret", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeleteSecretResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace to delete secret from.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "secretType", "description": "The secret type of the secret to be deleted, can be one of (`bucket`, `registry`).", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "all", "bucket", "registry" ] } }, { "name": "name", "description": "The name of the secret to delete.", "in": "path", "required": true, "schema": { "type": "string" } } ], "tags": [ "SecretsService" ] } }, "/healthcheck/{dependency}": { "get": { "summary": "List the current health of a specific Seldon Deploy dependency or all of them", "operationId": "HealthcheckService_GetDependencyHealth", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DependencyHealthResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "dependency", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ALL", "PROMETHEUS", "ELASTICSEARCH", "ALERTMANAGER", "POSTGRES", "KEYCLOAK", "KAFKA", "SELDONCORE_V1", "SELDONCORE_V2", "GITEA", "ARGOCD", "ARGOWF", "KNATIVE", "METRONOME", "MINIO", "FLUENTD" ] } } ], "tags": [ "HealthcheckService" ] } }, "/inference-logs/models": { "get": { "summary": "Get inference logs metadata for seldon models.", "operationId": "InferenceLogsService_ListModelInferenceLogs", "responses": { "200": { "description": "Inference logs metadata for seldon models", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ListModelInferenceLogsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "501": { "description": "Service not implemented or enabled", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace that this seldon deployment belongs to.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pipelineName", "description": "The name of the seldon pipeline to get inference logs for.", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "modelName", "description": "The name of the seldon model to get inference logs for.", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": [ "InferenceLogsService" ] } }, "/inference-logs/namespace/{namespace}/pipelines/{pipelineName}/models/{modelName}": { "post": { "summary": "Get inference logs for seldon models.", "operationId": "InferenceLogsService_GetModelInferenceLogs", "responses": { "200": { "description": "Inference logs metadata for seldon models", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetModelInferenceLogsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "501": { "description": "Service not implemented or enabled", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace that this seldon deployment belongs to.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pipelineName", "description": "The name of the seldon pipeline to get inference logs for.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "modelName", "description": "The name of the seldon model to get inference logs for.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The start time of the inference logs to get." }, "endTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The end time of the inference logs to get." }, "limit": { "type": "integer", "format": "int32", "example": 100, "description": "The maximum number of inference logs to get." }, "pageToken": { "type": "string", "example": "my-page-token", "description": "The page token to use to get the next page of inference logs." } } } } }, "required": true }, "tags": [ "InferenceLogsService" ] } }, "/inference-logs/namespace/{namespace}/seldondeployments/{deploymentName}": { "post": { "summary": "Get inference logs for seldon deployments.", "operationId": "InferenceLogsService_GetDeploymentInferenceLogs", "responses": { "200": { "description": "Inference logs metadata for seldon deployments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GetDeploymentInferenceLogsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "501": { "description": "Service not implemented or enabled", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace that this seldon deployment belongs to.", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deploymentName", "description": "The name of the seldon deployment to get inference logs for.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "predictorName": { "type": "string", "example": "default", "description": "The predictor name of the seldon deployment to get inference logs for. e.g. \"default\", \"canary\", \"shadow\"" }, "containerName": { "type": "string", "example": "my-container", "description": "The container name of the seldon deployment to get inference logs for. e.g. \"my-container\", \"input-transformer\", \"output-transformer\"" }, "startTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The start time of the inference logs to get." }, "endTime": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The end time of the inference logs to get." }, "limit": { "type": "integer", "format": "int32", "example": 100, "description": "The maximum number of inference logs to get." }, "pageToken": { "type": "string", "example": "my-page-token", "description": "The page token to use to get the next page of inference logs." } }, "required": [ "predictorName", "containerName" ] } } }, "required": true }, "tags": [ "InferenceLogsService" ] } }, "/inference-logs/seldondeployments": { "get": { "summary": "Get inference logs metadata for seldon deployments.", "operationId": "InferenceLogsService_ListDeploymentInferenceLogs", "responses": { "200": { "description": "Inference logs metadata for seldon deployments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ListDeploymentInferenceLogsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": {} } } }, "501": { "description": "Service not implemented or enabled", "content": { "application/json": { "schema": {} } } }, "default": { "description": "An unexpected error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } } } }, "parameters": [ { "name": "namespace", "description": "The namespace that this seldon deployment belongs to.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "deploymentName", "description": "The name of the seldon deployment to get inference logs for.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "predictorName", "description": "The predictor name of the seldon deployment to get inference logs for. e.g. \"default\", \"canary\", \"shadow\"", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "containerName", "description": "The container name of the seldon deployment to get inference logs for. e.g. \"my-container\", \"input-transformer\", \"output-transformer\"", "in": "query", "required": false, "schema": { "type": "string" } } ], "tags": [ "InferenceLogsService" ] } } }, "security": [ { "OAuth2": [ "[]" ] } ], "tags": [ { "description": "Environment APIs for Seldon Deploy", "name": "Environment" }, { "description": "SeldonDeployments APIs for Seldon Deploy", "name": "SeldonDeployments" }, { "description": "Seldon Core Pipeline APIs for Seldon Deploy", "name": "Pipelines" }, { "description": "Seldon Core Model APIs for Seldon Deploy", "name": "Models" }, { "description": "Seldon Core Experiment APIs for Seldon Deploy", "name": "Experiments" }, { "description": "Prediction APIs for Seldon Deploy", "name": "Predict" }, { "description": "Explanation APIs for Seldon Deploy", "name": "Explain" }, { "description": "GitOps APIs for Seldon Deploy", "name": "GitOps" }, { "description": "Loadtest Jobs APIs for Seldon Deploy", "name": "LoadtestJobs" }, { "description": "Batch Jobs APIs for Seldon Deploy", "name": "BatchJobs" }, { "description": "Drift Detector APIs for Seldon Deploy", "name": "DriftDetector" }, { "description": "Outlier Detector APIs for Seldon Deploy", "name": "OutlierDetector" }, { "description": "Metrics Server APIs for Seldon Deploy", "name": "MetricsServer" }, { "description": "KubernetesResources APIs for Seldon Deploy", "name": "KubernetesResources" }, { "description": "ApplicationLogs APIs for Seldon Deploy", "name": "ApplicationLogs" } ], "servers": [ { "url": "http://X.X.X.X/seldon-deploy/api/v1alpha1" }, { "url": "https://X.X.X.X/seldon-deploy/api/v1alpha1" } ], "components": { "responses": { "AnalyticsProps": { "description": "", "headers": { "distinct_id": { "schema": { "type": "string" } }, "release_type": { "schema": { "type": "string" } }, "schema_version": { "schema": { "type": "string" } }, "seldon_deploy_version": { "schema": { "type": "string" } }, "token": { "schema": { "type": "string" } } } }, "ApplicationLogsResponse": { "description": "Application Logs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationLogsResponse" } } } }, "BatchJobGetResponse": { "description": "Batch Job Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobGetResponse" } } } }, "BatchJobPostResponse": { "description": "Batch Job Post Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobPostResponse" } } } }, "BatchJobsListResponse": { "description": "Batch Jobs List Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobsListResponse" } } } }, "ClusterInfoResponse": { "description": "Cluster Info", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterInfo" } } } }, "DetectorListResponse": { "description": "Detector configuration data list", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DetectorData" }, "type": "array" } } } }, "DetectorResponse": { "description": "Detector configuration data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetectorData" } } } }, "ErrorDefault": { "description": "ErrorDefault Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "FeatureDistResponse": { "description": "Feature Distribution Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureDistributionResponse" } } } }, "FeatureStatResponse": { "description": "Feature Statistics Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureStatisticsResponse" } } } }, "GenericResponse": { "description": "Generic", "content": { "application/json": { "schema": {} } } }, "GitDiffResponse": { "description": "Git Diff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDiff" } } } }, "GitDiffsResponse": { "description": "Git Diffs", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FileDiff" }, "type": "array" } } } }, "GitLogsResponse": { "description": "Git Logs", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AuditLog" }, "type": "array" } } } }, "HealthCheckResponse": { "description": "Version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckInfo" } } } }, "MessageResponse": { "description": "GenericMessage Message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "ResourceListResponse": { "description": "Resource list", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Component" }, "type": "array" } } } }, "SeldonDeploymentListResponse": { "description": "Seldon Deployment list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonDeploymentList" } } } }, "SeldonDeploymentResponse": { "description": "Seldon Deployment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonDeployment" } } } }, "SeldonExperimentResponse": { "description": "Seldon Experiment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonExperiment" } } } }, "SeldonModelListResponse": { "description": "Seldon Model List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonModelList" } } } }, "SeldonModelResponse": { "description": "Seldon Model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonModel" } } } }, "SeldonPipelineListResponse": { "description": "Seldon Pipeline List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonPipelineList" } } } }, "SeldonPipelineResponse": { "description": "Seldon Pipeline", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonPipeline" } } } }, "UserResponse": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInfo" } } } }, "VersionResponse": { "description": "Version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionInfo" } } } } }, "requestBodies": { "CreateLoadtestPipeline": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "loadFile": { "description": "Prediction contains predict payload", "type": "string", "format": "binary" }, "connectionsNumber": { "description": "Connections Number provides number of allowed connections", "type": "string" }, "requestsNumber": { "description": "Requests Number provides number of allowed requests", "type": "string" }, "duration": { "description": "Duration of load test in seconds", "type": "string" } }, "required": [ "loadFile" ] } } }, "required": true }, "ExplainSeldonPipelineExplaindata": { "content": { "application/json": { "schema": {} } }, "description": "Prediction contains predict payload" }, "BatchJobDefinition": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchJobDefinition" } } }, "description": "WorkflowName", "required": true }, "Model": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Model" } } }, "description": "Seldon Model", "required": true }, "Pipeline": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } }, "description": "Seldon Pipeline", "required": true }, "Experiment": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Experiment" } } }, "description": "Seldon Experiment", "required": true }, "DetectorConfigData": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetectorConfigData" } } }, "description": "Deployment Detector Data", "required": true }, "DeploymentFeatureData": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentFeatureData" } } }, "description": "Deployment Feature Data", "required": true }, "ReadPredictCurlSeldonPipelinePrediction": { "content": { "application/json": { "schema": {} } }, "description": "Prediction", "required": true }, "PredictFileSeldonPipeline": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "predictFile": { "description": "PredictionFile", "type": "string", "format": "binary" } }, "required": [ "predictFile" ] } } }, "required": true }, "SeldonDeployment": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeldonDeployment" } } }, "description": "Seldon Deployment", "required": true }, "v1Model": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1Model" } } }, "required": true } }, "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://Y.Y.Y.Y", "scopes": { "email": "", "groups": "", "openid": "", "profile": "" } } } } }, "schemas": { "AWSElasticBlockStoreVolumeSource": { "description": "An AWS EBS disk must exist before mounting to a container. The disk\nmust also be in the same AWS zone as the kubelet. An AWS EBS disk\ncan only be mounted as read/write once. AWS EBS volumes support\nownership management and SELinux relabeling.", "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "partition": { "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\n+optional", "format": "int32", "type": "integer" }, "readOnly": { "description": "readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional", "type": "boolean" }, "volumeID": { "description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": "string" } }, "title": "Represents a Persistent Disk resource in AWS.", "type": "object" }, "AdvancedConfig": { "description": "AdvancedConfig specifies advance scaling options", "properties": { "horizontalPodAutoscalerConfig": { "$ref": "#/components/schemas/HorizontalPodAutoscalerConfig" }, "restoreToOriginalReplicaCount": { "description": "+optional", "type": "boolean" } }, "type": "object" }, "Affinity": { "properties": { "nodeAffinity": { "$ref": "#/components/schemas/NodeAffinity" }, "podAffinity": { "$ref": "#/components/schemas/PodAffinity" }, "podAntiAffinity": { "$ref": "#/components/schemas/PodAntiAffinity" } }, "title": "Affinity is a group of affinity scheduling rules.", "type": "object" }, "AlibiExplainerType": { "type": "string" }, "ApplicationLog": { "description": "ApplicationLog represents the message and timestamp of a single\napplication log entry.", "properties": { "message": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" } }, "type": "object" }, "ApplicationLogsParams": { "description": "ApplicationLogsParams describes a set of parameters that can be\nused to build a search query for an application's logs.\nIn most cases, only ContainerId, From, and Size are required in\norder to create a search query.", "properties": { "container_id": { "type": "string" }, "container_name": { "type": "string" }, "deployment_namespace": { "type": "string" }, "from": { "format": "int64", "type": "integer" }, "pod_name": { "type": "string" }, "size": { "format": "int64", "type": "integer" } }, "type": "object" }, "ApplicationLogsResponse": { "description": "ApplicationLogsResponse represents the collection of application logs\nand their total size after being parsed from their raw forms\ne.g. from json strings or map[string]any types.", "properties": { "logs": { "items": { "$ref": "#/components/schemas/ApplicationLog" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "AuditLog": { "properties": { "AuthorName": { "type": "string" }, "AuthorWhen": { "format": "date-time", "type": "string" }, "CommitterName": { "type": "string" }, "CommitterWhen": { "format": "date-time", "type": "string" }, "Hash": { "type": "string" } }, "type": "object" }, "AzureDataDiskCachingMode": { "description": "+enum", "type": "string" }, "AzureDataDiskKind": { "description": "+enum", "type": "string" }, "AzureDiskVolumeSource": { "properties": { "cachingMode": { "$ref": "#/components/schemas/AzureDataDiskCachingMode" }, "diskName": { "description": "diskName is the Name of the data disk in the blob storage", "type": "string" }, "diskURI": { "description": "diskURI is the URI of data disk in the blob storage", "type": "string" }, "fsType": { "description": "fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "type": "string" }, "kind": { "$ref": "#/components/schemas/AzureDataDiskKind" }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" } }, "title": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.", "type": "object" }, "AzureFileVolumeSource": { "properties": { "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretName": { "description": "secretName is the name of secret that contains Azure Storage Account Name and Key", "type": "string" }, "shareName": { "description": "shareName is the azure share Name", "type": "string" } }, "title": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", "type": "object" }, "BasicDetectorConfiguration": { "properties": { "drift_batch_size": { "type": "string" }, "drift_type_feature": { "type": "boolean" }, "env_secret_ref": { "type": "string" }, "project": { "type": "string" }, "storage_uri": { "type": "string" } }, "type": "object" }, "BatchJobDefinition": { "description": "BatchJobDefinition is a common interface for BatchJob v1 and v2 which specifies necessary arguments", "properties": { "batchDataType": { "description": "Batch Data Type (data, json or str)", "type": "string" }, "batchInterval": { "description": "Interval between batches", "format": "double", "type": "number" }, "batchMethod": { "description": "Batch Method (predict, feedback (for SCv1))", "type": "string" }, "batchPayloadType": { "description": "Batch Payload Type (ndarray, tensor, tftensor, v2raw, v2binary - only if DataType=data)", "type": "string" }, "batchRetries": { "description": "Number of retries for each instance", "format": "int64", "type": "integer" }, "batchSize": { "description": "Size of the batch (number of predictions per request)", "format": "int64", "type": "integer" }, "batchTransportProtocol": { "description": "Batch Transport Protocol (rest or grpc)", "type": "string" }, "batchWorkers": { "description": "Number of batch workers", "format": "int64", "type": "integer" }, "inputData": { "description": "S3 URI of input data file", "type": "string" }, "limitsCpu": { "description": "Container Resources for running batch jobs: limits: CPU", "type": "string" }, "limitsMemory": { "description": "Container Resources for running batch jobs: limits: Memory", "type": "string" }, "objectStoreSecretName": { "description": "name of Kubernetes Secret with S3 credentials", "type": "string" }, "outputData": { "description": "S3 URI of output data file", "type": "string" }, "pvcSize": { "description": "Size of PVC required for the batch job", "type": "string" }, "requestsCpu": { "description": "Container Resources for running batch jobs: requests: CPU", "type": "string" }, "requestsMemory": { "description": "Container Resources for running batch jobs: requests: Memory", "type": "string" } }, "type": "object" }, "BatchJobDescription": { "description": "BatchJobDescription describes the workflow of the batch job", "properties": { "FinishedAt": { "description": "Time when job finished", "type": "string" }, "StartedAt": { "description": "Time when job started", "type": "string" }, "workflowName": { "description": "Name of related Argo Workflow", "type": "string" }, "workflowStatus": { "$ref": "#/components/schemas/WorkflowPhase" }, "workflowUID": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "BatchJobDescriptionList": { "description": "BatchJobDescriptionList is a list of BatchJobDescription", "items": { "$ref": "#/components/schemas/BatchJobDescription" }, "type": "array" }, "BatchJobGetResponse": { "description": "BatchJobGetResponse represents the full description and definition of a\nretrieved batch job", "properties": { "Definition": { "$ref": "#/components/schemas/BatchJobDefinition" }, "Description": { "$ref": "#/components/schemas/BatchJobDescription" } }, "type": "object" }, "BatchJobPostResponse": { "description": "BatchJobPostResponse represents the name and uid of the batch job\ncreated after a post request", "properties": { "workflowName": { "description": "Name of created Argo Workflow\nin: body", "type": "string" }, "workflowUID": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "BatchJobsListResponse": { "description": "BatchJobsListResponse represents the list of batch descriptions and their\nlimit, page, and page counts.", "properties": { "batchJobs": { "$ref": "#/components/schemas/BatchJobDescriptionList" }, "limit": { "description": "Limit of the request\nin: body", "format": "int64", "type": "integer" }, "page": { "description": "Returned Page (counting from 0)\nin: body", "format": "int64", "type": "integer" }, "pagesCount": { "description": "Number of available pages (Page = 0, ..., PagesCount - 1)\nin: body", "format": "int64", "type": "integer" } }, "type": "object" }, "CSIVolumeSource": { "description": "Represents a source location of a volume to mount, managed by an external CSI driver", "properties": { "driver": { "description": "driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster.", "type": "string" }, "fsType": { "description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.\n+optional", "type": "string" }, "nodePublishSecretRef": { "$ref": "#/components/schemas/LocalObjectReference" }, "readOnly": { "description": "readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional", "type": "boolean" }, "volumeAttributes": { "additionalProperties": { "type": "string" }, "description": "volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.\n+optional", "type": "object" } }, "type": "object" }, "Capabilities": { "properties": { "add": { "description": "Added capabilities\n+optional", "items": { "$ref": "#/components/schemas/Capability" }, "type": "array" }, "drop": { "description": "Removed capabilities\n+optional", "items": { "$ref": "#/components/schemas/Capability" }, "type": "array" } }, "title": "Adds and removes POSIX capabilities from running containers.", "type": "object" }, "Capability": { "description": "Capability represent POSIX capabilities type", "type": "string" }, "CephFSVolumeSource": { "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod\nCephfs volumes do not support ownership management or SELinux relabeling.", "properties": { "monitors": { "description": "monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "items": { "type": "string" }, "type": "array" }, "path": { "description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional", "type": "string" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "boolean" }, "secretFile": { "description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "string" }, "secretRef": { "$ref": "#/components/schemas/LocalObjectReference" }, "user": { "description": "user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "string" } }, "type": "object" }, "CinderVolumeSource": { "description": "A Cinder volume must exist before mounting to a container.\nThe volume must also be in the same region as the kubelet.\nCinder volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "type": "boolean" }, "secretRef": { "$ref": "#/components/schemas/LocalObjectReference" }, "volumeID": { "description": "volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" } }, "title": "Represents a cinder volume resource in Openstack.", "type": "object" }, "ClaimSource": { "description": "Exactly one of these fields should be set. Consumers of this type must\ntreat an empty object as if it has an unknown value.", "properties": { "resourceClaimName": { "description": "ResourceClaimName is the name of a ResourceClaim object in the same\nnamespace as this pod.", "type": "string" }, "resourceClaimTemplateName": { "description": "ResourceClaimTemplateName is the name of a ResourceClaimTemplate\nobject in the same namespace as this pod.\n\nThe template will be used to create a new ResourceClaim, which will\nbe bound to this pod. When this pod is deleted, the ResourceClaim\nwill also be deleted. The pod name and resource name, along with a\ngenerated component, will be used to form a unique name for the\nResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.\n\nThis field is immutable and no changes will be made to the\ncorresponding ResourceClaim by the control plane after creating the\nResourceClaim.", "type": "string" } }, "title": "ClaimSource describes a reference to a ResourceClaim.", "type": "object" }, "ClientIPConfig": { "properties": { "timeoutSeconds": { "description": "timeoutSeconds specifies the seconds of ClientIP type session sticky time.\nThe value must be >0 && <=86400(for 1 day) if ServiceAffinity == \"ClientIP\".\nDefault value is 10800(for 3 hours).\n+optional", "format": "int32", "type": "integer" } }, "title": "ClientIPConfig represents the configurations of Client IP based session affinity.", "type": "object" }, "ClusterInfo": { "properties": { "Namespaces": { "items": { "$ref": "#/components/schemas/Namespace" }, "type": "array" } }, "type": "object" }, "ClusterTrustBundleProjection": { "description": "ClusterTrustBundleProjection describes how to select a set of\nClusterTrustBundle objects and project their contents into the pod\nfilesystem.", "properties": { "labelSelector": { "$ref": "#/components/schemas/LabelSelector" }, "name": { "description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector.\n+optional", "type": "string" }, "optional": { "description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles.\n+optional", "type": "boolean" }, "path": { "description": "Relative path from the volume root to write the bundle.", "type": "string" }, "signerName": { "description": "Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated.\n+optional", "type": "string" } }, "type": "object" }, "Component": { "properties": { "component": { "type": "string" }, "deployments": { "$ref": "#/components/schemas/DeploymentList" }, "pods": { "$ref": "#/components/schemas/PodList" }, "services": { "$ref": "#/components/schemas/ServiceList" } }, "type": "object" }, "ConditionStatus": { "type": "string" }, "Conditions": { "$ref": "#/components/schemas/Conditions" }, "ConfigMapEnvSource": { "description": "The contents of the target ConfigMap's Data field will represent the\nkey-value pairs as environment variables.", "properties": { "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap must be defined\n+optional", "type": "boolean" } }, "title": "ConfigMapEnvSource selects a ConfigMap to populate the environment\nvariables with.", "type": "object" }, "ConfigMapKeySelector": { "description": "+structType=atomic", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined\n+optional", "type": "boolean" } }, "title": "Selects a key from a ConfigMap.", "type": "object" }, "ConfigMapProjection": { "description": "The contents of the target ConfigMap's Data field will be presented in a\nprojected volume as files using the keys in the Data field as the file names,\nunless the items element is populated with specific mappings of keys to paths.\nNote that this is identical to a configmap volume source without the default\nmode.", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/KeyToPath" }, "type": "array" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } }, "title": "Adapts a ConfigMap into a projected volume.", "type": "object" }, "ConfigMapVolumeSource": { "description": "The contents of the target ConfigMap's Data field will be presented in a\nvolume as files using the keys in the Data field as the file names, unless\nthe items element is populated with specific mappings of keys to paths.\nConfigMap volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "description": "defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "type": "integer" }, "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/KeyToPath" }, "type": "array" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } }, "title": "Adapts a ConfigMap into a volume.", "type": "object" }, "Container": { "properties": { "args": { "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "type": "array" }, "command": { "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "type": "array" }, "env": { "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/EnvVar" }, "type": "array" }, "envFrom": { "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional", "items": { "$ref": "#/components/schemas/EnvFromSource" }, "type": "array" }, "image": { "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional", "type": "string" }, "imagePullPolicy": { "$ref": "#/components/schemas/PullPolicy" }, "lifecycle": { "$ref": "#/components/schemas/Lifecycle" }, "livenessProbe": { "$ref": "#/components/schemas/Probe" }, "name": { "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated.", "type": "string" }, "ports": { "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol", "items": { "$ref": "#/components/schemas/ContainerPort" }, "type": "array" }, "readinessProbe": { "$ref": "#/components/schemas/Probe" }, "resizePolicy": { "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic", "items": { "$ref": "#/components/schemas/ContainerResizePolicy" }, "type": "array" }, "resources": { "$ref": "#/components/schemas/ResourceRequirements" }, "restartPolicy": { "$ref": "#/components/schemas/ContainerRestartPolicy" }, "securityContext": { "$ref": "#/components/schemas/SecurityContext" }, "startupProbe": { "$ref": "#/components/schemas/Probe" }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", "type": "boolean" }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", "type": "boolean" }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", "type": "string" }, "terminationMessagePolicy": { "$ref": "#/components/schemas/TerminationMessagePolicy" }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", "type": "boolean" }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional", "items": { "$ref": "#/components/schemas/VolumeDevice" }, "type": "array" }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/VolumeMount" }, "type": "array" }, "workingDir": { "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", "type": "string" } }, "title": "A single application container that you want to run within a pod.", "type": "object" }, "ContainerPort": { "properties": { "containerPort": { "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536.", "format": "int32", "type": "integer" }, "hostIP": { "description": "What host IP to bind the external port to.\n+optional", "type": "string" }, "hostPort": { "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional", "format": "int32", "type": "integer" }, "name": { "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional", "type": "string" }, "protocol": { "$ref": "#/components/schemas/Protocol" } }, "title": "ContainerPort represents a network port in a single container.", "type": "object" }, "ContainerResizePolicy": { "properties": { "resourceName": { "$ref": "#/components/schemas/ResourceName" }, "restartPolicy": { "$ref": "#/components/schemas/ResourceResizeRestartPolicy" } }, "title": "ContainerResizePolicy represents resource resize policy for the container.", "type": "object" }, "ContainerResourceMetricSource": { "description": "ContainerResourceMetricSource indicates how to scale on a resource metric known to\nKubernetes, as specified in requests and limits, describing each pod in the\ncurrent scale target (e.g. CPU or memory). The values will be averaged\ntogether before being compared to the target. Such metrics are built in to\nKubernetes, and have special scaling options on top of those available to\nnormal per-pod metrics using the \"pods\" source. Only one \"target\" type\nshould be set.", "properties": { "container": { "description": "container is the name of the container in the pods of the scaling target", "type": "string" }, "name": { "$ref": "#/components/schemas/ResourceName" }, "target": { "$ref": "#/components/schemas/MetricTarget" } }, "type": "object" }, "ContainerRestartPolicy": { "description": "This may only be set for init containers and only allowed value is \"Always\".", "title": "ContainerRestartPolicy is the restart policy for a single container.", "type": "string" }, "ContainerState": { "description": "Only one of its members may be specified.\nIf none of them is specified, the default one is ContainerStateWaiting.", "properties": { "running": { "$ref": "#/components/schemas/ContainerStateRunning" }, "terminated": { "$ref": "#/components/schemas/ContainerStateTerminated" }, "waiting": { "$ref": "#/components/schemas/ContainerStateWaiting" } }, "title": "ContainerState holds a possible state of container.", "type": "object" }, "ContainerStateRunning": { "properties": { "startedAt": { "description": "Time at which the container was last (re-)started\n+optional", "type": "string" } }, "title": "ContainerStateRunning is a running state of a container.", "type": "object" }, "ContainerStateTerminated": { "properties": { "containerID": { "description": "Container's ID in the format '://'\n+optional", "type": "string" }, "exitCode": { "description": "Exit status from the last termination of the container", "format": "int32", "type": "integer" }, "finishedAt": { "description": "Time at which the container last terminated\n+optional", "type": "string" }, "message": { "description": "Message regarding the last termination of the container\n+optional", "type": "string" }, "reason": { "description": "(brief) reason from the last termination of the container\n+optional", "type": "string" }, "signal": { "description": "Signal from the last termination of the container\n+optional", "format": "int32", "type": "integer" }, "startedAt": { "description": "Time at which previous execution of the container started\n+optional", "type": "string" } }, "title": "ContainerStateTerminated is a terminated state of a container.", "type": "object" }, "ContainerStateWaiting": { "properties": { "message": { "description": "Message regarding why the container is not yet running.\n+optional", "type": "string" }, "reason": { "description": "(brief) reason the container is not yet running.\n+optional", "type": "string" } }, "title": "ContainerStateWaiting is a waiting state of a container.", "type": "object" }, "ContainerStatus": { "properties": { "allocatedResources": { "$ref": "#/components/schemas/ResourceList" }, "containerID": { "description": "ContainerID is the ID of the container in the format '://'.\nWhere type is a container runtime identifier, returned from Version call of CRI API\n(for example \"containerd\").\n+optional", "type": "string" }, "image": { "description": "Image is the name of container image that the container is running.\nThe container image may not match the image used in the PodSpec,\nas it may have been resolved by the runtime.\nMore info: https://kubernetes.io/docs/concepts/containers/images.", "type": "string" }, "imageID": { "description": "ImageID is the image ID of the container's image. The image ID may not\nmatch the image ID of the image used in the PodSpec, as it may have been\nresolved by the runtime.", "type": "string" }, "lastState": { "$ref": "#/components/schemas/ContainerState" }, "name": { "description": "Name is a DNS_LABEL representing the unique name of the container.\nEach container in a pod must have a unique name across all container types.\nCannot be updated.", "type": "string" }, "ready": { "description": "Ready specifies whether the container is currently passing its readiness check.\nThe value will change as readiness probes keep executing. If no readiness\nprobes are specified, this field defaults to true once the container is\nfully started (see Started field).\n\nThe value is typically used to determine whether a container is ready to\naccept traffic.", "type": "boolean" }, "resources": { "$ref": "#/components/schemas/ResourceRequirements" }, "restartCount": { "description": "RestartCount holds the number of times the container has been restarted.\nKubelet makes an effort to always increment the value, but there\nare cases when the state may be lost due to node restarts and then the value\nmay be reset to 0. The value is never negative.", "format": "int32", "type": "integer" }, "started": { "description": "Started indicates whether the container has finished its postStart lifecycle hook\nand passed its startup probe.\nInitialized as false, becomes true after startupProbe is considered\nsuccessful. Resets to false when the container is restarted, or if kubelet\nloses state temporarily. In both cases, startup probes will run again.\nIs always true when no startupProbe is defined and container is running and\nhas passed the postStart lifecycle hook. The null value must be treated the\nsame as false.\n+optional", "type": "boolean" }, "state": { "$ref": "#/components/schemas/ContainerState" } }, "title": "ContainerStatus contains details for the current status of this container.", "type": "object" }, "CrossVersionObjectReference": { "properties": { "apiVersion": { "description": "apiVersion is the API version of the referent\n+optional", "type": "string" }, "kind": { "description": "kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "name": { "description": "name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" } }, "title": "CrossVersionObjectReference contains enough information to let you identify the referred resource.", "type": "object" }, "DNSPolicy": { "description": "+enum", "title": "DNSPolicy defines how a pod's DNS will be configured.", "type": "string" }, "Deployment": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/DeploymentSpec" }, "status": { "$ref": "#/components/schemas/DeploymentStatus" }, "uid": { "$ref": "#/components/schemas/UID" } }, "title": "Deployment enables declarative updates for Pods and ReplicaSets.", "type": "object" }, "DeploymentFeatureData": { "description": "DeploymentFeatureData represents a deployment level feature data", "properties": { "aggregate_over_time": { "description": "AggregateOverTime is a boolean to decide if the distribution response is to be aggregated over the time period selected", "type": "boolean" }, "deployment_endpoint": { "description": "DeploymentEndpoint refers to endpoint/predictor name relevant to the feature distribution query", "type": "string" }, "deployment_kind": { "description": "DeploymentType refers to kubernetes kind of the deployment relevant to the feature distribution query", "type": "string" }, "deployment_name": { "description": "DeploymentName refers to name of the deployment relevant to the feature distribution query", "type": "string" }, "deployment_namespace": { "description": "DeploymentNamespace refers to namespace of the deployment relevant to the feature distribution query", "type": "string" }, "deployment_node": { "description": "DeploymentNode refers to node name relevant to the feature distribution query", "type": "string" }, "feature": { "description": "FeatureName refers to the name of feature as per the model predictions schema", "type": "string" }, "filters": { "description": "Filters is a set of time, feature and/or outlier filters for the distribution/stats query", "items": { "$ref": "#/components/schemas/FeatureFilter" }, "type": "array" }, "interaction": { "$ref": "#/components/schemas/FeatureInteraction" }, "parameters": { "$ref": "#/components/schemas/FeatureDistributionParameters" }, "reference_data": { "description": "ReferenceData is a boolean to compute stats and distributions over reference data or inference data (false by default)", "type": "boolean" } }, "type": "object" }, "DeploymentList": { "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "continue": { "description": "continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nconsistent list may not be possible if the server configuration has changed or more than a few\nminutes have passed. The resourceVersion field returned when using this continue value will be\nidentical to the value in the first response, unless you have received this token from an error\nmessage.", "type": "string" }, "items": { "description": "Items is the list of Deployments.", "items": { "$ref": "#/components/schemas/Deployment" }, "type": "array" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "remainingItemCount": { "description": "remainingItemCount is the number of subsequent items in the list which are not included in this\nlist response. If the list request contained label or field selectors, then the number of\nremaining items is unknown and the field will be left unset and omitted during serialization.\nIf the list is complete (either because it is not chunking or because this is the last chunk),\nthen there are no more remaining items and this field will be left unset and omitted during\nserialization.\nServers older than v1.15 do not set this field.\nThe intended use of the remainingItemCount is *estimating* the size of a collection. Clients\nshould not rely on the remainingItemCount to be set or to be exact.\n+optional", "format": "int64", "type": "integer" }, "resourceVersion": { "description": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" } }, "title": "DeploymentList is a list of Deployments.", "type": "object" }, "DeploymentSpec": { "properties": { "minReadySeconds": { "description": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing, for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n+optional", "format": "int32", "type": "integer" }, "paused": { "description": "Indicates that the deployment is paused.\n+optional", "type": "boolean" }, "progressDeadlineSeconds": { "description": "The maximum time in seconds for a deployment to make progress before it\nis considered to be failed. The deployment controller will continue to\nprocess failed deployments and a condition with a ProgressDeadlineExceeded\nreason will be surfaced in the deployment status. Note that progress will\nnot be estimated during the time a deployment is paused. Defaults to 600s.", "format": "int32", "type": "integer" }, "replicas": { "description": "Number of desired pods. This is a pointer to distinguish between explicit\nzero and not specified. Defaults to 1.\n+optional", "format": "int32", "type": "integer" }, "revisionHistoryLimit": { "description": "The number of old ReplicaSets to retain to allow rollback.\nThis is a pointer to distinguish between explicit zero and not specified.\nDefaults to 10.\n+optional", "format": "int32", "type": "integer" }, "selector": { "$ref": "#/components/schemas/LabelSelector" }, "strategy": { "$ref": "#/components/schemas/DeploymentStrategy" }, "template": { "$ref": "#/components/schemas/PodTemplateSpec" } }, "title": "DeploymentSpec is the specification of the desired behavior of the Deployment.", "type": "object" }, "DeploymentStatus": { "properties": { "availableReplicas": { "format": "int32", "type": "integer" }, "description": { "type": "string" }, "explainerFor": { "type": "string" }, "name": { "type": "string" }, "replicas": { "format": "int32", "type": "integer" }, "status": { "type": "string" } }, "type": "object" }, "DeploymentStrategy": { "properties": { "rollingUpdate": { "$ref": "#/components/schemas/RollingUpdateDeployment" }, "type": { "$ref": "#/components/schemas/DeploymentStrategyType" } }, "title": "DeploymentStrategy describes how to replace existing pods with new ones.", "type": "object" }, "DeploymentStrategyType": { "description": "+enum", "type": "string" }, "DetectorConfigData": { "properties": { "config": { "$ref": "#/components/schemas/DetectorConfiguration" }, "name": { "type": "string" } }, "type": "object" }, "DetectorConfiguration": { "properties": { "basic": { "$ref": "#/components/schemas/BasicDetectorConfiguration" }, "deployment": { "$ref": "#/components/schemas/DetectorDeploymentConfiguration" } }, "type": "object" }, "DetectorData": { "properties": { "config": { "$ref": "#/components/schemas/DetectorConfiguration" }, "deployment_kind": { "type": "string" }, "deployment_name": { "type": "string" }, "detector_type": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "status": { "$ref": "#/components/schemas/DetectorStatus" } }, "type": "object" }, "DetectorDeploymentConfiguration": { "properties": { "event_source": { "type": "string" }, "event_type": { "type": "string" }, "http_port": { "type": "string" }, "memory_requirement": { "type": "string" }, "model_name": { "type": "string" }, "prom_scraping": { "type": "boolean" }, "protocol": { "type": "string", "description": "For model inference, Seldon recommends using the industry-standard Open Inference Protocol (OIP) as the preferred protocol over others.
The corresponding protocol OIP value for Seldon Deployment detectors is 'kfserving.http'. For Seldon ML Pipelines, this is the only supported protocol.
For more information, please refer to the Seldon documentation: https://docs.seldon.ai/seldon-core-2/apis/inference/v2" }, "reply_url": { "type": "string" }, "user_permission": { "format": "int64", "type": "integer" } }, "type": "object" }, "DetectorStatus": { "type": "string" }, "DownwardAPIProjection": { "description": "Note that this is identical to a downwardAPI volume source without the default\nmode.", "properties": { "items": { "description": "Items is a list of DownwardAPIVolume file\n+optional", "items": { "$ref": "#/components/schemas/DownwardAPIVolumeFile" }, "type": "array" } }, "title": "Represents downward API info for projecting into a projected volume.", "type": "object" }, "DownwardAPIVolumeFile": { "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field", "properties": { "fieldRef": { "$ref": "#/components/schemas/ObjectFieldSelector" }, "mode": { "description": "Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "type": "integer" }, "path": { "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'", "type": "string" }, "resourceFieldRef": { "$ref": "#/components/schemas/ResourceFieldSelector" } }, "type": "object" }, "DownwardAPIVolumeSource": { "description": "Downward API volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "description": "Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "type": "integer" }, "items": { "description": "Items is a list of downward API volume file\n+optional", "items": { "$ref": "#/components/schemas/DownwardAPIVolumeFile" }, "type": "array" } }, "title": "DownwardAPIVolumeSource represents a volume containing downward API info.", "type": "object" }, "EmptyDirVolumeSource": { "description": "Empty directory volumes support ownership management and SELinux relabeling.", "properties": { "medium": { "$ref": "#/components/schemas/StorageMedium" }, "sizeLimit": { "$ref": "#/components/schemas/Quantity" } }, "title": "Represents an empty directory for a pod.", "type": "object" }, "Endpoint": { "properties": { "grpcPort": { "format": "int32", "type": "integer" }, "httpPort": { "format": "int32", "type": "integer" }, "service_host": { "type": "string" }, "service_port": { "format": "int32", "type": "integer" }, "type": { "$ref": "#/components/schemas/EndpointType" } }, "type": "object" }, "EndpointType": { "type": "string" }, "EnvFromSource": { "description": "EnvFromSource represents the source of a set of ConfigMaps", "properties": { "configMapRef": { "$ref": "#/components/schemas/ConfigMapEnvSource" }, "prefix": { "description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.\n+optional", "type": "string" }, "secretRef": { "$ref": "#/components/schemas/SecretEnvSource" } }, "type": "object" }, "EnvVar": { "properties": { "name": { "description": "Name of the environment variable. Must be a C_IDENTIFIER.", "type": "string" }, "value": { "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional", "type": "string" }, "valueFrom": { "$ref": "#/components/schemas/EnvVarSource" } }, "title": "EnvVar represents an environment variable present in a Container.", "type": "object" }, "EnvVarSource": { "properties": { "configMapKeyRef": { "$ref": "#/components/schemas/ConfigMapKeySelector" }, "fieldRef": { "$ref": "#/components/schemas/ObjectFieldSelector" }, "resourceFieldRef": { "$ref": "#/components/schemas/ResourceFieldSelector" }, "secretKeyRef": { "$ref": "#/components/schemas/SecretKeySelector" } }, "title": "EnvVarSource represents a source for the value of an EnvVar.", "type": "object" }, "EphemeralContainer": { "description": "To add an ephemeral container, use the ephemeralcontainers subresource of an existing\nPod. Ephemeral containers may not be removed or restarted.", "properties": { "args": { "description": "Arguments to the entrypoint.\nThe image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "type": "array" }, "command": { "description": "Entrypoint array. Not executed within a shell.\nThe image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional", "items": { "type": "string" }, "type": "array" }, "env": { "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/EnvVar" }, "type": "array" }, "envFrom": { "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional", "items": { "$ref": "#/components/schemas/EnvFromSource" }, "type": "array" }, "image": { "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images", "type": "string" }, "imagePullPolicy": { "$ref": "#/components/schemas/PullPolicy" }, "lifecycle": { "$ref": "#/components/schemas/Lifecycle" }, "livenessProbe": { "$ref": "#/components/schemas/Probe" }, "name": { "description": "Name of the ephemeral container specified as a DNS_LABEL.\nThis name must be unique among all containers, init containers and ephemeral containers.", "type": "string" }, "ports": { "description": "Ports are not allowed for ephemeral containers.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol", "items": { "$ref": "#/components/schemas/ContainerPort" }, "type": "array" }, "readinessProbe": { "$ref": "#/components/schemas/Probe" }, "resizePolicy": { "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic", "items": { "$ref": "#/components/schemas/ContainerResizePolicy" }, "type": "array" }, "resources": { "$ref": "#/components/schemas/ResourceRequirements" }, "restartPolicy": { "$ref": "#/components/schemas/ContainerRestartPolicy" }, "securityContext": { "$ref": "#/components/schemas/SecurityContext" }, "startupProbe": { "$ref": "#/components/schemas/Probe" }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", "type": "boolean" }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", "type": "boolean" }, "targetContainerName": { "description": "If set, the name of the container from PodSpec that this ephemeral container targets.\nThe ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.\nIf not set then the ephemeral container uses the namespaces configured in the Pod spec.\n\nThe container runtime must implement support for this feature. If the runtime does not\nsupport namespace targeting then the result of setting this field is undefined.\n+optional", "type": "string" }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", "type": "string" }, "terminationMessagePolicy": { "$ref": "#/components/schemas/TerminationMessagePolicy" }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", "type": "boolean" }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional", "items": { "$ref": "#/components/schemas/VolumeDevice" }, "type": "array" }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/VolumeMount" }, "type": "array" }, "workingDir": { "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", "type": "string" } }, "title": "An EphemeralContainer is a temporary container that you may add to an existing Pod for\nuser-initiated activities such as debugging. Ephemeral containers have no resource or\nscheduling guarantees, and they will not be restarted when they exit or when a Pod is\nremoved or restarted. The kubelet may evict a Pod if an ephemeral container causes the\nPod to exceed its resource allocation.", "type": "object" }, "EphemeralVolumeSource": { "properties": { "volumeClaimTemplate": { "$ref": "#/components/schemas/PersistentVolumeClaimTemplate" } }, "title": "Represents an ephemeral volume that is handled by a normal storage driver.", "type": "object" }, "Error": { "description": "Error Error", "properties": { "code": { "description": "Code", "format": "int64", "type": "integer" }, "message": { "description": "Message", "type": "string" }, "requestId": { "description": "RequestId", "type": "string" } }, "type": "object" }, "ExecAction": { "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional", "items": { "type": "string" }, "type": "array" } }, "title": "ExecAction describes a \"run in container\" action.", "type": "object" }, "Experiment": { "description": "Experiment is the Schema for the experiments API", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/ExperimentSpec" }, "status": { "$ref": "#/components/schemas/ExperimentStatus" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "ExperimentCandidate": { "properties": { "name": { "type": "string" }, "weight": { "format": "uint32", "type": "integer" } }, "type": "object" }, "ExperimentMirror": { "properties": { "name": { "type": "string" }, "percent": { "format": "uint32", "type": "integer" } }, "type": "object" }, "ExperimentSpec": { "description": "ExperimentSpec defines the desired state of Experiment", "properties": { "candidates": { "items": { "$ref": "#/components/schemas/ExperimentCandidate" }, "type": "array" }, "default": { "type": "string" }, "mirror": { "$ref": "#/components/schemas/ExperimentMirror" }, "resourceType": { "$ref": "#/components/schemas/ResourceType" } }, "type": "object" }, "ExperimentStatus": { "description": "ExperimentStatus defines the observed state of Experiment", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is additional Status fields for the Resource to save some\nadditional State as well as convey more information to the user. This is\nroughly akin to Annotations on any k8s resource, just the reconciler conveying\nricher information outwards.", "type": "object" }, "conditions": { "$ref": "#/components/schemas/Conditions" }, "observedGeneration": { "description": "ObservedGeneration is the 'Generation' of the Service that\nwas last processed by the controller.\n+optional", "format": "int64", "type": "integer" } }, "type": "object" }, "Explainer": { "properties": { "config": { "additionalProperties": { "type": "string" }, "type": "object" }, "containerSpec": { "$ref": "#/components/schemas/Container" }, "endpoint": { "$ref": "#/components/schemas/Endpoint" }, "envSecretRefName": { "type": "string" }, "initParameters": { "type": "string" }, "modelUri": { "type": "string" }, "replicas": { "format": "int32", "type": "integer" }, "serviceAccountName": { "type": "string" }, "storageInitializerImage": { "type": "string" }, "type": { "$ref": "#/components/schemas/AlibiExplainerType" } }, "type": "object" }, "ExplainerSpec": { "description": "Either ModelRef or PipelineRef is required", "properties": { "modelRef": { "description": "one of the following need to be set for blackbox explainers\nReference to Model\n+optional", "type": "string" }, "pipelineRef": { "description": "Reference to Pipeline\n+optional", "type": "string" }, "type": { "description": "type of explainer", "type": "string" } }, "type": "object" }, "ExternalMetricSource": { "description": "ExternalMetricSource indicates how to scale on a metric not associated with\nany Kubernetes object (for example length of queue in cloud\nmessaging service, or QPS from loadbalancer running outside of cluster).", "properties": { "metric": { "$ref": "#/components/schemas/MetricIdentifier" }, "target": { "$ref": "#/components/schemas/MetricTarget" } }, "type": "object" }, "FCVolumeSource": { "description": "Fibre Channel volumes can only be mounted as read/write once.\nFibre Channel volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "lun": { "description": "lun is Optional: FC target lun number\n+optional", "format": "int32", "type": "integer" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "targetWWNs": { "description": "targetWWNs is Optional: FC target worldwide names (WWNs)\n+optional", "items": { "type": "string" }, "type": "array" }, "wwids": { "description": "wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.\n+optional", "items": { "type": "string" }, "type": "array" } }, "title": "Represents a Fibre Channel volume.", "type": "object" }, "Fallback": { "description": "Fallback is the spec for fallback options", "properties": { "failureThreshold": { "format": "int32", "type": "integer" }, "replicas": { "format": "int32", "type": "integer" } }, "type": "object" }, "FeatureDistribution": { "description": "FeatureDistribution represents feature level distribution", "properties": { "buckets": { "description": "Buckets in a feature distribution", "items": { "$ref": "#/components/schemas/FeatureDistributionBucket" }, "type": "array" } }, "type": "object" }, "FeatureDistributionBucket": { "description": "FeatureDistribution represents feature level distribution bucket", "properties": { "count": { "description": "Bucket Count in a feature distribution", "format": "double", "type": "number" }, "distribution": { "$ref": "#/components/schemas/FeatureDistribution" }, "key": { "description": "Bucket Key in a feature distribution", "type": "string" } }, "type": "object" }, "FeatureDistributionParameters": { "description": "FeatureDistributionParameters represents user defined feature distribution parameters", "properties": { "histogram_interval": { "description": "HistogramInterval refers to the size of bins in a aggregated feature distribution or statistics queries for real features", "format": "double", "type": "number" }, "minimum_bucket_count": { "description": "MinimumBucketCount refers to the minimum bucket size to filter in case of categorical, proba or one_hot feature queries", "format": "int64", "type": "integer" }, "number_of_time_buckets": { "description": "NumberOfTimeBuckets refers to the number of time bins in a non time-aggregated feature distribution or statistics queries", "format": "int64", "type": "integer" } }, "type": "object" }, "FeatureDistributionResponse": { "description": "FeatureDistributionResponse represents a feature distribution response", "properties": { "distribution": { "$ref": "#/components/schemas/FeatureDistribution" }, "feature": { "description": "FeatureName refers to the name of feature as per the model predictions schema", "type": "string" }, "interaction": { "$ref": "#/components/schemas/FeatureInteraction" }, "total_instances": { "description": "TotalInstances represents the total prediction over which the distribution is computed", "format": "int64", "type": "integer" }, "type": { "description": "FeatureType refers to the type of feature as per the model predictions schema", "type": "string" } }, "type": "object" }, "FeatureFilter": { "description": "FeatureFilter represents a feature distribution filter", "properties": { "category_name": { "description": "CategoryName refers to name of the feature category relevant to PROBA and ONE_HOT features", "type": "string" }, "feature": { "description": "FeatureName refers to the name of feature as per the model predictions schema", "type": "string" }, "gt": { "description": "GreaterThan refers to numerical value of the feature filter relevant for timestamps or REAL features", "type": "string" }, "gte": { "description": "GreaterThanOrEqual refers to numerical value of the feature filter relevant for timestamps or REAL features", "type": "string" }, "interaction": { "$ref": "#/components/schemas/FeatureInteraction" }, "is_outlier": { "description": "IsOutlier refers to boolean for outlier filters", "type": "boolean" }, "is_timestamp": { "description": "IsTimestamp refers to boolean for timestamp filters", "type": "boolean" }, "lt": { "description": "LessThan refers to numerical value of the feature filter relevant for timestamps or REAL features", "type": "string" }, "lte": { "description": "LessThanOrEqual refers to numerical value of the feature filter relevant for timestamps or REAL features", "type": "string" }, "terms": { "description": "Terms refers to set of feature categories to filter relevant to CATEGORICAL features", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "FeatureInteraction": { "description": "Feature Prediction Interaction", "type": "string" }, "FeatureStatisticsResponse": { "description": "FeatureStatisticsResponse represents a feature statistics response", "properties": { "feature": { "description": "FeatureName refers to the name of feature as per the model predictions schema", "type": "string" }, "interaction": { "$ref": "#/components/schemas/FeatureInteraction" }, "stats": { "$ref": "#/components/schemas/FeatureStats" }, "total_instances": { "description": "TotalInstances represents the total prediction over which the distribution is computed", "format": "int64", "type": "integer" }, "type": { "description": "FeatureType refers to the type of feature as per the model predictions schema", "type": "string" } }, "type": "object" }, "FeatureStats": { "description": "FeatureStats represents feature level statistics", "properties": { "avg": { "description": "Statistical Average of a feature value (relevant to REAL features)", "format": "double", "type": "number" }, "buckets": { "description": "Buckets in a feature statistics", "items": { "$ref": "#/components/schemas/FeatureStatsBucket" }, "type": "array" }, "count": { "description": "Statistical Count of a feature value (relevant to REAL features)", "format": "int64", "type": "integer" }, "max": { "description": "Statistical Maximum of a feature value (relevant to REAL features)", "format": "double", "type": "number" }, "min": { "description": "Statistical Minimum of a feature value (relevant to REAL features)", "format": "double", "type": "number" }, "most_frequent_category": { "description": "Statistical Most Frequent Category Name of a feature value (relevant to CATEGORICAL, PROBA and ONE_HOT features)", "type": "string" }, "most_frequent_category_count": { "description": "Statistical Most Frequent Category Count of a feature value (relevant to CATEGORICAL, PROBA and ONE_HOT features)", "format": "double", "type": "number" } }, "type": "object" }, "FeatureStatsBucket": { "description": "FeatureDistribution represents feature level statistics bucket", "properties": { "key": { "description": "Bucket Key in a feature statistics", "type": "string" }, "stats": { "$ref": "#/components/schemas/FeatureStats" } }, "type": "object" }, "FieldsV1": { "description": "Each key is either a '.' representing the field itself, and will always map to an empty set,\nor a string representing a sub-field or item. The string will follow one of these four formats:\n'f:', where is the name of a field in a struct, or key in a map\n'v:', where is the exact json formatted value of a list item\n'i:', where is position of a item in a list\n'k:', where is a map of a list item's key fields to their unique values\nIf a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff\n+protobuf.options.(gogoproto.goproto_stringer)=false", "title": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.", "type": "object" }, "FileDiff": { "description": "note diff is html that needs to be unicode decoded/unescaped\nfrom and to are raw values\nGitHubUrl is a github compare url", "properties": { "ChangeType": { "type": "string" }, "CommitHash": { "type": "string" }, "Diff": { "type": "string" }, "FileName": { "type": "string" }, "From": { "type": "string" }, "GitHubUrl": { "type": "string" }, "PrevCommitHash": { "type": "string" }, "To": { "type": "string" } }, "type": "object" }, "FinalizerName": { "title": "FinalizerName is the name identifying a finalizer during namespace lifecycle.", "type": "string" }, "FlexVolumeSource": { "description": "FlexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.", "properties": { "driver": { "description": "driver is the name of the driver to use for this volume.", "type": "string" }, "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional", "type": "string" }, "options": { "additionalProperties": { "type": "string" }, "description": "options is Optional: this field holds extra command options if any.\n+optional", "type": "object" }, "readOnly": { "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "$ref": "#/components/schemas/LocalObjectReference" } }, "type": "object" }, "FlockerVolumeSource": { "description": "One and only one of datasetName and datasetUUID should be set.\nFlocker volumes do not support ownership management or SELinux relabeling.", "properties": { "datasetName": { "description": "datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated\n+optional", "type": "string" }, "datasetUUID": { "description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset\n+optional", "type": "string" } }, "title": "Represents a Flocker volume mounted by the Flocker agent.", "type": "object" }, "GCEPersistentDiskVolumeSource": { "description": "A GCE PD must exist before mounting to a container. The disk must\nalso be in the same GCE project and zone as the kubelet. A GCE PD\ncan only be mounted as read/write once or read-only many times. GCE\nPDs support ownership management and SELinux relabeling.", "properties": { "fsType": { "description": "fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "partition": { "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "format": "int32", "type": "integer" }, "pdName": { "description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "type": "boolean" } }, "title": "Represents a Persistent Disk resource in Google Compute Engine.", "type": "object" }, "GRPCAction": { "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "service": { "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.\n+optional\n+default=\"\"", "type": "string" } }, "type": "object" }, "GitRepoVolumeSource": { "description": "DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container.", "properties": { "directory": { "description": "directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.\n+optional", "type": "string" }, "repository": { "description": "repository is the URL", "type": "string" }, "revision": { "description": "revision is the commit hash for the specified revision.\n+optional", "type": "string" } }, "title": "Represents a volume that is populated with the contents of a git repository.\nGit repo volumes do not support ownership management.\nGit repo volumes support SELinux relabeling.", "type": "object" }, "GlusterfsVolumeSource": { "description": "Glusterfs volumes do not support ownership management or SELinux relabeling.", "properties": { "endpoints": { "description": "endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "path": { "description": "path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "readOnly": { "description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional", "type": "boolean" } }, "title": "Represents a Glusterfs mount that lasts the lifetime of a pod.", "type": "object" }, "HPAScalingPolicy": { "properties": { "periodSeconds": { "description": "periodSeconds specifies the window of time for which the policy should hold true.\nPeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).", "format": "int32", "type": "integer" }, "type": { "$ref": "#/components/schemas/HPAScalingPolicyType" }, "value": { "description": "value contains the amount of change which is permitted by the policy.\nIt must be greater than zero", "format": "int32", "type": "integer" } }, "title": "HPAScalingPolicy is a single policy which must hold true for a specified past interval.", "type": "object" }, "HPAScalingPolicyType": { "title": "HPAScalingPolicyType is the type of the policy which could be used while making scaling decisions.", "type": "string" }, "HPAScalingRules": { "description": "These Rules are applied after calculating DesiredReplicas from metrics for the HPA.\nThey can limit the scaling velocity by specifying scaling policies.\nThey can prevent flapping by specifying the stabilization window, so that the\nnumber of replicas is not set instantly, instead, the safest value from the stabilization\nwindow is chosen.", "properties": { "policies": { "description": "policies is a list of potential scaling polices which can be used during scaling.\nAt least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid\n+optional", "items": { "$ref": "#/components/schemas/HPAScalingPolicy" }, "type": "array" }, "selectPolicy": { "$ref": "#/components/schemas/ScalingPolicySelect" }, "stabilizationWindowSeconds": { "description": "stabilizationWindowSeconds is the number of seconds for which past recommendations should be\nconsidered while scaling up or scaling down.\nStabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour).\nIf not set, use the default values:\nFor scale up: 0 (i.e. no stabilization is done).\nFor scale down: 300 (i.e. the stabilization window is 300 seconds long).\n+optional", "format": "int32", "type": "integer" } }, "title": "HPAScalingRules configures the scaling behavior for one direction.", "type": "object" }, "HTTPGetAction": { "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional", "type": "string" }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional", "items": { "$ref": "#/components/schemas/HTTPHeader" }, "type": "array" }, "path": { "description": "Path to access on the HTTP server.\n+optional", "type": "string" }, "port": { "$ref": "#/components/schemas/IntOrString" }, "scheme": { "$ref": "#/components/schemas/URIScheme" } }, "title": "HTTPGetAction describes an action based on HTTP Get requests.", "type": "object" }, "HTTPHeader": { "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "type": "object" }, "HealthCheckInfo": { "description": "for checking health of dependencies", "properties": { "Elastic": { "type": "string" }, "Prometheus": { "type": "string" } }, "type": "object" }, "HorizontalPodAutoscalerBehavior": { "description": "HorizontalPodAutoscalerBehavior configures the scaling behavior of the target\nin both Up and Down directions (scaleUp and scaleDown fields respectively).", "properties": { "scaleDown": { "$ref": "#/components/schemas/HPAScalingRules" }, "scaleUp": { "$ref": "#/components/schemas/HPAScalingRules" } }, "type": "object" }, "HorizontalPodAutoscalerConfig": { "description": "HorizontalPodAutoscalerConfig specifies horizontal scale config", "properties": { "behavior": { "$ref": "#/components/schemas/HorizontalPodAutoscalerBehavior" } }, "type": "object" }, "HostAlias": { "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file.", "properties": { "hostnames": { "description": "Hostnames for the above IP address.", "items": { "type": "string" }, "type": "array" }, "ip": { "description": "IP address of the host file entry.", "type": "string" } }, "type": "object" }, "HostIP": { "properties": { "ip": { "description": "IP is the IP address assigned to the host", "type": "string" } }, "title": "HostIP represents a single IP address allocated to the host.", "type": "object" }, "HostPathType": { "description": "+enum", "type": "string" }, "HostPathVolumeSource": { "description": "Host path volumes do not support ownership management or SELinux relabeling.", "properties": { "path": { "description": "path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "type": "string" }, "type": { "$ref": "#/components/schemas/HostPathType" } }, "title": "Represents a host path mapped into a pod.", "type": "object" }, "IPFamily": { "description": "IPFamily represents the IP Family (IPv4 or IPv6). This type is used\nto express the family of an IP expressed by a type (e.g. service.spec.ipFamilies).\n+enum", "type": "string" }, "IPFamilyPolicy": { "description": "IPFamilyPolicy represents the dual-stack-ness requested or required by a Service\n+enum", "type": "string" }, "ISCSIVolumeSource": { "description": "ISCSI volumes can only be mounted as read/write once.\nISCSI volumes support ownership management and SELinux relabeling.", "properties": { "chapAuthDiscovery": { "description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication\n+optional", "type": "boolean" }, "chapAuthSession": { "description": "chapAuthSession defines whether support iSCSI Session CHAP authentication\n+optional", "type": "boolean" }, "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "initiatorName": { "description": "initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection.\n+optional", "type": "string" }, "iqn": { "description": "iqn is the target iSCSI Qualified Name.", "type": "string" }, "iscsiInterface": { "description": "iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+optional", "type": "string" }, "lun": { "description": "lun represents iSCSI Target Lun number.", "format": "int32", "type": "integer" }, "portals": { "description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).\n+optional", "items": { "type": "string" }, "type": "array" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional", "type": "boolean" }, "secretRef": { "$ref": "#/components/schemas/LocalObjectReference" }, "targetPortal": { "description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).", "type": "string" } }, "title": "Represents an ISCSI disk.", "type": "object" }, "IntOrString": { "description": "+protobuf=true\n+protobuf.options.(gogoproto.goproto_stringer)=false\n+k8s:openapi-gen=true", "properties": { "IntVal": { "format": "int32", "type": "integer" }, "StrVal": { "type": "string" }, "Type": { "$ref": "#/components/schemas/Type" } }, "title": "IntOrString is a type that can hold an int32 or a string. When used in\nJSON or YAML marshalling and unmarshalling, it produces or consumes the\ninner type. This allows you to have, for example, a JSON field that can\naccept a name or number.\nTODO: Rename to Int32OrString", "type": "object" }, "JoinType": { "type": "string" }, "KeyToPath": { "properties": { "key": { "description": "key is the key to project.", "type": "string" }, "mode": { "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "type": "integer" }, "path": { "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "type": "string" } }, "title": "Maps a string key to a path within a volume.", "type": "object" }, "LabelSelector": { "description": "A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects.\n+structType=atomic", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional", "items": { "$ref": "#/components/schemas/LabelSelectorRequirement" }, "type": "array" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional", "type": "object" } }, "type": "object" }, "LabelSelectorOperator": { "title": "A label selector operator is the set of operators that can be used in a selector requirement.", "type": "string" }, "LabelSelectorRequirement": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "$ref": "#/components/schemas/LabelSelectorOperator" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.\n+optional", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "Lifecycle": { "description": "Lifecycle describes actions that the management system should take in response to container lifecycle\nevents. For the PostStart and PreStop lifecycle handlers, management of the container blocks\nuntil the action is complete, unless the container process fails, in which case the handler is aborted.", "properties": { "postStart": { "$ref": "#/components/schemas/LifecycleHandler" }, "preStop": { "$ref": "#/components/schemas/LifecycleHandler" } }, "type": "object" }, "LifecycleHandler": { "description": "LifecycleHandler defines a specific action that should be taken in a lifecycle\nhook. One and only one of the fields, except TCPSocket must be specified.", "properties": { "exec": { "$ref": "#/components/schemas/ExecAction" }, "httpGet": { "$ref": "#/components/schemas/HTTPGetAction" }, "sleep": { "$ref": "#/components/schemas/SleepAction" }, "tcpSocket": { "$ref": "#/components/schemas/TCPSocketAction" } }, "type": "object" }, "ListMeta": { "description": "ListMeta describes metadata that synthetic resources must have, including lists and\nvarious status objects. A resource may have only one of {ObjectMeta, ListMeta}.", "properties": { "continue": { "description": "continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nconsistent list may not be possible if the server configuration has changed or more than a few\nminutes have passed. The resourceVersion field returned when using this continue value will be\nidentical to the value in the first response, unless you have received this token from an error\nmessage.", "type": "string" }, "remainingItemCount": { "description": "remainingItemCount is the number of subsequent items in the list which are not included in this\nlist response. If the list request contained label or field selectors, then the number of\nremaining items is unknown and the field will be left unset and omitted during serialization.\nIf the list is complete (either because it is not chunking or because this is the last chunk),\nthen there are no more remaining items and this field will be left unset and omitted during\nserialization.\nServers older than v1.15 do not set this field.\nThe intended use of the remainingItemCount is *estimating* the size of a collection. Clients\nshould not rely on the remainingItemCount to be set or to be exact.\n+optional", "format": "int64", "type": "integer" }, "resourceVersion": { "description": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" } }, "type": "object" }, "LocalObjectReference": { "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.\n+structType=atomic", "properties": { "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" } }, "type": "object" }, "Logger": { "description": "Logger provides optional payload logging for all endpoints\n+experimental", "properties": { "mode": { "$ref": "#/components/schemas/LoggerMode" }, "url": { "description": "URL to send request logging CloudEvents\n+optional", "type": "string" } }, "type": "object" }, "LoggerMode": { "type": "string" }, "LoggingSpec": { "properties": { "percent": { "description": "Percentage of payloads to log", "format": "uint64", "type": "integer" } }, "type": "object" }, "ManagedFieldsEntry": { "description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource\nthat the fieldset applies to.", "properties": { "apiVersion": { "description": "APIVersion defines the version of this resource that this field set\napplies to. The format is \"group/version\" just like the top-level\nAPIVersion field. It is necessary to track the version of a field\nset because it cannot be automatically converted.", "type": "string" }, "fieldsType": { "description": "FieldsType is the discriminator for the different fields format and version.\nThere is currently only one possible value: \"FieldsV1\"", "type": "string" }, "fieldsV1": { "$ref": "#/components/schemas/FieldsV1" }, "manager": { "description": "Manager is an identifier of the workflow managing these fields.", "type": "string" }, "operation": { "$ref": "#/components/schemas/ManagedFieldsOperationType" }, "subresource": { "description": "Subresource is the name of the subresource used to update that object, or\nempty string if the object was updated through the main resource. The\nvalue of this field is used to distinguish between managers, even if they\nshare the same name. For example, a status update will be distinct from a\nregular update using the same manager name.\nNote that the APIVersion field is not related to the Subresource field and\nit always corresponds to the version of the main resource.", "type": "string" }, "time": { "description": "Time is the timestamp of when the ManagedFields entry was added. The\ntimestamp will also be updated if a field is added, the manager\nchanges any of the owned fields value or removes a field. The\ntimestamp does not update when a field is removed from the entry\nbecause another manager took it over.\n+optional", "type": "string" } }, "type": "object" }, "ManagedFieldsOperationType": { "title": "ManagedFieldsOperationType is the type of operation which lead to a ManagedFieldsEntry being created.", "type": "string" }, "Message": { "description": "Message Message", "properties": { "code": { "description": "Code", "format": "int64", "type": "integer" }, "message": { "description": "Message", "type": "string" } }, "type": "object" }, "MetricIdentifier": { "description": "MetricIdentifier defines the name and optionally selector for a metric", "properties": { "name": { "description": "name is the name of the given metric", "type": "string" }, "selector": { "$ref": "#/components/schemas/LabelSelector" } }, "type": "object" }, "MetricSourceType": { "title": "MetricSourceType indicates the type of metric.", "type": "string" }, "MetricSpec": { "description": "MetricSpec specifies how to scale based on a single metric\n(only `type` and one other matching field should be set at once).", "properties": { "containerResource": { "$ref": "#/components/schemas/ContainerResourceMetricSource" }, "external": { "$ref": "#/components/schemas/ExternalMetricSource" }, "object": { "$ref": "#/components/schemas/ObjectMetricSource" }, "pods": { "$ref": "#/components/schemas/PodsMetricSource" }, "resource": { "$ref": "#/components/schemas/ResourceMetricSource" }, "type": { "$ref": "#/components/schemas/MetricSourceType" } }, "type": "object" }, "MetricTarget": { "description": "MetricTarget defines the target value, average value, or average utilization of a specific metric", "properties": { "averageUtilization": { "description": "averageUtilization is the target value of the average of the\nresource metric across all relevant pods, represented as a percentage of\nthe requested value of the resource for the pods.\nCurrently only valid for Resource metric source type\n+optional", "format": "int32", "type": "integer" }, "averageValue": { "$ref": "#/components/schemas/Quantity" }, "type": { "$ref": "#/components/schemas/MetricTargetType" }, "value": { "$ref": "#/components/schemas/Quantity" } }, "type": "object" }, "MetricTargetType": { "description": "MetricTargetType specifies the type of metric being targeted, and should be either\n\"Value\", \"AverageValue\", or \"Utilization\"", "type": "string" }, "Model": { "description": "Model is the Schema for the models API", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/ModelSpec" }, "status": { "$ref": "#/components/schemas/ModelStatus" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "ModelSpec": { "description": "ModelSpec defines the desired state of Model", "properties": { "artifactVersion": { "description": "Artifact Version\nA v2 version folder to select from storage bucket\n+optional", "format": "uint32", "type": "integer" }, "dedicated": { "description": "Dedicated server exclusive to this model\nDefault false", "type": "boolean" }, "explainer": { "$ref": "#/components/schemas/ExplainerSpec" }, "logger": { "$ref": "#/components/schemas/LoggingSpec" }, "maxReplicas": { "description": "Max number of replicas - default equal to 0", "format": "int32", "type": "integer" }, "memory": { "$ref": "#/components/schemas/Quantity" }, "minReplicas": { "description": "Min number of replicas - default equal to 0", "format": "int32", "type": "integer" }, "modelType": { "description": "Model type\n+optional", "type": "string" }, "parameters": { "description": "Parameters to load with model", "items": { "$ref": "#/components/schemas/ParameterSpec" }, "type": "array" }, "preloaded": { "description": "Model already loaded on a server. Don't schedule.\nDefault false", "type": "boolean" }, "replicas": { "description": "Number of replicas - default 1", "format": "int32", "type": "integer" }, "requirements": { "description": "List of extra requirements for this model to be loaded on a compatible server", "items": { "type": "string" }, "type": "array" }, "schemaUri": { "description": "Schema URI\n+optional", "type": "string" }, "secretName": { "description": "Secret name\n+optional", "type": "string" }, "server": { "description": "Name of the Server to deploy this artifact\n+optional", "type": "string" }, "storageUri": { "description": "Storage URI for the model repository", "type": "string" } }, "type": "object" }, "ModelStatus": { "description": "ModelStatus defines the observed state of Model", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is additional Status fields for the Resource to save some\nadditional State as well as convey more information to the user. This is\nroughly akin to Annotations on any k8s resource, just the reconciler conveying\nricher information outwards.", "type": "object" }, "conditions": { "$ref": "#/components/schemas/Conditions" }, "observedGeneration": { "description": "ObservedGeneration is the 'Generation' of the Service that\nwas last processed by the controller.\n+optional", "format": "int64", "type": "integer" }, "replicas": { "description": "Total number of replicas targeted by this model", "format": "int32", "type": "integer" } }, "type": "object" }, "MonitorInputData": { "description": "MonitorInputData represents sent in payload of monitor request\nalso passed into template to create query", "properties": { "DeploymentName": { "type": "string" }, "DeploymentType": { "type": "string" }, "End": { "type": "string" }, "GroupBy": { "type": "string" }, "ModelImage": { "type": "string" }, "ModelName": { "type": "string" }, "ModelVersion": { "type": "string" }, "Namespace": { "type": "string" }, "Offset": { "type": "string" }, "Percentile": { "type": "string" }, "PredictorName": { "type": "string" }, "QueryTemplate": { "type": "string" }, "Range": { "type": "string" }, "Start": { "type": "string" }, "Step": { "type": "string" } }, "type": "object" }, "MountPropagationMode": { "description": "+enum", "title": "MountPropagationMode describes mount propagation.", "type": "string" }, "NFSVolumeSource": { "description": "NFS volumes do not support ownership management or SELinux relabeling.", "properties": { "path": { "description": "path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" }, "readOnly": { "description": "readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional", "type": "boolean" }, "server": { "description": "server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" } }, "title": "Represents an NFS mount that lasts the lifetime of a pod.", "type": "object" }, "Namespace": { "description": "Use of multiple namespaces is optional.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/NamespaceSpec" }, "status": { "$ref": "#/components/schemas/NamespaceStatus" }, "uid": { "$ref": "#/components/schemas/UID" } }, "title": "Namespace provides a scope for Names.", "type": "object" }, "NamespaceCondition": { "properties": { "lastTransitionTime": { "description": "+optional", "type": "string" }, "message": { "description": "+optional", "type": "string" }, "reason": { "description": "+optional", "type": "string" }, "status": { "$ref": "#/components/schemas/ConditionStatus" }, "type": { "$ref": "#/components/schemas/NamespaceConditionType" } }, "title": "NamespaceCondition contains details about state of namespace.", "type": "object" }, "NamespaceConditionType": { "type": "string" }, "NamespacePhase": { "description": "+enum", "type": "string" }, "NamespaceSpec": { "properties": { "finalizers": { "description": "Finalizers is an opaque list of values that must be empty to permanently remove object from storage.\nMore info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/\n+optional", "items": { "$ref": "#/components/schemas/FinalizerName" }, "type": "array" } }, "title": "NamespaceSpec describes the attributes on a Namespace.", "type": "object" }, "NamespaceStatus": { "properties": { "conditions": { "description": "Represents the latest available observations of a namespace's current state.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/NamespaceCondition" }, "type": "array" }, "phase": { "$ref": "#/components/schemas/NamespacePhase" } }, "title": "NamespaceStatus is information about the current status of a Namespace.", "type": "object" }, "NodeAffinity": { "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.\n+optional", "items": { "$ref": "#/components/schemas/PreferredSchedulingTerm" }, "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "$ref": "#/components/schemas/NodeSelector" } }, "title": "Node affinity is a group of node affinity scheduling rules.", "type": "object" }, "NodeInclusionPolicy": { "description": "NodeInclusionPolicy defines the type of node inclusion policy\n+enum", "type": "string" }, "NodeSelector": { "description": "A node selector represents the union of the results of one or more label queries\nover a set of nodes; that is, it represents the OR of the selectors represented\nby the node selector terms.\n+structType=atomic", "properties": { "nodeSelectorTerms": { "description": "Required. A list of node selector terms. The terms are ORed.", "items": { "$ref": "#/components/schemas/NodeSelectorTerm" }, "type": "array" } }, "type": "object" }, "NodeSelectorOperator": { "description": "A node selector operator is the set of operators that can be used in\na node selector requirement.\n+enum", "type": "string" }, "NodeSelectorRequirement": { "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "$ref": "#/components/schemas/NodeSelectorOperator" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.\n+optional", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "NodeSelectorTerm": { "description": "A null or empty node selector term matches no objects. The requirements of\nthem are ANDed.\nThe TopologySelectorTerm type implements a subset of the NodeSelectorTerm.\n+structType=atomic", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.\n+optional", "items": { "$ref": "#/components/schemas/NodeSelectorRequirement" }, "type": "array" }, "matchFields": { "description": "A list of node selector requirements by node's fields.\n+optional", "items": { "$ref": "#/components/schemas/NodeSelectorRequirement" }, "type": "array" } }, "type": "object" }, "OSName": { "title": "OSName is the set of OS'es that can be used in OS.", "type": "string" }, "ObjectFieldSelector": { "description": "+structType=atomic", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional", "type": "string" }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } }, "title": "ObjectFieldSelector selects an APIVersioned field of an object.", "type": "object" }, "ObjectMeta": { "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects\nusers must create.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "ObjectMetricSource": { "description": "ObjectMetricSource indicates how to scale on a metric describing a\nkubernetes object (for example, hits-per-second on an Ingress object).", "properties": { "describedObject": { "$ref": "#/components/schemas/CrossVersionObjectReference" }, "metric": { "$ref": "#/components/schemas/MetricIdentifier" }, "target": { "$ref": "#/components/schemas/MetricTarget" } }, "type": "object" }, "OwnerReference": { "description": "OwnerReference contains enough information to let you identify an owning\nobject. An owning object must be in the same namespace as the dependent, or\nbe cluster-scoped, so there is no namespace field.\n+structType=atomic", "properties": { "apiVersion": { "description": "API version of the referent.", "type": "string" }, "blockOwnerDeletion": { "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nSee https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion\nfor how the garbage collector interacts with this field and enforces the foreground deletion.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional", "type": "boolean" }, "controller": { "description": "If true, this reference points to the managing controller.\n+optional", "type": "boolean" }, "kind": { "description": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names", "type": "string" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "Parameter": { "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ParmeterType" }, "value": { "type": "string" } }, "type": "object" }, "ParameterSpec": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "ParmeterType": { "type": "string" }, "PersistentVolumeAccessMode": { "description": "+enum", "type": "string" }, "PersistentVolumeClaimSpec": { "description": "PersistentVolumeClaimSpec describes the common attributes of storage devices\nand allows a Source for provider-specific attributes", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1\n+optional", "items": { "$ref": "#/components/schemas/PersistentVolumeAccessMode" }, "type": "array" }, "dataSource": { "$ref": "#/components/schemas/TypedLocalObjectReference" }, "dataSourceRef": { "$ref": "#/components/schemas/TypedObjectReference" }, "resources": { "$ref": "#/components/schemas/VolumeResourceRequirements" }, "selector": { "$ref": "#/components/schemas/LabelSelector" }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1\n+optional", "type": "string" }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\n+featureGate=VolumeAttributesClass\n+optional", "type": "string" }, "volumeMode": { "$ref": "#/components/schemas/PersistentVolumeMode" }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.\n+optional", "type": "string" } }, "type": "object" }, "PersistentVolumeClaimTemplate": { "description": "PersistentVolumeClaimTemplate is used to produce\nPersistentVolumeClaim objects as part of an EphemeralVolumeSource.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/PersistentVolumeClaimSpec" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "PersistentVolumeClaimVolumeSource": { "description": "This volume finds the bound PV and mounts that volume for the pod. A\nPersistentVolumeClaimVolumeSource is, essentially, a wrapper around another\ntype of volume that is owned by someone else (the system).", "properties": { "claimName": { "description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "type": "string" }, "readOnly": { "description": "readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false.\n+optional", "type": "boolean" } }, "title": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.", "type": "object" }, "PersistentVolumeMode": { "description": "+enum", "title": "PersistentVolumeMode describes how a volume is intended to be consumed, either Block or Filesystem.", "type": "string" }, "PhotonPersistentDiskVolumeSource": { "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "pdID": { "description": "pdID is the ID that identifies Photon Controller persistent disk", "type": "string" } }, "title": "Represents a Photon Controller persistent disk resource.", "type": "object" }, "Pipeline": { "description": "Pipeline is the Schema for the pipelines API", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/PipelineSpec" }, "status": { "$ref": "#/components/schemas/PipelineStatus" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "PipelineBatch": { "properties": { "rolling": { "type": "boolean" }, "size": { "format": "uint32", "type": "integer" }, "windowMs": { "format": "uint32", "type": "integer" } }, "type": "object" }, "PipelineOutput": { "properties": { "joinWindowMs": { "description": "msecs to wait for messages from multiple inputs to arrive before joining the inputs", "format": "uint32", "type": "integer" }, "steps": { "description": "Previous step to receive data from", "items": { "type": "string" }, "type": "array" }, "stepsJoin": { "$ref": "#/components/schemas/JoinType" }, "tensorMap": { "additionalProperties": { "type": "string" }, "description": "Map of tensor name conversions to use e.g. output1 -> input1", "type": "object" } }, "type": "object" }, "PipelineSpec": { "description": "PipelineSpec defines the desired state of Pipeline", "properties": { "output": { "$ref": "#/components/schemas/PipelineOutput" }, "steps": { "description": "The steps of this inference graph pipeline", "items": { "$ref": "#/components/schemas/PipelineStep" }, "type": "array" } }, "type": "object" }, "PipelineStatus": { "description": "PipelineStatus defines the observed state of Pipeline", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is additional Status fields for the Resource to save some\nadditional State as well as convey more information to the user. This is\nroughly akin to Annotations on any k8s resource, just the reconciler conveying\nricher information outwards.", "type": "object" }, "conditions": { "$ref": "#/components/schemas/Conditions" }, "observedGeneration": { "description": "ObservedGeneration is the 'Generation' of the Service that\nwas last processed by the controller.\n+optional", "format": "int64", "type": "integer" } }, "type": "object" }, "PipelineStep": { "properties": { "batch": { "$ref": "#/components/schemas/PipelineBatch" }, "inputs": { "description": "Previous step to receive data from", "items": { "type": "string" }, "type": "array" }, "inputsJoinType": { "$ref": "#/components/schemas/JoinType" }, "joinWindowMs": { "description": "msecs to wait for messages from multiple inputs to arrive before joining the inputs", "format": "uint32", "type": "integer" }, "name": { "description": "Name of the step", "type": "string" }, "tensorMap": { "additionalProperties": { "type": "string" }, "description": "Map of tensor name conversions to use e.g. output1 -> input1", "type": "object" }, "triggers": { "description": "Triggers required to activate step", "items": { "type": "string" }, "type": "array" }, "triggersJoinType": { "$ref": "#/components/schemas/JoinType" } }, "type": "object" }, "Pod": { "description": "Pod is a collection of containers that can run on a host. This resource is created\nby clients and scheduled onto hosts.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/PodSpec" }, "status": { "$ref": "#/components/schemas/PodStatus" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "PodAffinity": { "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional", "items": { "$ref": "#/components/schemas/WeightedPodAffinityTerm" }, "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional", "items": { "$ref": "#/components/schemas/PodAffinityTerm" }, "type": "array" } }, "title": "Pod affinity is a group of inter pod affinity scheduling rules.", "type": "object" }, "PodAffinityTerm": { "description": "Defines a set of pods (namely those matching the labelSelector\nrelative to the given namespace(s)) that this pod should be\nco-located (affinity) or not co-located (anti-affinity) with,\nwhere co-located is defined as running on a node whose value of\nthe label with key matches that of any node on which\na pod of the set of pods is running", "properties": { "labelSelector": { "$ref": "#/components/schemas/LabelSelector" }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nAlso, MatchLabelKeys cannot be set when LabelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\n+listType=atomic\n+optional", "items": { "type": "string" }, "type": "array" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both MismatchLabelKeys and LabelSelector.\nAlso, MismatchLabelKeys cannot be set when LabelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\n+listType=atomic\n+optional", "items": { "type": "string" }, "type": "array" }, "namespaceSelector": { "$ref": "#/components/schemas/LabelSelector" }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".\n+optional", "items": { "type": "string" }, "type": "array" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "type": "object" }, "PodAntiAffinity": { "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional", "items": { "$ref": "#/components/schemas/WeightedPodAffinityTerm" }, "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional", "items": { "$ref": "#/components/schemas/PodAffinityTerm" }, "type": "array" } }, "title": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.", "type": "object" }, "PodCondition": { "properties": { "lastProbeTime": { "description": "Last time we probed the condition.\n+optional", "type": "string" }, "lastTransitionTime": { "description": "Last time the condition transitioned from one status to another.\n+optional", "type": "string" }, "message": { "description": "Human-readable message indicating details about last transition.\n+optional", "type": "string" }, "reason": { "description": "Unique, one-word, CamelCase reason for the condition's last transition.\n+optional", "type": "string" }, "status": { "$ref": "#/components/schemas/ConditionStatus" }, "type": { "$ref": "#/components/schemas/PodConditionType" } }, "title": "PodCondition contains details for the current condition of this pod.", "type": "object" }, "PodConditionType": { "description": "PodConditionType is a valid value for PodCondition.Type", "type": "string" }, "PodDNSConfig": { "description": "PodDNSConfig defines the DNS parameters of a pod in addition to\nthose generated from DNSPolicy.", "properties": { "nameservers": { "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed.\n+optional", "items": { "type": "string" }, "type": "array" }, "options": { "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy.\n+optional", "items": { "$ref": "#/components/schemas/PodDNSConfigOption" }, "type": "array" }, "searches": { "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed.\n+optional", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "PodDNSConfigOption": { "properties": { "name": { "description": "Required.", "type": "string" }, "value": { "description": "+optional", "type": "string" } }, "title": "PodDNSConfigOption defines DNS resolver options of a pod.", "type": "object" }, "PodFSGroupChangePolicy": { "description": "PodFSGroupChangePolicy holds policies that will be used for applying fsGroup to a volume\nwhen volume is mounted.\n+enum", "type": "string" }, "PodIP": { "properties": { "ip": { "description": "IP is the IP address assigned to the pod", "type": "string" } }, "title": "PodIP represents a single IP address allocated to the pod.", "type": "object" }, "PodList": { "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "continue": { "description": "continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nconsistent list may not be possible if the server configuration has changed or more than a few\nminutes have passed. The resourceVersion field returned when using this continue value will be\nidentical to the value in the first response, unless you have received this token from an error\nmessage.", "type": "string" }, "items": { "description": "List of pods.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md", "items": { "$ref": "#/components/schemas/Pod" }, "type": "array" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "remainingItemCount": { "description": "remainingItemCount is the number of subsequent items in the list which are not included in this\nlist response. If the list request contained label or field selectors, then the number of\nremaining items is unknown and the field will be left unset and omitted during serialization.\nIf the list is complete (either because it is not chunking or because this is the last chunk),\nthen there are no more remaining items and this field will be left unset and omitted during\nserialization.\nServers older than v1.15 do not set this field.\nThe intended use of the remainingItemCount is *estimating* the size of a collection. Clients\nshould not rely on the remainingItemCount to be set or to be exact.\n+optional", "format": "int64", "type": "integer" }, "resourceVersion": { "description": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" } }, "title": "PodList is a list of Pods.", "type": "object" }, "PodOS": { "properties": { "name": { "$ref": "#/components/schemas/OSName" } }, "title": "PodOS defines the OS parameters of a pod.", "type": "object" }, "PodPhase": { "description": "+enum", "title": "PodPhase is a label for the condition of a pod at the current time.", "type": "string" }, "PodQOSClass": { "description": "+enum", "title": "PodQOSClass defines the supported qos classes of Pods.", "type": "string" }, "PodReadinessGate": { "description": "PodReadinessGate contains the reference to a pod condition", "properties": { "conditionType": { "$ref": "#/components/schemas/PodConditionType" } }, "type": "object" }, "PodResizeStatus": { "title": "PodResizeStatus shows status of desired resize of a pod's containers.", "type": "string" }, "PodResourceClaim": { "description": "It adds a name to it that uniquely identifies the ResourceClaim inside the Pod.\nContainers that need access to the ResourceClaim reference it with this name.", "properties": { "name": { "description": "Name uniquely identifies this resource claim inside the pod.\nThis must be a DNS_LABEL.", "type": "string" }, "source": { "$ref": "#/components/schemas/ClaimSource" } }, "title": "PodResourceClaim references exactly one ResourceClaim through a ClaimSource.", "type": "object" }, "PodResourceClaimStatus": { "description": "PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim\nwhich references a ResourceClaimTemplate. It stores the generated name for\nthe corresponding ResourceClaim.", "properties": { "name": { "description": "Name uniquely identifies this resource claim inside the pod.\nThis must match the name of an entry in pod.spec.resourceClaims,\nwhich implies that the string must be a DNS_LABEL.", "type": "string" }, "resourceClaimName": { "description": "ResourceClaimName is the name of the ResourceClaim that was\ngenerated for the Pod in the namespace of the Pod. It this is\nunset, then generating a ResourceClaim was not necessary. The\npod.spec.resourceClaims entry can be ignored in this case.\n\n+optional", "type": "string" } }, "type": "object" }, "PodSchedulingGate": { "properties": { "name": { "description": "Name of the scheduling gate.\nEach scheduling gate must have a unique name field.", "type": "string" } }, "title": "PodSchedulingGate is associated to a Pod to guard its scheduling.", "type": "object" }, "PodSecurityContext": { "description": "Some fields are also present in container.securityContext. Field values of\ncontainer.securityContext take precedence over field values of PodSecurityContext.", "properties": { "fsGroup": { "description": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "format": "int64", "type": "integer" }, "fsGroupChangePolicy": { "$ref": "#/components/schemas/PodFSGroupChangePolicy" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "format": "int64", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "format": "int64", "type": "integer" }, "seLinuxOptions": { "$ref": "#/components/schemas/SELinuxOptions" }, "seccompProfile": { "$ref": "#/components/schemas/SeccompProfile" }, "supplementalGroups": { "description": "A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "sysctls": { "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "items": { "$ref": "#/components/schemas/Sysctl" }, "type": "array" }, "windowsOptions": { "$ref": "#/components/schemas/WindowsSecurityContextOptions" } }, "title": "PodSecurityContext holds pod-level security attributes and common container settings.", "type": "object" }, "PodSpec": { "properties": { "activeDeadlineSeconds": { "description": "Optional duration in seconds the pod may be active on the node relative to\nStartTime before the system will actively try to mark it failed and kill associated containers.\nValue must be a positive integer.\n+optional", "format": "int64", "type": "integer" }, "affinity": { "$ref": "#/components/schemas/Affinity" }, "automountServiceAccountToken": { "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.\n+optional", "type": "boolean" }, "containers": { "description": "List of containers belonging to the pod.\nContainers cannot currently be added or removed.\nThere must be at least one container in a Pod.\nCannot be updated.\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/Container" }, "type": "array" }, "dnsConfig": { "$ref": "#/components/schemas/PodDNSConfig" }, "dnsPolicy": { "$ref": "#/components/schemas/DNSPolicy" }, "enableServiceLinks": { "description": "EnableServiceLinks indicates whether information about services should be injected into pod's\nenvironment variables, matching the syntax of Docker links.\nOptional: Defaults to true.\n+optional", "type": "boolean" }, "ephemeralContainers": { "description": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing\npod to perform user-initiated actions such as debugging. This list cannot be specified when\ncreating a pod, and it cannot be modified by updating the pod spec. In order to add an\nephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/EphemeralContainer" }, "type": "array" }, "hostAliases": { "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts\nfile if specified. This is only valid for non-hostNetwork pods.\n+optional\n+patchMergeKey=ip\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/HostAlias" }, "type": "array" }, "hostIPC": { "description": "Use the host's ipc namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostNetwork": { "description": "Host networking requested for this pod. Use the host's network namespace.\nIf this option is set, the ports that will be used must be specified.\nDefault to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostPID": { "description": "Use the host's pid namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostUsers": { "description": "Use the host's user namespace.\nOptional: Default to true.\nIf set to true or not present, the pod will be run in the host user namespace, useful\nfor when the pod needs a feature only available to the host user namespace, such as\nloading a kernel module with CAP_SYS_MODULE.\nWhen set to false, a new userns is created for the pod. Setting false is useful for\nmitigating container breakout vulnerabilities even allowing users to run their\ncontainers as root without actually having root privileges on the host.\nThis field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostname": { "description": "Specifies the hostname of the Pod\nIf not specified, the pod's hostname will be set to a system-defined value.\n+optional", "type": "string" }, "imagePullSecrets": { "description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.\nIf specified, these secrets will be passed to individual puller implementations for them to use.\nMore info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod\n+optional\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/LocalObjectReference" }, "type": "array" }, "initContainers": { "description": "List of initialization containers belonging to the pod.\nInit containers are executed in order prior to containers being started. If any\ninit container fails, the pod is considered to have failed and is handled according\nto its restartPolicy. The name for an init container or normal container must be\nunique among all containers.\nInit containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.\nThe resourceRequirements of an init container are taken into account during scheduling\nby finding the highest request/limit for each resource type, and then using the max of\nof that value or the sum of the normal containers. Limits are applied to init containers\nin a similar fashion.\nInit containers cannot currently be added or removed.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\n+patchMergeKey=name\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/Container" }, "type": "array" }, "nodeName": { "description": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty,\nthe scheduler simply schedules this pod onto that node, assuming that it fits resource\nrequirements.\n+optional", "type": "string" }, "nodeSelector": { "additionalProperties": { "type": "string" }, "description": "NodeSelector is a selector which must be true for the pod to fit on a node.\nSelector which must match a node's labels for the pod to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n+optional\n+mapType=atomic", "type": "object" }, "os": { "$ref": "#/components/schemas/PodOS" }, "overhead": { "$ref": "#/components/schemas/ResourceList" }, "preemptionPolicy": { "$ref": "#/components/schemas/PreemptionPolicy" }, "priority": { "description": "The priority value. Various system components use this field to find the\npriority of the pod. When Priority Admission Controller is enabled, it\nprevents users from setting this field. The admission controller populates\nthis field from PriorityClassName.\nThe higher the value, the higher the priority.\n+optional", "format": "int32", "type": "integer" }, "priorityClassName": { "description": "If specified, indicates the pod's priority. \"system-node-critical\" and\n\"system-cluster-critical\" are two special keywords which indicate the\nhighest priorities with the former being the highest priority. Any other\nname must be defined by creating a PriorityClass object with that name.\nIf not specified, the pod priority will be default or zero if there is no\ndefault.\n+optional", "type": "string" }, "readinessGates": { "description": "If specified, all readiness gates will be evaluated for pod readiness.\nA pod is ready when all its containers are ready AND\nall conditions specified in the readiness gates have status equal to \"True\"\nMore info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates\n+optional", "items": { "$ref": "#/components/schemas/PodReadinessGate" }, "type": "array" }, "resourceClaims": { "description": "ResourceClaims defines which ResourceClaims must be allocated\nand reserved before the Pod is allowed to start. The resources\nwill be made available to those containers which consume them\nby name.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable.\n\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional", "items": { "$ref": "#/components/schemas/PodResourceClaim" }, "type": "array" }, "restartPolicy": { "$ref": "#/components/schemas/RestartPolicy" }, "runtimeClassName": { "description": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used\nto run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.\nIf unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an\nempty definition that uses the default runtime handler.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class\n+optional", "type": "string" }, "schedulerName": { "description": "If specified, the pod will be dispatched by specified scheduler.\nIf not specified, the pod will be dispatched by default scheduler.\n+optional", "type": "string" }, "schedulingGates": { "description": "SchedulingGates is an opaque list of values that if specified will block scheduling the pod.\nIf schedulingGates is not empty, the pod will stay in the SchedulingGated state and the\nscheduler will not attempt to schedule the pod.\n\nSchedulingGates can only be set at pod creation time, and be removed only afterwards.\n\nThis is a beta feature enabled by the PodSchedulingReadiness feature gate.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+featureGate=PodSchedulingReadiness\n+optional", "items": { "$ref": "#/components/schemas/PodSchedulingGate" }, "type": "array" }, "securityContext": { "$ref": "#/components/schemas/PodSecurityContext" }, "serviceAccount": { "description": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.\nDeprecated: Use serviceAccountName instead.\n+k8s:conversion-gen=false\n+optional", "type": "string" }, "serviceAccountName": { "description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional", "type": "string" }, "setHostnameAsFQDN": { "description": "If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).\nIn Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).\nIn Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\\\SYSTEM\\\\CurrentControlSet\\\\Services\\\\Tcpip\\\\Parameters to FQDN.\nIf a pod does not have FQDN, this has no effect.\nDefault to false.\n+optional", "type": "boolean" }, "shareProcessNamespace": { "description": "Share a single process namespace between all of the containers in a pod.\nWhen this is set containers will be able to view and signal processes from other containers\nin the same pod, and the first process in each container will not be assigned PID 1.\nHostPID and ShareProcessNamespace cannot both be set.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "subdomain": { "description": "If specified, the fully qualified Pod hostname will be \"...svc.\".\nIf not specified, the pod will not have a domainname at all.\n+optional", "type": "string" }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "format": "int64", "type": "integer" }, "tolerations": { "description": "If specified, the pod's tolerations.\n+optional", "items": { "$ref": "#/components/schemas/Toleration" }, "type": "array" }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nAll topologySpreadConstraints are ANDed.\n+optional\n+patchMergeKey=topologyKey\n+patchStrategy=merge\n+listType=map\n+listMapKey=topologyKey\n+listMapKey=whenUnsatisfiable", "items": { "$ref": "#/components/schemas/TopologySpreadConstraint" }, "type": "array" }, "volumes": { "description": "List of volumes that can be mounted by containers belonging to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes\n+optional\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys", "items": { "$ref": "#/components/schemas/Volume" }, "type": "array" } }, "title": "PodSpec is a description of a pod.", "type": "object" }, "PodStatus": { "description": "PodStatus represents information about the status of a pod. Status may trail the actual\nstate of a system, especially if the node that hosts the pod cannot contact the control\nplane.", "properties": { "conditions": { "description": "Current service state of pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions\n+optional\n+patchMergeKey=type\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/PodCondition" }, "type": "array" }, "containerStatuses": { "description": "The list has one entry per container in the manifest.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status\n+optional", "items": { "$ref": "#/components/schemas/ContainerStatus" }, "type": "array" }, "ephemeralContainerStatuses": { "description": "Status for any ephemeral containers that have run in this pod.\n+optional", "items": { "$ref": "#/components/schemas/ContainerStatus" }, "type": "array" }, "hostIP": { "description": "hostIP holds the IP address of the host to which the pod is assigned. Empty if the pod has not started yet.\nA pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will\nnot be updated even if there is a node is assigned to pod\n+optional", "type": "string" }, "hostIPs": { "description": "hostIPs holds the IP addresses allocated to the host. If this field is specified, the first entry must\nmatch the hostIP field. This list is empty if the pod has not started yet.\nA pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will\nnot be updated even if there is a node is assigned to this pod.\n+optional\n+patchStrategy=merge\n+patchMergeKey=ip\n+listType=atomic", "items": { "$ref": "#/components/schemas/HostIP" }, "type": "array" }, "initContainerStatuses": { "description": "The list has one entry per init container in the manifest. The most recent successful\ninit container will have ready = true, the most recently started container will have\nstartTime set.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status", "items": { "$ref": "#/components/schemas/ContainerStatus" }, "type": "array" }, "message": { "description": "A human readable message indicating details about why the pod is in this condition.\n+optional", "type": "string" }, "nominatedNodeName": { "description": "nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be\nscheduled right away as preemption victims receive their graceful termination periods.\nThis field does not guarantee that the pod will be scheduled on this node. Scheduler may decide\nto place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to\ngive the resources on this node to a higher priority pod that is created after preemption.\nAs a result, this field may be different than PodSpec.nodeName when the pod is\nscheduled.\n+optional", "type": "string" }, "phase": { "$ref": "#/components/schemas/PodPhase" }, "podIP": { "description": "podIP address allocated to the pod. Routable at least within the cluster.\nEmpty if not yet allocated.\n+optional", "type": "string" }, "podIPs": { "description": "podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must\nmatch the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list\nis empty if no IPs have been allocated yet.\n+optional\n+patchStrategy=merge\n+patchMergeKey=ip", "items": { "$ref": "#/components/schemas/PodIP" }, "type": "array" }, "qosClass": { "$ref": "#/components/schemas/PodQOSClass" }, "reason": { "description": "A brief CamelCase message indicating details about why the pod is in this state.\ne.g. 'Evicted'\n+optional", "type": "string" }, "resize": { "$ref": "#/components/schemas/PodResizeStatus" }, "resourceClaimStatuses": { "description": "Status of resource claims.\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional", "items": { "$ref": "#/components/schemas/PodResourceClaimStatus" }, "type": "array" }, "startTime": { "description": "RFC 3339 date and time at which the object was acknowledged by the Kubelet.\nThis is before the Kubelet pulled the container image(s) for the pod.\n+optional", "type": "string" } }, "type": "object" }, "PodTemplateSpec": { "description": "PodTemplateSpec describes the data a pod should have when created from a template", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/PodSpec" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "PodsMetricSource": { "description": "PodsMetricSource indicates how to scale on a metric describing each pod in\nthe current scale target (for example, transactions-processed-per-second).\nThe values will be averaged together before being compared to the target\nvalue.", "properties": { "metric": { "$ref": "#/components/schemas/MetricIdentifier" }, "target": { "$ref": "#/components/schemas/MetricTarget" } }, "type": "object" }, "PortworxVolumeSource": { "properties": { "fsType": { "description": "fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "volumeID": { "description": "volumeID uniquely identifies a Portworx volume", "type": "string" } }, "title": "PortworxVolumeSource represents a Portworx volume resource.", "type": "object" }, "PredictiveUnit": { "properties": { "children": { "items": { "$ref": "#/components/schemas/PredictiveUnit" }, "type": "array" }, "endpoint": { "$ref": "#/components/schemas/Endpoint" }, "envSecretRefName": { "type": "string" }, "implementation": { "$ref": "#/components/schemas/PredictiveUnitImplementation" }, "logger": { "$ref": "#/components/schemas/Logger" }, "methods": { "items": { "$ref": "#/components/schemas/PredictiveUnitMethod" }, "type": "array" }, "modelUri": { "type": "string" }, "name": { "type": "string" }, "parameters": { "items": { "$ref": "#/components/schemas/Parameter" }, "type": "array" }, "serviceAccountName": { "type": "string" }, "storageInitializerImage": { "type": "string" }, "type": { "$ref": "#/components/schemas/PredictiveUnitType" } }, "type": "object" }, "PredictiveUnitImplementation": { "type": "string" }, "PredictiveUnitMethod": { "type": "string" }, "PredictiveUnitType": { "type": "string" }, "PredictorSpec": { "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "componentSpecs": { "items": { "$ref": "#/components/schemas/SeldonPodSpec" }, "type": "array" }, "engineResources": { "$ref": "#/components/schemas/ResourceRequirements" }, "explainer": { "$ref": "#/components/schemas/Explainer" }, "graph": { "$ref": "#/components/schemas/PredictiveUnit" }, "labels": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" }, "progressDeadlineSeconds": { "format": "int32", "type": "integer" }, "replicas": { "format": "int32", "type": "integer" }, "shadow": { "type": "boolean" }, "ssl": { "$ref": "#/components/schemas/SSL" }, "svcOrchSpec": { "$ref": "#/components/schemas/SvcOrchSpec" }, "traffic": { "format": "int32", "type": "integer" } }, "type": "object" }, "PreemptionPolicy": { "description": "+enum", "title": "PreemptionPolicy describes a policy for if/when to preempt a pod.", "type": "string" }, "PreferredSchedulingTerm": { "description": "An empty preferred scheduling term matches all objects with implicit weight 0\n(i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).", "properties": { "preference": { "$ref": "#/components/schemas/NodeSelectorTerm" }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "format": "int32", "type": "integer" } }, "type": "object" }, "Probe": { "description": "Probe describes a health check to be performed against a container to determine whether it is\nalive or ready to receive traffic.", "properties": { "exec": { "$ref": "#/components/schemas/ExecAction" }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional", "format": "int32", "type": "integer" }, "grpc": { "$ref": "#/components/schemas/GRPCAction" }, "httpGet": { "$ref": "#/components/schemas/HTTPGetAction" }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "format": "int32", "type": "integer" }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional", "format": "int32", "type": "integer" }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional", "format": "int32", "type": "integer" }, "tcpSocket": { "$ref": "#/components/schemas/TCPSocketAction" }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\n+optional", "format": "int64", "type": "integer" }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "format": "int32", "type": "integer" } }, "type": "object" }, "ProcMountType": { "description": "+enum", "type": "string" }, "ProjectedVolumeSource": { "description": "Represents a projected volume source", "properties": { "defaultMode": { "description": "defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "type": "integer" }, "sources": { "description": "sources is the list of volume projections\n+optional", "items": { "$ref": "#/components/schemas/VolumeProjection" }, "type": "array" } }, "type": "object" }, "Protocol": { "type": "string", "description": "For model inference, Seldon recommends using the industry-standard Open Inference Protocol (OIP) as the preferred protocol over others.
The corresponding protocol OIP value for Seldon Deployments is 'v2'. For Seldon ML Pipelines, this is the only supported protocol.
For more information, please refer to the Seldon documentation: https://docs.seldon.ai/seldon-core-2/apis/inference/v2" }, "PullPolicy": { "description": "PullPolicy describes a policy for if/when to pull a container image\n+enum", "type": "string" }, "Quantity": { "description": "The serialization format is:\n\n```\n ::= \n\n(Note that may be empty, from the \"\" case in .)\n\n ::= 0 | 1 | ... | 9\n ::= | \n ::= | . | . | .\n ::= \"+\" | \"-\"\n ::= | \n ::= | | \n ::= Ki | Mi | Gi | Ti | Pi | Ei\n\n(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n\n ::= m | \"\" | k | M | G | T | P | E\n\n(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n\n ::= \"e\" | \"E\" \n```\n\nNo matter which of the three exponent forms is used, no quantity may represent\na number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal\nplaces. Numbers larger or more precise will be capped or rounded up.\n(E.g.: 0.1m will rounded up to 1m.)\nThis may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix\nit had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\".\nThis means that Exponent/suffix will be adjusted up or down (with a\ncorresponding increase or decrease in Mantissa) such that:\n\nNo precision is lost\nNo fractional digits will be emitted\nThe exponent (or suffix) is as large as possible.\n\nThe sign will be omitted unless the number is negative.\n\nExamples:\n\n1.5 will be serialized as \"1500m\"\n1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a\nfloating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed,\nbut will be re-emitted in their canonical form. (So always use canonical\nform, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without\nwriting some sort of special handling code in the hopes that that will\ncause implementors to also use a fixed point implementation.\n\n+protobuf=true\n+protobuf.embed=string\n+protobuf.options.marshal=false\n+protobuf.options.(gogoproto.goproto_stringer)=false\n+k8s:deepcopy-gen=true\n+k8s:openapi-gen=true", "title": "Quantity is a fixed-point representation of a number.\nIt provides convenient marshaling/unmarshaling in JSON and YAML,\nin addition to String() and AsInt64() accessors.", "type": "object" }, "QuobyteVolumeSource": { "description": "Quobyte volumes do not support ownership management or SELinux relabeling.", "properties": { "group": { "description": "group to map volume access to\nDefault is no group\n+optional", "type": "string" }, "readOnly": { "description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.\n+optional", "type": "boolean" }, "registry": { "description": "registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes", "type": "string" }, "tenant": { "description": "tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin\n+optional", "type": "string" }, "user": { "description": "user to map volume access to\nDefaults to serivceaccount user\n+optional", "type": "string" }, "volume": { "description": "volume is a string that references an already created Quobyte volume by name.", "type": "string" } }, "title": "Represents a Quobyte mount that lasts the lifetime of a pod.", "type": "object" }, "RBDVolumeSource": { "description": "RBD volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "image": { "description": "image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" }, "keyring": { "description": "keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "string" }, "monitors": { "description": "monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "items": { "type": "string" }, "type": "array" }, "pool": { "description": "pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "boolean" }, "secretRef": { "$ref": "#/components/schemas/LocalObjectReference" }, "user": { "description": "user is the rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "string" } }, "title": "Represents a Rados Block Device mount that lasts the lifetime of a pod.", "type": "object" }, "ResourceClaim": { "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container.", "type": "string" } }, "title": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "type": "object" }, "ResourceFieldSelector": { "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format\n+structType=atomic", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars\n+optional", "type": "string" }, "divisor": { "$ref": "#/components/schemas/Quantity" }, "resource": { "description": "Required: resource to select", "type": "string" } }, "type": "object" }, "ResourceList": { "additionalProperties": { "$ref": "#/components/schemas/Quantity" }, "title": "ResourceList is a set of (resource name, quantity) pairs.", "type": "object" }, "ResourceMetricSource": { "description": "ResourceMetricSource indicates how to scale on a resource metric known to\nKubernetes, as specified in requests and limits, describing each pod in the\ncurrent scale target (e.g. CPU or memory). The values will be averaged\ntogether before being compared to the target. Such metrics are built in to\nKubernetes, and have special scaling options on top of those available to\nnormal per-pod metrics using the \"pods\" source. Only one \"target\" type\nshould be set.", "properties": { "name": { "$ref": "#/components/schemas/ResourceName" }, "target": { "$ref": "#/components/schemas/MetricTarget" } }, "type": "object" }, "ResourceName": { "title": "ResourceName is the name identifying various resources in a ResourceList.", "type": "string" }, "ResourceRequirements": { "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.\n\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional", "items": { "$ref": "#/components/schemas/ResourceClaim" }, "type": "array" }, "limits": { "$ref": "#/components/schemas/ResourceList" }, "requests": { "$ref": "#/components/schemas/ResourceList" } }, "title": "ResourceRequirements describes the compute resource requirements.", "type": "object" }, "ResourceResizeRestartPolicy": { "title": "ResourceResizeRestartPolicy specifies how to handle container resource resize.", "type": "string" }, "ResourceType": { "type": "string" }, "RestartPolicy": { "description": "Only one of the following restart policies may be specified.\nIf none of the following policies is specified, the default one\nis RestartPolicyAlways.\n+enum", "title": "RestartPolicy describes how the container should be restarted.", "type": "string" }, "RollingUpdateDeployment": { "properties": { "maxSurge": { "$ref": "#/components/schemas/IntOrString" }, "maxUnavailable": { "$ref": "#/components/schemas/IntOrString" } }, "title": "Spec to control the desired behavior of rolling update.", "type": "object" }, "SELinuxOptions": { "description": "SELinuxOptions are the labels to be applied to the container", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.\n+optional", "type": "string" }, "role": { "description": "Role is a SELinux role label that applies to the container.\n+optional", "type": "string" }, "type": { "description": "Type is a SELinux type label that applies to the container.\n+optional", "type": "string" }, "user": { "description": "User is a SELinux user label that applies to the container.\n+optional", "type": "string" } }, "type": "object" }, "SSL": { "properties": { "certSecretName": { "type": "string" } }, "type": "object" }, "ScaleIOVolumeSource": { "description": "ScaleIOVolumeSource represents a persistent ScaleIO volume", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".\n+optional", "type": "string" }, "gateway": { "description": "gateway is the host address of the ScaleIO API Gateway.", "type": "string" }, "protectionDomain": { "description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.\n+optional", "type": "string" }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "$ref": "#/components/schemas/LocalObjectReference" }, "sslEnabled": { "description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false\n+optional", "type": "boolean" }, "storageMode": { "description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional", "type": "string" }, "storagePool": { "description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.\n+optional", "type": "string" }, "system": { "description": "system is the name of the storage system as configured in ScaleIO.", "type": "string" }, "volumeName": { "description": "volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source.", "type": "string" } }, "type": "object" }, "ScaleTriggers": { "description": "ScaleTriggers reference the scaler that will be used", "properties": { "authenticationRef": { "$ref": "#/components/schemas/ScaledObjectAuthRef" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "metricType": { "$ref": "#/components/schemas/MetricTargetType" }, "name": { "description": "+optional", "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "ScaledObjectAuthRef": { "description": "ScaledObjectAuthRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that\nis used to authenticate the scaler with the environment", "properties": { "kind": { "description": "Kind of the resource being referred to. Defaults to TriggerAuthentication.\n+optional", "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "ScalingPolicySelect": { "description": "ScalingPolicySelect is used to specify which policy should be used while scaling in a certain direction", "type": "string" }, "SeccompProfile": { "description": "Only one profile source may be set.\n+union", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.\n+optional", "type": "string" }, "type": { "$ref": "#/components/schemas/SeccompProfileType" } }, "title": "SeccompProfile defines a pod/container's seccomp profile settings.", "type": "object" }, "SeccompProfileType": { "description": "+enum", "title": "SeccompProfileType defines the supported seccomp profile types.", "type": "string" }, "SecretEnvSource": { "description": "The contents of the target Secret's Data field will represent the\nkey-value pairs as environment variables.", "properties": { "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the Secret must be defined\n+optional", "type": "boolean" } }, "title": "SecretEnvSource selects a Secret to populate the environment\nvariables with.", "type": "object" }, "SecretKeySelector": { "description": "+structType=atomic", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } }, "title": "SecretKeySelector selects a key of a Secret.", "type": "object" }, "SecretProjection": { "description": "The contents of the target Secret's Data field will be presented in a\nprojected volume as files using the keys in the Data field as the file names.\nNote that this is identical to a secret volume source without the default\nmode.", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/KeyToPath" }, "type": "array" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional", "type": "string" }, "optional": { "description": "optional field specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } }, "title": "Adapts a secret into a projected volume.", "type": "object" }, "SecretVolumeSource": { "description": "The contents of the target Secret's Data field will be presented in a volume\nas files using the keys in the Data field as the file names.\nSecret volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "description": "defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "format": "int32", "type": "integer" }, "items": { "description": "items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional", "items": { "$ref": "#/components/schemas/KeyToPath" }, "type": "array" }, "optional": { "description": "optional field specify whether the Secret or its keys must be defined\n+optional", "type": "boolean" }, "secretName": { "description": "secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional", "type": "string" } }, "title": "Adapts a Secret into a volume.", "type": "object" }, "SecurityContext": { "description": "Some fields are present in both SecurityContext and PodSecurityContext. When both\nare set, the values in SecurityContext take precedence.", "properties": { "allowPrivilegeEscalation": { "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "boolean" }, "capabilities": { "$ref": "#/components/schemas/Capabilities" }, "privileged": { "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "boolean" }, "procMount": { "$ref": "#/components/schemas/ProcMountType" }, "readOnlyRootFilesystem": { "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "boolean" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "format": "int64", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "format": "int64", "type": "integer" }, "seLinuxOptions": { "$ref": "#/components/schemas/SELinuxOptions" }, "seccompProfile": { "$ref": "#/components/schemas/SeccompProfile" }, "windowsOptions": { "$ref": "#/components/schemas/WindowsSecurityContextOptions" } }, "title": "SecurityContext holds security configuration that will be applied to a container.", "type": "object" }, "SeldonAddressable": { "description": "https://github.com/kubernetes-sigs/controller-tools/issues/391", "properties": { "url": { "type": "string" } }, "title": "Addressable placeholder until duckv1 issue is fixed:", "type": "object" }, "SeldonDeployment": { "description": "+genclient\n+genclient:noStatus\n+kubebuilder:object:root=true\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object\n+kubebuilder:storageversion\nSeldonDeployment is the Schema for the seldondeployments API\n+k8s:openapi-gen=true\n+kubebuilder:resource:shortName=sdep\n+kubebuilder:subresource:status\n+kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/components/schemas/ObjectMeta" }, "spec": { "$ref": "#/components/schemas/SeldonDeploymentSpec" }, "status": { "$ref": "#/components/schemas/SeldonDeploymentStatus" } }, "type": "object" }, "SeldonDeploymentList": { "properties": { "apiVersion": { "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/SeldonDeployment" }, "type": "array" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ListMeta" } }, "type": "object" }, "SeldonDeploymentSpec": { "description": "SeldonDeploymentSpec defines the desired state of SeldonDeployment", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "description": "Name is Deprecated will be removed in future", "type": "string" }, "oauth_key": { "type": "string" }, "oauth_secret": { "type": "string" }, "predictors": { "items": { "$ref": "#/components/schemas/PredictorSpec" }, "type": "array" }, "protocol": { "$ref": "#/components/schemas/Protocol" }, "replicas": { "format": "int32", "type": "integer" }, "serverType": { "$ref": "#/components/schemas/ServerType" }, "transport": { "$ref": "#/components/schemas/Transport" } }, "type": "object" }, "SeldonDeploymentStatus": { "description": "SeldonDeploymentStatus defines the observed state of SeldonDeployment", "properties": { "address": { "$ref": "#/components/schemas/SeldonAddressable" }, "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is additional Status fields for the Resource to save some\nadditional State as well as convey more information to the user. This is\nroughly akin to Annotations on any k8s resource, just the reconciler conveying\nricher information outwards.", "type": "object" }, "conditions": { "$ref": "#/components/schemas/Conditions" }, "deploymentStatus": { "additionalProperties": { "$ref": "#/components/schemas/DeploymentStatus" }, "type": "object" }, "description": { "type": "string" }, "observedGeneration": { "description": "ObservedGeneration is the 'Generation' of the Service that\nwas last processed by the controller.\n+optional", "format": "int64", "type": "integer" }, "replicas": { "format": "int32", "type": "integer" }, "serviceStatus": { "additionalProperties": { "$ref": "#/components/schemas/ServiceStatus" }, "type": "object" }, "state": { "$ref": "#/components/schemas/StatusState" } }, "type": "object" }, "SeldonExperiment": { "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ObjectMeta" }, "spec": { "$ref": "#/components/schemas/ExperimentSpec" }, "status": { "$ref": "#/components/schemas/ExperimentStatus" } }, "type": "object" }, "SeldonHpaSpec": { "properties": { "maxReplicas": { "format": "int32", "type": "integer" }, "metrics": { "items": { "$ref": "#/components/schemas/MetricSpec" }, "type": "array" }, "metricsv2": { "items": { "$ref": "#/components/schemas/MetricSpec" }, "type": "array" }, "minReplicas": { "format": "int32", "type": "integer" } }, "type": "object" }, "SeldonModel": { "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ObjectMeta" }, "spec": { "$ref": "#/components/schemas/ModelSpec" }, "status": { "$ref": "#/components/schemas/ModelStatus" } }, "type": "object" }, "SeldonModelList": { "properties": { "apiVersion": { "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/Model" }, "type": "array" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ListMeta" } }, "type": "object" }, "SeldonPdbSpec": { "properties": { "maxUnavailable": { "$ref": "#/components/schemas/IntOrString" }, "minAvailable": { "$ref": "#/components/schemas/IntOrString" } }, "type": "object" }, "SeldonPipeline": { "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ObjectMeta" }, "spec": { "$ref": "#/components/schemas/PipelineSpec" }, "status": { "$ref": "#/components/schemas/PipelineStatus" } }, "type": "object" }, "SeldonPipelineList": { "properties": { "apiVersion": { "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/Pipeline" }, "type": "array" }, "kind": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/ListMeta" } }, "type": "object" }, "SeldonPodSpec": { "properties": { "hpaSpec": { "$ref": "#/components/schemas/SeldonHpaSpec" }, "kedaSpec": { "$ref": "#/components/schemas/SeldonScaledObjectSpec" }, "metadata": { "$ref": "#/components/schemas/ObjectMeta" }, "pdbSpec": { "$ref": "#/components/schemas/SeldonPdbSpec" }, "replicas": { "format": "int32", "type": "integer" }, "spec": { "$ref": "#/components/schemas/PodSpec" } }, "type": "object" }, "SeldonScaledObjectSpec": { "description": "SeldonScaledObjectSpec is the spec for a KEDA ScaledObject resource", "properties": { "advanced": { "$ref": "#/components/schemas/AdvancedConfig" }, "cooldownPeriod": { "description": "+optional", "format": "int32", "type": "integer" }, "fallback": { "$ref": "#/components/schemas/Fallback" }, "idleReplicaCount": { "description": "+optional", "format": "int32", "type": "integer" }, "maxReplicaCount": { "description": "+optional", "format": "int32", "type": "integer" }, "minReplicaCount": { "description": "+optional", "format": "int32", "type": "integer" }, "pollingInterval": { "description": "+optional", "format": "int32", "type": "integer" }, "triggers": { "items": { "$ref": "#/components/schemas/ScaleTriggers" }, "type": "array" } }, "type": "object" }, "ServerType": { "type": "string" }, "Service": { "description": "Service is a named abstraction of software service (for example, mysql) consisting of local port\n(for example 3306) that the proxy listens on, and the selector that determines which pods\nwill answer requests sent through the proxy.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "format": "int64", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge", "items": { "type": "string" }, "type": "array" }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "format": "int64", "type": "integer" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object" }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional", "items": { "$ref": "#/components/schemas/ManagedFieldsEntry" }, "type": "array" }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", "items": { "$ref": "#/components/schemas/OwnerReference" }, "type": "array" }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "spec": { "$ref": "#/components/schemas/ServiceSpec" }, "status": { "$ref": "#/components/schemas/ServiceStatus" }, "uid": { "$ref": "#/components/schemas/UID" } }, "type": "object" }, "ServiceAccountTokenProjection": { "description": "ServiceAccountTokenProjection represents a projected service account token\nvolume. This projection can be used to insert a service account token into\nthe pods runtime filesystem for use against APIs (Kubernetes API Server or\notherwise).", "properties": { "audience": { "description": "audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.\n+optional", "type": "string" }, "expirationSeconds": { "description": "expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.\n+optional", "format": "int64", "type": "integer" }, "path": { "description": "path is the path relative to the mount point of the file to project the\ntoken into.", "type": "string" } }, "type": "object" }, "ServiceAffinity": { "description": "Session Affinity Type string\n+enum", "type": "string" }, "ServiceExternalTrafficPolicy": { "description": "ServiceExternalTrafficPolicy describes how nodes distribute service traffic they\nreceive on one of the Service's \"externally-facing\" addresses (NodePorts, ExternalIPs,\nand LoadBalancer IPs.\n+enum", "type": "string" }, "ServiceInternalTrafficPolicy": { "description": "ServiceInternalTrafficPolicy describes how nodes distribute service traffic they\nreceive on the ClusterIP.\n+enum", "type": "string" }, "ServiceList": { "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "continue": { "description": "continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nconsistent list may not be possible if the server configuration has changed or more than a few\nminutes have passed. The resourceVersion field returned when using this continue value will be\nidentical to the value in the first response, unless you have received this token from an error\nmessage.", "type": "string" }, "items": { "description": "List of services", "items": { "$ref": "#/components/schemas/Service" }, "type": "array" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "remainingItemCount": { "description": "remainingItemCount is the number of subsequent items in the list which are not included in this\nlist response. If the list request contained label or field selectors, then the number of\nremaining items is unknown and the field will be left unset and omitted during serialization.\nIf the list is complete (either because it is not chunking or because this is the last chunk),\nthen there are no more remaining items and this field will be left unset and omitted during\nserialization.\nServers older than v1.15 do not set this field.\nThe intended use of the remainingItemCount is *estimating* the size of a collection. Clients\nshould not rely on the remainingItemCount to be set or to be exact.\n+optional", "format": "int64", "type": "integer" }, "resourceVersion": { "description": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" } }, "title": "ServiceList holds a list of services.", "type": "object" }, "ServicePort": { "properties": { "appProtocol": { "description": "The application protocol for this port.\nThis is used as a hint for implementations to offer richer behavior for protocols that they understand.\nThis field follows standard Kubernetes label syntax.\nValid values are either:\n\nUn-prefixed protocol names - reserved for IANA standard service names (as per\nRFC-6335 and https://www.iana.org/assignments/service-names).\n\nKubernetes-defined prefixed names:\n'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-\n'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455\n'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455\n\nOther protocols should use implementation-defined prefixed names such as\nmycompany.com/my-custom-protocol.\n+optional", "type": "string" }, "name": { "description": "The name of this port within the service. This must be a DNS_LABEL.\nAll ports within a ServiceSpec must have unique names. When considering\nthe endpoints for a Service, this must match the 'name' field in the\nEndpointPort.\nOptional if only one ServicePort is defined on this service.\n+optional", "type": "string" }, "nodePort": { "description": "The port on each node on which this service is exposed when type is\nNodePort or LoadBalancer. Usually assigned by the system. If a value is\nspecified, in-range, and not in use it will be used, otherwise the\noperation will fail. If not specified, a port will be allocated if this\nService requires one. If this field is specified when creating a\nService which does not need it, creation will fail. This field will be\nwiped when updating a Service to no longer need it (e.g. changing type\nfrom NodePort to ClusterIP).\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport\n+optional", "format": "int32", "type": "integer" }, "port": { "description": "The port that will be exposed by this service.", "format": "int32", "type": "integer" }, "protocol": { "$ref": "#/components/schemas/Protocol" }, "targetPort": { "$ref": "#/components/schemas/IntOrString" } }, "title": "ServicePort contains information on service's port.", "type": "object" }, "ServiceSpec": { "properties": { "allocateLoadBalancerNodePorts": { "description": "allocateLoadBalancerNodePorts defines if NodePorts will be automatically\nallocated for services with type LoadBalancer. Default is \"true\". It\nmay be set to \"false\" if the cluster load-balancer does not rely on\nNodePorts. If the caller requests specific NodePorts (by specifying a\nvalue), those requests will be respected, regardless of this field.\nThis field may only be set for services with type LoadBalancer and will\nbe cleared if the type is changed to any other type.\n+optional", "type": "boolean" }, "clusterIP": { "description": "clusterIP is the IP address of the service and is usually assigned\nrandomly. If an address is specified manually, is in-range (as per\nsystem configuration), and is not in use, it will be allocated to the\nservice; otherwise creation of the service will fail. This field may not\nbe changed through updates unless the type field is also being changed\nto ExternalName (which requires this field to be blank) or the type\nfield is being changed from ExternalName (in which case this field may\noptionally be specified, as describe above). Valid values are \"None\",\nempty string (\"\"), or a valid IP address. Setting this to \"None\" makes a\n\"headless service\" (no virtual IP), which is useful when direct endpoint\nconnections are preferred and proxying is not required. Only applies to\ntypes ClusterIP, NodePort, and LoadBalancer. If this field is specified\nwhen creating a Service of type ExternalName, creation will fail. This\nfield will be wiped when updating a Service to type ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional", "type": "string" }, "clusterIPs": { "description": "ClusterIPs is a list of IP addresses assigned to this service, and are\nusually assigned randomly. If an address is specified manually, is\nin-range (as per system configuration), and is not in use, it will be\nallocated to the service; otherwise creation of the service will fail.\nThis field may not be changed through updates unless the type field is\nalso being changed to ExternalName (which requires this field to be\nempty) or the type field is being changed from ExternalName (in which\ncase this field may optionally be specified, as describe above). Valid\nvalues are \"None\", empty string (\"\"), or a valid IP address. Setting\nthis to \"None\" makes a \"headless service\" (no virtual IP), which is\nuseful when direct endpoint connections are preferred and proxying is\nnot required. Only applies to types ClusterIP, NodePort, and\nLoadBalancer. If this field is specified when creating a Service of type\nExternalName, creation will fail. This field will be wiped when updating\na Service to type ExternalName. If this field is not specified, it will\nbe initialized from the clusterIP field. If this field is specified,\nclients must ensure that clusterIPs[0] and clusterIP have the same\nvalue.\n\nThis field may hold a maximum of two entries (dual-stack IPs, in either order).\nThese IPs must correspond to the values of the ipFamilies field. Both\nclusterIPs and ipFamilies are governed by the ipFamilyPolicy field.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+listType=atomic\n+optional", "items": { "type": "string" }, "type": "array" }, "externalIPs": { "description": "externalIPs is a list of IP addresses for which nodes in the cluster\nwill also accept traffic for this service. These IPs are not managed by\nKubernetes. The user is responsible for ensuring that traffic arrives\nat a node with this IP. A common example is external load-balancers\nthat are not part of the Kubernetes system.\n+optional", "items": { "type": "string" }, "type": "array" }, "externalName": { "description": "externalName is the external reference that discovery mechanisms will\nreturn as an alias for this service (e.g. a DNS CNAME record). No\nproxying will be involved. Must be a lowercase RFC-1123 hostname\n(https://tools.ietf.org/html/rfc1123) and requires `type` to be \"ExternalName\".\n+optional", "type": "string" }, "externalTrafficPolicy": { "$ref": "#/components/schemas/ServiceExternalTrafficPolicy" }, "healthCheckNodePort": { "description": "healthCheckNodePort specifies the healthcheck nodePort for the service.\nThis only applies when type is set to LoadBalancer and\nexternalTrafficPolicy is set to Local. If a value is specified, is\nin-range, and is not in use, it will be used. If not specified, a value\nwill be automatically allocated. External systems (e.g. load-balancers)\ncan use this port to determine if a given node holds endpoints for this\nservice or not. If this field is specified when creating a Service\nwhich does not need it, creation will fail. This field will be wiped\nwhen updating a Service to no longer need it (e.g. changing type).\nThis field cannot be updated once set.\n+optional", "format": "int32", "type": "integer" }, "internalTrafficPolicy": { "$ref": "#/components/schemas/ServiceInternalTrafficPolicy" }, "ipFamilies": { "description": "IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this\nservice. This field is usually assigned automatically based on cluster\nconfiguration and the ipFamilyPolicy field. If this field is specified\nmanually, the requested family is available in the cluster,\nand ipFamilyPolicy allows it, it will be used; otherwise creation of\nthe service will fail. This field is conditionally mutable: it allows\nfor adding or removing a secondary IP family, but it does not allow\nchanging the primary IP family of the Service. Valid values are \"IPv4\"\nand \"IPv6\". This field only applies to Services of types ClusterIP,\nNodePort, and LoadBalancer, and does apply to \"headless\" services.\nThis field will be wiped when updating a Service to type ExternalName.\n\nThis field may hold a maximum of two entries (dual-stack families, in\neither order). These families must correspond to the values of the\nclusterIPs field, if specified. Both clusterIPs and ipFamilies are\ngoverned by the ipFamilyPolicy field.\n+listType=atomic\n+optional", "items": { "$ref": "#/components/schemas/IPFamily" }, "type": "array" }, "ipFamilyPolicy": { "$ref": "#/components/schemas/IPFamilyPolicy" }, "loadBalancerClass": { "description": "loadBalancerClass is the class of the load balancer implementation this Service belongs to.\nIf specified, the value of this field must be a label-style identifier, with an optional prefix,\ne.g. \"internal-vip\" or \"example.com/internal-vip\". Unprefixed names are reserved for end-users.\nThis field can only be set when the Service type is 'LoadBalancer'. If not set, the default load\nbalancer implementation is used, today this is typically done through the cloud provider integration,\nbut should apply for any default implementation. If set, it is assumed that a load balancer\nimplementation is watching for Services with a matching class. Any default load balancer\nimplementation (e.g. cloud providers) should ignore Services that set this field.\nThis field can only be set when creating or updating a Service to type 'LoadBalancer'.\nOnce set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type.\n+optional", "type": "string" }, "loadBalancerIP": { "description": "Only applies to Service Type: LoadBalancer.\nThis feature depends on whether the underlying cloud-provider supports specifying\nthe loadBalancerIP when a load balancer is created.\nThis field will be ignored if the cloud-provider does not support the feature.\nDeprecated: This field was under-specified and its meaning varies across implementations.\nUsing it is non-portable and it may not support dual-stack.\nUsers are encouraged to use implementation-specific annotations when available.\n+optional", "type": "string" }, "loadBalancerSourceRanges": { "description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider\nload-balancer will be restricted to the specified client IPs. This field will be ignored if the\ncloud-provider does not support the feature.\"\nMore info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/\n+optional", "items": { "type": "string" }, "type": "array" }, "ports": { "description": "The list of ports that are exposed by this service.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+patchMergeKey=port\n+patchStrategy=merge\n+listType=map\n+listMapKey=port\n+listMapKey=protocol", "items": { "$ref": "#/components/schemas/ServicePort" }, "type": "array" }, "publishNotReadyAddresses": { "description": "publishNotReadyAddresses indicates that any agent which deals with endpoints for this\nService should disregard any indications of ready/not-ready.\nThe primary use case for setting this field is for a StatefulSet's Headless Service to\npropagate SRV DNS records for its Pods for the purpose of peer discovery.\nThe Kubernetes controllers that generate Endpoints and EndpointSlice resources for\nServices interpret this to mean that all endpoints are considered \"ready\" even if the\nPods themselves are not. Agents which consume only Kubernetes generated endpoints\nthrough the Endpoints or EndpointSlice resources can safely assume this behavior.\n+optional", "type": "boolean" }, "selector": { "additionalProperties": { "type": "string" }, "description": "Route service traffic to pods with label keys and values matching this\nselector. If empty or not present, the service is assumed to have an\nexternal process managing its endpoints, which Kubernetes will not\nmodify. Only applies to types ClusterIP, NodePort, and LoadBalancer.\nIgnored if type is ExternalName.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/\n+optional\n+mapType=atomic", "type": "object" }, "sessionAffinity": { "$ref": "#/components/schemas/ServiceAffinity" }, "sessionAffinityConfig": { "$ref": "#/components/schemas/SessionAffinityConfig" }, "type": { "$ref": "#/components/schemas/ServiceType" } }, "title": "ServiceSpec describes the attributes that a user creates on a service.", "type": "object" }, "ServiceStatus": { "properties": { "explainerFor": { "type": "string" }, "grpcEndpoint": { "type": "string" }, "httpEndpoint": { "type": "string" }, "svcName": { "type": "string" } }, "type": "object" }, "ServiceType": { "description": "Service Type string describes ingress methods for a service\n+enum", "type": "string" }, "SessionAffinityConfig": { "properties": { "clientIP": { "$ref": "#/components/schemas/ClientIPConfig" } }, "title": "SessionAffinityConfig represents the configurations of session affinity.", "type": "object" }, "SleepAction": { "properties": { "seconds": { "description": "Seconds is the number of seconds to sleep.", "format": "int64", "type": "integer" } }, "title": "SleepAction describes a \"sleep\" action.", "type": "object" }, "StatusState": { "type": "string" }, "StorageMedium": { "title": "StorageMedium defines ways that storage can be allocated to a volume.", "type": "string" }, "StorageOSVolumeSource": { "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "$ref": "#/components/schemas/LocalObjectReference" }, "volumeName": { "description": "volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace.", "type": "string" }, "volumeNamespace": { "description": "volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional", "type": "string" } }, "title": "Represents a StorageOS persistent volume resource.", "type": "object" }, "SvcOrchSpec": { "properties": { "env": { "items": { "$ref": "#/components/schemas/EnvVar" }, "type": "array" }, "replicas": { "format": "int32", "type": "integer" }, "resources": { "$ref": "#/components/schemas/ResourceRequirements" } }, "type": "object" }, "Sysctl": { "description": "Sysctl defines a kernel parameter to be set", "properties": { "name": { "description": "Name of a property to set", "type": "string" }, "value": { "description": "Value of a property to set", "type": "string" } }, "type": "object" }, "TCPSocketAction": { "description": "TCPSocketAction describes an action based on opening a socket", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.\n+optional", "type": "string" }, "port": { "$ref": "#/components/schemas/IntOrString" } }, "type": "object" }, "TaintEffect": { "description": "+enum", "type": "string" }, "TerminationMessagePolicy": { "description": "+enum", "title": "TerminationMessagePolicy describes how termination messages are retrieved from a container.", "type": "string" }, "Toleration": { "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator .", "properties": { "effect": { "$ref": "#/components/schemas/TaintEffect" }, "key": { "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.\n+optional", "type": "string" }, "operator": { "$ref": "#/components/schemas/TolerationOperator" }, "tolerationSeconds": { "description": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.\n+optional", "format": "int64", "type": "integer" }, "value": { "description": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.\n+optional", "type": "string" } }, "type": "object" }, "TolerationOperator": { "description": "+enum", "title": "A toleration operator is the set of operators that can be used in a toleration.", "type": "string" }, "TopologySpreadConstraint": { "properties": { "labelSelector": { "$ref": "#/components/schemas/LabelSelector" }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\n+listType=atomic\n+optional", "items": { "type": "string" }, "type": "array" }, "maxSkew": { "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n+-------+-------+-------+\n zone1 | zone2 | zone3 |\n+-------+-------+-------+\n P P | P P | P |\n+-------+-------+-------+\nif MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\nif MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed.", "format": "int32", "type": "integer" }, "minDomains": { "description": "MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n+-------+-------+-------+\n zone1 | zone2 | zone3 |\n+-------+-------+-------+\n P P | P P | P P |\n+-------+-------+-------+\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew.\n\nThis is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).\n+optional", "format": "int32", "type": "integer" }, "nodeAffinityPolicy": { "$ref": "#/components/schemas/NodeInclusionPolicy" }, "nodeTaintsPolicy": { "$ref": "#/components/schemas/NodeInclusionPolicy" }, "topologyKey": { "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field.", "type": "string" }, "whenUnsatisfiable": { "$ref": "#/components/schemas/UnsatisfiableConstraintAction" } }, "title": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.", "type": "object" }, "Transport": { "type": "string" }, "Type": { "format": "int64", "title": "Type represents the stored type of IntOrString.", "type": "integer" }, "TypedLocalObjectReference": { "description": "TypedLocalObjectReference contains enough information to let you locate the\ntyped referenced object inside the same namespace.\n+structType=atomic", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" } }, "type": "object" }, "TypedObjectReference": { "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" }, "namespace": { "description": "Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+featureGate=CrossNamespaceVolumeDataSource\n+optional", "type": "string" } }, "type": "object" }, "UID": { "description": "UID is a type that holds unique ID values, including UUIDs. Because we\ndon't ONLY use UUIDs, this is an alias to string. Being a type captures\nintent and helps make sure that UIDs and names do not get conflated.", "type": "string" }, "URIScheme": { "description": "URIScheme identifies the scheme used for connection to a host for Get actions\n+enum", "type": "string" }, "UnsatisfiableConstraintAction": { "description": "+enum", "type": "string" }, "UserInfo": { "properties": { "Email": { "type": "string" }, "Groups": { "items": { "type": "string" }, "type": "array" }, "Id": { "type": "string" }, "Name": { "type": "string" } }, "type": "object" }, "VersionInfo": { "properties": { "BuildTime": { "type": "string" }, "BuildVersion": { "type": "string" }, "GitBranch": { "type": "string" }, "GitCommit": { "type": "string" }, "GitStatus": { "type": "string" }, "ReleaseType": { "type": "string" } }, "type": "object" }, "Volume": { "properties": { "awsElasticBlockStore": { "$ref": "#/components/schemas/AWSElasticBlockStoreVolumeSource" }, "azureDisk": { "$ref": "#/components/schemas/AzureDiskVolumeSource" }, "azureFile": { "$ref": "#/components/schemas/AzureFileVolumeSource" }, "cephfs": { "$ref": "#/components/schemas/CephFSVolumeSource" }, "cinder": { "$ref": "#/components/schemas/CinderVolumeSource" }, "configMap": { "$ref": "#/components/schemas/ConfigMapVolumeSource" }, "csi": { "$ref": "#/components/schemas/CSIVolumeSource" }, "downwardAPI": { "$ref": "#/components/schemas/DownwardAPIVolumeSource" }, "emptyDir": { "$ref": "#/components/schemas/EmptyDirVolumeSource" }, "ephemeral": { "$ref": "#/components/schemas/EphemeralVolumeSource" }, "fc": { "$ref": "#/components/schemas/FCVolumeSource" }, "flexVolume": { "$ref": "#/components/schemas/FlexVolumeSource" }, "flocker": { "$ref": "#/components/schemas/FlockerVolumeSource" }, "gcePersistentDisk": { "$ref": "#/components/schemas/GCEPersistentDiskVolumeSource" }, "gitRepo": { "$ref": "#/components/schemas/GitRepoVolumeSource" }, "glusterfs": { "$ref": "#/components/schemas/GlusterfsVolumeSource" }, "hostPath": { "$ref": "#/components/schemas/HostPathVolumeSource" }, "iscsi": { "$ref": "#/components/schemas/ISCSIVolumeSource" }, "name": { "description": "name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "nfs": { "$ref": "#/components/schemas/NFSVolumeSource" }, "persistentVolumeClaim": { "$ref": "#/components/schemas/PersistentVolumeClaimVolumeSource" }, "photonPersistentDisk": { "$ref": "#/components/schemas/PhotonPersistentDiskVolumeSource" }, "portworxVolume": { "$ref": "#/components/schemas/PortworxVolumeSource" }, "projected": { "$ref": "#/components/schemas/ProjectedVolumeSource" }, "quobyte": { "$ref": "#/components/schemas/QuobyteVolumeSource" }, "rbd": { "$ref": "#/components/schemas/RBDVolumeSource" }, "scaleIO": { "$ref": "#/components/schemas/ScaleIOVolumeSource" }, "secret": { "$ref": "#/components/schemas/SecretVolumeSource" }, "storageos": { "$ref": "#/components/schemas/StorageOSVolumeSource" }, "vsphereVolume": { "$ref": "#/components/schemas/VsphereVirtualDiskVolumeSource" } }, "title": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "type": "object" }, "VolumeDevice": { "properties": { "devicePath": { "description": "devicePath is the path inside of the container that the device will be mapped to.", "type": "string" }, "name": { "description": "name must match the name of a persistentVolumeClaim in the pod", "type": "string" } }, "title": "volumeDevice describes a mapping of a raw block device within a container.", "type": "object" }, "VolumeMount": { "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "$ref": "#/components/schemas/MountPropagationMode" }, "name": { "description": "This must match the Name of a Volume.", "type": "string" }, "readOnly": { "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional", "type": "boolean" }, "subPath": { "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional", "type": "string" }, "subPathExpr": { "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\n+optional", "type": "string" } }, "title": "VolumeMount describes a mounting of a Volume within a container.", "type": "object" }, "VolumeProjection": { "description": "Projection that may be projected along with other supported volume types", "properties": { "clusterTrustBundle": { "$ref": "#/components/schemas/ClusterTrustBundleProjection" }, "configMap": { "$ref": "#/components/schemas/ConfigMapProjection" }, "downwardAPI": { "$ref": "#/components/schemas/DownwardAPIProjection" }, "secret": { "$ref": "#/components/schemas/SecretProjection" }, "serviceAccountToken": { "$ref": "#/components/schemas/ServiceAccountTokenProjection" } }, "type": "object" }, "VolumeResourceRequirements": { "properties": { "limits": { "$ref": "#/components/schemas/ResourceList" }, "requests": { "$ref": "#/components/schemas/ResourceList" } }, "title": "VolumeResourceRequirements describes the storage resource requirements for a volume.", "type": "object" }, "VsphereVirtualDiskVolumeSource": { "properties": { "fsType": { "description": "fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "type": "string" }, "storagePolicyID": { "description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.\n+optional", "type": "string" }, "storagePolicyName": { "description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.\n+optional", "type": "string" }, "volumePath": { "description": "volumePath is the path that identifies vSphere volume vmdk", "type": "string" } }, "title": "Represents a vSphere volume resource.", "type": "object" }, "WeightedPodAffinityTerm": { "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", "properties": { "podAffinityTerm": { "$ref": "#/components/schemas/PodAffinityTerm" }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "format": "int32", "type": "integer" } }, "type": "object" }, "WindowsSecurityContextOptions": { "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\n+optional", "type": "string" }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\n+optional", "type": "string" }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\n+optional", "type": "boolean" }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "string" } }, "title": "WindowsSecurityContextOptions contain Windows-specific options and credentials.", "type": "object" }, "WorkflowPhase": { "description": "the workflow's phase", "type": "string" }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": {} }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/protobufAny" } } } }, "v1ArtifactType": { "type": "string", "enum": [ "UNKNOWN", "CUSTOM", "TENSORFLOW", "SKLEARN", "XGBOOST", "MLFLOW", "PYTORCH", "ONNX", "TENSORRT", "ALIBI_EXPLAIN", "ALIBI_DETECT", "HUGGINGFACE", "MLSERVER_PYTHON", "TRITON_PYTHON" ], "default": "UNKNOWN" }, "v1DataType": { "type": "string", "enum": [ "FLOAT", "INT", "BOOL", "STRING", "BYTES" ], "default": "FLOAT" }, "v1DefaultProtocol": { "type": "string", "enum": [ "PROTOCOL_UNKNOWN", "PROTOCOL_SELDON", "PROTOCOL_TENSORFLOW", "PROTOCOL_V2" ], "default": "PROTOCOL_UNKNOWN", "description": "For model inference, Seldon recommends using the industry-standard Open Inference Protocol (OIP) as the preferred protocol over others.
This value is managed internally by the Seldon Enterprise Platform. For Seldon Deployments using the OIP, the protocol value is 'PROTOCOL_V2'. For Seldon ML Pipelines, it is 'PROTOCOL_UNKNOWN'.
For more information, please refer to the Seldon documentation: https://docs.seldon.ai/seldon-core-2/apis/inference/v2" }, "v1DeploymentStatus": { "type": "string", "enum": [ "Running", "Stopped", "Unknown" ], "default": "Running" }, "v1DeploymentType": { "type": "string", "enum": [ "UndefinedDeploymentType", "SeldonDeployment", "SeldonModel", "KnativeDetector" ], "default": "UndefinedDeploymentType" }, "v1FeatureCategorySchema": { "type": "object", "properties": { "name": { "type": "string" }, "dataType": { "$ref": "#/components/schemas/v1DataType" } }, "required": [ "name" ] }, "v1FeatureSchema": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/v1FeatureType" }, "dataType": { "$ref": "#/components/schemas/v1DataType" }, "nCategories": { "type": "string", "format": "int64" }, "categoryMap": { "type": "object", "additionalProperties": { "type": "string" } }, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/v1FeatureCategorySchema" } }, "shape": { "type": "array", "items": { "type": "string", "format": "int64" } } }, "required": [ "name", "type" ] }, "v1FeatureType": { "type": "string", "enum": [ "REAL", "CATEGORICAL", "PROBA", "ONE_HOT", "TEXT", "TENSOR" ], "default": "REAL", "title": "- REAL: A numerical variable\n - CATEGORICAL: A categorical variable\n - PROBA: A list of probabilities\n - ONE_HOT: A list of one-hot encodings\n - TEXT: A text string\n - TENSOR: N-dimensional Tensor" }, "v1Model": { "type": "object", "properties": { "URI": { "type": "string", "example": "gs://seldon-models/sklearn/iris", "description": "The URI for the storage bucket containing the model, or the URI to the docker image for custom models. It must be a valid URI as defined in RFC 3986, and must not exceed 200 characters." }, "name": { "type": "string", "example": "Iris Classifier", "description": "The name of the model. It must not exceed 200 characters." }, "version": { "type": "string", "example": "v1.2.3", "default": "\"v0.0.1\"", "description": "The version of the model. It must not exceed 50 characters." }, "artifactType": { "$ref": "#/components/schemas/v1ArtifactType" }, "taskType": { "type": "string", "example": "classification", "description": "The task type of the model. It must not exceed 50 characters." }, "tags": { "type": "object", "example": { "author": "Jon" }, "additionalProperties": { "type": "string" }, "description": "Key-value pairs of arbitrary metadata associated with the model. Each key and value must not exceed 100 and 500 characters respectively." }, "metrics": { "type": "object", "example": { "trainingPrecision": 0.78, "trainingRecall": 0.87 }, "additionalProperties": { "type": "number", "format": "double" }, "description": "Key-value pairs of static metrics associated with the model. For dynamic metrics look into metrics https://deploy.seldon.io/en/latest/contents/getting-started/production-installation/metrics.html. Keys must not exceed 100 characters." }, "creationTime": { "type": "string", "format": "date-time", "example": "2017-01-15T01:30:15.01Z", "description": "The creation timestamp for the model metadata entry. It is automatically created by the Metadata service and cannot be modified. The timestamp is using the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format/" }, "predictionSchema": { "$ref": "#/components/schemas/v1PredictionSchema" }, "project": { "type": "string", "example": "project_1", "description": "The project that this model belongs to." }, "runtimeDefaults": { "$ref": "#/components/schemas/v1RuntimeDefaults" } }, "required": [ "URI" ] }, "v1ModelMetadataCreateResponse": { "type": "object" }, "v1ModelMetadataDeleteResponse": { "type": "object" }, "v1ModelMetadataListResponse": { "type": "object", "properties": { "models": { "type": "array", "items": { "$ref": "#/components/schemas/v1Model" } }, "nextPageToken": { "type": "string", "description": "A pagination token returned from a previous call to `List`\nthat indicates from where listing should continue." } } }, "v1ModelMetadataUpdateResponse": { "type": "object" }, "v1PredictionSchema": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/v1FeatureSchema" } }, "responses": { "type": "array", "items": { "$ref": "#/components/schemas/v1FeatureSchema" } } }, "required": [ "requests", "responses" ] }, "v1RuntimeDefaults": { "type": "object", "properties": { "defaultProtocol": { "$ref": "#/components/schemas/v1DefaultProtocol" } } }, "v1RuntimeMetadata": { "type": "object", "properties": { "modelUri": { "type": "string", "example": "gs://seldon-models/sklearn/iris", "description": "The URI for the storage bucket containing the model, or the URI to the docker image for custom models." }, "deploymentName": { "type": "string", "example": "iris", "description": "The name of the Kubernetes deployment that is associated with a model." }, "deploymentNamespace": { "type": "string", "example": "seldon", "description": "The Kubernetes namespace in which this deployment is running in." }, "deploymentKubernetesUid": { "type": "string", "example": "2c60bdb0-8a8e-46bf-a3c5-627ad507f76b", "description": "The Kubernetes UID of the deployment associated with a model. See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids for details" }, "predictorName": { "type": "string", "example": "default", "description": "The name of the predictor inside the deployment that contains the referenced model." }, "nodeName": { "type": "string", "example": "default-node", "description": "The name of the node inside the predictor that contains the referenced model. This is relevant and populated only for SeldonDeployment deployment types." }, "deploymentStatus": { "$ref": "#/components/schemas/v1DeploymentStatus" }, "deploymentType": { "$ref": "#/components/schemas/v1DeploymentType" }, "traffic": { "type": "string", "format": "int64", "description": "The amount of traffic server by this model in the deployment." }, "shadow": { "type": "boolean", "description": "True if this model is a shadow in the deployment." }, "creationTime": { "type": "string", "format": "date-time", "example": "2017-01-15T01:30:15.01Z", "description": "The creation timestamp for the runtime model metadata entry. It is automatically created by the Metadata service and cannot be modified. The timestamp is using the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format/" }, "model": { "$ref": "#/components/schemas/v1Model" }, "explainer": { "type": "boolean", "description": "True if this model is a explainer in the deployment." }, "replicas": { "type": "string", "format": "int64", "description": "The number of replicas for this model." } } }, "v1RuntimeMetadataListResponse": { "type": "object", "properties": { "runtimeMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/v1RuntimeMetadata" } }, "nextPageToken": { "type": "string", "description": "A pagination token returned from a previous call to `List`\nthat indicates from where listing should continue." } } }, "v1AddUserToGroupResponse": { "type": "object" }, "v1CreateGroupRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group to be created." } }, "required": [ "name" ] }, "v1CreateGroupResponse": { "type": "object" }, "v1CreatePolicyResponse": { "type": "object" }, "v1CreateUserRequest": { "type": "object", "properties": { "username": { "type": "string", "description": "The username of the user. It must consist of only letters, numbers, underscores, and dashes, and be at most 30 characters. It can be used for login and be part of policies." }, "email": { "type": "string", "description": "The email of the user. It must be a valid email. The user will receive instructions for setting credentials on this email." }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "required": [ "username", "email" ] }, "v1CreateUserResponse": { "type": "object" }, "v1DeleteGroupResponse": { "type": "object" }, "v1DeletePolicyResponse": { "type": "object" }, "v1DeleteUserFromGroupResponse": { "type": "object" }, "v1DeleteUserResponse": { "type": "object" }, "v1GetGroupMembersResponse": { "type": "object", "properties": { "members": { "type": "array", "items": { "$ref": "#/components/schemas/v1User" } } } }, "v1GetGroupsResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/v1Group" } } } }, "v1GetPermissionsResponse": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/v1ResourceActionPair" } } } }, "v1GetPolicyTargetsResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "string" } } } }, "v1GetUserGroupsResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/v1Group" } } } }, "v1GetUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/v1User" } } } }, "v1Group": { "type": "object", "properties": { "name": { "type": "string" } } }, "v1GroupPolicy": { "type": "object", "properties": { "group": { "type": "string" }, "permission": { "$ref": "#/components/schemas/v1ResourceActionPair" } } }, "v1Policy": { "type": "object", "properties": { "userGrants": { "type": "array", "items": { "$ref": "#/components/schemas/v1UserPolicy" } }, "groupGrants": { "type": "array", "items": { "$ref": "#/components/schemas/v1GroupPolicy" } } } }, "v1ResetUserPasswordResponse": { "type": "object" }, "v1ResourceActionPair": { "type": "object", "properties": { "action": { "type": "string" }, "resource": { "type": "string" } } }, "v1User": { "type": "object", "properties": { "username": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "enabled": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "creationTime": { "type": "string", "format": "date-time" } } }, "v1UserPolicy": { "type": "object", "properties": { "user": { "type": "string" }, "permission": { "$ref": "#/components/schemas/v1ResourceActionPair" } } }, "v1FiringAlert": { "type": "object", "properties": { "name": { "type": "string" }, "severity": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" }, "activeAt": { "type": "string", "format": "date-time" } } }, "v1ListAlertsResponse": { "type": "object", "properties": { "firingAlerts": { "type": "array", "items": { "$ref": "#/components/schemas/v1FiringAlert" } } } }, "v1TriggerTestAlertResponse": { "type": "object" }, "protobufNullValue": { "type": "string", "enum": [ "NULL_VALUE" ], "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value." }, "v1BucketSecretFormat": { "type": "string", "enum": [ "env_var", "config_param" ], "default": "env_var", "description": "Default to env_var for backwards compatibility." }, "v1CreateGCSBucketSecretResponse": { "type": "object" }, "v1CreateRcloneBucketSecretResponse": { "type": "object" }, "v1CreateRegistrySecretResponse": { "type": "object" }, "v1CreateS3BucketSecretResponse": { "type": "object" }, "v1DeleteSecretResponse": { "type": "object" }, "v1ListSecretsResponse": { "type": "object", "properties": { "secrets": { "type": "array", "items": { "$ref": "#/components/schemas/v1Secret" } }, "nextPageToken": { "type": "string", "description": "A pagination token returned from a previous call to `List`\nthat indicates from where listing should continue." } } }, "v1RcloneConfig": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The Rclone key value pairs for your secret; see the Rclone documentation for more detail." }, "remoteType": { "type": "string", "example": "s3", "description": "The Rclone type of the remote; see the Rclone documentation for available types." } } }, "v1S3Credentials": { "type": "object", "properties": { "s3AccessKeyId": { "type": "string", "description": "The S3 access key ID." }, "s3SecretAccessKey": { "type": "string", "description": "The S3 secret access key." } } }, "v1Secret": { "type": "object", "properties": { "secretName": { "type": "string" }, "secretType": { "$ref": "#/components/schemas/v1SecretType" }, "bucketSecretFormat": { "$ref": "#/components/schemas/v1BucketSecretFormat" }, "remoteName": { "type": "string", "description": "The remote name of the secret. Used by the user as a prefix to a model uri and by RClone as a config during download of artefacts. Only available for bucket secrets." } } }, "v1SecretType": { "type": "string", "enum": [ "all", "bucket", "registry" ], "default": "all", "description": "Note: intentionally lower case so that the URL format accepts lowercase." }, "v1SecretVersion": { "type": "string", "enum": [ "CORE_1", "CORE_2" ], "default": "CORE_1" }, "v1DependencyHealthResponse": { "type": "object", "properties": { "dependenciesHealth": { "type": "array", "items": { "$ref": "#/components/schemas/v1DeployDependencyHealth" } } } }, "v1DeployDependency": { "type": "string", "enum": [ "ALL", "PROMETHEUS", "ELASTICSEARCH", "ALERTMANAGER", "POSTGRES", "KEYCLOAK", "KAFKA", "SELDONCORE_V1", "SELDONCORE_V2", "GITEA", "ARGOCD", "ARGOWF", "KNATIVE", "METRONOME", "MINIO", "FLUENTD" ], "default": "ALL" }, "v1DeployDependencyHealth": { "type": "object", "properties": { "dependency": { "$ref": "#/components/schemas/v1DeployDependency" }, "status": { "$ref": "#/components/schemas/v1DeployDependencyStatus" }, "description": { "type": "string" }, "fetchedAt": { "type": "string", "format": "date-time" }, "lastActiveFetchedAt": { "type": "string", "format": "date-time" } } }, "v1DeployDependencyStatus": { "type": "string", "enum": [ "UNSPECIFIED", "DISABLED", "ENABLED_AND_UNREACHABLE", "ENABLED_AND_REACHABLE" ], "default": "UNSPECIFIED" }, "v1GetDeploymentInferenceLogsResponse": { "type": "object", "properties": { "namespace": { "type": "string" }, "deploymentName": { "type": "string" }, "predictorName": { "type": "string" }, "containerName": { "type": "string" }, "payloads": { "type": "array", "items": { "$ref": "#/components/schemas/v1InferenceLogsRawPayload" } }, "nextPageToken": { "type": "string" }, "totalCount": { "type": "integer", "format": "int32" } } }, "v1GetModelInferenceLogsResponse": { "type": "object", "properties": { "namespace": { "type": "string" }, "pipelineName": { "type": "string" }, "modelName": { "type": "string" }, "payloads": { "type": "array", "items": { "$ref": "#/components/schemas/v1InferenceLogsRawPayload" } }, "nextPageToken": { "type": "string" }, "totalCount": { "type": "integer", "format": "int32" } } }, "v1InferenceLogsDeploymentItem": { "type": "object", "properties": { "namespace": { "type": "string" }, "name": { "type": "string" }, "predictor": { "type": "string" }, "container": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" } } }, "v1InferenceLogsModelItem": { "type": "object", "properties": { "namespace": { "type": "string" }, "pipelineName": { "type": "string" }, "modelName": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" } } }, "v1InferenceLogsRawPayload": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "request": {}, "response": {} } }, "v1ListDeploymentInferenceLogsResponse": { "type": "object", "properties": { "inferenceLogs": { "type": "array", "items": { "$ref": "#/components/schemas/v1InferenceLogsDeploymentItem" } } } }, "v1ListModelInferenceLogsResponse": { "type": "object", "properties": { "inferenceLogs": { "type": "array", "items": { "$ref": "#/components/schemas/v1InferenceLogsModelItem" } } } } } } }