{ "schemes": [ "http", "https" ], "swagger": "2.0", "info": { "description": "This API provides endpoints to manage notebooks in a Kubernetes cluster.\nFor more information, visit https://www.kubeflow.org/docs/components/notebooks/", "title": "Kubeflow Notebooks API", "contact": {}, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "host": "localhost:4000", "basePath": "/api/v1", "paths": { "/healthcheck": { "get": { "description": "Provides a healthcheck response indicating the status of key services.", "produces": [ "application/json" ], "tags": [ "healthcheck" ], "summary": "Returns the health status of the application", "operationId": "getHealthcheck", "responses": { "200": { "description": "Successful healthcheck response", "schema": { "$ref": "#/definitions/health_check.HealthCheck" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/namespaces": { "get": { "description": "Returns a list of all namespaces in the cluster.", "produces": [ "application/json" ], "tags": [ "namespaces" ], "summary": "List namespaces", "operationId": "listNamespaces", "responses": { "200": { "description": "Successful namespaces response", "schema": { "$ref": "#/definitions/api.NamespaceListEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/persistentvolumeclaims/{namespace}": { "get": { "description": "Returns a list of persistent volume claims in a specific namespace.", "produces": [ "application/json" ], "tags": [ "persistentvolumeclaims" ], "summary": "List persistent volume claims by namespace", "operationId": "listPVCs", "parameters": [ { "type": "string", "x-example": "my-namespace", "description": "Namespace name", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "Successful PVCs response", "schema": { "$ref": "#/definitions/api.PVCListEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "post": { "description": "Creates a new persistent volume claim in the specified namespace.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "persistentvolumeclaims" ], "summary": "Create persistent volume claim", "operationId": "createPVC", "parameters": [ { "type": "string", "description": "Namespace name", "name": "namespace", "in": "path", "required": true }, { "description": "PVC creation request", "name": "pvc", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.PVCCreateEnvelope" } } ], "responses": { "201": { "description": "PVC created successfully", "schema": { "$ref": "#/definitions/api.PVCCreateEnvelope" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "PVC already exists", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/persistentvolumeclaims/{namespace}/{name}": { "delete": { "description": "Deletes a specific persistent volume claim identified by namespace and name.", "tags": [ "persistentvolumeclaims" ], "summary": "Deletes a persistent volume claim", "operationId": "deletePVC", "parameters": [ { "type": "string", "x-example": "my-namespace", "description": "Namespace name", "name": "namespace", "in": "path", "required": true }, { "type": "string", "x-example": "my-pvc", "description": "PVC name", "name": "name", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "PVC not found", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/secrets/{namespace}": { "get": { "description": "Returns a list of secrets in a specific namespace.", "produces": [ "application/json" ], "tags": [ "secrets" ], "summary": "List secrets by namespace", "operationId": "listSecrets", "parameters": [ { "type": "string", "x-example": "my-namespace", "description": "Namespace name", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "Successful secrets response", "schema": { "$ref": "#/definitions/api.SecretListEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "post": { "description": "Creates a new secret in the specified namespace.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "secrets" ], "summary": "Create secret", "operationId": "createSecret", "parameters": [ { "type": "string", "description": "Namespace name", "name": "namespace", "in": "path", "required": true }, { "description": "Secret creation request", "name": "secret", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.SecretCreateEnvelope" } } ], "responses": { "201": { "description": "Secret created successfully", "schema": { "$ref": "#/definitions/api.SecretCreateEnvelope" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Secret already exists", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/secrets/{namespace}/{name}": { "get": { "description": "Returns the current state of a specific secret identified by namespace and name. This endpoint is intended for retrieving the secret state before updating it.", "produces": [ "application/json" ], "tags": [ "secrets" ], "summary": "Get secret", "operationId": "getSecret", "parameters": [ { "type": "string", "description": "Namespace name", "name": "namespace", "in": "path", "required": true }, { "type": "string", "x-example": "my-secret", "description": "Secret name", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "Successful secret response", "schema": { "$ref": "#/definitions/api.SecretEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Secret not found", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "put": { "description": "Updates an existing secret.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "secrets" ], "summary": "Update secret", "operationId": "updateSecret", "parameters": [ { "type": "string", "description": "Namespace name", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "Secret name", "name": "name", "in": "path", "required": true }, { "description": "Secret update request", "name": "secret", "in": "body", "required": true, "schema": { "$ref": "#/definitions/secrets.SecretUpdate" } } ], "responses": { "200": { "description": "Secret updated successfully", "schema": { "$ref": "#/definitions/api.SecretEnvelope" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Secret not found", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "delete": { "description": "Deletes a specific secret identified by namespace and name.", "consumes": [ "application/json" ], "tags": [ "secrets" ], "summary": "Delete secret", "operationId": "deleteSecret", "parameters": [ { "type": "string", "x-example": "my-namespace", "description": "Namespace name", "name": "namespace", "in": "path", "required": true }, { "type": "string", "x-example": "my-secret", "description": "Secret name", "name": "name", "in": "path", "required": true } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Secret not found", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/storageclasses": { "get": { "description": "Returns a list of all storage classes in the cluster. When namespace is provided, authorization checks whether the user can create PersistentVolumeClaims in that namespace instead of requiring a cluster-wide permission to list storage classes.", "produces": [ "application/json" ], "tags": [ "storageclasses" ], "summary": "List storage classes", "operationId": "listStorageClasses", "parameters": [ { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace to request storage classes for.", "name": "namespace", "in": "query" } ], "responses": { "200": { "description": "Successful storage classes response", "schema": { "$ref": "#/definitions/api.StorageClassListEnvelope" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/user": { "get": { "description": "Returns the current user's settings including user ID and admin status", "produces": [ "application/json" ], "tags": [ "user" ], "summary": "Get user settings", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.UserEnvelope" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspacekinds": { "get": { "description": "Returns a list of all workspace kinds in the cluster. When namespaceFilter is provided, authorization checks whether the user can create workspaces in that namespace instead of requiring workspace kind list permission.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspacekinds" ], "summary": "List workspace kinds", "operationId": "listWorkspaceKinds", "parameters": [ { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace to filter workspace kinds", "name": "namespaceFilter", "in": "query" } ], "responses": { "200": { "description": "Successful operation. Returns a list of all available workspace kinds.", "schema": { "$ref": "#/definitions/api.WorkspaceKindListEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to list workspace kinds.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "post": { "description": "Creates a new workspace kind.", "consumes": [ "application/yaml" ], "produces": [ "application/json" ], "tags": [ "workspacekinds" ], "summary": "Create workspace kind", "operationId": "createWorkspaceKind", "parameters": [ { "description": "Kubernetes YAML manifest of a WorkspaceKind", "name": "body", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "WorkspaceKind created successfully", "schema": { "$ref": "#/definitions/api.WorkspaceKindCreateEnvelope" } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to create WorkspaceKind.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict. WorkspaceKind with the same name already exists.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspacekinds/{name}": { "get": { "description": "Returns details of a specific workspace kind identified by its name.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspacekinds" ], "summary": "Get workspace kind", "operationId": "getWorkspaceKind", "parameters": [ { "type": "string", "x-example": "jupyterlab", "description": "Name of the workspace kind", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "Successful operation. Returns the requested workspace kind details with new revision.", "schema": { "$ref": "#/definitions/api.WorkspaceKindEnvelope" } }, "400": { "description": "Bad Request. Invalid workspace kind name format.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to access the workspace kind.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Workspace kind does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "put": { "description": "Updates an existing workspace kind.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspacekinds" ], "summary": "Update workspace kind", "operationId": "updateWorkspaceKind", "parameters": [ { "type": "string", "x-example": "jupyterlab", "description": "Name of the workspace kind", "name": "name", "in": "path", "required": true }, { "description": "WorkspaceKind update configuration", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.WorkspaceKindEnvelope" } } ], "responses": { "200": { "description": "WorkspaceKind updated successfully", "schema": { "$ref": "#/definitions/api.WorkspaceKindEnvelope" } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to update workspace kind.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. WorkspaceKind does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict. Current workspace kind revision is newer than provided.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "delete": { "description": "Deletes a specific workspace kind identified by its name.", "consumes": [ "application/json" ], "tags": [ "workspacekinds" ], "summary": "Delete workspace kind", "operationId": "deleteWorkspaceKind", "parameters": [ { "type": "string", "x-example": "jupyterlab", "description": "Name of the workspace kind", "name": "name", "in": "path", "required": true } ], "responses": { "204": { "description": "Workspace kind deleted successfully" }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to delete the workspace kind.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Workspace kind does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict. Workspace kind is in use by one or more workspaces.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspacekinds/{name}/assets/icon": { "get": { "description": "Returns the icon image for a specific workspace kind. If the icon is stored in a ConfigMap, it serves the image content. If the icon is a remote URL, returns 404 (browser should fetch directly).", "consumes": [ "application/json" ], "produces": [ "application/json", "image/svg+xml" ], "tags": [ "workspacekinds" ], "summary": "Get workspace kind icon", "operationId": "getWorkspaceKindIcon", "parameters": [ { "type": "string", "description": "Name of the workspace kind", "name": "name", "in": "path", "required": true }, { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace to request asset for.", "name": "namespace", "in": "query" } ], "responses": { "200": { "description": "The image file content.", "schema": { "type": "file" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to get asset.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Icon uses remote URL or resource does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspacekinds/{name}/assets/logo": { "get": { "description": "Returns the logo image for a specific workspace kind. If the logo is stored in a ConfigMap, it serves the image content. If the logo is a remote URL, returns 404 (browser should fetch directly).", "consumes": [ "application/json" ], "produces": [ "application/json", "image/svg+xml" ], "tags": [ "workspacekinds" ], "summary": "Get workspace kind logo", "operationId": "getWorkspaceKindLogo", "parameters": [ { "type": "string", "description": "Name of the workspace kind", "name": "name", "in": "path", "required": true }, { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace to request asset for.", "name": "namespace", "in": "query" } ], "responses": { "200": { "description": "The image file content.", "schema": { "type": "file" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to get asset.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Logo uses remote URL or resource does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspacekinds/{name}/podtemplate/options/listvalues": { "post": { "description": "Returns filtered imageConfig and podConfig options based on the provided context.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspacekinds" ], "summary": "List options values for a pod template workspace kind", "operationId": "podTemplateOptionsListValues", "parameters": [ { "type": "string", "x-example": "jupyterlab", "description": "Name of the workspace kind", "name": "name", "in": "path", "required": true }, { "description": "Request body with optional context filters", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.PodTemplateOptionsListValuesRequestEnvelope" } } ], "responses": { "200": { "description": "Successful operation. Returns filtered options with ruleEffects.", "schema": { "$ref": "#/definitions/api.PodTemplateOptionsEnvelope" } }, "400": { "description": "Bad Request. Invalid workspace kind name or request body.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to access the workspace kind.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Workspace kind does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspaces": { "get": { "description": "Returns a list of all workspaces in the cluster.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspaces" ], "summary": "List all workspaces", "operationId": "listAllWorkspaces", "responses": { "200": { "description": "Successful operation. Returns a list of all workspaces.", "schema": { "$ref": "#/definitions/api.WorkspaceListEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to list workspaces.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspaces/{namespace}": { "get": { "description": "Returns a list of workspaces in a specific namespace.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspaces" ], "summary": "List workspaces by namespace", "operationId": "listWorkspacesByNamespace", "parameters": [ { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace to filter workspaces", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "Successful operation. Returns a list of workspaces in the specified namespace.", "schema": { "$ref": "#/definitions/api.WorkspaceListEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to list workspaces.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "post": { "description": "Creates a new workspace in the specified namespace.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspaces" ], "summary": "Create workspace", "operationId": "createWorkspace", "parameters": [ { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace for the workspace", "name": "namespace", "in": "path", "required": true }, { "description": "Workspace creation configuration", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.WorkspaceCreateEnvelope" } } ], "responses": { "201": { "description": "Workspace created successfully", "schema": { "$ref": "#/definitions/api.WorkspaceCreateEnvelope" } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to create workspace.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict. Workspace with the same name already exists.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspaces/{namespace}/{name}": { "get": { "description": "Returns the current state of a specific workspace identified by namespace and workspace name, including the revision for optimistic locking. This endpoint is intended for retrieving the workspace state before updating it.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspaces" ], "summary": "Get workspace", "operationId": "getWorkspace", "parameters": [ { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace of the workspace", "name": "namespace", "in": "path", "required": true }, { "type": "string", "x-example": "my-workspace", "description": "Name of the workspace", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "Successful operation. Returns the requested workspace details with new revision.", "schema": { "$ref": "#/definitions/api.WorkspaceEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to access the workspace.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Workspace does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "put": { "description": "Updates an existing workspace.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspaces" ], "summary": "Update workspace", "operationId": "updateWorkspace", "parameters": [ { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace of the workspace", "name": "namespace", "in": "path", "required": true }, { "type": "string", "x-example": "my-workspace", "description": "Name of the workspace", "name": "name", "in": "path", "required": true }, { "description": "Workspace update configuration", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.WorkspaceEnvelope" } } ], "responses": { "200": { "description": "Workspace updated successfully", "schema": { "$ref": "#/definitions/api.WorkspaceEnvelope" } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to update workspace.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict. Current workspace revision is newer than provided.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } }, "delete": { "description": "Deletes a specific workspace identified by namespace and name.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspaces" ], "summary": "Delete workspace", "operationId": "deleteWorkspace", "parameters": [ { "type": "string", "x-example": "kubeflow-user-example-com", "description": "Namespace of the workspace", "name": "namespace", "in": "path", "required": true }, { "type": "string", "x-example": "my-workspace", "description": "Name of the workspace", "name": "name", "in": "path", "required": true } ], "responses": { "204": { "description": "Workspace deleted successfully" }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to delete the workspace.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Workspace does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } }, "/workspaces/{namespace}/{name}/actions/pause": { "post": { "description": "Pauses or unpauses a workspace, stopping or resuming all associated pods.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "workspaces" ], "summary": "Pause or unpause a workspace", "operationId": "updateWorkspacePauseState", "parameters": [ { "type": "string", "x-example": "default", "description": "Namespace of the workspace", "name": "namespace", "in": "path", "required": true }, { "type": "string", "x-example": "my-workspace", "description": "Name of the workspace", "name": "name", "in": "path", "required": true }, { "description": "Intended pause state of the workspace", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.WorkspaceActionPauseEnvelope" } } ], "responses": { "200": { "description": "Successful action. Returns the current pause state.", "schema": { "$ref": "#/definitions/api.WorkspaceActionPauseEnvelope" } }, "400": { "description": "Bad Request.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "401": { "description": "Unauthorized. Authentication is required.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "403": { "description": "Forbidden. User does not have permission to access the workspace.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "404": { "description": "Not Found. Workspace does not exist.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "409": { "description": "Conflict. Workspace not in valid state for action.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "413": { "description": "Request Entity Too Large. The request body is too large.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "415": { "description": "Unsupported Media Type. Content-Type header is not correct.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "422": { "description": "Unprocessable Entity. Validation error.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } }, "500": { "description": "Internal server error. An unexpected error occurred on the server.", "schema": { "$ref": "#/definitions/api.ErrorEnvelope" } } } } } }, "definitions": { "actions.WorkspaceActionPause": { "type": "object", "required": [ "paused" ], "properties": { "paused": { "type": "boolean" } } }, "api.ConflictError": { "type": "object", "properties": { "message": { "description": "A human-readable description of the cause of the error.\nThis field may be presented as-is to a reader.", "type": "string" }, "origin": { "description": "Origin indicates where the conflict error originated.\nIf value is empty, the origin is unknown.", "allOf": [ { "$ref": "#/definitions/api.ErrorCauseOrigin" } ] } } }, "api.ErrorCause": { "type": "object", "properties": { "conflict_cause": { "description": "ConflictCauses contains details about conflict errors that caused the request to fail.", "type": "array", "items": { "$ref": "#/definitions/api.ConflictError" } }, "validation_errors": { "description": "ValidationErrors contains details about validation errors that caused the request to fail.", "type": "array", "items": { "$ref": "#/definitions/api.ValidationError" } } } }, "api.ErrorCauseOrigin": { "type": "string", "enum": [ "INTERNAL", "KUBERNETES" ], "x-enum-varnames": [ "OriginInternal", "OriginKubernetes" ] }, "api.ErrorEnvelope": { "type": "object", "required": [ "error" ], "properties": { "error": { "$ref": "#/definitions/api.HTTPError" } } }, "api.HTTPError": { "type": "object", "required": [ "code", "message" ], "properties": { "cause": { "description": "Cause contains detailed information about the cause of the error.", "allOf": [ { "$ref": "#/definitions/api.ErrorCause" } ] }, "code": { "description": "Code is a string representation of the HTTP status code.", "type": "string" }, "message": { "description": "Message is a human-readable description of the error.", "type": "string" } } }, "api.NamespaceListEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/namespaces.Namespace" } } } }, "api.PVCCreateEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/pvcs.PVCCreate" } } }, "api.PVCListEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/pvcs.PVCListItem" } } } }, "api.PodTemplateOptionsEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/options.PodTemplateOptions" } } }, "api.PodTemplateOptionsListValuesRequestEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/options.ListValuesRequest" } } }, "api.SecretCreateEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/secrets.SecretCreate" } } }, "api.SecretEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/secrets.SecretUpdate" } } }, "api.SecretListEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/secrets.SecretListItem" } } } }, "api.StorageClassListEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/storageclasses.StorageClassListItem" } } } }, "api.UserEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/api.UserResponse" } } }, "api.UserResponse": { "type": "object", "required": [ "clusterAdmin", "userId" ], "properties": { "clusterAdmin": { "type": "boolean" }, "userId": { "type": "string" } } }, "api.ValidationError": { "type": "object", "properties": { "field": { "description": "The field of the resource that has caused this error, as named by its JSON serialization.\nMay include dot and postfix notation for nested attributes.\nArrays are zero-indexed.\nFields may appear more than once in an array of causes due to fields having multiple errors.\n\nExamples:\n \"name\" - the field \"name\" on the current resource\n \"items[0].name\" - the field \"name\" on the first array entry in \"items\"", "type": "string" }, "message": { "description": "A human-readable description of the cause of the error.\nThis field may be presented as-is to a reader.", "type": "string" }, "origin": { "description": "Origin indicates where the validation error originated.\nIf value is empty, the origin is unknown.", "allOf": [ { "$ref": "#/definitions/api.ErrorCauseOrigin" } ] }, "type": { "description": "A machine-readable description of the cause of the error.\nIf value is empty, there is no information available.", "allOf": [ { "$ref": "#/definitions/field.ErrorType" } ] } } }, "api.WorkspaceActionPauseEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/actions.WorkspaceActionPause" } } }, "api.WorkspaceCreateEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/workspaces.WorkspaceCreate" } } }, "api.WorkspaceEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/workspaces.WorkspaceUpdate" } } }, "api.WorkspaceKindCreateEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/workspacekinds.WorkspaceKindCreate" } } }, "api.WorkspaceKindEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/definitions/workspacekinds.WorkspaceKindUpdate" } } }, "api.WorkspaceKindListEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/workspacekinds.WorkspaceKindListItem" } } } }, "api.WorkspaceListEnvelope": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/workspaces.WorkspaceListItem" } } } }, "assets.ImageRef": { "type": "object", "required": [ "url" ], "properties": { "error": { "$ref": "#/definitions/assets.ImageRefErrorCode" }, "url": { "type": "string" } } }, "assets.ImageRefErrorCode": { "type": "string", "enum": [ "CONFIGMAP_MISSING", "CONFIGMAP_KEY_MISSING", "CONFIGMAP_OTHER", "CONFIGMAP_UNKNOWN" ], "x-enum-varnames": [ "ImageRefErrorCodeConfigMapMissing", "ImageRefErrorCodeConfigMapKeyMissing", "ImageRefErrorCodeConfigMapOther", "ImageRefErrorCodeConfigMapUnknown" ] }, "common.Audit": { "type": "object", "required": [ "createdAt", "createdBy", "deletedAt", "updatedAt", "updatedBy" ], "properties": { "createdAt": { "type": "string" }, "createdBy": { "type": "string" }, "deletedAt": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "type": "string" } } }, "field.ErrorType": { "type": "string", "enum": [ "FieldValueNotFound", "FieldValueRequired", "FieldValueDuplicate", "FieldValueInvalid", "FieldValueNotSupported", "FieldValueForbidden", "FieldValueTooLong", "FieldValueTooMany", "InternalError", "FieldValueTypeInvalid" ], "x-enum-varnames": [ "ErrorTypeNotFound", "ErrorTypeRequired", "ErrorTypeDuplicate", "ErrorTypeInvalid", "ErrorTypeNotSupported", "ErrorTypeForbidden", "ErrorTypeTooLong", "ErrorTypeTooMany", "ErrorTypeInternal", "ErrorTypeTypeInvalid" ] }, "health_check.HealthCheck": { "type": "object", "required": [ "status", "systemInfo" ], "properties": { "status": { "$ref": "#/definitions/health_check.ServiceStatus" }, "systemInfo": { "$ref": "#/definitions/health_check.SystemInfo" } } }, "health_check.ServiceStatus": { "type": "string", "enum": [ "Healthy", "Unhealthy" ], "x-enum-varnames": [ "ServiceStatusHealthy", "ServiceStatusUnhealthy" ] }, "health_check.SystemInfo": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "string" } } }, "intstr.IntOrString": { "type": "object", "required": [ "intVal", "strVal", "type" ], "properties": { "intVal": { "type": "integer" }, "strVal": { "type": "string" }, "type": { "$ref": "#/definitions/intstr.Type" } } }, "intstr.Type": { "type": "integer", "format": "int64", "enum": [ 0, 1 ], "x-enum-comments": { "Int": "The IntOrString holds an int.", "String": "The IntOrString holds a string." }, "x-enum-descriptions": [ "The IntOrString holds an int.", "The IntOrString holds a string." ], "x-enum-varnames": [ "Int", "String" ] }, "k8s_io_api_core_v1.ResourceClaim": { "type": "object", "required": [ "name" ], "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" }, "request": { "description": "Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request.\n\n+optional", "type": "string" } } }, "namespaces.Namespace": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "options.ClusterOptionMetrics": { "type": "object", "required": [ "workspacesCount" ], "properties": { "workspacesCount": { "type": "integer" } } }, "options.ContextImageConfig": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "options.ContextNamespace": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "options.ContextPodConfig": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "options.ImageConfig": { "type": "object", "required": [ "default" ], "properties": { "default": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/definitions/options.ImageConfigValue" } } } }, "options.ImageConfigValue": { "type": "object", "required": [ "description", "displayName", "hidden", "id" ], "properties": { "clusterMetrics": { "$ref": "#/definitions/options.ClusterOptionMetrics" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "hidden": { "type": "boolean" }, "id": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/definitions/options.OptionLabel" } }, "redirect": { "$ref": "#/definitions/options.OptionRedirect" } } }, "options.ListValuesContext": { "type": "object", "properties": { "imageConfig": { "$ref": "#/definitions/options.ContextImageConfig" }, "namespace": { "$ref": "#/definitions/options.ContextNamespace" }, "podConfig": { "$ref": "#/definitions/options.ContextPodConfig" } } }, "options.ListValuesRequest": { "type": "object", "required": [ "context" ], "properties": { "context": { "$ref": "#/definitions/options.ListValuesContext" } } }, "options.OptionLabel": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "options.OptionRedirect": { "type": "object", "required": [ "to" ], "properties": { "message": { "$ref": "#/definitions/options.RedirectMessage" }, "to": { "type": "string" } } }, "options.PodConfig": { "type": "object", "required": [ "default" ], "properties": { "default": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/definitions/options.PodConfigValue" } } } }, "options.PodConfigValue": { "type": "object", "required": [ "description", "displayName", "hidden", "id" ], "properties": { "clusterMetrics": { "$ref": "#/definitions/options.ClusterOptionMetrics" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "hidden": { "type": "boolean" }, "id": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/definitions/options.OptionLabel" } }, "redirect": { "$ref": "#/definitions/options.OptionRedirect" } } }, "options.PodTemplateOptions": { "type": "object", "required": [ "imageConfig", "podConfig" ], "properties": { "imageConfig": { "$ref": "#/definitions/options.ImageConfig" }, "podConfig": { "$ref": "#/definitions/options.PodConfig" } } }, "options.RedirectMessage": { "type": "object", "required": [ "level", "text" ], "properties": { "level": { "$ref": "#/definitions/options.RedirectMessageLevel" }, "text": { "type": "string" } } }, "options.RedirectMessageLevel": { "type": "string", "enum": [ "Info", "Warning", "Danger" ], "x-enum-varnames": [ "RedirectMessageLevelInfo", "RedirectMessageLevelWarning", "RedirectMessageLevelDanger" ] }, "pvcs.PVCCreate": { "type": "object", "required": [ "accessModes", "name", "requests", "storageClassName" ], "properties": { "accessModes": { "type": "array", "items": { "$ref": "#/definitions/v1.PersistentVolumeAccessMode" } }, "name": { "type": "string" }, "requests": { "$ref": "#/definitions/pvcs.StorageRequestsMutate" }, "storageClassName": { "type": "string" } } }, "pvcs.PVCListItem": { "type": "object", "required": [ "audit", "canMount", "canUpdate", "name", "pods", "pvcSpec", "workspaces" ], "properties": { "audit": { "$ref": "#/definitions/common.Audit" }, "canMount": { "type": "boolean" }, "canUpdate": { "type": "boolean" }, "name": { "type": "string" }, "pods": { "type": "array", "items": { "$ref": "#/definitions/pvcs.PodInfo" } }, "pv": { "description": "This field is nil until a PV is bound to the PVC.\nhttps://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding", "allOf": [ { "$ref": "#/definitions/pvcs.PVInfo" } ] }, "pvcSpec": { "$ref": "#/definitions/pvcs.PVCSpec" }, "workspaces": { "type": "array", "items": { "$ref": "#/definitions/pvcs.WorkspaceInfo" } } } }, "pvcs.PVCSpec": { "type": "object", "required": [ "accessModes", "requests", "storageClassName", "volumeMode" ], "properties": { "accessModes": { "type": "array", "items": { "$ref": "#/definitions/v1.PersistentVolumeAccessMode" } }, "requests": { "$ref": "#/definitions/pvcs.StorageRequests" }, "storageClassName": { "description": "This field may be an empty string in two cases:\n1. The PVC is requesting the default storage class, and it has not been bound to a PV yet.\n2. The PVC is explicitly requesting a PV with no storage class (i.e. manual or out-of-band binding).", "type": "string" }, "volumeMode": { "$ref": "#/definitions/v1.PersistentVolumeMode" } } }, "pvcs.PVInfo": { "type": "object", "required": [ "accessModes", "name", "persistentVolumeReclaimPolicy", "volumeMode" ], "properties": { "accessModes": { "type": "array", "items": { "$ref": "#/definitions/v1.PersistentVolumeAccessMode" } }, "name": { "type": "string" }, "persistentVolumeReclaimPolicy": { "$ref": "#/definitions/v1.PersistentVolumeReclaimPolicy" }, "storageClass": { "description": "This field should only be nil if the bound PV does not have a storage class (i.e. manual or out-of-band binding).", "allOf": [ { "$ref": "#/definitions/pvcs.StorageClassInfo" } ] }, "volumeMode": { "$ref": "#/definitions/v1.PersistentVolumeMode" } } }, "pvcs.PodInfo": { "type": "object", "required": [ "name", "phase" ], "properties": { "name": { "type": "string" }, "node": { "$ref": "#/definitions/pvcs.PodNode" }, "phase": { "$ref": "#/definitions/v1.PodPhase" } } }, "pvcs.PodNode": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "pvcs.PodTemplatePod": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "node": { "$ref": "#/definitions/pvcs.PodNode" } } }, "pvcs.StorageClassInfo": { "type": "object", "required": [ "description", "displayName", "name" ], "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" } } }, "pvcs.StorageRequests": { "type": "object", "required": [ "storage" ], "properties": { "storage": { "type": "string" } } }, "pvcs.StorageRequestsMutate": { "type": "object", "required": [ "storage" ], "properties": { "storage": { "type": "string" } } }, "pvcs.WorkspaceInfo": { "type": "object", "required": [ "name", "state", "stateMessage" ], "properties": { "name": { "type": "string" }, "podTemplatePod": { "$ref": "#/definitions/pvcs.PodTemplatePod" }, "state": { "$ref": "#/definitions/v1beta1.WorkspaceState" }, "stateMessage": { "type": "string" } } }, "resource.Quantity": { "type": "object", "properties": { "Format": { "type": "string", "enum": [ "DecimalExponent", "BinarySI", "DecimalSI" ], "x-enum-comments": { "BinarySI": "e.g., 12Mi (12 * 2^20)", "DecimalExponent": "e.g., 12e6", "DecimalSI": "e.g., 12M (12 * 10^6)" }, "x-enum-descriptions": [ "e.g., 12e6", "e.g., 12Mi (12 * 2^20)", "e.g., 12M (12 * 10^6)" ], "x-enum-varnames": [ "DecimalExponent", "BinarySI", "DecimalSI" ] } } }, "secrets.SecretCreate": { "type": "object", "required": [ "contents", "immutable", "name", "type" ], "properties": { "contents": { "$ref": "#/definitions/secrets.SecretData" }, "immutable": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "secrets.SecretData": { "type": "object", "additionalProperties": { "$ref": "#/definitions/secrets.SecretValue" } }, "secrets.SecretListItem": { "type": "object", "required": [ "audit", "canMount", "canUpdate", "immutable", "name", "type" ], "properties": { "audit": { "$ref": "#/definitions/common.Audit" }, "canMount": { "type": "boolean" }, "canUpdate": { "type": "boolean" }, "immutable": { "type": "boolean" }, "mounts": { "type": "array", "items": { "$ref": "#/definitions/secrets.SecretMount" } }, "name": { "type": "string" }, "type": { "type": "string" } } }, "secrets.SecretMount": { "type": "object", "required": [ "group", "kind", "name" ], "properties": { "group": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" } } }, "secrets.SecretUpdate": { "type": "object", "required": [ "contents", "immutable", "type" ], "properties": { "contents": { "$ref": "#/definitions/secrets.SecretData" }, "immutable": { "type": "boolean" }, "type": { "type": "string" } } }, "secrets.SecretValue": { "type": "object", "properties": { "base64": { "type": "string" } } }, "storageclasses.StorageClassListItem": { "type": "object", "required": [ "canUse", "description", "displayName", "name" ], "properties": { "canUse": { "type": "boolean" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" } } }, "v1.AWSElasticBlockStoreVolumeSource": { "type": "object", "required": [ "volumeID" ], "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", "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" } } }, "v1.Affinity": { "type": "object", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.NodeAffinity" } ] }, "podAffinity": { "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).\n+optional", "allOf": [ { "$ref": "#/definitions/v1.PodAffinity" } ] }, "podAntiAffinity": { "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).\n+optional", "allOf": [ { "$ref": "#/definitions/v1.PodAntiAffinity" } ] } } }, "v1.AppArmorProfile": { "type": "object", "required": [ "type" ], "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\".\n+optional", "type": "string" }, "type": { "description": "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.\n+unionDiscriminator", "allOf": [ { "$ref": "#/definitions/v1.AppArmorProfileType" } ] } } }, "v1.AppArmorProfileType": { "type": "string", "enum": [ "Unconfined", "RuntimeDefault", "Localhost" ], "x-enum-varnames": [ "AppArmorProfileTypeUnconfined", "AppArmorProfileTypeRuntimeDefault", "AppArmorProfileTypeLocalhost" ] }, "v1.AzureDataDiskCachingMode": { "type": "string", "enum": [ "None", "ReadOnly", "ReadWrite" ], "x-enum-varnames": [ "AzureDataDiskCachingNone", "AzureDataDiskCachingReadOnly", "AzureDataDiskCachingReadWrite" ] }, "v1.AzureDataDiskKind": { "type": "string", "enum": [ "Shared", "Dedicated", "Managed" ], "x-enum-varnames": [ "AzureSharedBlobDisk", "AzureDedicatedBlobDisk", "AzureManagedDisk" ] }, "v1.AzureDiskVolumeSource": { "type": "object", "required": [ "diskName", "diskURI" ], "properties": { "cachingMode": { "description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.\n+optional\n+default=ref(AzureDataDiskCachingReadWrite)", "allOf": [ { "$ref": "#/definitions/v1.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\n+default=\"ext4\"", "type": "string" }, "kind": { "description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared\n+default=ref(AzureSharedBlobDisk)", "allOf": [ { "$ref": "#/definitions/v1.AzureDataDiskKind" } ] }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional\n+default=false", "type": "boolean" } } }, "v1.AzureFileVolumeSource": { "type": "object", "required": [ "secretName", "shareName" ], "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" } } }, "v1.CSIVolumeSource": { "type": "object", "required": [ "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": { "description": "nodePublishSecretRef is a reference to the secret object containing\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.LocalObjectReference" } ] }, "readOnly": { "description": "readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional", "type": "boolean" }, "volumeAttributes": { "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", "additionalProperties": { "type": "string" } } } }, "v1.Capabilities": { "type": "object", "properties": { "add": { "description": "Added capabilities\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "drop": { "description": "Removed capabilities\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "v1.CephFSVolumeSource": { "type": "object", "required": [ "monitors" ], "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\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "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": { "description": "secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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" } } }, "v1.CinderVolumeSource": { "type": "object", "required": [ "volumeID" ], "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": { "description": "secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.LocalObjectReference" } ] }, "volumeID": { "description": "volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" } } }, "v1.ClusterTrustBundleProjection": { "type": "object", "required": [ "path" ], "properties": { "labelSelector": { "description": "Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\".\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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" } } }, "v1.ConfigMapKeySelector": { "type": "object", "required": [ "key" ], "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined\n+optional", "type": "boolean" } } }, "v1.ConfigMapProjection": { "type": "object", "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } } }, "v1.ConfigMapVolumeSource": { "type": "object", "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", "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } } }, "v1.DownwardAPIProjection": { "type": "object", "properties": { "items": { "description": "Items is a list of DownwardAPIVolume file\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.DownwardAPIVolumeFile" } } } }, "v1.DownwardAPIVolumeFile": { "type": "object", "required": [ "path" ], "properties": { "fieldRef": { "description": "Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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", "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": { "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ResourceFieldSelector" } ] } } }, "v1.DownwardAPIVolumeSource": { "type": "object", "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", "type": "integer" }, "items": { "description": "Items is a list of downward API volume file\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.DownwardAPIVolumeFile" } } } }, "v1.EmptyDirVolumeSource": { "type": "object", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "allOf": [ { "$ref": "#/definitions/v1.StorageMedium" } ] }, "sizeLimit": { "description": "sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "allOf": [ { "$ref": "#/definitions/resource.Quantity" } ] } } }, "v1.EnvVar": { "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Name of the environment variable.\nMay consist of any printable ASCII characters except '='.", "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": { "description": "Source for the environment variable's value. Cannot be used if value is not empty.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.EnvVarSource" } ] } } }, "v1.EnvVarSource": { "type": "object", "properties": { "configMapKeyRef": { "description": "Selects a key of a ConfigMap.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ConfigMapKeySelector" } ] }, "fieldRef": { "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ObjectFieldSelector" } ] }, "fileKeyRef": { "description": "FileKeyRef selects a key of the env file.\nRequires the EnvFiles feature gate to be enabled.\n\n+featureGate=EnvFiles\n+optional", "allOf": [ { "$ref": "#/definitions/v1.FileKeySelector" } ] }, "resourceFieldRef": { "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ResourceFieldSelector" } ] }, "secretKeyRef": { "description": "Selects a key of a secret in the pod's namespace\n+optional", "allOf": [ { "$ref": "#/definitions/v1.SecretKeySelector" } ] } } }, "v1.EphemeralVolumeSource": { "type": "object", "properties": { "volumeClaimTemplate": { "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `\u003cpod name\u003e-\u003cvolume name\u003e` where\n`\u003cvolume name\u003e` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", "allOf": [ { "$ref": "#/definitions/v1.PersistentVolumeClaimTemplate" } ] } } }, "v1.ExecAction": { "type": "object", "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\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "v1.FCVolumeSource": { "type": "object", "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", "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\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "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\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "v1.FieldsV1": { "type": "object" }, "v1.FileKeySelector": { "type": "object", "required": [ "key", "path", "volumeName" ], "properties": { "key": { "description": "The key within the env file. An invalid key will prevent the pod from starting.\nThe keys defined within a source may consist of any printable ASCII characters except '='.\nDuring Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.\n+required", "type": "string" }, "optional": { "description": "Specify whether the file or its key must be defined. If the file or key\ndoes not exist, then the env var is not published.\nIf optional is set to true and the specified key does not exist,\nthe environment variable will not be set in the Pod's containers.\n\nIf optional is set to false and the specified key does not exist,\nan error will be returned during Pod creation.\n+optional\n+default=false", "type": "boolean" }, "path": { "description": "The path within the volume from which to select the file.\nMust be relative and may not contain the '..' path or start with '..'.\n+required", "type": "string" }, "volumeName": { "description": "The name of the volume mount containing the env file.\n+required", "type": "string" } } }, "v1.FlexVolumeSource": { "type": "object", "required": [ "driver" ], "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": { "description": "options is Optional: this field holds extra command options if any.\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "readOnly": { "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.LocalObjectReference" } ] } } }, "v1.FlockerVolumeSource": { "type": "object", "properties": { "datasetName": { "description": "datasetName is Name of the dataset stored as metadata -\u003e 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" } } }, "v1.GCEPersistentDiskVolumeSource": { "type": "object", "required": [ "pdName" ], "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", "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" } } }, "v1.GRPCAction": { "type": "object", "required": [ "port", "service" ], "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "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" } } }, "v1.GitRepoVolumeSource": { "type": "object", "required": [ "repository" ], "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" } } }, "v1.GlusterfsVolumeSource": { "type": "object", "required": [ "endpoints", "path" ], "properties": { "endpoints": { "description": "endpoints is the endpoint name that details Glusterfs topology.", "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" } } }, "v1.HTTPGetAction": { "type": "object", "required": [ "port" ], "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.HTTPHeader" } }, "path": { "description": "Path to access on the HTTP server.\n+optional", "type": "string" }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "allOf": [ { "$ref": "#/definitions/intstr.IntOrString" } ] }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.URIScheme" } ] } } }, "v1.HTTPHeader": { "type": "object", "required": [ "name", "value" ], "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" } } }, "v1.HostPathType": { "type": "string", "enum": [ "", "DirectoryOrCreate", "Directory", "FileOrCreate", "File", "Socket", "CharDevice", "BlockDevice" ], "x-enum-varnames": [ "HostPathUnset", "HostPathDirectoryOrCreate", "HostPathDirectory", "HostPathFileOrCreate", "HostPathFile", "HostPathSocket", "HostPathCharDev", "HostPathBlockDev" ] }, "v1.HostPathVolumeSource": { "type": "object", "required": [ "path" ], "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": { "description": "type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n+optional", "allOf": [ { "$ref": "#/definitions/v1.HostPathType" } ] } } }, "v1.ISCSIVolumeSource": { "type": "object", "required": [ "iqn", "lun", "targetPortal" ], "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\u003ctarget portal\u003e:\u003cvolume name\u003e 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\n+default=\"default\"", "type": "string" }, "lun": { "description": "lun represents iSCSI Target Lun number.", "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\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef is the CHAP Secret for iSCSI target and initiator authentication\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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" } } }, "v1.ImageVolumeSource": { "type": "object", "properties": { "pullPolicy": { "description": "Policy for pulling OCI objects. Possible values are:\nAlways: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.\nNever: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.\nIfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.PullPolicy" } ] }, "reference": { "description": "Required: Image or artifact reference to be used.\nBehaves in the same way as pod.spec.containers[*].image.\nPull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.\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" } } }, "v1.KeyToPath": { "type": "object", "required": [ "key", "path" ], "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", "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" } } }, "v1.LabelSelector": { "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.LabelSelectorRequirement" } }, "matchLabels": { "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", "additionalProperties": { "type": "string" } } } }, "v1.LabelSelectorOperator": { "type": "string", "enum": [ "In", "NotIn", "Exists", "DoesNotExist" ], "x-enum-varnames": [ "LabelSelectorOpIn", "LabelSelectorOpNotIn", "LabelSelectorOpExists", "LabelSelectorOpDoesNotExist" ] }, "v1.LabelSelectorRequirement": { "type": "object", "required": [ "key", "operator" ], "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "allOf": [ { "$ref": "#/definitions/v1.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\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "v1.LocalObjectReference": { "type": "object", "properties": { "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" } } }, "v1.ManagedFieldsEntry": { "type": "object", "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": { "description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.FieldsV1" } ] }, "manager": { "description": "Manager is an identifier of the workflow managing these fields.", "type": "string" }, "operation": { "description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.\nThe only valid values for this field are 'Apply' and 'Update'.", "allOf": [ { "$ref": "#/definitions/v1.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" } } }, "v1.ManagedFieldsOperationType": { "type": "string", "enum": [ "Apply", "Update" ], "x-enum-varnames": [ "ManagedFieldsOperationApply", "ManagedFieldsOperationUpdate" ] }, "v1.MountPropagationMode": { "type": "string", "enum": [ "None", "HostToContainer", "Bidirectional" ], "x-enum-varnames": [ "MountPropagationNone", "MountPropagationHostToContainer", "MountPropagationBidirectional" ] }, "v1.NFSVolumeSource": { "type": "object", "required": [ "path", "server" ], "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" } } }, "v1.NodeAffinity": { "type": "object", "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.PreferredSchedulingTerm" } }, "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 an update), the system\nmay or may not try to eventually evict the pod from its node.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.NodeSelector" } ] } } }, "v1.NodeSelector": { "type": "object", "required": [ "nodeSelectorTerms" ], "properties": { "nodeSelectorTerms": { "description": "Required. A list of node selector terms. The terms are ORed.\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.NodeSelectorTerm" } } } }, "v1.NodeSelectorOperator": { "type": "string", "enum": [ "In", "NotIn", "Exists", "DoesNotExist", "Gt", "Lt" ], "x-enum-varnames": [ "NodeSelectorOpIn", "NodeSelectorOpNotIn", "NodeSelectorOpExists", "NodeSelectorOpDoesNotExist", "NodeSelectorOpGt", "NodeSelectorOpLt" ] }, "v1.NodeSelectorRequirement": { "type": "object", "required": [ "key", "operator" ], "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "allOf": [ { "$ref": "#/definitions/v1.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\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "v1.NodeSelectorTerm": { "type": "object", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.NodeSelectorRequirement" } }, "matchFields": { "description": "A list of node selector requirements by node's fields.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.NodeSelectorRequirement" } } } }, "v1.ObjectFieldSelector": { "type": "object", "required": [ "fieldPath" ], "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" } } }, "v1.ObjectMeta": { "type": "object", "properties": { "annotations": { "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", "additionalProperties": { "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", "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\n+listType=set", "type": "array", "items": { "type": "string" } }, "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", "type": "integer" }, "labels": { "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", "additionalProperties": { "type": "string" } }, "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.ManagedFieldsEntry" } }, "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\n+listType=map\n+listMapKey=uid", "type": "array", "items": { "$ref": "#/definitions/v1.OwnerReference" } }, "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": { "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids\n+optional", "type": "string" } } }, "v1.OwnerReference": { "type": "object", "required": [ "apiVersion", "kind", "name", "uid" ], "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": { "description": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids", "type": "string" } } }, "v1.PersistentVolumeAccessMode": { "type": "string", "enum": [ "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany", "ReadWriteOncePod" ], "x-enum-varnames": [ "ReadWriteOnce", "ReadOnlyMany", "ReadWriteMany", "ReadWriteOncePod" ] }, "v1.PersistentVolumeClaimSpec": { "type": "object", "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.PersistentVolumeAccessMode" } }, "dataSource": { "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.TypedLocalObjectReference" } ] }, "dataSourceRef": { "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.TypedObjectReference" } ] }, "resources": { "description": "resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources\n+optional", "allOf": [ { "$ref": "#/definitions/v1.VolumeResourceRequirements" } ] }, "selector": { "description": "selector is a label query over volumes to consider for binding.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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 or nil value indicates that no\nVolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,\nthis field can be reset to its previous value (including nil) to cancel the modification.\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/volume-attributes-classes/\n+featureGate=VolumeAttributesClass\n+optional", "type": "string" }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.PersistentVolumeMode" } ] }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.\n+optional", "type": "string" } } }, "v1.PersistentVolumeClaimTemplate": { "type": "object", "required": [ "spec" ], "properties": { "metadata": { "description": "May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation.\n\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ObjectMeta" } ] }, "spec": { "description": "The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here.", "allOf": [ { "$ref": "#/definitions/v1.PersistentVolumeClaimSpec" } ] } } }, "v1.PersistentVolumeClaimVolumeSource": { "type": "object", "required": [ "claimName" ], "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" } } }, "v1.PersistentVolumeMode": { "type": "string", "enum": [ "Block", "Filesystem" ], "x-enum-varnames": [ "PersistentVolumeBlock", "PersistentVolumeFilesystem" ] }, "v1.PersistentVolumeReclaimPolicy": { "type": "string", "enum": [ "Recycle", "Delete", "Retain" ], "x-enum-varnames": [ "PersistentVolumeReclaimRecycle", "PersistentVolumeReclaimDelete", "PersistentVolumeReclaimRetain" ] }, "v1.PhotonPersistentDiskVolumeSource": { "type": "object", "required": [ "pdID" ], "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" } } }, "v1.PodAffinity": { "type": "object", "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.WeightedPodAffinityTerm" } }, "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.PodAffinityTerm" } } } }, "v1.PodAffinityTerm": { "type": "object", "required": [ "topologyKey" ], "properties": { "labelSelector": { "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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.\n\n+listType=atomic\n+optional", "type": "array", "items": { "type": "string" } }, "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.\n\n+listType=atomic\n+optional", "type": "array", "items": { "type": "string" } }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "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" } } }, "v1.PodAntiAffinity": { "type": "object", "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 subtracting\n\"weight\" from 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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.WeightedPodAffinityTerm" } }, "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.PodAffinityTerm" } } } }, "v1.PodCertificateProjection": { "type": "object", "properties": { "certificateChainPath": { "description": "Write the certificate chain at this path in the projected volume.\n\nMost applications should use credentialBundlePath. When using keyPath\nand certificateChainPath, your application needs to check that the key\nand leaf certificate are consistent, because it is possible to read the\nfiles mid-rotation.\n\n+optional", "type": "string" }, "credentialBundlePath": { "description": "Write the credential bundle at this path in the projected volume.\n\nThe credential bundle is a single file that contains multiple PEM blocks.\nThe first PEM block is a PRIVATE KEY block, containing a PKCS#8 private\nkey.\n\nThe remaining blocks are CERTIFICATE blocks, containing the issued\ncertificate chain from the signer (leaf and any intermediates).\n\nUsing credentialBundlePath lets your Pod's application code make a single\natomic read that retrieves a consistent key and certificate chain. If you\nproject them to separate files, your application code will need to\nadditionally check that the leaf certificate was issued to the key.\n\n+optional", "type": "string" }, "keyPath": { "description": "Write the key at this path in the projected volume.\n\nMost applications should use credentialBundlePath. When using keyPath\nand certificateChainPath, your application needs to check that the key\nand leaf certificate are consistent, because it is possible to read the\nfiles mid-rotation.\n\n+optional", "type": "string" }, "keyType": { "description": "The type of keypair Kubelet will generate for the pod.\n\nValid values are \"RSA3072\", \"RSA4096\", \"ECDSAP256\", \"ECDSAP384\",\n\"ECDSAP521\", and \"ED25519\".\n\n+required", "type": "string" }, "maxExpirationSeconds": { "description": "maxExpirationSeconds is the maximum lifetime permitted for the\ncertificate.\n\nKubelet copies this value verbatim into the PodCertificateRequests it\ngenerates for this projection.\n\nIf omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver\nwill reject values shorter than 3600 (1 hour). The maximum allowable\nvalue is 7862400 (91 days).\n\nThe signer implementation is then free to issue a certificate with any\nlifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600\nseconds (1 hour). This constraint is enforced by kube-apiserver.\n`kubernetes.io` signers will never issue certificates with a lifetime\nlonger than 24 hours.\n\n+optional", "type": "integer" }, "signerName": { "description": "Kubelet's generated CSRs will be addressed to this signer.\n\n+required", "type": "string" } } }, "v1.PodFSGroupChangePolicy": { "type": "string", "enum": [ "OnRootMismatch", "Always" ], "x-enum-varnames": [ "FSGroupChangeOnRootMismatch", "FSGroupChangeAlways" ] }, "v1.PodPhase": { "type": "string", "enum": [ "Pending", "Running", "Succeeded", "Failed", "Unknown" ], "x-enum-varnames": [ "PodPending", "PodRunning", "PodSucceeded", "PodFailed", "PodUnknown" ] }, "v1.PodSELinuxChangePolicy": { "type": "string", "enum": [ "Recursive", "MountOption" ], "x-enum-varnames": [ "SELinuxChangePolicyRecursive", "SELinuxChangePolicyMountOption" ] }, "v1.PodSecurityContext": { "type": "object", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.AppArmorProfile" } ] }, "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", "type": "integer" }, "fsGroupChangePolicy": { "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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", "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", "type": "integer" }, "seLinuxChangePolicy": { "description": "seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.\nIt has no effect on nodes that do not support SELinux or to volumes does not support SELinux.\nValid values are \"MountOption\" and \"Recursive\".\n\n\"Recursive\" means relabeling of all files on all Pod volumes by the container runtime.\nThis may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.\n\n\"MountOption\" mounts all eligible Pod volumes with `-o context` mount option.\nThis requires all Pods that share the same volume to use the same SELinux label.\nIt is not possible to share the same volume among privileged and unprivileged Pods.\nEligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes\nwhose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their\nCSIDriver instance. Other volumes are always re-labelled recursively.\n\"MountOption\" value is allowed only when SELinuxMount feature gate is enabled.\n\nIf not specified and SELinuxMount feature gate is enabled, \"MountOption\" is used.\nIf not specified and SELinuxMount feature gate is disabled, \"MountOption\" is used for ReadWriteOncePod volumes\nand \"Recursive\" for all other volumes.\n\nThis field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.\n\nAll Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.\nNote that this field cannot be set when spec.os.name is windows.\n+featureGate=SELinuxChangePolicy\n+optional", "allOf": [ { "$ref": "#/definitions/v1.PodSELinuxChangePolicy" } ] }, "seLinuxOptions": { "description": "The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.SELinuxOptions" } ] }, "seccompProfile": { "description": "The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.SeccompProfile" } ] }, "supplementalGroups": { "description": "A list of groups applied to the first process run in each container, in\naddition to the container's primary GID and fsGroup (if specified). If\nthe SupplementalGroupsPolicy feature is enabled, the\nsupplementalGroupsPolicy field determines whether these are in addition\nto or instead of any group memberships defined in the container image.\nIf unspecified, no additional groups are added, though group memberships\ndefined in the container image may still be used, depending on the\nsupplementalGroupsPolicy field.\nNote that this field cannot be set when spec.os.name is windows.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "integer" } }, "supplementalGroupsPolicy": { "description": "Defines how supplemental groups of the first container processes are calculated.\nValid values are \"Merge\" and \"Strict\". If not specified, \"Merge\" is used.\n(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled\nand the container runtime must implement support for this feature.\nNote that this field cannot be set when spec.os.name is windows.\nTODO: update the default value to \"Merge\" when spec.os.name is not windows in v1.34\n+featureGate=SupplementalGroupsPolicy\n+optional", "allOf": [ { "$ref": "#/definitions/v1.SupplementalGroupsPolicy" } ] }, "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.Sysctl" } }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.WindowsSecurityContextOptions" } ] } } }, "v1.PortworxVolumeSource": { "type": "object", "required": [ "volumeID" ], "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" } } }, "v1.PreferredSchedulingTerm": { "type": "object", "required": [ "preference", "weight" ], "properties": { "preference": { "description": "A node selector term, associated with the corresponding weight.", "allOf": [ { "$ref": "#/definitions/v1.NodeSelectorTerm" } ] }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "type": "integer" } } }, "v1.Probe": { "type": "object", "properties": { "exec": { "description": "Exec specifies a command to execute in the container.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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", "type": "integer" }, "grpc": { "description": "GRPC specifies a GRPC HealthCheckRequest.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.GRPCAction" } ] }, "httpGet": { "description": "HTTPGet specifies an HTTP GET request to perform.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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", "type": "integer" }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional", "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", "type": "integer" }, "tcpSocket": { "description": "TCPSocket specifies a connection to a TCP port.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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", "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", "type": "integer" } } }, "v1.ProcMountType": { "type": "string", "enum": [ "Default", "Unmasked" ], "x-enum-varnames": [ "DefaultProcMount", "UnmaskedProcMount" ] }, "v1.ProjectedVolumeSource": { "type": "object", "required": [ "sources" ], "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", "type": "integer" }, "sources": { "description": "sources is the list of volume projections. Each entry in this list\nhandles one source.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeProjection" } } } }, "v1.PullPolicy": { "type": "string", "enum": [ "Always", "Never", "IfNotPresent" ], "x-enum-varnames": [ "PullAlways", "PullNever", "PullIfNotPresent" ] }, "v1.QuobyteVolumeSource": { "type": "object", "required": [ "registry", "volume" ], "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" } } }, "v1.RBDVolumeSource": { "type": "object", "required": [ "image", "monitors" ], "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\n+default=\"/etc/ceph/keyring\"", "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\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "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\n+default=\"rbd\"", "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": { "description": "secretRef is name of the authentication secret for RBDUser. If provided\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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\n+default=\"admin\"", "type": "string" } } }, "v1.RecursiveReadOnlyMode": { "type": "string", "enum": [ "Disabled", "IfPossible", "Enabled" ], "x-enum-varnames": [ "RecursiveReadOnlyDisabled", "RecursiveReadOnlyIfPossible", "RecursiveReadOnlyEnabled" ] }, "v1.ResourceFieldSelector": { "type": "object", "required": [ "resource" ], "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars\n+optional", "type": "string" }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"\n+optional", "allOf": [ { "$ref": "#/definitions/resource.Quantity" } ] }, "resource": { "description": "Required: resource to select", "type": "string" } } }, "v1.ResourceList": { "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "v1.ResourceRequirements": { "type": "object", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on 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", "type": "array", "items": { "$ref": "#/definitions/k8s_io_api_core_v1.ResourceClaim" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ResourceList" } ] }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ResourceList" } ] } } }, "v1.SELinuxOptions": { "type": "object", "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" } } }, "v1.ScaleIOVolumeSource": { "type": "object", "required": [ "gateway", "secretRef", "system" ], "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\n+default=\"xfs\"", "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": { "description": "secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail.", "allOf": [ { "$ref": "#/definitions/v1.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\n+default=\"ThinProvisioned\"", "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" } } }, "v1.SeccompProfile": { "type": "object", "required": [ "type" ], "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": { "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.\n+unionDiscriminator", "allOf": [ { "$ref": "#/definitions/v1.SeccompProfileType" } ] } } }, "v1.SeccompProfileType": { "type": "string", "enum": [ "Unconfined", "RuntimeDefault", "Localhost" ], "x-enum-varnames": [ "SeccompProfileTypeUnconfined", "SeccompProfileTypeRuntimeDefault", "SeccompProfileTypeLocalhost" ] }, "v1.SecretKeySelector": { "type": "object", "required": [ "key" ], "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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } } }, "v1.SecretProjection": { "type": "object", "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "optional field specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } } }, "v1.SecretVolumeSource": { "type": "object", "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", "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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "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" } } }, "v1.SecurityContext": { "type": "object", "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" }, "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.AppArmorProfile" } ] }, "capabilities": { "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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": { "description": "procMount denotes the type of proc mount to use for the containers.\nThe default value is Default which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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", "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", "type": "integer" }, "seLinuxOptions": { "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May 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", "allOf": [ { "$ref": "#/definitions/v1.SELinuxOptions" } ] }, "seccompProfile": { "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod \u0026 container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.SeccompProfile" } ] }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.WindowsSecurityContextOptions" } ] } } }, "v1.ServiceAccountTokenProjection": { "type": "object", "required": [ "path" ], "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", "type": "integer" }, "path": { "description": "path is the path relative to the mount point of the file to project the\ntoken into.", "type": "string" } } }, "v1.StorageMedium": { "type": "string", "enum": [ "", "Memory", "HugePages", "HugePages-" ], "x-enum-comments": { "StorageMediumDefault": "use whatever the default is for the node, assume anything we don't explicitly handle is this", "StorageMediumHugePages": "use hugepages", "StorageMediumHugePagesPrefix": "prefix for full medium notation HugePages-\u003csize\u003e", "StorageMediumMemory": "use memory (e.g. tmpfs on linux)" }, "x-enum-descriptions": [ "use whatever the default is for the node, assume anything we don't explicitly handle is this", "use memory (e.g. tmpfs on linux)", "use hugepages", "prefix for full medium notation HugePages-\u003csize\u003e" ], "x-enum-varnames": [ "StorageMediumDefault", "StorageMediumMemory", "StorageMediumHugePages", "StorageMediumHugePagesPrefix" ] }, "v1.StorageOSVolumeSource": { "type": "object", "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": { "description": "secretRef specifies the secret to use for obtaining the StorageOS API\ncredentials. If not specified, default values will be attempted.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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" } } }, "v1.SupplementalGroupsPolicy": { "type": "string", "enum": [ "Merge", "Strict" ], "x-enum-varnames": [ "SupplementalGroupsPolicyMerge", "SupplementalGroupsPolicyStrict" ] }, "v1.Sysctl": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "description": "Name of a property to set", "type": "string" }, "value": { "description": "Value of a property to set", "type": "string" } } }, "v1.TCPSocketAction": { "type": "object", "required": [ "port" ], "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.\n+optional", "type": "string" }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "allOf": [ { "$ref": "#/definitions/intstr.IntOrString" } ] } } }, "v1.TaintEffect": { "type": "string", "enum": [ "NoSchedule", "PreferNoSchedule", "NoExecute" ], "x-enum-varnames": [ "TaintEffectNoSchedule", "TaintEffectPreferNoSchedule", "TaintEffectNoExecute" ] }, "v1.Toleration": { "type": "object", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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": { "description": "Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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", "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" } } }, "v1.TolerationOperator": { "type": "string", "enum": [ "Exists", "Equal" ], "x-enum-varnames": [ "TolerationOpExists", "TolerationOpEqual" ] }, "v1.TypedLocalObjectReference": { "type": "object", "required": [ "apiGroup", "kind", "name" ], "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" } } }, "v1.TypedObjectReference": { "type": "object", "required": [ "apiGroup", "kind", "name" ], "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" } } }, "v1.URIScheme": { "type": "string", "enum": [ "HTTP", "HTTPS" ], "x-enum-varnames": [ "URISchemeHTTP", "URISchemeHTTPS" ] }, "v1.Volume": { "type": "object", "required": [ "name" ], "properties": { "awsElasticBlockStore": { "description": "awsElasticBlockStore represents an AWS Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nDeprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree\nawsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional", "allOf": [ { "$ref": "#/definitions/v1.AWSElasticBlockStoreVolumeSource" } ] }, "azureDisk": { "description": "azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.\nDeprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type\nare redirected to the disk.csi.azure.com CSI driver.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.AzureDiskVolumeSource" } ] }, "azureFile": { "description": "azureFile represents an Azure File Service mount on the host and bind mount to the pod.\nDeprecated: AzureFile is deprecated. All operations for the in-tree azureFile type\nare redirected to the file.csi.azure.com CSI driver.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.AzureFileVolumeSource" } ] }, "cephfs": { "description": "cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.\nDeprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.CephFSVolumeSource" } ] }, "cinder": { "description": "cinder represents a cinder volume attached and mounted on kubelets host machine.\nDeprecated: Cinder is deprecated. All operations for the in-tree cinder type\nare redirected to the cinder.csi.openstack.org CSI driver.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "allOf": [ { "$ref": "#/definitions/v1.CinderVolumeSource" } ] }, "configMap": { "description": "configMap represents a configMap that should populate this volume\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ConfigMapVolumeSource" } ] }, "csi": { "description": "csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.CSIVolumeSource" } ] }, "downwardAPI": { "description": "downwardAPI represents downward API about the pod that should populate this volume\n+optional", "allOf": [ { "$ref": "#/definitions/v1.DownwardAPIVolumeSource" } ] }, "emptyDir": { "description": "emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "allOf": [ { "$ref": "#/definitions/v1.EmptyDirVolumeSource" } ] }, "ephemeral": { "description": "ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time.\n\n+optional", "allOf": [ { "$ref": "#/definitions/v1.EphemeralVolumeSource" } ] }, "fc": { "description": "fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.FCVolumeSource" } ] }, "flexVolume": { "description": "flexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.\nDeprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.FlexVolumeSource" } ] }, "flocker": { "description": "flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.\nDeprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.FlockerVolumeSource" } ] }, "gcePersistentDisk": { "description": "gcePersistentDisk represents a GCE Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nDeprecated: GCEPersistentDisk is deprecated. All operations for the in-tree\ngcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "allOf": [ { "$ref": "#/definitions/v1.GCEPersistentDiskVolumeSource" } ] }, "gitRepo": { "description": "gitRepo represents a git repository at a particular revision.\nDeprecated: 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.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.GitRepoVolumeSource" } ] }, "glusterfs": { "description": "glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nDeprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.GlusterfsVolumeSource" } ] }, "hostPath": { "description": "hostPath represents a pre-existing file or directory on the host\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.HostPathVolumeSource" } ] }, "image": { "description": "image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.\nThe volume is resolved at pod startup depending on which PullPolicy value is provided:\n\n- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.\n- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.\n- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\n\nThe volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.\nA failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.\nThe types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.\nThe OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.\nThe volume will be mounted read-only (ro) and non-executable files (noexec).\nSub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.\nThe field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.\n+featureGate=ImageVolume\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ImageVolumeSource" } ] }, "iscsi": { "description": "iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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": { "description": "nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional", "allOf": [ { "$ref": "#/definitions/v1.NFSVolumeSource" } ] }, "persistentVolumeClaim": { "description": "persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional", "allOf": [ { "$ref": "#/definitions/v1.PersistentVolumeClaimVolumeSource" } ] }, "photonPersistentDisk": { "description": "photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.\nDeprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.", "allOf": [ { "$ref": "#/definitions/v1.PhotonPersistentDiskVolumeSource" } ] }, "portworxVolume": { "description": "portworxVolume represents a portworx volume attached and mounted on kubelets host machine.\nDeprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type\nare redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate\nis on.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.PortworxVolumeSource" } ] }, "projected": { "description": "projected items for all in one resources secrets, configmaps, and downward API", "allOf": [ { "$ref": "#/definitions/v1.ProjectedVolumeSource" } ] }, "quobyte": { "description": "quobyte represents a Quobyte mount on the host that shares a pod's lifetime.\nDeprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.QuobyteVolumeSource" } ] }, "rbd": { "description": "rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\nDeprecated: RBD is deprecated and the in-tree rbd type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.RBDVolumeSource" } ] }, "scaleIO": { "description": "scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.\nDeprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ScaleIOVolumeSource" } ] }, "secret": { "description": "secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional", "allOf": [ { "$ref": "#/definitions/v1.SecretVolumeSource" } ] }, "storageos": { "description": "storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.\nDeprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.StorageOSVolumeSource" } ] }, "vsphereVolume": { "description": "vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.\nDeprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type\nare redirected to the csi.vsphere.vmware.com CSI driver.\n+optional", "allOf": [ { "$ref": "#/definitions/v1.VsphereVirtualDiskVolumeSource" } ] } } }, "v1.VolumeMount": { "type": "object", "required": [ "mountPath", "name" ], "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None).\n+optional", "allOf": [ { "$ref": "#/definitions/v1.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" }, "recursiveReadOnly": { "description": "RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.\n\n+featureGate=RecursiveReadOnlyMounts\n+optional", "allOf": [ { "$ref": "#/definitions/v1.RecursiveReadOnlyMode" } ] }, "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" } } }, "v1.VolumeProjection": { "type": "object", "properties": { "clusterTrustBundle": { "description": "ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time.\n\n+featureGate=ClusterTrustBundleProjection\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ClusterTrustBundleProjection" } ] }, "configMap": { "description": "configMap information about the configMap data to project\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ConfigMapProjection" } ] }, "downwardAPI": { "description": "downwardAPI information about the downwardAPI data to project\n+optional", "allOf": [ { "$ref": "#/definitions/v1.DownwardAPIProjection" } ] }, "podCertificate": { "description": "Projects an auto-rotating credential bundle (private key and certificate\nchain) that the pod can use either as a TLS client or server.\n\nKubelet generates a private key and uses it to send a\nPodCertificateRequest to the named signer. Once the signer approves the\nrequest and issues a certificate chain, Kubelet writes the key and\ncertificate chain to the pod filesystem. The pod does not start until\ncertificates have been issued for each podCertificate projected volume\nsource in its spec.\n\nKubelet will begin trying to rotate the certificate at the time indicated\nby the signer using the PodCertificateRequest.Status.BeginRefreshAt\ntimestamp.\n\nKubelet can write a single file, indicated by the credentialBundlePath\nfield, or separate files, indicated by the keyPath and\ncertificateChainPath fields.\n\nThe credential bundle is a single file in PEM format. The first PEM\nentry is the private key (in PKCS#8 format), and the remaining PEM\nentries are the certificate chain issued by the signer (typically,\nsigners will return their certificate chain in leaf-to-root order).\n\nPrefer using the credential bundle format, since your application code\ncan read it atomically. If you use keyPath and certificateChainPath,\nyour application must make two separate file reads. If these coincide\nwith a certificate rotation, it is possible that the private key and leaf\ncertificate you read may not correspond to each other. Your application\nwill need to check for this condition, and re-read until they are\nconsistent.\n\nThe named signer controls chooses the format of the certificate it\nissues; consult the signer implementation's documentation to learn how to\nuse the certificates it issues.\n\n+featureGate=PodCertificateProjection +optional", "allOf": [ { "$ref": "#/definitions/v1.PodCertificateProjection" } ] }, "secret": { "description": "secret information about the secret data to project\n+optional", "allOf": [ { "$ref": "#/definitions/v1.SecretProjection" } ] }, "serviceAccountToken": { "description": "serviceAccountToken is information about the serviceAccountToken data to project\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ServiceAccountTokenProjection" } ] } } }, "v1.VolumeResourceRequirements": { "type": "object", "properties": { "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ResourceList" } ] }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/v1.ResourceList" } ] } } }, "v1.VsphereVirtualDiskVolumeSource": { "type": "object", "required": [ "volumePath" ], "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" } } }, "v1.WeightedPodAffinityTerm": { "type": "object", "required": [ "podAffinityTerm", "weight" ], "properties": { "podAffinityTerm": { "description": "Required. A pod affinity term, associated with the corresponding weight.", "allOf": [ { "$ref": "#/definitions/v1.PodAffinityTerm" } ] }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "type": "integer" } } }, "v1.WindowsSecurityContextOptions": { "type": "object", "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" } } }, "v1beta1.ActivityProbe": { "type": "object", "properties": { "exec": { "description": "a shell command probe\n - if the Workspace had activity in the last 60 seconds this command\n should return status 0, otherwise it should return status 1\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.ActivityProbeExec" } ] }, "jupyter": { "description": "a Jupyter-specific probe\n - will poll the `/api/status` endpoint of the Jupyter API, and use the `last_activity` field\n - note, users need to be careful that their other probes don't trigger a \"last_activity\" update\n e.g. they should only check the health of Jupyter using the `/api/status` endpoint\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.ActivityProbeJupyter" } ] } } }, "v1beta1.ActivityProbeExec": { "type": "object", "required": [ "command" ], "properties": { "command": { "description": "the command to run\n+kubebuilder:validation:MinItems:=1\n+kubebuilder:example={\"bash\", \"-c\", \"exit 0\"}", "type": "array", "items": { "type": "string" } } } }, "v1beta1.ActivityProbeJupyter": { "type": "object", "required": [ "lastActivity" ], "properties": { "lastActivity": { "description": "if the Jupyter-specific probe is enabled\n+kubebuilder:example=true", "type": "boolean" } } }, "v1beta1.HTTPProxy": { "type": "object", "properties": { "removePathPrefix": { "description": "if the path prefix is stripped from incoming HTTP requests\n - if true, the '/workspace/connect/{profile_name}/{workspace_name}/' path prefix\n is stripped from incoming requests, the application sees the request\n as if it was made to '/...'\n - this only works if the application serves RELATIVE URLs for its assets\n+kubebuilder:validation:Optional\n+kubebuilder:default:=false", "type": "boolean" }, "requestHeaders": { "description": "header manipulation rules for incoming HTTP requests\n - sets the `spec.http[].headers.request` of the Istio VirtualService\n https://istio.io/latest/docs/reference/config/networking/virtual-service/#Headers-HeaderOperations\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.IstioHeaderOperations" } ] } } }, "v1beta1.ImageConfig": { "type": "object", "required": [ "spawner", "values" ], "properties": { "spawner": { "description": "spawner ui configs", "allOf": [ { "$ref": "#/definitions/v1beta1.OptionsSpawnerConfig" } ] }, "values": { "description": "the list of image configs that are available\n+kubebuilder:validation:MinItems:=1\n+listType:=\"map\"\n+listMapKey:=\"id\"", "type": "array", "items": { "$ref": "#/definitions/v1beta1.ImageConfigValue" } } } }, "v1beta1.ImageConfigSpec": { "type": "object", "required": [ "image", "imagePullPolicy", "ports" ], "properties": { "image": { "description": "the container image to use\n+kubebuilder:validation:MinLength:=2\n+kubeflow:example=\"ghcr.io/kubeflow/kubeflow/notebook-servers/jupyter-scipy:v1.7.0\"", "type": "string" }, "imagePullPolicy": { "description": "the pull policy for the container image\n+kubebuilder:validation:Optional\n+kubebuilder:default:=\"IfNotPresent\"\n+kubebuilder:validation:Enum:={\"Always\",\"IfNotPresent\",\"Never\"}", "allOf": [ { "$ref": "#/definitions/v1.PullPolicy" } ] }, "ports": { "description": "ports that the container listens on\n - if multiple ports are defined, the user will see multiple \"Connect\" buttons\n in a dropdown menu on the Workspace overview page\n+kubebuilder:validation:MinItems:=1\n+listType:=\"map\"\n+listMapKey:=\"id\"", "type": "array", "items": { "$ref": "#/definitions/v1beta1.ImagePort" } } } }, "v1beta1.ImageConfigValue": { "type": "object", "required": [ "id", "spawner", "spec" ], "properties": { "id": { "description": "the id of this image config\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=256\n+kubebuilder:example:=\"jupyterlab_scipy_190\"", "type": "string" }, "redirect": { "description": "redirect configs\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.OptionRedirect" } ] }, "spawner": { "description": "information for the spawner ui", "allOf": [ { "$ref": "#/definitions/v1beta1.OptionSpawnerInfo" } ] }, "spec": { "description": "the spec of the image config", "allOf": [ { "$ref": "#/definitions/v1beta1.ImageConfigSpec" } ] } } }, "v1beta1.ImagePort": { "type": "object", "required": [ "id", "port" ], "properties": { "displayName": { "description": "the display name of the port\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=64\n+kubebuilder:validation:Optional", "type": "string" }, "id": { "description": "the id of the port\n - this is NOT used as the Container or Service port name, but as part of the HTTP path\n+kubebuilder:example=\"jupyterlab\"", "type": "string" }, "port": { "description": "the port number\n+kubebuilder:validation:Minimum:=1\n+kubebuilder:validation:Maximum:=65535\n+kubebuilder:example:=8888", "type": "integer" } } }, "v1beta1.ImagePortProtocol": { "type": "string", "enum": [ "HTTP" ], "x-enum-varnames": [ "ImagePortProtocolHTTP" ] }, "v1beta1.IstioHeaderOperations": { "type": "object", "properties": { "add": { "description": "append the given values to the headers specified by keys (will create a comma-separated list of values)\n - the following go template functions are available in the values:\n - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port\n+kubebuilder:validation:Optional\n+kubebuilder:example:={ \"My-Header\": \"value-to-append\" }", "type": "object", "additionalProperties": { "type": "string" } }, "remove": { "description": "remove the specified headers\n+kubebuilder:validation:Optional\n+kubebuilder:example:={\"Header-To-Remove\"}", "type": "array", "items": { "type": "string" } }, "set": { "description": "overwrite the headers specified by key with the given values\n - the following go template functions are available in the values:\n - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port\n+kubebuilder:validation:Optional\n+kubebuilder:example:={ \"X-RStudio-Root-Path\": \"{{ httpPathPrefix 'rstudio' }}\" }", "type": "object", "additionalProperties": { "type": "string" } } } }, "v1beta1.OptionRedirect": { "type": "object", "required": [ "to" ], "properties": { "message": { "description": "information about the redirect\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.RedirectMessage" } ] }, "to": { "description": "the id of the option to redirect to\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=256\n+kubebuilder:example:=\"jupyterlab_scipy_190\"", "type": "string" } } }, "v1beta1.OptionSpawnerInfo": { "type": "object", "required": [ "displayName" ], "properties": { "description": { "description": "a description of the option\n+kubebuilder:validation:Optional\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=1024", "type": "string" }, "displayName": { "description": "the display name of the option\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=128", "type": "string" }, "hidden": { "description": "if this option should be hidden from the Workspace Spawner UI\n+kubebuilder:validation:Optional\n+kubebuilder:default:=false", "type": "boolean" }, "labels": { "description": "labels for the option\n+kubebuilder:validation:Optional\n+kubebuilder:validation:MaxItems:=32\n+listType:=\"map\"\n+listMapKey:=\"key\"", "type": "array", "items": { "$ref": "#/definitions/v1beta1.OptionSpawnerLabel" } } } }, "v1beta1.OptionSpawnerLabel": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "description": "the key of the label\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=64", "type": "string" }, "value": { "description": "the value of the label\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=64", "type": "string" } } }, "v1beta1.OptionsSpawnerConfig": { "type": "object", "required": [ "default" ], "properties": { "default": { "description": "the id of the default option\n - this will be selected by default in the spawner ui\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=256\n+kubebuilder:example=\"jupyterlab_scipy_190\"", "type": "string" } } }, "v1beta1.PodConfig": { "type": "object", "required": [ "spawner", "values" ], "properties": { "spawner": { "description": "spawner ui configs", "allOf": [ { "$ref": "#/definitions/v1beta1.OptionsSpawnerConfig" } ] }, "values": { "description": "the list of pod configs that are available\n+kubebuilder:validation:MinItems:=1\n+listType:=\"map\"\n+listMapKey:=\"id\"", "type": "array", "items": { "$ref": "#/definitions/v1beta1.PodConfigValue" } } } }, "v1beta1.PodConfigSpec": { "type": "object", "properties": { "affinity": { "description": "affinity configs for the pod\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1.Affinity" } ] }, "nodeSelector": { "description": "node selector configs for the pod\n+kubebuilder:validation:Optional", "type": "object", "additionalProperties": { "type": "string" } }, "resources": { "description": "resource configs for the \"main\" container in the pod\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1.ResourceRequirements" } ] }, "tolerations": { "description": "toleration configs for the pod\n+kubebuilder:validation:Optional", "type": "array", "items": { "$ref": "#/definitions/v1.Toleration" } } } }, "v1beta1.PodConfigValue": { "type": "object", "required": [ "id", "spawner", "spec" ], "properties": { "id": { "description": "the id of this pod config\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=256\n+kubebuilder:example=\"big_gpu\"", "type": "string" }, "redirect": { "description": "redirect configs\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.OptionRedirect" } ] }, "spawner": { "description": "information for the spawner ui", "allOf": [ { "$ref": "#/definitions/v1beta1.OptionSpawnerInfo" } ] }, "spec": { "description": "the spec of the pod config", "allOf": [ { "$ref": "#/definitions/v1beta1.PodConfigSpec" } ] } } }, "v1beta1.RedirectMessage": { "type": "object", "required": [ "level", "text" ], "properties": { "level": { "description": "the importance level of the message\n+kubebuilder:example:=\"Info\"", "allOf": [ { "$ref": "#/definitions/v1beta1.RedirectMessageLevel" } ] }, "text": { "description": "the text of the message to show\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=1024\n+kubebuilder:example:=\"This update will increase the version of JupyterLab to v1.7.1\"", "type": "string" } } }, "v1beta1.RedirectMessageLevel": { "type": "string", "enum": [ "Info", "Warning", "Danger" ], "x-enum-varnames": [ "RedirectMessageLevelInfo", "RedirectMessageLevelWarning", "RedirectMessageLevelDanger" ] }, "v1beta1.WorkspaceKindAsset": { "type": "object", "properties": { "configMap": { "description": "the ConfigMap reference for the asset\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindAssetConfigMap" } ] }, "url": { "description": "the URL of the asset\n+kubebuilder:validation:Optional\n+kubebuilder:example=\"https://jupyter.org/assets/favicons/apple-touch-icon-152x152.png\"", "type": "string" } } }, "v1beta1.WorkspaceKindAssetConfigMap": { "type": "object", "required": [ "key", "mediaType", "name", "namespace" ], "properties": { "key": { "description": "the key in the ConfigMap which contains the data\n+kubebuilder:example=\"jupyterlab-logo.svg\"\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=253\n+kubebuilder:validation:Pattern:=^[-._a-zA-Z0-9]+$", "type": "string" }, "mediaType": { "description": "the media type of the asset data in the ConfigMap\n+kubebuilder:example=\"image/svg+xml\"", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindAssetMediaType" } ] }, "name": { "description": "the name of the ConfigMap\n+kubebuilder:example=\"my-logos\"\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=253\n+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "namespace": { "description": "the namespace of the ConfigMap\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=63\n+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?$\n+kubebuilder:example=\"kubeflow\"", "type": "string" } } }, "v1beta1.WorkspaceKindAssetMediaType": { "type": "string", "enum": [ "image/svg+xml" ], "x-enum-varnames": [ "WorkspaceKindAssetMediaTypeSVG" ] }, "v1beta1.WorkspaceKindCullingConfig": { "type": "object", "required": [ "activityProbe" ], "properties": { "activityProbe": { "description": "the probe used to determine if the Workspace is active", "allOf": [ { "$ref": "#/definitions/v1beta1.ActivityProbe" } ] }, "enabled": { "description": "if the culling feature is enabled\n+kubebuilder:validation:Optional\n+kubebuilder:default=true", "type": "boolean" }, "maxInactiveSeconds": { "description": "the maximum number of seconds a Workspace can be inactive\n+kubebuilder:validation:Optional\n+kubebuilder:validation:Minimum:=60\n+kubebuilder:default=86400", "type": "integer" } } }, "v1beta1.WorkspaceKindPodMetadata": { "type": "object", "properties": { "annotations": { "description": "annotations to be applied to the Pod resource\n+kubebuilder:validation:Optional", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "labels to be applied to the Pod resource\n+kubebuilder:validation:Optional", "type": "object", "additionalProperties": { "type": "string" } } } }, "v1beta1.WorkspaceKindPodOptions": { "type": "object", "required": [ "imageConfig", "podConfig" ], "properties": { "imageConfig": { "description": "imageConfig options", "allOf": [ { "$ref": "#/definitions/v1beta1.ImageConfig" } ] }, "podConfig": { "description": "podConfig options", "allOf": [ { "$ref": "#/definitions/v1beta1.PodConfig" } ] } } }, "v1beta1.WorkspaceKindPodTemplate": { "type": "object", "required": [ "options", "ports", "serviceAccount", "volumeMounts" ], "properties": { "containerSecurityContext": { "description": "container security context for Workspace Pods (MUTABLE)\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1.SecurityContext" } ] }, "culling": { "description": "culling configs for pausing inactive Workspaces (MUTABLE)\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindCullingConfig" } ] }, "extraEnv": { "description": "environment variables for Workspace Pods (MUTABLE)\n - the following go template functions are available:\n - `httpPathPrefix(portId string)`: returns the HTTP path prefix of the specified port\n+kubebuilder:validation:Optional\n+kubebuilder:example:={ \"NB_PREFIX\": \"{{ httpPathPrefix 'jupyterlab' }}\" }\n+listType:=\"map\"\n+listMapKey:=\"name\"", "type": "array", "items": { "$ref": "#/definitions/v1.EnvVar" } }, "extraVolumeMounts": { "description": "extra volume mounts for Workspace Pods (MUTABLE)\n+kubebuilder:validation:Optional\n+listType:=\"map\"\n+listMapKey:=\"mountPath\"", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMount" } }, "extraVolumes": { "description": "extra volumes for Workspace Pods (MUTABLE)\n+kubebuilder:validation:Optional\n+listType:=\"map\"\n+listMapKey:=\"name\"", "type": "array", "items": { "$ref": "#/definitions/v1.Volume" } }, "options": { "description": "options are the user-selectable fields, they determine the PodSpec of the Workspace", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindPodOptions" } ] }, "podMetadata": { "description": "metadata for Workspace Pods (MUTABLE)\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindPodMetadata" } ] }, "ports": { "description": "port definitions which can be referenced in image config values\n- think of port definitions as the \"types\" of services which could be provided by a specific image\n- a port definition has a common id (URL path) for consistency if the listening TCP port changes\n- ports are referenced in image config values by their `id` and their definition here establishes\n their protocol type, and default display name in the UI\n+kubebuilder:validation:MinItems:=1\n+listType:=\"map\"\n+listMapKey:=\"id\"", "type": "array", "items": { "$ref": "#/definitions/v1beta1.WorkspaceKindPort" } }, "probes": { "description": "standard probes to determine Container health (MUTABLE)\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindProbes" } ] }, "securityContext": { "description": "security context for Workspace Pods (MUTABLE)\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1.PodSecurityContext" } ] }, "serviceAccount": { "description": "service account configs for Workspace Pods", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindServiceAccount" } ] }, "volumeMounts": { "description": "volume mount paths", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindVolumeMounts" } ] } } }, "v1beta1.WorkspaceKindPort": { "type": "object", "required": [ "defaultDisplayName", "id", "protocol" ], "properties": { "defaultDisplayName": { "description": "the default display name of the port\n- note, this can be overridden on a per image config value basis\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=64\n+kubebuilder:example:=\"JupyterLab\"", "type": "string" }, "httpProxy": { "description": "the http proxy config for the port (MUTABLE)\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1beta1.HTTPProxy" } ] }, "id": { "description": "the id of the port\n- identifier for the port in `imageconfig` ports.[].id\n+kubebuilder:example=\"jupyterlab\"", "type": "string" }, "protocol": { "description": "the protocol of the port\n+kubebuilder:example:=\"HTTP\"", "allOf": [ { "$ref": "#/definitions/v1beta1.ImagePortProtocol" } ] } } }, "v1beta1.WorkspaceKindProbes": { "type": "object", "properties": { "livenessProbe": { "description": "the liveness probe for the main container\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1.Probe" } ] }, "readinessProbe": { "description": "the readiness probe for the main container\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1.Probe" } ] }, "startupProbe": { "description": "the startup probe for the main container\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/v1.Probe" } ] } } }, "v1beta1.WorkspaceKindServiceAccount": { "type": "object", "required": [ "name" ], "properties": { "name": { "description": "the name of the ServiceAccount (NOT MUTABLE)\n - this Service Account MUST already exist in the Namespace\n of the Workspace, the controller will NOT create it\n - we will not show this WorkspaceKind in the Spawner UI\n if the SA does not exist in the Namespace\n+kubebuilder:validation:XValidation:rule=\"self == oldSelf\",message=\"ServiceAccount 'name' is immutable\"\n+kubebuilder:example=\"default-editor\"\n+kubebuilder:validation:MinLength:=1\n+kubebuilder:validation:MaxLength:=253\n+kubebuilder:validation:Pattern:=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" } } }, "v1beta1.WorkspaceKindSpawner": { "type": "object", "required": [ "description", "displayName", "icon", "logo" ], "properties": { "deprecated": { "description": "if this WorkspaceKind is deprecated\n+kubebuilder:validation:Optional\n+kubebuilder:default:=false", "type": "boolean" }, "deprecationMessage": { "description": "a message to show in Workspace Spawner UI when the WorkspaceKind is deprecated\n+kubebuilder:validation:Optional\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=256\n+kubebuilder:example:=\"This WorkspaceKind will be removed on 20XX-XX-XX, please use another WorkspaceKind.\"", "type": "string" }, "description": { "description": "the description of the WorkspaceKind\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=4096\n+kubebuilder:example:=\"A Workspace which runs JupyterLab in a Pod\"", "type": "string" }, "displayName": { "description": "the display name of the WorkspaceKind\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=128\n+kubebuilder:example:=\"JupyterLab Notebook\"", "type": "string" }, "hidden": { "description": "if this WorkspaceKind should be hidden from the Workspace Spawner UI\n+kubebuilder:validation:Optional\n+kubebuilder:default:=false", "type": "boolean" }, "icon": { "description": "the icon of the WorkspaceKind\n - a small (favicon-sized) icon used in the Workspace Spawner UI", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindAsset" } ] }, "logo": { "description": "the logo of the WorkspaceKind\n - a 1:1 (card size) logo used in the Workspace Spawner UI", "allOf": [ { "$ref": "#/definitions/v1beta1.WorkspaceKindAsset" } ] } } }, "v1beta1.WorkspaceKindVolumeMounts": { "type": "object", "required": [ "home" ], "properties": { "home": { "description": "the path to mount the home PVC (NOT MUTABLE)\n+kubebuilder:validation:MinLength:=2\n+kubebuilder:validation:MaxLength:=4096\n+kubebuilder:validation:Pattern:=^/[^/].*$\n+kubebuilder:validation:XValidation:rule=\"self == oldSelf\",message=\"mount path of 'home' is immutable\"\n+kubebuilder:example:=\"/home/jovyan\"", "type": "string" } } }, "v1beta1.WorkspaceState": { "type": "string", "enum": [ "Running", "Terminating", "Paused", "Pending", "Error", "Unknown" ], "x-enum-varnames": [ "WorkspaceStateRunning", "WorkspaceStateTerminating", "WorkspaceStatePaused", "WorkspaceStatePending", "WorkspaceStateError", "WorkspaceStateUnknown" ] }, "workspacekinds.ClusterKindMetrics": { "type": "object", "required": [ "workspacesCount" ], "properties": { "workspacesCount": { "type": "integer" } } }, "workspacekinds.PodMetadata": { "type": "object", "required": [ "annotations", "labels" ], "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" } } } }, "workspacekinds.PodTemplate": { "type": "object", "required": [ "options", "podMetadata", "volumeMounts" ], "properties": { "options": { "description": "TODO: remove once frontend migrates to the new listValues endpoint for both create/update and wsk admin views", "allOf": [ { "$ref": "#/definitions/options.PodTemplateOptions" } ] }, "podMetadata": { "$ref": "#/definitions/workspacekinds.PodMetadata" }, "volumeMounts": { "$ref": "#/definitions/workspacekinds.PodVolumeMounts" } } }, "workspacekinds.PodVolumeMounts": { "type": "object", "required": [ "home" ], "properties": { "home": { "type": "string" } } }, "workspacekinds.WorkspaceKindCreate": { "type": "object", "required": [ "name", "podTemplate", "spawner" ], "properties": { "name": { "type": "string" }, "podTemplate": { "$ref": "#/definitions/v1beta1.WorkspaceKindPodTemplate" }, "spawner": { "$ref": "#/definitions/v1beta1.WorkspaceKindSpawner" } } }, "workspacekinds.WorkspaceKindListItem": { "type": "object", "required": [ "clusterMetrics", "deprecated", "deprecationMessage", "description", "displayName", "hidden", "icon", "logo", "name", "podTemplate" ], "properties": { "clusterMetrics": { "$ref": "#/definitions/workspacekinds.ClusterKindMetrics" }, "deprecated": { "type": "boolean" }, "deprecationMessage": { "type": "string" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "hidden": { "type": "boolean" }, "icon": { "$ref": "#/definitions/assets.ImageRef" }, "logo": { "$ref": "#/definitions/assets.ImageRef" }, "name": { "type": "string" }, "podTemplate": { "$ref": "#/definitions/workspacekinds.PodTemplate" } } }, "workspacekinds.WorkspaceKindUpdate": { "type": "object", "required": [ "podTemplate", "revision", "spawner" ], "properties": { "podTemplate": { "$ref": "#/definitions/v1beta1.WorkspaceKindPodTemplate" }, "revision": { "description": "RevisionString is an opaque token that can be treated like an etag.\n - Clients receive this value from GET requests and must include it\n in update requests to ensure they are updating the expected version.\n - Clients must not parse, interpret, or compare revision values\n other than for equality, as the format is not guaranteed to be stable.", "type": "string" }, "spawner": { "$ref": "#/definitions/v1beta1.WorkspaceKindSpawner" } } }, "workspaces.Activity": { "type": "object", "required": [ "lastActivity", "lastUpdate" ], "properties": { "lastActivity": { "description": "Unix Epoch time", "type": "integer" }, "lastProbe": { "$ref": "#/definitions/workspaces.LastProbeInfo" }, "lastUpdate": { "description": "Unix Epoch time", "type": "integer" } } }, "workspaces.HttpService": { "type": "object", "required": [ "displayName", "httpPath" ], "properties": { "displayName": { "type": "string" }, "httpPath": { "type": "string" } } }, "workspaces.ImageConfig": { "type": "object", "required": [ "current" ], "properties": { "current": { "$ref": "#/definitions/workspaces.OptionInfo" }, "redirectChain": { "type": "array", "items": { "$ref": "#/definitions/workspaces.RedirectStep" } } } }, "workspaces.LastProbeInfo": { "type": "object", "required": [ "endTimeMs", "message", "result", "startTimeMs" ], "properties": { "endTimeMs": { "description": "Unix Epoch time in milliseconds", "type": "integer" }, "message": { "type": "string" }, "result": { "$ref": "#/definitions/workspaces.ProbeResult" }, "startTimeMs": { "description": "Unix Epoch time in milliseconds", "type": "integer" } } }, "workspaces.OptionInfo": { "type": "object", "required": [ "description", "displayName", "id", "labels" ], "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "id": { "type": "string" }, "labels": { "type": "array", "items": { "$ref": "#/definitions/workspaces.OptionLabel" } } } }, "workspaces.OptionLabel": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "workspaces.PodConfig": { "type": "object", "required": [ "current" ], "properties": { "current": { "$ref": "#/definitions/workspaces.OptionInfo" }, "redirectChain": { "type": "array", "items": { "$ref": "#/definitions/workspaces.RedirectStep" } } } }, "workspaces.PodMetadata": { "type": "object", "required": [ "annotations", "labels" ], "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" } } } }, "workspaces.PodMetadataMutate": { "type": "object", "required": [ "annotations", "labels" ], "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "type": "object", "additionalProperties": { "type": "string" } } } }, "workspaces.PodSecretInfo": { "type": "object", "required": [ "mountPath", "secretName" ], "properties": { "defaultMode": { "type": "integer" }, "mountPath": { "type": "string" }, "secretName": { "type": "string" } } }, "workspaces.PodSecretMount": { "type": "object", "required": [ "mountPath", "secretName" ], "properties": { "defaultMode": { "type": "integer" }, "mountPath": { "type": "string" }, "secretName": { "type": "string" } } }, "workspaces.PodTemplate": { "type": "object", "required": [ "options", "podMetadata", "volumes" ], "properties": { "options": { "$ref": "#/definitions/workspaces.PodTemplateOptions" }, "podMetadata": { "$ref": "#/definitions/workspaces.PodMetadata" }, "volumes": { "$ref": "#/definitions/workspaces.PodVolumes" } } }, "workspaces.PodTemplateMutate": { "type": "object", "required": [ "options", "podMetadata", "volumes" ], "properties": { "options": { "$ref": "#/definitions/workspaces.PodTemplateOptionsMutate" }, "podMetadata": { "$ref": "#/definitions/workspaces.PodMetadataMutate" }, "volumes": { "$ref": "#/definitions/workspaces.PodVolumesMutate" } } }, "workspaces.PodTemplateOptions": { "type": "object", "required": [ "imageConfig", "podConfig" ], "properties": { "imageConfig": { "$ref": "#/definitions/workspaces.ImageConfig" }, "podConfig": { "$ref": "#/definitions/workspaces.PodConfig" } } }, "workspaces.PodTemplateOptionsMutate": { "type": "object", "required": [ "imageConfig", "podConfig" ], "properties": { "imageConfig": { "type": "string" }, "podConfig": { "type": "string" } } }, "workspaces.PodVolumeInfo": { "type": "object", "required": [ "mountPath", "pvcName", "readOnly" ], "properties": { "mountPath": { "type": "string" }, "pvcName": { "type": "string" }, "readOnly": { "type": "boolean" } } }, "workspaces.PodVolumeMount": { "type": "object", "required": [ "mountPath", "pvcName" ], "properties": { "mountPath": { "type": "string" }, "pvcName": { "type": "string" }, "readOnly": { "type": "boolean" } } }, "workspaces.PodVolumes": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/workspaces.PodVolumeInfo" } }, "home": { "$ref": "#/definitions/workspaces.PodVolumeInfo" }, "secrets": { "type": "array", "items": { "$ref": "#/definitions/workspaces.PodSecretInfo" } } } }, "workspaces.PodVolumesMutate": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/workspaces.PodVolumeMount" } }, "home": { "type": "string" }, "secrets": { "type": "array", "items": { "$ref": "#/definitions/workspaces.PodSecretMount" } } } }, "workspaces.ProbeResult": { "type": "string", "enum": [ "Success", "Failure", "Timeout" ], "x-enum-varnames": [ "ProbeResultSuccess", "ProbeResultFailure", "ProbeResultTimeout" ] }, "workspaces.RedirectMessage": { "type": "object", "required": [ "level", "text" ], "properties": { "level": { "$ref": "#/definitions/workspaces.RedirectMessageLevel" }, "text": { "type": "string" } } }, "workspaces.RedirectMessageLevel": { "type": "string", "enum": [ "Info", "Warning", "Danger" ], "x-enum-varnames": [ "RedirectMessageLevelInfo", "RedirectMessageLevelWarning", "RedirectMessageLevelDanger" ] }, "workspaces.RedirectStep": { "type": "object", "required": [ "source", "target" ], "properties": { "message": { "$ref": "#/definitions/workspaces.RedirectMessage" }, "source": { "$ref": "#/definitions/workspaces.OptionInfo" }, "target": { "$ref": "#/definitions/workspaces.OptionInfo" } } }, "workspaces.Service": { "type": "object", "properties": { "httpService": { "$ref": "#/definitions/workspaces.HttpService" } } }, "workspaces.WorkspaceCreate": { "type": "object", "required": [ "kind", "name", "paused", "podTemplate" ], "properties": { "kind": { "type": "string" }, "name": { "type": "string" }, "paused": { "type": "boolean" }, "podTemplate": { "$ref": "#/definitions/workspaces.PodTemplateMutate" } } }, "workspaces.WorkspaceKindInfo": { "type": "object", "required": [ "icon", "logo", "missing", "name" ], "properties": { "icon": { "$ref": "#/definitions/assets.ImageRef" }, "logo": { "$ref": "#/definitions/assets.ImageRef" }, "missing": { "type": "boolean" }, "name": { "type": "string" } } }, "workspaces.WorkspaceListItem": { "type": "object", "required": [ "activity", "audit", "name", "namespace", "paused", "pausedTime", "pendingRestart", "podTemplate", "services", "state", "stateMessage", "workspaceKind" ], "properties": { "activity": { "$ref": "#/definitions/workspaces.Activity" }, "audit": { "$ref": "#/definitions/common.Audit" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "paused": { "type": "boolean" }, "pausedTime": { "type": "integer" }, "pendingRestart": { "type": "boolean" }, "podTemplate": { "$ref": "#/definitions/workspaces.PodTemplate" }, "services": { "type": "array", "items": { "$ref": "#/definitions/workspaces.Service" } }, "state": { "$ref": "#/definitions/v1beta1.WorkspaceState" }, "stateMessage": { "type": "string" }, "workspaceKind": { "$ref": "#/definitions/workspaces.WorkspaceKindInfo" } } }, "workspaces.WorkspaceUpdate": { "type": "object", "required": [ "paused", "podTemplate", "revision" ], "properties": { "paused": { "description": "TODO: remove `paused` once we have an \"actions\" api for pausing workspaces", "type": "boolean" }, "podTemplate": { "$ref": "#/definitions/workspaces.PodTemplateMutate" }, "revision": { "description": "RevisionString is an opaque token that can be treated like an etag.\n - Clients receive this value from GET requests and must include it\n in update requests to ensure they are updating the expected version.\n - Clients must not parse, interpret, or compare revision values\n other than for equality, as the format is not guaranteed to be stable.", "type": "string" } } } } }