{ "swagger": "2.0", "info": { "title": "Kubernetes Dashboard API", "version": "0.0.0-dev" }, "paths": { "/api/v1/_raw/{kind}/name/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a non-namespaced resource", "operationId": "handleGetResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/unstructured.Unstructured" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "creates or updates a non-namespaced resource", "operationId": "handlePutResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handler.JSON" } } ], "responses": { "204": { "description": "" } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "deletes a non-namespaced resource", "operationId": "handleDeleteResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "override graceful delete options and enforce immediate deletion", "name": "deleteNow", "in": "query" }, { "type": "string", "description": "override default delete propagation policy", "name": "propagation", "in": "query" } ], "responses": { "204": { "description": "" } } } }, "/api/v1/_raw/{kind}/namespace/{namespace}/name/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns unstructured resource from a namespace", "operationId": "handleGetResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "namespace of the resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/unstructured.Unstructured" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "creates or updates a resource in a namespace", "operationId": "handlePutResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "namespace of the resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/handler.JSON" } } ], "responses": { "204": { "description": "" } } }, "delete": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "deletes a resource from a namespace", "operationId": "handleDeleteResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "namespace of the resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "override graceful delete options and enforce immediate deletion", "name": "deleteNow", "in": "query" }, { "type": "string", "description": "override default delete propagation policy", "name": "propagation", "in": "query" } ], "responses": { "204": { "description": "" } } } }, "/api/v1/appdeployment": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "creates an application based on provided deployment.AppDeploymentSpec", "operationId": "handleDeploy", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/deployment.AppDeploymentSpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.AppDeploymentSpec" } } } } }, "/api/v1/appdeployment/protocols": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of available protocols for the service", "operationId": "handleGetAvailableProtocols", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.Protocols" } } } } }, "/api/v1/appdeployment/validate/imagereference": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "checks if provided image is valid", "operationId": "handleImageReferenceValidity", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/validation.ImageReferenceValiditySpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/validation.ImageReferenceValidity" } } } } }, "/api/v1/appdeployment/validate/name": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "checks if provided name is valid", "operationId": "handleNameValidity", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/validation.AppNameValiditySpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/validation.AppNameValidity" } } } } }, "/api/v1/appdeployment/validate/protocol": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "checks if provided service protocol is valid", "operationId": "handleProtocolValidity", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/validation.ProtocolValiditySpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/validation.ProtocolValidity" } } } } }, "/api/v1/appdeploymentfromfile": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "create an application from file", "operationId": "handleDeployFromFile", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/deployment.AppDeploymentFromFileSpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.AppDeploymentFromFileResponse" } } } } }, "/api/v1/clusterrole": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ClusterRoles", "operationId": "handleGetClusterRoleList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clusterrole.ClusterRoleList" } } } } }, "/api/v1/clusterrole/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about ClusterRole", "operationId": "handleGetClusterRoleDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the ClusterRole", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clusterrole.ClusterRoleDetail" } } } } }, "/api/v1/clusterrolebinding": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ClusterRoleBindings", "operationId": "handleGetClusterRoleBindingList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clusterrolebinding.ClusterRoleBindingList" } } } } }, "/api/v1/clusterrolebinding/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about ClusterRoleBinding", "operationId": "handleGetClusterRoleBindingDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the ClusterRoleBinding", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/clusterrolebinding.ClusterRoleBindingDetail" } } } } }, "/api/v1/configmap": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ConfigMaps from all namespaces", "operationId": "handleGetConfigMapList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/configmap.ConfigMapList" } } } } }, "/api/v1/configmap/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ConfigMaps in a namespaces", "operationId": "handleGetConfigMapList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ConfigMap", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/configmap.ConfigMapList" } } } } }, "/api/v1/configmap/{namespace}/{configmap}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about ConfigMap", "operationId": "handleGetConfigMapDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ConfigMap", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ConfigMap", "name": "configmap", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/configmap.ConfigMapDetail" } } } } }, "/api/v1/crd": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of CustomResourceDefinition", "operationId": "handleGetCustomResourceDefinitionList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/types.CustomResourceDefinitionList" } } } } }, "/api/v1/crd/{crd}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about CustomResourceDefinition", "operationId": "handleGetCustomResourceDefinitionDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the CustomResourceDefinition", "name": "crd", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/types.CustomResourceDefinitionDetail" } } } } }, "/api/v1/crd/{namespace}/{crd}/object": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of objects of CustomResourceDefinition", "operationId": "handleGetCustomResourceObjectList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the custom resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the CustomResourceDefinition", "name": "crd", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/types.CustomResourceObjectList" } } } } }, "/api/v1/crd/{namespace}/{crd}/{object}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about custom resource object", "operationId": "handleGetCustomResourceObjectDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the custom resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the CustomResourceDefinition", "name": "crd", "in": "path", "required": true }, { "type": "string", "description": "name of the custom resource object", "name": "object", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/types.CustomResourceObjectDetail" } } } } }, "/api/v1/crd/{namespace}/{crd}/{object}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns Events for custom resource object", "operationId": "handleGetCustomResourceObjectEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the custom resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the CustomResourceDefinition", "name": "crd", "in": "path", "required": true }, { "type": "string", "description": "name of the custom resource object", "name": "object", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/cronjob": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of CronJobs from all namespaces", "operationId": "handleGetCronJobList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cronjob.CronJobList" } } } } }, "/api/v1/cronjob/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of CronJobs in a namespaces", "operationId": "handleGetCronJobList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the CronJob", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cronjob.CronJobList" } } } } }, "/api/v1/cronjob/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about CronJob", "operationId": "handleGetCronJobDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the CronJob", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the CronJob", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/cronjob.CronJobDetail" } } } } }, "/api/v1/cronjob/{namespace}/{name}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for CronJob", "operationId": "handleGetCronJobEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the CronJob", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the CronJob", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/cronjob/{namespace}/{name}/job": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Jobs for CronJob", "operationId": "handleGetCronJobJobs", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the CronJob", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the CronJob", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "filter related Jobs by active status", "name": "active", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/job.JobList" } } } } }, "/api/v1/cronjob/{namespace}/{name}/trigger": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "triggers a Job based on CronJob", "operationId": "handleTriggerCronJob", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the CronJob", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the CronJob", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/csrftoken/{action}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "generates a one-time CSRF token that can be used by POST request", "operationId": "handleGetCsrfToken", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "action name to generate CSRF token for", "name": "action", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/csrf.Response" } } } } }, "/api/v1/daemonset": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of DaemonSets from all namespaces", "operationId": "handleGetDaemonSetList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/daemonset.DaemonSetList" } } } } }, "/api/v1/daemonset/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of DaemonSets in a namespaces", "operationId": "handleGetDaemonSetList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the DaemonSet", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/daemonset.DaemonSetList" } } } } }, "/api/v1/daemonset/{namespace}/{daemonSet}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about DaemonSet", "operationId": "handleGetDaemonSetDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the DaemonSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the DaemonSet", "name": "daemonSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/daemonset.DaemonSetDetail" } } } } }, "/api/v1/daemonset/{namespace}/{daemonSet}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for DaemonSet", "operationId": "handleGetDaemonSetEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the DaemonSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the DaemonSet", "name": "daemonSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/daemonset/{namespace}/{daemonSet}/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods for DaemonSet", "operationId": "handleGetDaemonSetPods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the DaemonSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the DaemonSet", "name": "daemonSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/daemonset/{namespace}/{daemonSet}/service": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Services for DaemonSet", "operationId": "handleGetDaemonSetServices", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the DaemonSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the DaemonSet", "name": "daemonSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/service.ServiceList" } } } } }, "/api/v1/deployment": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Deployments from all namespaces", "operationId": "handleGetDeployments", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.DeploymentList" } } } } }, "/api/v1/deployment/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Deployments in a namespaces", "operationId": "handleGetDeployments", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.DeploymentList" } } } } }, "/api/v1/deployment/{namespace}/{deployment}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Deployment", "operationId": "handleGetDeploymentDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.DeploymentDetail" } } } } }, "/api/v1/deployment/{namespace}/{deployment}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for Deployment", "operationId": "handleGetDeploymentEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/deployment/{namespace}/{deployment}/newreplicaset": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of new ReplicaSets for Deployment", "operationId": "handleGetDeploymentNewReplicaSet", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicaset.ReplicaSet" } } } } }, "/api/v1/deployment/{namespace}/{deployment}/oldreplicaset": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of old ReplicaSets for Deployment", "operationId": "handleGetDeploymentOldReplicaSets", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicaset.ReplicaSetList" } } } } }, "/api/v1/deployment/{namespace}/{deployment}/pause": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "pauses the Deployment", "operationId": "handleDeploymentPause", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.DeploymentDetail" } } } } }, "/api/v1/deployment/{namespace}/{deployment}/restart": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "rollout restart of the Deployment", "operationId": "handleDeploymentRestart", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.RolloutSpec" } } } } }, "/api/v1/deployment/{namespace}/{deployment}/resume": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "resumes the Deployment", "operationId": "handleDeploymentResume", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.DeploymentDetail" } } } } }, "/api/v1/deployment/{namespace}/{deployment}/rollback": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "rolls back the Deployment to the target revision", "operationId": "handleDeploymentRollback", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Deployment", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Deployment", "name": "deployment", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/deployment.RolloutSpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/deployment.RolloutSpec" } } } } }, "/api/v1/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events from all namespaces", "operationId": "handleGetEventList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/event/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events in a namespace", "operationId": "handleGetEventList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace to get Events from", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/horizontalpodautoscaler": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of HorizontalPodAutoscalers from all namespaces", "operationId": "handleGetHorizontalPodAutoscalerList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/horizontalpodautoscaler.HorizontalPodAutoscalerList" } } } } }, "/api/v1/horizontalpodautoscaler/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of HorizontalPodAutoscalers in a namespaces", "operationId": "handleGetHorizontalPodAutoscalerList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the HorizontalPodAutoscaler", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/horizontalpodautoscaler.HorizontalPodAutoscalerList" } } } } }, "/api/v1/horizontalpodautoscaler/{namespace}/{horizontalpodautoscaler}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about HorizontalPodAutoscaler", "operationId": "handleGetHorizontalPodAutoscalerDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the HorizontalPodAutoscaler", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the HorizontalPodAutoscaler", "name": "horizontalpodautoscaler", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/horizontalpodautoscaler.HorizontalPodAutoscalerDetail" } } } } }, "/api/v1/ingress": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Ingresses from all namespaces", "operationId": "handleGetIngressList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ingress.IngressList" } } } } }, "/api/v1/ingress/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Ingresses in a namespaces", "operationId": "handleGetIngressList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Ingress", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ingress.IngressList" } } } } }, "/api/v1/ingress/{namespace}/{ingress}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for Ingress", "operationId": "handleGetIngressEvent", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Ingress", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Ingress", "name": "ingress", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/ingress/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Ingress", "operationId": "handleGetIngressDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Ingress", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Ingress", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ingress.IngressDetail" } } } } }, "/api/v1/ingressclass": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of IngressClasses", "operationId": "handleGetIngressClassList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ingressclass.IngressClassList" } } } } }, "/api/v1/ingressclass/{ingressclass}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about IngressClass", "operationId": "handleGetIngressClass", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the IngressClass", "name": "ingressclass", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ingressclass.IngressClass" } } } } }, "/api/v1/integration/{name}/state": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "operationId": "handleGetState", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/job": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Jobs from all namespaces", "operationId": "handleGetJobList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/job.JobList" } } } } }, "/api/v1/job/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Jobs in a namespaces", "operationId": "handleGetJobList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Job", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/job.JobList" } } } } }, "/api/v1/job/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Job", "operationId": "handleGetJobDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Job", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Job", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/job.JobDetail" } } } } }, "/api/v1/job/{namespace}/{name}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for Job", "operationId": "handleGetJobEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Job", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Job", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/job/{namespace}/{name}/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods for Job", "operationId": "handleGetJobPods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Job", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Job", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/log/file/{namespace}/{pod}/{container}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a text file with logs from a Container", "operationId": "handleLogFile", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true }, { "type": "string", "description": "name of container in the Pod", "name": "container", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "integer" } } } } } }, "/api/v1/log/source/{namespace}/{resourceName}/{resourceType}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns log sources for a resource", "operationId": "handleLogSource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "resourceName", "in": "path", "required": true }, { "type": "string", "description": "type of the resource", "name": "resourceType", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/controller.LogSources" } } } } }, "/api/v1/log/{namespace}/{pod}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns logs from a Pod", "operationId": "handleLogs", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/logs.LogDetails" } } } } }, "/api/v1/log/{namespace}/{pod}/{container}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns logs from a Container", "operationId": "handleLogs", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true }, { "type": "string", "description": "name of container in the Pod", "name": "container", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/logs.LogDetails" } } } } }, "/api/v1/namespace": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Namespaces", "operationId": "handleGetNamespaces", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/namespace.NamespaceList" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "create a Namespace", "operationId": "handleCreateNamespace", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/namespace.NamespaceSpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/namespace.NamespaceSpec" } } } } }, "/api/v1/namespace/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Namespace", "operationId": "handleGetNamespaceDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the Namespace", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/namespace.NamespaceDetail" } } } } }, "/api/v1/namespace/{name}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for Namespace", "operationId": "handleGetNamespaceEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the Namespace", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/networkpolicy": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of NetworkPolicies from all namespaces", "operationId": "handleGetNetworkPolicyList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/networkpolicy.NetworkPolicyList" } } } } }, "/api/v1/networkpolicy/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of NetworkPolicies in a namespaces", "operationId": "handleGetNetworkPolicyList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the NetworkPolicy", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/networkpolicy.NetworkPolicyList" } } } } }, "/api/v1/networkpolicy/{namespace}/{networkpolicy}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about NetworkPolicy", "operationId": "handleGetNetworkPolicyDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the NetworkPolicy", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the NetworkPolicy", "name": "networkpolicy", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/networkpolicy.NetworkPolicyDetail" } } } } }, "/api/v1/node": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Nodes", "operationId": "handleGetNodeList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/node.NodeList" } } } } }, "/api/v1/node/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Node", "operationId": "handleGetNodeDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the Node", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/node.NodeDetail" } } } } }, "/api/v1/node/{name}/drain": { "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "drains Node", "operationId": "handleNodeDrain", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the Node", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/node.NodeDrainSpec" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/node/{name}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for Node", "operationId": "handleGetNodeEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the Node", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/node/{name}/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods for Node", "operationId": "handleGetNodePods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the Node", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/persistentvolume": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of PersistentVolumes from all namespaces", "operationId": "handleGetPersistentVolumeList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolume.PersistentVolumeList" } } } } }, "/api/v1/persistentvolume/namespace/{namespace}/name/{persistentvolume}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about PersistentVolume", "operationId": "handleGetPersistentVolumeDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the PersistentVolume", "name": "persistentvolume", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolume.PersistentVolumeDetail" } } } } }, "/api/v1/persistentvolume/{persistentvolume}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about PersistentVolume", "operationId": "handleGetPersistentVolumeDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the PersistentVolume", "name": "persistentvolume", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolume.PersistentVolumeDetail" } } } } }, "/api/v1/persistentvolumeclaim": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of PersistentVolumeClaim", "operationId": "handleGetPersistentVolumeClaimList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolumeclaim.PersistentVolumeClaimList" } } } } }, "/api/v1/persistentvolumeclaim/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of PersistentVolumeClaim from specified namespace", "operationId": "handleGetPersistentVolumeClaimList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the PersistentVolumeClaim", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolumeclaim.PersistentVolumeClaimList" } } } } }, "/api/v1/persistentvolumeclaim/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about PersistentVolumeClaim", "operationId": "handleGetPersistentVolumeClaimDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the PersistentVolumeClaim", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "namespace of the PersistentVolumeClaim", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolumeclaim.PersistentVolumeClaimDetail" } } } } }, "/api/v1/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods from all namespaces", "operationId": "handleGetPods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/pod/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods in a namespaces", "operationId": "handleGetPods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/pod/{namespace}/{pod}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Pod", "operationId": "handleGetPodDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodDetail" } } } } }, "/api/v1/pod/{namespace}/{pod}/container": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of containers for Pod", "operationId": "handleGetPodContainers", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodDetail" } } } } }, "/api/v1/pod/{namespace}/{pod}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for Pod", "operationId": "handleGetPodEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/pod/{namespace}/{pod}/persistentvolumeclaim": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of containers for Pod", "operationId": "handleGetPodPersistentVolumeClaims", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolumeclaim.PersistentVolumeClaimList" } } } } }, "/api/v1/pod/{namespace}/{pod}/shell/{container}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "handles exec into pod", "operationId": "handleExecShell", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Pod", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Pod", "name": "pod", "in": "path", "required": true }, { "type": "string", "description": "name of container in the Pod", "name": "container", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/handler.TerminalResponse" } } } } }, "/api/v1/replicaset": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ReplicaSets from all namespaces", "operationId": "handleGetReplicaSets", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicaset.ReplicaSetList" } } } } }, "/api/v1/replicaset/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ReplicaSets in a namespace", "operationId": "handleGetReplicaSets", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicaSets", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicaset.ReplicaSetList" } } } } }, "/api/v1/replicaset/{namespace}/{replicaSet}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about ReplicaSet", "operationId": "handleGetReplicaSetDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicaSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicaSets", "name": "replicaSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicaset.ReplicaSetDetail" } } } } }, "/api/v1/replicaset/{namespace}/{replicaSet}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for ReplicaSet", "operationId": "handleGetReplicaSetEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicaSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicaSets", "name": "replicaSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/replicaset/{namespace}/{replicaSet}/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods for ReplicaSet", "operationId": "handleGetReplicaSetPods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicaSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicaSets", "name": "replicaSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/replicaset/{namespace}/{replicaSet}/service": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Services for ReplicaSet", "operationId": "handleGetReplicaSetServices", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicaSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicaSets", "name": "replicaSet", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/service.ServiceList" } } } } }, "/api/v1/replicationcontroller": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ReplicationControllers from all namespaces", "operationId": "handleGetReplicationControllerList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicationcontroller.ReplicationControllerList" } } } } }, "/api/v1/replicationcontroller/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ReplicationController in a namespace", "operationId": "handleGetReplicationControllerList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace to get a list of ReplicationController from", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicationcontroller.ReplicationControllerList" } } } } }, "/api/v1/replicationcontroller/{namespace}/{replicationController}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about ReplicationController", "operationId": "handleGetReplicationControllerDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicationController", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicationController", "name": "replicationController", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/replicationcontroller.ReplicationControllerDetail" } } } } }, "/api/v1/replicationcontroller/{namespace}/{replicationController}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for ReplicationController", "operationId": "handleGetReplicationControllerEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicationController", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicationController", "name": "replicationController", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/replicationcontroller/{namespace}/{replicationController}/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods for ReplicationController", "operationId": "handleGetReplicationControllerPods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicationController", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicationController", "name": "replicationController", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/replicationcontroller/{namespace}/{replicationController}/service": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Services for ReplicationController", "operationId": "handleGetReplicationControllerServices", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicationController", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicationController", "name": "replicationController", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/service.ServiceList" } } } } }, "/api/v1/replicationcontroller/{namespace}/{replicationController}/update/pod": { "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "scales ReplicationController to a number of replicas", "operationId": "handleUpdateReplicasCount", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ReplicationController", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ReplicationController", "name": "replicationController", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/replicationcontroller.ReplicationControllerSpec" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/role": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Roles from all namespace", "operationId": "handleGetRoleList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/role.RoleList" } } } } }, "/api/v1/role/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Roles in a namespace", "operationId": "handleGetRoleList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Role", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/role.RoleList" } } } } }, "/api/v1/role/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Role", "operationId": "handleGetRoleDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Role", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Role", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/role.RoleDetail" } } } } }, "/api/v1/rolebinding": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of RoleBindings from all namespace", "operationId": "handleGetRoleBindingList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/rolebinding.RoleBindingList" } } } } }, "/api/v1/rolebinding/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of RoleBindings in a namespace", "operationId": "handleGetRoleBindingList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the RoleBinding", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/rolebinding.RoleBindingList" } } } } }, "/api/v1/rolebinding/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about RoleBinding", "operationId": "handleGetRoleBindingDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the RoleBinding", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the RoleBinding", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/rolebinding.RoleBindingDetail" } } } } }, "/api/v1/scale/{kind}/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a number of replicas of namespaced resource", "operationId": "handleGetReplicaCount", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "namespace of the resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/scaling.ReplicaCounts" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "scales a namespaced resource", "operationId": "handleScaleResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "namespace of the resource", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "desired number of replicas", "name": "scaleBy", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/scaling.ReplicaCounts" } } } } }, "/api/v1/scale/{kind}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a number of replicas of non-namespaced resource", "operationId": "handleGetReplicaCount", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/scaling.ReplicaCounts" } } } }, "put": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "scales a non-namespaced resource", "operationId": "handleScaleResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "name of the resource", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "desired number of replicas", "name": "scaleBy", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/scaling.ReplicaCounts" } } } } }, "/api/v1/secret": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Secrets from all namespaces", "operationId": "handleGetSecretList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/secret.SecretList" } } } }, "post": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "stores ImagePullSecret in a Kubernetes Secret", "operationId": "handleCreateImagePullSecret", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/secret.ImagePullSecretSpec" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/secret.Secret" } } } } }, "/api/v1/secret/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Secrets in a namespace", "operationId": "handleGetSecretList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Secret", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/secret.SecretList" } } } } }, "/api/v1/secret/{namespace}/{name}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Secret", "operationId": "handleGetSecretDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Secret", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Secret", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/secret.SecretDetail" } } } } }, "/api/v1/service": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Services from all namespaces", "operationId": "handleGetServiceList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/service.ServiceList" } } } } }, "/api/v1/service/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Services in a namespace", "operationId": "handleGetServiceList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Service", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/service.ServiceList" } } } } }, "/api/v1/service/{namespace}/{service}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about Service", "operationId": "handleGetServiceDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Service", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Service", "name": "service", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/service.ServiceDetail" } } } } }, "/api/v1/service/{namespace}/{service}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for Service", "operationId": "handleGetServiceEvent", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Service", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Service", "name": "service", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/service/{namespace}/{service}/ingress": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Ingresses for Service", "operationId": "handleGetServiceIngressList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Service", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Service", "name": "service", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ingress.IngressList" } } } } }, "/api/v1/service/{namespace}/{service}/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods for Service", "operationId": "handleGetServicePods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the Service", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the Service", "name": "service", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/serviceaccount": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ServiceAccounts from all namespaces", "operationId": "handleGetServiceAccountList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serviceaccount.ServiceAccountList" } } } } }, "/api/v1/serviceaccount/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ServiceAccounts in a namespaces", "operationId": "handleGetServiceAccountList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ServiceAccount", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serviceaccount.ServiceAccountList" } } } } }, "/api/v1/serviceaccount/{namespace}/{serviceaccount}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about ServiceAccount", "operationId": "handleGetServiceAccountDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ServiceAccount", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ServiceAccount", "name": "serviceaccount", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/serviceaccount.ServiceAccountDetail" } } } } }, "/api/v1/serviceaccount/{namespace}/{serviceaccount}/imagepullsecret": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of ImagePullSecret Secrets for ServiceAccount", "operationId": "handleGetServiceAccountImagePullSecrets", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ServiceAccount", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ServiceAccount", "name": "serviceaccount", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/secret.SecretList" } } } } }, "/api/v1/serviceaccount/{namespace}/{serviceaccount}/secret": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Secrets for ServiceAccount", "operationId": "handleGetServiceAccountSecrets", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the ServiceAccount", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the ServiceAccount", "name": "serviceaccount", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/secret.SecretList" } } } } }, "/api/v1/statefulset": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of StatefulSets from all namespaces", "operationId": "handleGetStatefulSetList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/statefulset.StatefulSetList" } } } } }, "/api/v1/statefulset/{namespace}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of StatefulSets in a namespaces", "operationId": "handleGetStatefulSetList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the StatefulSet", "name": "namespace", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/statefulset.StatefulSetList" } } } } }, "/api/v1/statefulset/{namespace}/{statefulset}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about StatefulSets", "operationId": "handleGetStatefulSetDetail", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the StatefulSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the StatefulSet", "name": "statefulset", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/statefulset.StatefulSetDetail" } } } } }, "/api/v1/statefulset/{namespace}/{statefulset}/event": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Events for StatefulSets", "operationId": "handleGetStatefulSetEvents", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the StatefulSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the StatefulSet", "name": "statefulset", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/common.EventList" } } } } }, "/api/v1/statefulset/{namespace}/{statefulset}/pod": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of Pods for StatefulSets", "operationId": "handleGetStatefulSetPods", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "namespace of the StatefulSet", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the StatefulSet", "name": "statefulset", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pod.PodList" } } } } }, "/api/v1/storageclass": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of StorageClasses", "operationId": "handleGetStorageClassList", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/storageclass.StorageClassList" } } } } }, "/api/v1/storageclass/{storageclass}": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns detailed information about StorageClass", "operationId": "handleGetStorageClass", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the StorageClass", "name": "storageclass", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/storageclass.StorageClass" } } } } }, "/api/v1/storageclass/{storageclass}/persistentvolume": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of PersistentVolumes assigned to StorageClass", "operationId": "handleGetStorageClassPersistentVolumes", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "name of the StorageClass", "name": "storageclass", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/persistentvolume.PersistentVolumeList" } } } } }, "/api/v1/{kind}/{namespace}/{name}/horizontalpodautoscaler": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "summary": "returns a list of HorizontalPodAutoscalers for resource", "operationId": "handleGetHorizontalPodAutoscalerListForResource", "parameters": [ { "type": "string", "description": "Comma delimited string used to apply filtering: 'propertyName,filterValue'", "name": "filterBy", "in": "query" }, { "type": "string", "description": "Name of the column to sort by", "name": "sortBy", "in": "query" }, { "type": "string", "description": "Number of items to return when pagination is applied", "name": "itemsPerPage", "in": "query" }, { "type": "string", "description": "Page number to return items from", "name": "page", "in": "query" }, { "type": "string", "description": "Metric names to download", "name": "metricNames", "in": "query" }, { "type": "string", "description": "Aggregations to be performed for each metric (default: sum)", "name": "aggregations", "in": "query" }, { "type": "string", "description": "kind of the resource to get HorizontalPodAutoscalers for", "name": "kind", "in": "path", "required": true }, { "type": "string", "description": "namespace of the resource to get HorizontalPodAutoscalers for", "name": "namespace", "in": "path", "required": true }, { "type": "string", "description": "name of the resource to get HorizontalPodAutoscalers for", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/horizontalpodautoscaler.HorizontalPodAutoscalerList" } } } } } }, "definitions": { "api.DataPoint": { "required": [ "x", "y" ], "properties": { "x": { "type": "integer", "format": "int64" }, "y": { "type": "integer", "format": "int64" } } }, "api.IntegrationState": { "required": [ "connected", "lastChecked", "error" ], "properties": { "connected": { "type": "boolean" }, "error": { "$ref": "#/definitions/error" }, "lastChecked": { "$ref": "#/definitions/v1.Time" } } }, "api.Metric": { "required": [ "dataPoints", "metricPoints", "metricName" ], "properties": { "aggregation": { "type": "string" }, "dataPoints": { "type": "array", "items": { "$ref": "#/definitions/api.DataPoint" } }, "metricName": { "type": "string" }, "metricPoints": { "type": "array", "items": { "$ref": "#/definitions/api.MetricPoint" } } } }, "api.MetricPoint": { "required": [ "timestamp", "value" ], "properties": { "timestamp": { "type": "string", "format": "date-time" }, "value": { "type": "integer", "format": "integer" } } }, "big.Int": { "required": [ "neg", "abs" ], "properties": { "abs": { "type": "array", "items": { "type": "integer", "format": "integer" } }, "neg": { "type": "boolean" } } }, "clusterrole.ClusterRole": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "clusterrole.ClusterRoleDetail": { "required": [ "objectMeta", "typeMeta", "rules", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "rules": { "type": "array", "items": { "$ref": "#/definitions/v1.PolicyRule" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "clusterrole.ClusterRoleList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/clusterrole.ClusterRole" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "clusterrolebinding.ClusterRoleBinding": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "clusterrolebinding.ClusterRoleBindingDetail": { "required": [ "objectMeta", "typeMeta", "roleRef", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "roleRef": { "$ref": "#/definitions/v1.RoleRef" }, "subjects": { "type": "array", "items": { "$ref": "#/definitions/v1.Subject" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "clusterrolebinding.ClusterRoleBindingList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/clusterrolebinding.ClusterRoleBinding" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "common.Condition": { "required": [ "type", "status", "lastProbeTime", "lastTransitionTime", "reason", "message" ], "properties": { "lastProbeTime": { "$ref": "#/definitions/v1.Time" }, "lastTransitionTime": { "$ref": "#/definitions/v1.Time" }, "message": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" } } }, "common.Endpoint": { "required": [ "host", "ports" ], "properties": { "host": { "type": "string" }, "ports": { "type": "array", "items": { "$ref": "#/definitions/common.ServicePort" } } } }, "common.Event": { "required": [ "objectMeta", "typeMeta", "message", "sourceComponent", "sourceHost", "object", "count", "firstSeen", "lastSeen", "reason", "type" ], "properties": { "count": { "type": "integer", "format": "int32" }, "firstSeen": { "$ref": "#/definitions/v1.Time" }, "lastSeen": { "$ref": "#/definitions/v1.Time" }, "message": { "type": "string" }, "object": { "type": "string" }, "objectKind": { "type": "string" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "objectName": { "type": "string" }, "objectNamespace": { "type": "string" }, "reason": { "type": "string" }, "sourceComponent": { "type": "string" }, "sourceHost": { "type": "string" }, "type": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "common.EventList": { "required": [ "listMeta", "events", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "events": { "type": "array", "items": { "$ref": "#/definitions/common.Event" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "common.PodInfo": { "required": [ "current", "running", "pending", "failed", "succeeded", "warnings" ], "properties": { "current": { "type": "integer", "format": "int32" }, "desired": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "running": { "type": "integer", "format": "int32" }, "succeeded": { "type": "integer", "format": "int32" }, "warnings": { "type": "array", "items": { "$ref": "#/definitions/common.Event" } } } }, "common.ResourceStatus": { "required": [ "running", "pending", "failed", "succeeded", "terminating" ], "properties": { "failed": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "running": { "type": "integer", "format": "int32" }, "succeeded": { "type": "integer", "format": "int32" }, "terminating": { "type": "integer", "format": "int32" } } }, "common.ServicePort": { "required": [ "port", "protocol", "nodePort" ], "properties": { "nodePort": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "protocol": { "type": "string" } } }, "configmap.ConfigMap": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "configmap.ConfigMapDetail": { "required": [ "typeMeta", "objectMeta" ], "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "configmap.ConfigMapList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/configmap.ConfigMap" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "controller.LogSources": { "required": [ "containerNames", "initContainerNames", "podNames" ], "properties": { "containerNames": { "type": "array", "items": { "type": "string" } }, "initContainerNames": { "type": "array", "items": { "type": "string" } }, "podNames": { "type": "array", "items": { "type": "string" } } } }, "controller.ResourceOwner": { "required": [ "objectMeta", "typeMeta", "pods", "containerImages", "initContainerImages" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "pods": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "cronjob.CronJob": { "required": [ "objectMeta", "typeMeta", "schedule", "suspend", "active", "lastSchedule", "containerImages" ], "properties": { "active": { "type": "integer", "format": "int32" }, "containerImages": { "type": "array", "items": { "type": "string" } }, "lastSchedule": { "$ref": "#/definitions/v1.Time" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "schedule": { "type": "string" }, "suspend": { "type": "boolean" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "cronjob.CronJobDetail": { "required": [ "active", "lastSchedule", "containerImages", "objectMeta", "typeMeta", "schedule", "suspend", "concurrencyPolicy", "startingDeadlineSeconds", "errors" ], "properties": { "active": { "type": "integer", "format": "int32" }, "concurrencyPolicy": { "type": "string" }, "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "lastSchedule": { "$ref": "#/definitions/v1.Time" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "schedule": { "type": "string" }, "startingDeadlineSeconds": { "type": "integer", "format": "int64" }, "suspend": { "type": "boolean" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "cronjob.CronJobList": { "required": [ "listMeta", "items", "status", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/cronjob.CronJob" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "csrf.Response": { "required": [ "token" ], "properties": { "token": { "type": "string" } } }, "daemonset.DaemonSet": { "required": [ "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "daemonset.DaemonSetDetail": { "required": [ "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages", "errors" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "labelSelector": { "$ref": "#/definitions/v1.LabelSelector" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "daemonset.DaemonSetList": { "required": [ "listMeta", "daemonSets", "cumulativeMetrics", "status", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "daemonSets": { "type": "array", "items": { "$ref": "#/definitions/daemonset.DaemonSet" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "deployment.AppDeploymentFromFileResponse": { "required": [ "name", "content", "error" ], "properties": { "content": { "type": "string" }, "error": { "type": "string" }, "name": { "type": "string" } } }, "deployment.AppDeploymentFromFileSpec": { "required": [ "name", "namespace", "content", "validate" ], "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "validate": { "type": "boolean" } } }, "deployment.AppDeploymentSpec": { "required": [ "name", "containerImage", "imagePullSecret", "containerCommand", "containerCommandArgs", "replicas", "portMappings", "variables", "isExternal", "description", "namespace", "memoryRequirement", "cpuRequirement", "labels", "runAsPrivileged" ], "properties": { "containerCommand": { "type": "string" }, "containerCommandArgs": { "type": "string" }, "containerImage": { "type": "string" }, "cpuRequirement": { "$ref": "#/definitions/resource.Quantity" }, "description": { "type": "string" }, "imagePullSecret": { "type": "string" }, "isExternal": { "type": "boolean" }, "labels": { "type": "array", "items": { "$ref": "#/definitions/deployment.Label" } }, "memoryRequirement": { "$ref": "#/definitions/resource.Quantity" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "portMappings": { "type": "array", "items": { "$ref": "#/definitions/deployment.PortMapping" } }, "replicas": { "type": "integer", "format": "int32" }, "runAsPrivileged": { "type": "boolean" }, "variables": { "type": "array", "items": { "$ref": "#/definitions/deployment.EnvironmentVariable" } } } }, "deployment.Deployment": { "required": [ "objectMeta", "typeMeta", "pods", "containerImages", "initContainerImages" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "pods": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "deployment.DeploymentDetail": { "required": [ "objectMeta", "typeMeta", "pods", "containerImages", "initContainerImages", "selector", "statusInfo", "conditions", "strategy", "minReadySeconds", "revisionHistoryLimit", "errors" ], "properties": { "conditions": { "type": "array", "items": { "$ref": "#/definitions/common.Condition" } }, "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "minReadySeconds": { "type": "integer", "format": "int32" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "pods": { "$ref": "#/definitions/common.PodInfo" }, "revisionHistoryLimit": { "type": "integer", "format": "int32" }, "rollingUpdateStrategy": { "$ref": "#/definitions/deployment.RollingUpdateStrategy" }, "selector": { "type": "object", "additionalProperties": { "type": "string" } }, "statusInfo": { "$ref": "#/definitions/deployment.StatusInfo" }, "strategy": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "deployment.DeploymentList": { "required": [ "listMeta", "cumulativeMetrics", "status", "deployments", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "deployments": { "type": "array", "items": { "$ref": "#/definitions/deployment.Deployment" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "deployment.EnvironmentVariable": { "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "deployment.Label": { "required": [ "key", "value" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "deployment.PortMapping": { "required": [ "port", "targetPort", "protocol" ], "properties": { "port": { "type": "integer", "format": "int32" }, "protocol": { "type": "string" }, "targetPort": { "type": "integer", "format": "int32" } } }, "deployment.Protocols": { "required": [ "protocols" ], "properties": { "protocols": { "type": "array", "items": { "type": "string" } } } }, "deployment.RollingUpdateStrategy": { "required": [ "maxSurge", "maxUnavailable" ], "properties": { "maxSurge": { "$ref": "#/definitions/intstr.IntOrString" }, "maxUnavailable": { "$ref": "#/definitions/intstr.IntOrString" } } }, "deployment.RolloutSpec": { "required": [ "revision" ], "properties": { "revision": { "type": "string" } } }, "deployment.StatusInfo": { "required": [ "replicas", "updated", "available", "unavailable" ], "properties": { "available": { "type": "integer", "format": "int32" }, "replicas": { "type": "integer", "format": "int32" }, "unavailable": { "type": "integer", "format": "int32" }, "updated": { "type": "integer", "format": "int32" } } }, "endpoint.Endpoint": { "required": [ "objectMeta", "typeMeta", "host", "nodeName", "ready", "ports" ], "properties": { "host": { "type": "string" }, "nodeName": { "type": "string" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "ports": { "type": "array", "items": { "$ref": "#/definitions/v1.EndpointPort" } }, "ready": { "type": "boolean" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "endpoint.EndpointList": { "required": [ "listMeta", "endpoints" ], "properties": { "endpoints": { "type": "array", "items": { "$ref": "#/definitions/endpoint.Endpoint" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "error": {}, "handler.TerminalResponse": { "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "horizontalpodautoscaler.HorizontalPodAutoscaler": { "required": [ "objectMeta", "typeMeta", "scaleTargetRef", "minReplicas", "maxReplicas", "currentCPUUtilizationPercentage", "targetCPUUtilizationPercentage" ], "properties": { "currentCPUUtilizationPercentage": { "type": "integer", "format": "int32" }, "maxReplicas": { "type": "integer", "format": "int32" }, "minReplicas": { "type": "integer", "format": "int32" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "scaleTargetRef": { "$ref": "#/definitions/horizontalpodautoscaler.ScaleTargetRef" }, "targetCPUUtilizationPercentage": { "type": "integer", "format": "int32" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "horizontalpodautoscaler.HorizontalPodAutoscalerDetail": { "required": [ "maxReplicas", "currentCPUUtilizationPercentage", "targetCPUUtilizationPercentage", "objectMeta", "typeMeta", "scaleTargetRef", "minReplicas", "currentReplicas", "desiredReplicas", "lastScaleTime" ], "properties": { "currentCPUUtilizationPercentage": { "type": "integer", "format": "int32" }, "currentReplicas": { "type": "integer", "format": "int32" }, "desiredReplicas": { "type": "integer", "format": "int32" }, "lastScaleTime": { "$ref": "#/definitions/v1.Time" }, "maxReplicas": { "type": "integer", "format": "int32" }, "minReplicas": { "type": "integer", "format": "int32" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "scaleTargetRef": { "$ref": "#/definitions/horizontalpodautoscaler.ScaleTargetRef" }, "targetCPUUtilizationPercentage": { "type": "integer", "format": "int32" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "horizontalpodautoscaler.HorizontalPodAutoscalerList": { "required": [ "listMeta", "horizontalpodautoscalers", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "horizontalpodautoscalers": { "type": "array", "items": { "$ref": "#/definitions/horizontalpodautoscaler.HorizontalPodAutoscaler" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "horizontalpodautoscaler.ScaleTargetRef": { "required": [ "kind", "name" ], "properties": { "kind": { "type": "string" }, "name": { "type": "string" } } }, "inf.Dec": { "required": [ "unscaled", "scale" ], "properties": { "scale": { "type": "integer", "format": "int32" }, "unscaled": { "$ref": "#/definitions/big.Int" } } }, "ingress.Ingress": { "required": [ "objectMeta", "typeMeta", "endpoints", "hosts" ], "properties": { "endpoints": { "type": "array", "items": { "$ref": "#/definitions/common.Endpoint" } }, "hosts": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "ingress.IngressDetail": { "required": [ "objectMeta", "typeMeta", "endpoints", "hosts", "spec", "status", "errors" ], "properties": { "endpoints": { "type": "array", "items": { "$ref": "#/definitions/common.Endpoint" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "hosts": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "spec": { "$ref": "#/definitions/v1.IngressSpec" }, "status": { "$ref": "#/definitions/v1.IngressStatus" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "ingress.IngressList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/ingress.Ingress" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "ingressclass.IngressClass": { "required": [ "objectMeta", "typeMeta", "controller" ], "properties": { "controller": { "type": "string" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "ingressclass.IngressClassList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/ingressclass.IngressClass" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "intstr.IntOrString": { "required": [ "Type", "IntVal", "StrVal" ], "properties": { "IntVal": { "type": "integer", "format": "int32" }, "StrVal": { "type": "string" }, "Type": { "type": "integer", "format": "int64" } } }, "job.Job": { "required": [ "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages", "parallelism", "jobStatus" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "jobStatus": { "$ref": "#/definitions/job.JobStatus" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "parallelism": { "type": "integer", "format": "int32" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "job.JobDetail": { "required": [ "parallelism", "jobStatus", "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages", "completions", "errors" ], "properties": { "completions": { "type": "integer", "format": "int32" }, "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "jobStatus": { "$ref": "#/definitions/job.JobStatus" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "parallelism": { "type": "integer", "format": "int32" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "job.JobList": { "required": [ "listMeta", "cumulativeMetrics", "status", "jobs", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "jobs": { "type": "array", "items": { "$ref": "#/definitions/job.Job" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "job.JobStatus": { "required": [ "status", "message", "conditions" ], "properties": { "conditions": { "type": "array", "items": { "$ref": "#/definitions/common.Condition" } }, "message": { "type": "string" }, "status": { "type": "string" } } }, "limitrange.LimitRangeItem": { "properties": { "default": { "type": "string" }, "defaultRequest": { "type": "string" }, "max": { "type": "string" }, "maxLimitRequestRatio": { "type": "string" }, "min": { "type": "string" }, "resourceName": { "type": "string" }, "resourceType": { "type": "string" } } }, "logs.LogDetails": { "required": [ "info", "selection", "logs" ], "properties": { "info": { "$ref": "#/definitions/logs.LogInfo" }, "logs": { "type": "array", "items": { "$ref": "#/definitions/logs.LogLine" } }, "selection": { "$ref": "#/definitions/logs.Selection" } } }, "logs.LogInfo": { "required": [ "podName", "containerName", "initContainerName", "fromDate", "toDate", "truncated" ], "properties": { "containerName": { "type": "string" }, "fromDate": { "type": "string" }, "initContainerName": { "type": "string" }, "podName": { "type": "string" }, "toDate": { "type": "string" }, "truncated": { "type": "boolean" } } }, "logs.LogLine": { "required": [ "timestamp", "content" ], "properties": { "content": { "type": "string" }, "timestamp": { "type": "string" } } }, "logs.LogLineId": { "required": [ "timestamp", "lineNum" ], "properties": { "lineNum": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string" } } }, "logs.Selection": { "required": [ "referencePoint", "offsetFrom", "offsetTo", "logFilePosition" ], "properties": { "logFilePosition": { "type": "string" }, "offsetFrom": { "type": "integer", "format": "int32" }, "offsetTo": { "type": "integer", "format": "int32" }, "referencePoint": { "$ref": "#/definitions/logs.LogLineId" } } }, "namespace.Namespace": { "required": [ "objectMeta", "typeMeta", "phase" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "phase": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "namespace.NamespaceDetail": { "required": [ "objectMeta", "typeMeta", "phase", "resourceQuotaList", "resourceLimits", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "phase": { "type": "string" }, "resourceLimits": { "type": "array", "items": { "$ref": "#/definitions/limitrange.LimitRangeItem" } }, "resourceQuotaList": { "$ref": "#/definitions/resourcequota.ResourceQuotaDetailList" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "namespace.NamespaceList": { "required": [ "listMeta", "namespaces", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "namespaces": { "type": "array", "items": { "$ref": "#/definitions/namespace.Namespace" } } } }, "namespace.NamespaceSpec": { "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "networkpolicy.NetworkPolicy": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "networkpolicy.NetworkPolicyDetail": { "required": [ "objectMeta", "typeMeta", "podSelector", "errors" ], "properties": { "egress": { "type": "array", "items": { "$ref": "#/definitions/v1.NetworkPolicyEgressRule" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "ingress": { "type": "array", "items": { "$ref": "#/definitions/v1.NetworkPolicyIngressRule" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podSelector": { "$ref": "#/definitions/v1.LabelSelector" }, "policyTypes": { "type": "array", "items": { "type": "string" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "networkpolicy.NetworkPolicyList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/networkpolicy.NetworkPolicy" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "node.Node": { "required": [ "objectMeta", "typeMeta", "ready", "allocatedResources" ], "properties": { "allocatedResources": { "$ref": "#/definitions/node.NodeAllocatedResources" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "ready": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "node.NodeAllocatedResources": { "required": [ "cpuRequests", "cpuRequestsFraction", "cpuLimits", "cpuLimitsFraction", "cpuCapacity", "memoryRequests", "memoryRequestsFraction", "memoryLimits", "memoryLimitsFraction", "memoryCapacity", "allocatedPods", "podCapacity", "podFraction" ], "properties": { "allocatedPods": { "type": "integer", "format": "int32" }, "cpuCapacity": { "type": "integer", "format": "int64" }, "cpuLimits": { "type": "integer", "format": "int64" }, "cpuLimitsFraction": { "type": "number", "format": "double" }, "cpuRequests": { "type": "integer", "format": "int64" }, "cpuRequestsFraction": { "type": "number", "format": "double" }, "memoryCapacity": { "type": "integer", "format": "int64" }, "memoryLimits": { "type": "integer", "format": "int64" }, "memoryLimitsFraction": { "type": "number", "format": "double" }, "memoryRequests": { "type": "integer", "format": "int64" }, "memoryRequestsFraction": { "type": "number", "format": "double" }, "podCapacity": { "type": "integer", "format": "int64" }, "podFraction": { "type": "number", "format": "double" } } }, "node.NodeDetail": { "required": [ "allocatedResources", "objectMeta", "typeMeta", "ready", "phase", "podCIDR", "providerID", "unschedulable", "nodeInfo", "conditions", "containerImages", "podList", "eventList", "metrics", "errors" ], "properties": { "addresses": { "type": "array", "items": { "$ref": "#/definitions/v1.NodeAddress" } }, "allocatedResources": { "$ref": "#/definitions/node.NodeAllocatedResources" }, "conditions": { "type": "array", "items": { "$ref": "#/definitions/common.Condition" } }, "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "eventList": { "$ref": "#/definitions/common.EventList" }, "metrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "nodeInfo": { "$ref": "#/definitions/v1.NodeSystemInfo" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "phase": { "type": "string" }, "podCIDR": { "type": "string" }, "podList": { "$ref": "#/definitions/pod.PodList" }, "providerID": { "type": "string" }, "ready": { "type": "string" }, "taints": { "type": "array", "items": { "$ref": "#/definitions/v1.Taint" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" }, "unschedulable": { "type": "boolean" } } }, "node.NodeDrainSpec": { "properties": { "deleteEmptyDirData": { "type": "boolean" }, "force": { "type": "boolean" }, "gracePeriodSeconds": { "type": "integer", "format": "int32" }, "ignoreAllDaemonSets": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int64" } } }, "node.NodeList": { "required": [ "listMeta", "nodes", "cumulativeMetrics", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "nodes": { "type": "array", "items": { "$ref": "#/definitions/node.Node" } } } }, "persistentvolume.PersistentVolume": { "required": [ "objectMeta", "typeMeta", "capacity", "accessModes", "reclaimPolicy", "storageClass", "mountOptions", "status", "claim", "reason" ], "properties": { "accessModes": { "type": "array", "items": { "type": "string" } }, "capacity": { "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "claim": { "type": "string" }, "mountOptions": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "reason": { "type": "string" }, "reclaimPolicy": { "type": "string" }, "status": { "type": "string" }, "storageClass": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "persistentvolume.PersistentVolumeDetail": { "required": [ "objectMeta", "typeMeta", "accessModes", "mountOptions", "capacity", "reclaimPolicy", "storageClass", "status", "claim", "reason", "message", "persistentVolumeSource" ], "properties": { "accessModes": { "type": "array", "items": { "type": "string" } }, "capacity": { "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "claim": { "type": "string" }, "message": { "type": "string" }, "mountOptions": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "persistentVolumeSource": { "$ref": "#/definitions/v1.PersistentVolumeSource" }, "reason": { "type": "string" }, "reclaimPolicy": { "type": "string" }, "status": { "type": "string" }, "storageClass": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "persistentvolume.PersistentVolumeList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/persistentvolume.PersistentVolume" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "persistentvolumeclaim.PersistentVolumeClaim": { "required": [ "objectMeta", "typeMeta", "status", "volume", "capacity", "accessModes", "storageClass" ], "properties": { "accessModes": { "type": "array", "items": { "type": "string" } }, "capacity": { "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "status": { "type": "string" }, "storageClass": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" }, "volume": { "type": "string" } } }, "persistentvolumeclaim.PersistentVolumeClaimDetail": { "required": [ "storageClass", "objectMeta", "typeMeta", "status", "volume", "capacity", "accessModes" ], "properties": { "accessModes": { "type": "array", "items": { "type": "string" } }, "capacity": { "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "status": { "type": "string" }, "storageClass": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" }, "volume": { "type": "string" } } }, "persistentvolumeclaim.PersistentVolumeClaimList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/persistentvolumeclaim.PersistentVolumeClaim" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "pod.Container": { "required": [ "name", "image", "env", "commands", "args", "volumeMounts", "securityContext", "status", "state", "livenessProbe", "readinessProbe", "startupProbe" ], "properties": { "args": { "type": "array", "items": { "type": "string" } }, "commands": { "type": "array", "items": { "type": "string" } }, "env": { "type": "array", "items": { "$ref": "#/definitions/pod.EnvVar" } }, "image": { "type": "string" }, "livenessProbe": { "$ref": "#/definitions/v1.Probe" }, "name": { "type": "string" }, "readinessProbe": { "$ref": "#/definitions/v1.Probe" }, "resources": { "$ref": "#/definitions/v1.ResourceRequirements" }, "securityContext": { "$ref": "#/definitions/v1.SecurityContext" }, "startupProbe": { "$ref": "#/definitions/v1.Probe" }, "state": { "type": "string" }, "status": { "$ref": "#/definitions/v1.ContainerStatus" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/definitions/pod.VolumeMount" } } } }, "pod.ContainerStatus": { "required": [ "name", "state", "ready" ], "properties": { "name": { "type": "string" }, "ready": { "type": "boolean" }, "state": { "type": "string" } } }, "pod.EnvVar": { "required": [ "name", "value", "valueFrom" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "valueFrom": { "$ref": "#/definitions/v1.EnvVarSource" } } }, "pod.Pod": { "required": [ "objectMeta", "typeMeta", "status", "restartCount", "metrics", "warnings", "nodeName", "containerImages", "containerStatuses", "allocatedResources" ], "properties": { "allocatedResources": { "$ref": "#/definitions/pod.PodAllocatedResources" }, "containerImages": { "type": "array", "items": { "type": "string" } }, "containerStatuses": { "type": "array", "items": { "$ref": "#/definitions/pod.ContainerStatus" } }, "metrics": { "$ref": "#/definitions/pod.PodMetrics" }, "nodeName": { "type": "string" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "restartCount": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" }, "warnings": { "type": "array", "items": { "$ref": "#/definitions/common.Event" } } } }, "pod.PodAllocatedResources": { "required": [ "cpuRequests", "cpuLimits", "memoryRequests", "memoryLimits" ], "properties": { "cpuLimits": { "type": "integer", "format": "int64" }, "cpuRequests": { "type": "integer", "format": "int64" }, "memoryLimits": { "type": "integer", "format": "int64" }, "memoryRequests": { "type": "integer", "format": "int64" } } }, "pod.PodDetail": { "required": [ "objectMeta", "typeMeta", "podPhase", "podIP", "nodeName", "serviceAccountName", "restartCount", "qosClass", "containers", "initContainers", "metrics", "conditions", "eventList", "persistentVolumeClaimList", "securityContext", "errors" ], "properties": { "conditions": { "type": "array", "items": { "$ref": "#/definitions/common.Condition" } }, "containers": { "type": "array", "items": { "$ref": "#/definitions/pod.Container" } }, "controller": { "$ref": "#/definitions/controller.ResourceOwner" }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "eventList": { "$ref": "#/definitions/common.EventList" }, "imagePullSecrets": { "type": "array", "items": { "$ref": "#/definitions/v1.LocalObjectReference" } }, "initContainers": { "type": "array", "items": { "$ref": "#/definitions/pod.Container" } }, "metrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "nodeName": { "type": "string" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "persistentVolumeClaimList": { "$ref": "#/definitions/persistentvolumeclaim.PersistentVolumeClaimList" }, "podIP": { "type": "string" }, "podPhase": { "type": "string" }, "qosClass": { "type": "string" }, "restartCount": { "type": "integer", "format": "int32" }, "securityContext": { "$ref": "#/definitions/v1.PodSecurityContext" }, "serviceAccountName": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "pod.PodList": { "required": [ "listMeta", "cumulativeMetrics", "status", "pods", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "pods": { "type": "array", "items": { "$ref": "#/definitions/pod.Pod" } }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "pod.PodMetrics": { "required": [ "cpuUsage", "memoryUsage", "cpuUsageHistory", "memoryUsageHistory" ], "properties": { "cpuUsage": { "type": "integer", "format": "integer" }, "cpuUsageHistory": { "type": "array", "items": { "$ref": "#/definitions/api.MetricPoint" } }, "memoryUsage": { "type": "integer", "format": "integer" }, "memoryUsageHistory": { "type": "array", "items": { "$ref": "#/definitions/api.MetricPoint" } } } }, "pod.VolumeMount": { "required": [ "name", "readOnly", "mountPath", "subPath", "volume" ], "properties": { "mountPath": { "type": "string" }, "name": { "type": "string" }, "readOnly": { "type": "boolean" }, "subPath": { "type": "string" }, "volume": { "$ref": "#/definitions/v1.Volume" } } }, "replicaset.ReplicaSet": { "required": [ "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "replicaset.ReplicaSetDetail": { "required": [ "initContainerImages", "objectMeta", "typeMeta", "podInfo", "containerImages", "selector", "horizontalPodAutoscalerList", "errors" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "horizontalPodAutoscalerList": { "$ref": "#/definitions/horizontalpodautoscaler.HorizontalPodAutoscalerList" }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "selector": { "$ref": "#/definitions/v1.LabelSelector" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "replicaset.ReplicaSetList": { "required": [ "listMeta", "cumulativeMetrics", "status", "replicaSets", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "replicaSets": { "type": "array", "items": { "$ref": "#/definitions/replicaset.ReplicaSet" } }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "replicationcontroller.ReplicationController": { "required": [ "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "replicationcontroller.ReplicationControllerDetail": { "required": [ "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages", "labelSelector", "errors" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "labelSelector": { "type": "object", "additionalProperties": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "replicationcontroller.ReplicationControllerList": { "required": [ "listMeta", "cumulativeMetrics", "status", "replicationControllers", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "replicationControllers": { "type": "array", "items": { "$ref": "#/definitions/replicationcontroller.ReplicationController" } }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "replicationcontroller.ReplicationControllerSpec": { "required": [ "replicas" ], "properties": { "replicas": { "type": "integer", "format": "int32" } } }, "resource.Quantity": { "required": [ "i", "d", "s", "Format" ], "properties": { "Format": { "type": "string" }, "d": { "$ref": "#/definitions/resource.infDecAmount" }, "i": { "$ref": "#/definitions/resource.int64Amount" }, "s": { "type": "string" } } }, "resource.infDecAmount": { "required": [ "Dec" ], "properties": { "Dec": { "$ref": "#/definitions/inf.Dec" } } }, "resource.int64Amount": { "required": [ "value", "scale" ], "properties": { "scale": { "type": "integer", "format": "int32" }, "value": { "type": "integer", "format": "int64" } } }, "resourcequota.ResourceQuotaDetail": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "scopes": { "type": "array", "items": { "type": "string" } }, "statusList": { "type": "object", "additionalProperties": { "$ref": "#/definitions/resourcequota.ResourceStatus" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "resourcequota.ResourceQuotaDetailList": { "required": [ "listMeta", "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/resourcequota.ResourceQuotaDetail" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "resourcequota.ResourceStatus": { "properties": { "hard": { "type": "string" }, "used": { "type": "string" } } }, "role.Role": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "role.RoleDetail": { "required": [ "objectMeta", "typeMeta", "rules", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "rules": { "type": "array", "items": { "$ref": "#/definitions/v1.PolicyRule" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "role.RoleList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/role.Role" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "rolebinding.RoleBinding": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "rolebinding.RoleBindingDetail": { "required": [ "objectMeta", "typeMeta", "roleRef", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "roleRef": { "$ref": "#/definitions/v1.RoleRef" }, "subjects": { "type": "array", "items": { "$ref": "#/definitions/v1.Subject" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "rolebinding.RoleBindingList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/rolebinding.RoleBinding" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "scaling.ReplicaCounts": { "required": [ "desiredReplicas", "actualReplicas" ], "properties": { "actualReplicas": { "type": "integer", "format": "int32" }, "desiredReplicas": { "type": "integer", "format": "int32" } } }, "secret.ImagePullSecretSpec": { "required": [ "name", "namespace", "data" ], "properties": { "data": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" } } }, "secret.Secret": { "required": [ "objectMeta", "typeMeta", "type" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "type": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "secret.SecretDetail": { "required": [ "objectMeta", "typeMeta", "type", "data" ], "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "type": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "secret.SecretList": { "required": [ "listMeta", "secrets", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "secrets": { "type": "array", "items": { "$ref": "#/definitions/secret.Secret" } } } }, "service.Service": { "required": [ "objectMeta", "typeMeta", "internalEndpoint", "externalEndpoints", "selector", "type", "clusterIP" ], "properties": { "clusterIP": { "type": "string" }, "externalEndpoints": { "type": "array", "items": { "$ref": "#/definitions/common.Endpoint" } }, "internalEndpoint": { "$ref": "#/definitions/common.Endpoint" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "selector": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "service.ServiceDetail": { "required": [ "clusterIP", "objectMeta", "typeMeta", "internalEndpoint", "externalEndpoints", "selector", "type", "endpointList", "sessionAffinity", "errors" ], "properties": { "clusterIP": { "type": "string" }, "endpointList": { "$ref": "#/definitions/endpoint.EndpointList" }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "externalEndpoints": { "type": "array", "items": { "$ref": "#/definitions/common.Endpoint" } }, "internalEndpoint": { "$ref": "#/definitions/common.Endpoint" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "selector": { "type": "object", "additionalProperties": { "type": "string" } }, "sessionAffinity": { "type": "string" }, "type": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "service.ServiceList": { "required": [ "listMeta", "services", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "services": { "type": "array", "items": { "$ref": "#/definitions/service.Service" } } } }, "serviceaccount.ServiceAccount": { "required": [ "objectMeta", "typeMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "serviceaccount.ServiceAccountDetail": { "required": [ "objectMeta", "typeMeta", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "serviceaccount.ServiceAccountList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/serviceaccount.ServiceAccount" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "statefulset.StatefulSet": { "required": [ "objectMeta", "typeMeta", "podInfo", "containerImages", "initContainerImages" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "statefulset.StatefulSetDetail": { "required": [ "typeMeta", "podInfo", "containerImages", "initContainerImages", "objectMeta", "errors" ], "properties": { "containerImages": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "initContainerImages": { "type": "array", "items": { "type": "string" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "podInfo": { "$ref": "#/definitions/common.PodInfo" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "statefulset.StatefulSetList": { "required": [ "listMeta", "status", "statefulSets", "cumulativeMetrics", "errors" ], "properties": { "cumulativeMetrics": { "type": "array", "items": { "$ref": "#/definitions/api.Metric" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "statefulSets": { "type": "array", "items": { "$ref": "#/definitions/statefulset.StatefulSet" } }, "status": { "$ref": "#/definitions/common.ResourceStatus" } } }, "storageclass.StorageClass": { "required": [ "objectMeta", "typeMeta", "provisioner", "parameters" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "provisioner": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "storageclass.StorageClassList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/storageclass.StorageClass" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "types.CustomResourceDefinition": { "required": [ "objectMeta", "typeMeta", "group", "scope", "names", "established" ], "properties": { "established": { "type": "string" }, "group": { "type": "string" }, "names": { "$ref": "#/definitions/types.CustomResourceDefinitionNames" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "scope": { "type": "string" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" }, "version": { "type": "string" } } }, "types.CustomResourceDefinitionDetail": { "required": [ "scope", "names", "established", "objectMeta", "typeMeta", "group", "conditions", "objects", "subresources", "errors" ], "properties": { "conditions": { "type": "array", "items": { "$ref": "#/definitions/common.Condition" } }, "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "established": { "type": "string" }, "group": { "type": "string" }, "names": { "$ref": "#/definitions/types.CustomResourceDefinitionNames" }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "objects": { "$ref": "#/definitions/types.CustomResourceObjectList" }, "scope": { "type": "string" }, "subresources": { "type": "array", "items": { "type": "string" } }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" }, "version": { "type": "string" }, "versions": { "type": "array", "items": { "$ref": "#/definitions/types.CustomResourceDefinitionVersion" } } } }, "types.CustomResourceDefinitionList": { "required": [ "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/types.CustomResourceDefinition" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" } } }, "types.CustomResourceDefinitionNames": { "required": [ "plural", "kind" ], "properties": { "categories": { "type": "array", "items": { "type": "string" } }, "kind": { "type": "string" }, "listKind": { "type": "string" }, "plural": { "type": "string" }, "shortNames": { "type": "array", "items": { "type": "string" } }, "singular": { "type": "string" } } }, "types.CustomResourceDefinitionVersion": { "required": [ "name", "served", "storage" ], "properties": { "name": { "type": "string" }, "served": { "type": "boolean" }, "storage": { "type": "boolean" } } }, "types.CustomResourceObject": { "required": [ "typeMeta", "objectMeta" ], "properties": { "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "types.CustomResourceObjectDetail": { "required": [ "objectMeta", "typeMeta", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "objectMeta": { "$ref": "#/definitions/types.ObjectMeta" }, "typeMeta": { "$ref": "#/definitions/types.TypeMeta" } } }, "types.CustomResourceObjectList": { "required": [ "typeMeta", "listMeta", "items", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/error" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/types.CustomResourceObject" } }, "listMeta": { "$ref": "#/definitions/types.ListMeta" }, "typeMeta": { "$ref": "#/definitions/v1.TypeMeta" } } }, "types.ListMeta": { "required": [ "totalItems" ], "properties": { "totalItems": { "type": "integer", "format": "int32" } } }, "types.ObjectMeta": { "properties": { "annotations": { "type": "object", "additionalProperties": { "type": "string" } }, "creationTimestamp": { "$ref": "#/definitions/v1.Time" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "namespace": { "type": "string" }, "uid": { "type": "string" } } }, "types.TypeMeta": { "properties": { "kind": { "type": "string" }, "restartable": { "type": "boolean" }, "scalable": { "type": "boolean" } } }, "unstructured.Unstructured": { "required": [ "Object" ], "properties": { "Object": { "type": "object" } } }, "v1.AWSElasticBlockStoreVolumeSource": { "description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.", "required": [ "volumeID" ], "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": "string" }, "partition": { "description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).", "type": "integer", "format": "int32" }, "readOnly": { "description": "readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": "boolean" }, "volumeID": { "description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": "string" } } }, "v1.AppArmorProfile": { "description": "AppArmorProfile defines a pod or container's AppArmor settings.", "required": [ "type" ], "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is \"Localhost\".", "type": "string" }, "type": { "description": "type indicates which kind of AppArmor profile will be applied. Valid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } } }, "v1.AzureDiskVolumeSource": { "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.", "required": [ "diskName", "diskURI" ], "properties": { "cachingMode": { "description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.", "type": "string" }, "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. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "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", "type": "string" }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" } } }, "v1.AzureFilePersistentVolumeSource": { "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", "required": [ "secretName", "shareName", "secretNamespace" ], "properties": { "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "secretName": { "description": "secretName is the name of secret that contains Azure Storage Account Name and Key", "type": "string" }, "secretNamespace": { "description": "secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod", "type": "string" }, "shareName": { "description": "shareName is the azure Share Name", "type": "string" } } }, "v1.AzureFileVolumeSource": { "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.", "required": [ "secretName", "shareName" ], "properties": { "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "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.CSIPersistentVolumeSource": { "description": "Represents storage that is managed by an external CSI volume driver (Beta feature)", "required": [ "driver", "volumeHandle" ], "properties": { "controllerExpandSecretRef": { "description": "controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.", "$ref": "#/definitions/v1.SecretReference" }, "controllerPublishSecretRef": { "description": "controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.", "$ref": "#/definitions/v1.SecretReference" }, "driver": { "description": "driver is the name of the driver to use for this volume. Required.", "type": "string" }, "fsType": { "description": "fsType to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\".", "type": "string" }, "nodeExpandSecretRef": { "description": "nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed.", "$ref": "#/definitions/v1.SecretReference" }, "nodePublishSecretRef": { "description": "nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.", "$ref": "#/definitions/v1.SecretReference" }, "nodeStageSecretRef": { "description": "nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.", "$ref": "#/definitions/v1.SecretReference" }, "readOnly": { "description": "readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write).", "type": "boolean" }, "volumeAttributes": { "description": "volumeAttributes of the volume to publish.", "type": "object", "additionalProperties": { "type": "string" } }, "volumeHandle": { "description": "volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required.", "type": "string" } } }, "v1.CSIVolumeSource": { "description": "Represents a source location of a volume to mount, managed by an external CSI driver", "required": [ "driver" ], "properties": { "driver": { "description": "driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.", "type": "string" }, "fsType": { "description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.", "type": "string" }, "nodePublishSecretRef": { "description": "nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.", "$ref": "#/definitions/v1.LocalObjectReference" }, "readOnly": { "description": "readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).", "type": "boolean" }, "volumeAttributes": { "description": "volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.", "type": "object", "additionalProperties": { "type": "string" } } } }, "v1.Capabilities": { "description": "Adds and removes POSIX capabilities from running containers.", "properties": { "add": { "description": "Added capabilities", "type": "array", "items": { "type": "string" } }, "drop": { "description": "Removed capabilities", "type": "array", "items": { "type": "string" } } } }, "v1.CephFSPersistentVolumeSource": { "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.", "required": [ "monitors" ], "properties": { "monitors": { "description": "monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "array", "items": { "type": "string" } }, "path": { "description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /", "type": "string" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "boolean" }, "secretFile": { "description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "string" }, "secretRef": { "description": "secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "$ref": "#/definitions/v1.SecretReference" }, "user": { "description": "user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "string" } } }, "v1.CephFSVolumeSource": { "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.", "required": [ "monitors" ], "properties": { "monitors": { "description": "monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "array", "items": { "type": "string" } }, "path": { "description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /", "type": "string" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "boolean" }, "secretFile": { "description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "string" }, "secretRef": { "description": "secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "$ref": "#/definitions/v1.LocalObjectReference" }, "user": { "description": "user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": "string" } } }, "v1.CinderPersistentVolumeSource": { "description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.", "required": [ "volumeID" ], "properties": { "fsType": { "description": "fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "boolean" }, "secretRef": { "description": "secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack.", "$ref": "#/definitions/v1.SecretReference" }, "volumeID": { "description": "volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" } } }, "v1.CinderVolumeSource": { "description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.", "required": [ "volumeID" ], "properties": { "fsType": { "description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "boolean" }, "secretRef": { "description": "secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.", "$ref": "#/definitions/v1.LocalObjectReference" }, "volumeID": { "description": "volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" } } }, "v1.ClusterTrustBundleProjection": { "description": "ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.", "required": [ "path" ], "properties": { "labelSelector": { "description": "Select all ClusterTrustBundles that match this label selector. Only has effect if signerName is set. Mutually-exclusive with name. If unset, interpreted as \"match nothing\". If set but empty, interpreted as \"match everything\".", "$ref": "#/definitions/v1.LabelSelector" }, "name": { "description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.", "type": "string" }, "optional": { "description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.", "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. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.", "type": "string" } } }, "v1.ConfigMapKeySelector": { "description": "Selects a key from a ConfigMap.", "required": [ "key" ], "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": "boolean" } } }, "v1.ConfigMapProjection": { "description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined", "type": "boolean" } } }, "v1.ConfigMapVolumeSource": { "description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "description": "defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "type": "integer", "format": "int32" }, "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined", "type": "boolean" } } }, "v1.ContainerState": { "description": "ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.", "properties": { "running": { "description": "Details about a running container", "$ref": "#/definitions/v1.ContainerStateRunning" }, "terminated": { "description": "Details about a terminated container", "$ref": "#/definitions/v1.ContainerStateTerminated" }, "waiting": { "description": "Details about a waiting container", "$ref": "#/definitions/v1.ContainerStateWaiting" } } }, "v1.ContainerStateRunning": { "description": "ContainerStateRunning is a running state of a container.", "properties": { "startedAt": { "description": "Time at which the container was last (re-)started", "$ref": "#/definitions/v1.Time" } } }, "v1.ContainerStateTerminated": { "description": "ContainerStateTerminated is a terminated state of a container.", "required": [ "exitCode" ], "properties": { "containerID": { "description": "Container's ID in the format '\u003ctype\u003e://\u003ccontainer_id\u003e'", "type": "string" }, "exitCode": { "description": "Exit status from the last termination of the container", "type": "integer", "format": "int32" }, "finishedAt": { "description": "Time at which the container last terminated", "$ref": "#/definitions/v1.Time" }, "message": { "description": "Message regarding the last termination of the container", "type": "string" }, "reason": { "description": "(brief) reason from the last termination of the container", "type": "string" }, "signal": { "description": "Signal from the last termination of the container", "type": "integer", "format": "int32" }, "startedAt": { "description": "Time at which previous execution of the container started", "$ref": "#/definitions/v1.Time" } } }, "v1.ContainerStateWaiting": { "description": "ContainerStateWaiting is a waiting state of a container.", "properties": { "message": { "description": "Message regarding why the container is not yet running.", "type": "string" }, "reason": { "description": "(brief) reason the container is not yet running.", "type": "string" } } }, "v1.ContainerStatus": { "description": "ContainerStatus contains details for the current status of this container.", "required": [ "name", "ready", "restartCount", "image", "imageID" ], "properties": { "allocatedResources": { "description": "AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.", "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "containerID": { "description": "ContainerID is the ID of the container in the format '\u003ctype\u003e://\u003ccontainer_id\u003e'. Where type is a container runtime identifier, returned from Version call of CRI API (for example \"containerd\").", "type": "string" }, "image": { "description": "Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images.", "type": "string" }, "imageID": { "description": "ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.", "type": "string" }, "lastState": { "description": "LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.", "$ref": "#/definitions/v1.ContainerState" }, "name": { "description": "Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.", "type": "string" }, "ready": { "description": "Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field).\n\nThe value is typically used to determine whether a container is ready to accept traffic.", "type": "boolean" }, "resources": { "description": "Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.", "$ref": "#/definitions/v1.ResourceRequirements" }, "restartCount": { "description": "RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.", "type": "integer", "format": "int32" }, "started": { "description": "Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.", "type": "boolean" }, "state": { "description": "State holds details about the container's current condition.", "$ref": "#/definitions/v1.ContainerState" }, "volumeMounts": { "description": "Status of volume mounts.", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeMountStatus" } } } }, "v1.DownwardAPIProjection": { "description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.", "properties": { "items": { "description": "Items is a list of DownwardAPIVolume file", "type": "array", "items": { "$ref": "#/definitions/v1.DownwardAPIVolumeFile" } } } }, "v1.DownwardAPIVolumeFile": { "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field", "required": [ "path" ], "properties": { "fieldRef": { "description": "Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.", "$ref": "#/definitions/v1.ObjectFieldSelector" }, "mode": { "description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "type": "integer", "format": "int32" }, "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 (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.", "$ref": "#/definitions/v1.ResourceFieldSelector" } } }, "v1.DownwardAPIVolumeSource": { "description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "type": "integer", "format": "int32" }, "items": { "description": "Items is a list of downward API volume file", "type": "array", "items": { "$ref": "#/definitions/v1.DownwardAPIVolumeFile" } } } }, "v1.EmptyDirVolumeSource": { "description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "type": "string" }, "sizeLimit": { "description": "sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "$ref": "#/definitions/resource.Quantity" } } }, "v1.EndpointPort": { "description": "EndpointPort is a tuple that describes a single port.", "required": [ "port" ], "properties": { "appProtocol": { "description": "The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either:\n\n* Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names).\n\n* Kubernetes-defined prefixed names:\n * 'kubernetes.io/h2c' - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior-\n * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455\n * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455\n\n* Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol.", "type": "string" }, "name": { "description": "The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined.", "type": "string" }, "port": { "description": "The port number of the endpoint.", "type": "integer", "format": "int32" }, "protocol": { "description": "The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP.", "type": "string" } } }, "v1.EnvVarSource": { "description": "EnvVarSource represents a source for the value of an EnvVar.", "properties": { "configMapKeyRef": { "description": "Selects a key of a ConfigMap.", "$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']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.", "$ref": "#/definitions/v1.ObjectFieldSelector" }, "resourceFieldRef": { "description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.", "$ref": "#/definitions/v1.ResourceFieldSelector" }, "secretKeyRef": { "description": "Selects a key of a secret in the pod's namespace", "$ref": "#/definitions/v1.SecretKeySelector" } } }, "v1.EphemeralVolumeSource": { "description": "Represents an ephemeral volume that is handled by a normal storage driver.", "properties": { "volumeClaimTemplate": { "description": "Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `\u003cpod name\u003e-\u003cvolume name\u003e` where `\u003cvolume name\u003e` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.\n\nRequired, must not be nil.", "$ref": "#/definitions/v1.PersistentVolumeClaimTemplate" } } }, "v1.ExecAction": { "description": "ExecAction describes a \"run in container\" action.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.", "type": "array", "items": { "type": "string" } } } }, "v1.FCVolumeSource": { "description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "lun": { "description": "lun is Optional: FC target lun number", "type": "integer", "format": "int32" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "targetWWNs": { "description": "targetWWNs is Optional: FC target worldwide names (WWNs)", "type": "array", "items": { "type": "string" } }, "wwids": { "description": "wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.", "type": "array", "items": { "type": "string" } } } }, "v1.FieldsV1": { "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:\u003cname\u003e', where \u003cname\u003e is the name of a field in a struct, or key in a map 'v:\u003cvalue\u003e', where \u003cvalue\u003e is the exact json formatted value of a list item 'i:\u003cindex\u003e', where \u003cindex\u003e is position of a item in a list 'k:\u003ckeys\u003e', where \u003ckeys\u003e is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff" }, "v1.FlexPersistentVolumeSource": { "description": "FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.", "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. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.", "type": "string" }, "options": { "description": "options is Optional: this field holds extra command options if any.", "type": "object", "additionalProperties": { "type": "string" } }, "readOnly": { "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "secretRef": { "description": "secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.", "$ref": "#/definitions/v1.SecretReference" } } }, "v1.FlexVolumeSource": { "description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.", "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. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.", "type": "string" }, "options": { "description": "options is Optional: this field holds extra command options if any.", "type": "object", "additionalProperties": { "type": "string" } }, "readOnly": { "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "secretRef": { "description": "secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.", "$ref": "#/definitions/v1.LocalObjectReference" } } }, "v1.FlockerVolumeSource": { "description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.", "properties": { "datasetName": { "description": "datasetName is Name of the dataset stored as metadata -\u003e name on the dataset for Flocker should be considered as deprecated", "type": "string" }, "datasetUUID": { "description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset", "type": "string" } } }, "v1.GCEPersistentDiskVolumeSource": { "description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.", "required": [ "pdName" ], "properties": { "fsType": { "description": "fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "string" }, "partition": { "description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "integer", "format": "int32" }, "pdName": { "description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "boolean" } } }, "v1.GRPCAction": { "required": [ "port", "service" ], "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "type": "integer", "format": "int32" }, "service": { "description": "Service is the name of the service to place in the gRPC HealthCheckRequest (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.", "type": "string" } } }, "v1.GitRepoVolumeSource": { "description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.", "required": [ "repository" ], "properties": { "directory": { "description": "directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", "type": "string" }, "repository": { "description": "repository is the URL", "type": "string" }, "revision": { "description": "revision is the commit hash for the specified revision.", "type": "string" } } }, "v1.GlusterfsPersistentVolumeSource": { "description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.", "required": [ "endpoints", "path" ], "properties": { "endpoints": { "description": "endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "endpointsNamespace": { "description": "endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "path": { "description": "path is the Glusterfs volume path. More 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. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "boolean" } } }, "v1.GlusterfsVolumeSource": { "description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.", "required": [ "endpoints", "path" ], "properties": { "endpoints": { "description": "endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "path": { "description": "path is the Glusterfs volume path. More 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. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "boolean" } } }, "v1.HTTPGetAction": { "description": "HTTPGetAction describes an action based on HTTP Get requests.", "required": [ "port" ], "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.", "type": "string" }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "type": "array", "items": { "$ref": "#/definitions/v1.HTTPHeader" } }, "path": { "description": "Path to access on the HTTP server.", "type": "string" }, "port": { "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.", "$ref": "#/definitions/intstr.IntOrString" }, "scheme": { "description": "Scheme to use for connecting to the host. Defaults to HTTP.", "type": "string" } } }, "v1.HTTPHeader": { "description": "HTTPHeader describes a custom header to be used in HTTP probes", "required": [ "name", "value" ], "properties": { "name": { "description": "The header field name. This 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.HTTPIngressPath": { "description": "HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.", "required": [ "pathType", "backend" ], "properties": { "backend": { "description": "backend defines the referenced service endpoint to which the traffic will be forwarded to.", "$ref": "#/definitions/v1.IngressBackend" }, "path": { "description": "path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value \"Exact\" or \"Prefix\".", "type": "string" }, "pathType": { "description": "pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.", "type": "string" } } }, "v1.HTTPIngressRuleValue": { "description": "HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://\u003chost\u003e/\u003cpath\u003e?\u003csearchpart\u003e -\u003e backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.", "required": [ "paths" ], "properties": { "paths": { "description": "paths is a collection of paths that map requests to backends.", "type": "array", "items": { "$ref": "#/definitions/v1.HTTPIngressPath" } } } }, "v1.HostPathVolumeSource": { "description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.", "required": [ "path" ], "properties": { "path": { "description": "path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "type": "string" }, "type": { "description": "type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "type": "string" } } }, "v1.IPBlock": { "description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.", "required": [ "cidr" ], "properties": { "cidr": { "description": "cidr is a string representing the IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"", "type": "string" }, "except": { "description": "except is a slice of CIDRs that should not be included within an IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the cidr range", "type": "array", "items": { "type": "string" } } } }, "v1.ISCSIPersistentVolumeSource": { "description": "ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.", "required": [ "targetPortal", "iqn", "lun" ], "properties": { "chapAuthDiscovery": { "description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication", "type": "boolean" }, "chapAuthSession": { "description": "chapAuthSession defines whether support iSCSI Session CHAP authentication", "type": "boolean" }, "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi", "type": "string" }, "initiatorName": { "description": "initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \u003ctarget portal\u003e:\u003cvolume name\u003e will be created for the connection.", "type": "string" }, "iqn": { "description": "iqn is Target iSCSI Qualified Name.", "type": "string" }, "iscsiInterface": { "description": "iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).", "type": "string" }, "lun": { "description": "lun is iSCSI Target Lun number.", "type": "integer", "format": "int32" }, "portals": { "description": "portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "type": "array", "items": { "type": "string" } }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.", "type": "boolean" }, "secretRef": { "description": "secretRef is the CHAP Secret for iSCSI target and initiator authentication", "$ref": "#/definitions/v1.SecretReference" }, "targetPortal": { "description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "type": "string" } } }, "v1.ISCSIVolumeSource": { "description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.", "required": [ "targetPortal", "iqn", "lun" ], "properties": { "chapAuthDiscovery": { "description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication", "type": "boolean" }, "chapAuthSession": { "description": "chapAuthSession defines whether support iSCSI Session CHAP authentication", "type": "boolean" }, "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi", "type": "string" }, "initiatorName": { "description": "initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface \u003ctarget portal\u003e:\u003cvolume name\u003e will be created for the connection.", "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. Defaults to 'default' (tcp).", "type": "string" }, "lun": { "description": "lun represents iSCSI Target Lun number.", "type": "integer", "format": "int32" }, "portals": { "description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "type": "array", "items": { "type": "string" } }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.", "type": "boolean" }, "secretRef": { "description": "secretRef is the CHAP Secret for iSCSI target and initiator authentication", "$ref": "#/definitions/v1.LocalObjectReference" }, "targetPortal": { "description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).", "type": "string" } } }, "v1.IngressBackend": { "description": "IngressBackend describes all endpoints for a given service and port.", "properties": { "resource": { "description": "resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with \"Service\".", "$ref": "#/definitions/v1.TypedLocalObjectReference" }, "service": { "description": "service references a service as a backend. This is a mutually exclusive setting with \"Resource\".", "$ref": "#/definitions/v1.IngressServiceBackend" } } }, "v1.IngressLoadBalancerIngress": { "description": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.", "properties": { "hostname": { "description": "hostname is set for load-balancer ingress points that are DNS based.", "type": "string" }, "ip": { "description": "ip is set for load-balancer ingress points that are IP based.", "type": "string" }, "ports": { "description": "ports provides information about the ports exposed by this LoadBalancer.", "type": "array", "items": { "$ref": "#/definitions/v1.IngressPortStatus" } } } }, "v1.IngressLoadBalancerStatus": { "description": "IngressLoadBalancerStatus represents the status of a load-balancer.", "properties": { "ingress": { "description": "ingress is a list containing ingress points for the load-balancer.", "type": "array", "items": { "$ref": "#/definitions/v1.IngressLoadBalancerIngress" } } } }, "v1.IngressPortStatus": { "description": "IngressPortStatus represents the error condition of a service port", "required": [ "port", "protocol" ], "properties": { "error": { "description": "error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.", "type": "string" }, "port": { "description": "port is the port number of the ingress port.", "type": "integer", "format": "int32" }, "protocol": { "description": "protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"", "type": "string" } } }, "v1.IngressRule": { "description": "IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.", "properties": { "host": { "description": "host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the \"host\" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.\n\nhost can be \"precise\" which is a domain name without the terminating dot of a network host (e.g. \"foo.bar.com\") or \"wildcard\", which is a domain name prefixed with a single wildcard label (e.g. \"*.foo.com\"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == \"*\"). Requests will be matched against the Host field in the following way: 1. If host is precise, the request matches this rule if the http host header is equal to Host. 2. If host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.", "type": "string" }, "http": { "$ref": "#/definitions/v1.HTTPIngressRuleValue" } } }, "v1.IngressServiceBackend": { "description": "IngressServiceBackend references a Kubernetes Service as a Backend.", "required": [ "name" ], "properties": { "name": { "description": "name is the referenced service. The service must exist in the same namespace as the Ingress object.", "type": "string" }, "port": { "description": "port of the referenced service. A port name or port number is required for a IngressServiceBackend.", "$ref": "#/definitions/v1.ServiceBackendPort" } } }, "v1.IngressSpec": { "description": "IngressSpec describes the Ingress the user wishes to exist.", "properties": { "defaultBackend": { "description": "defaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller.", "$ref": "#/definitions/v1.IngressBackend" }, "ingressClassName": { "description": "ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -\u003e IngressClass -\u003e Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.", "type": "string" }, "rules": { "description": "rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.", "type": "array", "items": { "$ref": "#/definitions/v1.IngressRule" } }, "tls": { "description": "tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.", "type": "array", "items": { "$ref": "#/definitions/v1.IngressTLS" } } } }, "v1.IngressStatus": { "description": "IngressStatus describe the current state of the Ingress.", "properties": { "loadBalancer": { "description": "loadBalancer contains the current status of the load-balancer.", "$ref": "#/definitions/v1.IngressLoadBalancerStatus" } } }, "v1.IngressTLS": { "description": "IngressTLS describes the transport layer security associated with an ingress.", "properties": { "hosts": { "description": "hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.", "type": "array", "items": { "type": "string" } }, "secretName": { "description": "secretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the \"Host\" header field used by an IngressRule, the SNI host is used for termination and value of the \"Host\" header is used for routing.", "type": "string" } } }, "v1.KeyToPath": { "description": "Maps a string key to a path within a volume.", "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. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "type": "integer", "format": "int32" }, "path": { "description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.", "type": "string" } } }, "v1.LabelSelector": { "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "type": "array", "items": { "$ref": "#/definitions/v1.LabelSelectorRequirement" } }, "matchLabels": { "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object", "additionalProperties": { "type": "string" } } } }, "v1.LabelSelectorRequirement": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", "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. Valid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.", "type": "array", "items": { "type": "string" } } } }, "v1.LocalObjectReference": { "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", "properties": { "name": { "description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" } } }, "v1.LocalVolumeSource": { "description": "Local represents directly-attached storage with node affinity (Beta feature)", "required": [ "path" ], "properties": { "fsType": { "description": "fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default value is to auto-select a filesystem if unspecified.", "type": "string" }, "path": { "description": "path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).", "type": "string" } } }, "v1.ManagedFieldsEntry": { "description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.", "properties": { "apiVersion": { "description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.", "type": "string" }, "fieldsType": { "description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"", "type": "string" }, "fieldsV1": { "description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.", "$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. The only valid values for this field are 'Apply' and 'Update'.", "type": "string" }, "subresource": { "description": "Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it 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 timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.", "$ref": "#/definitions/v1.Time" } } }, "v1.NFSVolumeSource": { "description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.", "required": [ "server", "path" ], "properties": { "path": { "description": "path that is exported by the NFS server. More 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. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "boolean" }, "server": { "description": "server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" } } }, "v1.NetworkPolicyEgressRule": { "description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8", "properties": { "ports": { "description": "ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "type": "array", "items": { "$ref": "#/definitions/v1.NetworkPolicyPort" } }, "to": { "description": "to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.", "type": "array", "items": { "$ref": "#/definitions/v1.NetworkPolicyPeer" } } } }, "v1.NetworkPolicyIngressRule": { "description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.", "properties": { "from": { "description": "from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.", "type": "array", "items": { "$ref": "#/definitions/v1.NetworkPolicyPeer" } }, "ports": { "description": "ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "type": "array", "items": { "$ref": "#/definitions/v1.NetworkPolicyPort" } } } }, "v1.NetworkPolicyPeer": { "description": "NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed", "properties": { "ipBlock": { "description": "ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.", "$ref": "#/definitions/v1.IPBlock" }, "namespaceSelector": { "description": "namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector.", "$ref": "#/definitions/v1.LabelSelector" }, "podSelector": { "description": "podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace.", "$ref": "#/definitions/v1.LabelSelector" } } }, "v1.NetworkPolicyPort": { "description": "NetworkPolicyPort describes a port to allow traffic on", "properties": { "endPort": { "description": "endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.", "type": "integer", "format": "int32" }, "port": { "description": "port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.", "$ref": "#/definitions/intstr.IntOrString" }, "protocol": { "description": "protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.", "type": "string" } } }, "v1.NodeAddress": { "description": "NodeAddress contains information for the node's address.", "required": [ "type", "address" ], "properties": { "address": { "description": "The node address.", "type": "string" }, "type": { "description": "Node address type, one of Hostname, ExternalIP or InternalIP.", "type": "string" } } }, "v1.NodeSystemInfo": { "description": "NodeSystemInfo is a set of ids/uuids to uniquely identify the node.", "required": [ "machineID", "systemUUID", "bootID", "kernelVersion", "osImage", "containerRuntimeVersion", "kubeletVersion", "kubeProxyVersion", "operatingSystem", "architecture" ], "properties": { "architecture": { "description": "The Architecture reported by the node", "type": "string" }, "bootID": { "description": "Boot ID reported by the node.", "type": "string" }, "containerRuntimeVersion": { "description": "ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).", "type": "string" }, "kernelVersion": { "description": "Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).", "type": "string" }, "kubeProxyVersion": { "description": "KubeProxy Version reported by the node.", "type": "string" }, "kubeletVersion": { "description": "Kubelet Version reported by the node.", "type": "string" }, "machineID": { "description": "MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html", "type": "string" }, "operatingSystem": { "description": "The Operating System reported by the node", "type": "string" }, "osImage": { "description": "OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).", "type": "string" }, "systemUUID": { "description": "SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid", "type": "string" } } }, "v1.ObjectFieldSelector": { "description": "ObjectFieldSelector selects an APIVersioned field of an object.", "required": [ "fieldPath" ], "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".", "type": "string" }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } } }, "v1.ObjectMeta": { "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.", "properties": { "annotations": { "description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations", "type": "object", "additionalProperties": { "type": "string" } }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "$ref": "#/definitions/v1.Time" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.", "type": "integer", "format": "int64" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "$ref": "#/definitions/v1.Time" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.", "type": "array", "items": { "type": "string" } }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique 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. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.", "type": "integer", "format": "int64" }, "labels": { "description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels", "type": "object", "additionalProperties": { "type": "string" } }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.", "type": "array", "items": { "$ref": "#/definitions/v1.ManagedFieldsEntry" } }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.", "type": "array", "items": { "$ref": "#/definitions/v1.OwnerReference" } }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.", "type": "string" }, "uid": { "description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids", "type": "string" } } }, "v1.ObjectReference": { "description": "ObjectReference contains enough information to let you inspect or modify the referred object.", "properties": { "apiVersion": { "description": "API version of the referent.", "type": "string" }, "fieldPath": { "description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.", "type": "string" }, "kind": { "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "name": { "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "namespace": { "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", "type": "string" }, "resourceVersion": { "description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency", "type": "string" }, "uid": { "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids", "type": "string" } } }, "v1.OwnerReference": { "description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.", "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 the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.", "type": "boolean" }, "controller": { "description": "If true, this reference points to the managing controller.", "type": "boolean" }, "kind": { "description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "name": { "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names", "type": "string" }, "uid": { "description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids", "type": "string" } } }, "v1.PersistentVolumeClaimSpec": { "description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "type": "array", "items": { "type": "string" } }, "dataSource": { "description": "dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.", "$ref": "#/definitions/v1.TypedLocalObjectReference" }, "dataSourceRef": { "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * 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. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "$ref": "#/definitions/v1.TypedObjectReference" }, "resources": { "description": "resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "$ref": "#/definitions/v1.VolumeResourceRequirements" }, "selector": { "description": "selector is a label query over volumes to consider for binding.", "$ref": "#/definitions/v1.LabelSelector" }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1", "type": "string" }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.", "type": "string" }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.", "type": "string" }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.", "type": "string" } } }, "v1.PersistentVolumeClaimTemplate": { "description": "PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.", "required": [ "spec" ], "properties": { "metadata": { "description": "May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation.", "$ref": "#/definitions/v1.ObjectMeta" }, "spec": { "description": "The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.", "$ref": "#/definitions/v1.PersistentVolumeClaimSpec" } } }, "v1.PersistentVolumeClaimVolumeSource": { "description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).", "required": [ "claimName" ], "properties": { "claimName": { "description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "type": "string" }, "readOnly": { "description": "readOnly Will force the ReadOnly setting in VolumeMounts. Default false.", "type": "boolean" } } }, "v1.PersistentVolumeSource": { "description": "PersistentVolumeSource is similar to VolumeSource but meant for the administrator who creates PVs. Exactly one of its members must be set.", "properties": { "awsElasticBlockStore": { "description": "awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "$ref": "#/definitions/v1.AWSElasticBlockStoreVolumeSource" }, "azureDisk": { "description": "azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.", "$ref": "#/definitions/v1.AzureDiskVolumeSource" }, "azureFile": { "description": "azureFile represents an Azure File Service mount on the host and bind mount to the pod.", "$ref": "#/definitions/v1.AzureFilePersistentVolumeSource" }, "cephfs": { "description": "cephFS represents a Ceph FS mount on the host that shares a pod's lifetime", "$ref": "#/definitions/v1.CephFSPersistentVolumeSource" }, "cinder": { "description": "cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "$ref": "#/definitions/v1.CinderPersistentVolumeSource" }, "csi": { "description": "csi represents storage that is handled by an external CSI driver (Beta feature).", "$ref": "#/definitions/v1.CSIPersistentVolumeSource" }, "fc": { "description": "fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.", "$ref": "#/definitions/v1.FCVolumeSource" }, "flexVolume": { "description": "flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.", "$ref": "#/definitions/v1.FlexPersistentVolumeSource" }, "flocker": { "description": "flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running", "$ref": "#/definitions/v1.FlockerVolumeSource" }, "gcePersistentDisk": { "description": "gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "$ref": "#/definitions/v1.GCEPersistentDiskVolumeSource" }, "glusterfs": { "description": "glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md", "$ref": "#/definitions/v1.GlusterfsPersistentVolumeSource" }, "hostPath": { "description": "hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "$ref": "#/definitions/v1.HostPathVolumeSource" }, "iscsi": { "description": "iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin.", "$ref": "#/definitions/v1.ISCSIPersistentVolumeSource" }, "local": { "description": "local represents directly-attached storage with node affinity", "$ref": "#/definitions/v1.LocalVolumeSource" }, "nfs": { "description": "nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "$ref": "#/definitions/v1.NFSVolumeSource" }, "photonPersistentDisk": { "description": "photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine", "$ref": "#/definitions/v1.PhotonPersistentDiskVolumeSource" }, "portworxVolume": { "description": "portworxVolume represents a portworx volume attached and mounted on kubelets host machine", "$ref": "#/definitions/v1.PortworxVolumeSource" }, "quobyte": { "description": "quobyte represents a Quobyte mount on the host that shares a pod's lifetime", "$ref": "#/definitions/v1.QuobyteVolumeSource" }, "rbd": { "description": "rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md", "$ref": "#/definitions/v1.RBDPersistentVolumeSource" }, "scaleIO": { "description": "scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.", "$ref": "#/definitions/v1.ScaleIOPersistentVolumeSource" }, "storageos": { "description": "storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md", "$ref": "#/definitions/v1.StorageOSPersistentVolumeSource" }, "vsphereVolume": { "description": "vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine", "$ref": "#/definitions/v1.VsphereVirtualDiskVolumeSource" } } }, "v1.PhotonPersistentDiskVolumeSource": { "description": "Represents a Photon Controller persistent disk resource.", "required": [ "pdID" ], "properties": { "fsType": { "description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"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.PodSecurityContext": { "description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.", "$ref": "#/definitions/v1.AppArmorProfile" }, "fsGroup": { "description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw ", "type": "integer", "format": "int64" }, "fsGroupChangePolicy": { "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used. Note that this field cannot be set when spec.os.name is windows.", "type": "string" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.", "type": "integer", "format": "int64" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.", "type": "integer", "format": "int64" }, "seLinuxOptions": { "description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.", "$ref": "#/definitions/v1.SELinuxOptions" }, "seccompProfile": { "description": "The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows.", "$ref": "#/definitions/v1.SeccompProfile" }, "supplementalGroups": { "description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "sysctls": { "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.", "type": "array", "items": { "$ref": "#/definitions/v1.Sysctl" } }, "windowsOptions": { "description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.", "$ref": "#/definitions/v1.WindowsSecurityContextOptions" } } }, "v1.PolicyRule": { "description": "PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.", "required": [ "verbs" ], "properties": { "apiGroups": { "description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.", "type": "array", "items": { "type": "string" } }, "nonResourceURLs": { "description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.", "type": "array", "items": { "type": "string" } }, "resourceNames": { "description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.", "type": "array", "items": { "type": "string" } }, "resources": { "description": "Resources is a list of resources this rule applies to. '*' represents all resources.", "type": "array", "items": { "type": "string" } }, "verbs": { "description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.", "type": "array", "items": { "type": "string" } } } }, "v1.PortworxVolumeSource": { "description": "PortworxVolumeSource represents a Portworx volume resource.", "required": [ "volumeID" ], "properties": { "fsType": { "description": "fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "volumeID": { "description": "volumeID uniquely identifies a Portworx volume", "type": "string" } } }, "v1.Probe": { "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "properties": { "exec": { "description": "Exec specifies the action to take.", "$ref": "#/definitions/v1.ExecAction" }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", "type": "integer", "format": "int32" }, "grpc": { "description": "GRPC specifies an action involving a GRPC port.", "$ref": "#/definitions/v1.GRPCAction" }, "httpGet": { "description": "HTTPGet specifies the http request to perform.", "$ref": "#/definitions/v1.HTTPGetAction" }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "type": "integer", "format": "int32" }, "periodSeconds": { "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.", "type": "integer", "format": "int32" }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", "type": "integer", "format": "int32" }, "tcpSocket": { "description": "TCPSocket specifies an action involving a TCP port.", "$ref": "#/definitions/v1.TCPSocketAction" }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "type": "integer", "format": "int64" }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "type": "integer", "format": "int32" } } }, "v1.ProjectedVolumeSource": { "description": "Represents a projected volume source", "required": [ "sources" ], "properties": { "defaultMode": { "description": "defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "type": "integer", "format": "int32" }, "sources": { "description": "sources is the list of volume projections", "type": "array", "items": { "$ref": "#/definitions/v1.VolumeProjection" } } } }, "v1.QuobyteVolumeSource": { "description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.", "required": [ "registry", "volume" ], "properties": { "group": { "description": "group to map volume access to Default is no group", "type": "string" }, "readOnly": { "description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.", "type": "boolean" }, "registry": { "description": "registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes", "type": "string" }, "tenant": { "description": "tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin", "type": "string" }, "user": { "description": "user to map volume access to Defaults to serivceaccount user", "type": "string" }, "volume": { "description": "volume is a string that references an already created Quobyte volume by name.", "type": "string" } } }, "v1.RBDPersistentVolumeSource": { "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.", "required": [ "monitors", "image" ], "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd", "type": "string" }, "image": { "description": "image is the rados image name. More 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. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" }, "monitors": { "description": "monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "array", "items": { "type": "string" } }, "pool": { "description": "pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "boolean" }, "secretRef": { "description": "secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "$ref": "#/definitions/v1.SecretReference" }, "user": { "description": "user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" } } }, "v1.RBDVolumeSource": { "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.", "required": [ "monitors", "image" ], "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd", "type": "string" }, "image": { "description": "image is the rados image name. More 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. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" }, "monitors": { "description": "monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "array", "items": { "type": "string" } }, "pool": { "description": "pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "boolean" }, "secretRef": { "description": "secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "$ref": "#/definitions/v1.LocalObjectReference" }, "user": { "description": "user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" } } }, "v1.ResourceClaim": { "description": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "required": [ "name" ], "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.", "type": "string" } } }, "v1.ResourceFieldSelector": { "description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format", "required": [ "resource" ], "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars", "type": "string" }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"", "$ref": "#/definitions/resource.Quantity" }, "resource": { "description": "Required: resource to select", "type": "string" } } }, "v1.ResourceRequirements": { "description": "ResourceRequirements describes the compute resource requirements.", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", "type": "array", "items": { "$ref": "#/definitions/v1.ResourceClaim" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "requests": { "description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } } } }, "v1.RoleRef": { "description": "RoleRef contains information that points to the role being used", "required": [ "apiGroup", "kind", "name" ], "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced", "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.SELinuxOptions": { "description": "SELinuxOptions are the labels to be applied to the container", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": "string" }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": "string" }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": "string" }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": "string" } } }, "v1.ScaleIOPersistentVolumeSource": { "description": "ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume", "required": [ "gateway", "system", "secretRef" ], "properties": { "fsType": { "description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"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.", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "secretRef": { "description": "secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.", "$ref": "#/definitions/v1.SecretReference" }, "sslEnabled": { "description": "sslEnabled is the flag to enable/disable SSL communication with Gateway, default false", "type": "boolean" }, "storageMode": { "description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.", "type": "string" }, "storagePool": { "description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.", "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 that is associated with this volume source.", "type": "string" } } }, "v1.ScaleIOVolumeSource": { "description": "ScaleIOVolumeSource represents a persistent ScaleIO volume", "required": [ "gateway", "system", "secretRef" ], "properties": { "fsType": { "description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"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.", "type": "string" }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "secretRef": { "description": "secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.", "$ref": "#/definitions/v1.LocalObjectReference" }, "sslEnabled": { "description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false", "type": "boolean" }, "storageMode": { "description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.", "type": "string" }, "storagePool": { "description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.", "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 that is associated with this volume source.", "type": "string" } } }, "v1.SeccompProfile": { "description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.", "required": [ "type" ], "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \"Localhost\". Must NOT be set for any other type.", "type": "string" }, "type": { "description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.", "type": "string" } } }, "v1.SecretKeySelector": { "description": "SecretKeySelector selects a key of a Secret.", "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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": "boolean" } } }, "v1.SecretProjection": { "description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "name": { "description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "optional": { "description": "optional field specify whether the Secret or its key must be defined", "type": "boolean" } } }, "v1.SecretReference": { "description": "SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace", "properties": { "name": { "description": "name is unique within a namespace to reference a secret resource.", "type": "string" }, "namespace": { "description": "namespace defines the space within which the secret name must be unique.", "type": "string" } } }, "v1.SecretVolumeSource": { "description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.", "properties": { "defaultMode": { "description": "defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "type": "integer", "format": "int32" }, "items": { "description": "items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.", "type": "array", "items": { "$ref": "#/definitions/v1.KeyToPath" } }, "optional": { "description": "optional field specify whether the Secret or its keys must be defined", "type": "boolean" }, "secretName": { "description": "secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret", "type": "string" } } }, "v1.SecurityContext": { "description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.", "properties": { "allowPrivilegeEscalation": { "description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.", "type": "boolean" }, "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by this container. If set, this profile overrides the pod's appArmorProfile. Note that this field cannot be set when spec.os.name is windows.", "$ref": "#/definitions/v1.AppArmorProfile" }, "capabilities": { "description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows.", "$ref": "#/definitions/v1.Capabilities" }, "privileged": { "description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.", "type": "boolean" }, "procMount": { "description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.", "type": "string" }, "readOnlyRootFilesystem": { "description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.", "type": "boolean" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.", "type": "integer", "format": "int64" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.", "type": "integer", "format": "int64" }, "seLinuxOptions": { "description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.", "$ref": "#/definitions/v1.SELinuxOptions" }, "seccompProfile": { "description": "The seccomp options to use by this container. If seccomp options are provided at both the pod \u0026 container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows.", "$ref": "#/definitions/v1.SeccompProfile" }, "windowsOptions": { "description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux.", "$ref": "#/definitions/v1.WindowsSecurityContextOptions" } } }, "v1.ServiceAccountTokenProjection": { "description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).", "required": [ "path" ], "properties": { "audience": { "description": "audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.", "type": "string" }, "expirationSeconds": { "description": "expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.", "type": "integer", "format": "int64" }, "path": { "description": "path is the path relative to the mount point of the file to project the token into.", "type": "string" } } }, "v1.ServiceBackendPort": { "description": "ServiceBackendPort is the service port being referenced.", "properties": { "name": { "description": "name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".", "type": "string" }, "number": { "description": "number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".", "type": "integer", "format": "int32" } } }, "v1.StorageOSPersistentVolumeSource": { "description": "Represents a StorageOS persistent volume resource.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "secretRef": { "description": "secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.", "$ref": "#/definitions/v1.ObjectReference" }, "volumeName": { "description": "volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.", "type": "string" }, "volumeNamespace": { "description": "volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.", "type": "string" } } }, "v1.StorageOSVolumeSource": { "description": "Represents a StorageOS persistent volume resource.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.", "type": "boolean" }, "secretRef": { "description": "secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.", "$ref": "#/definitions/v1.LocalObjectReference" }, "volumeName": { "description": "volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.", "type": "string" }, "volumeNamespace": { "description": "volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.", "type": "string" } } }, "v1.Subject": { "description": "Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.", "required": [ "kind", "name" ], "properties": { "apiGroup": { "description": "APIGroup holds the API group of the referenced subject. Defaults to \"\" for ServiceAccount subjects. Defaults to \"rbac.authorization.k8s.io\" for User and Group subjects.", "type": "string" }, "kind": { "description": "Kind of object being referenced. Values defined by this API group are \"User\", \"Group\", and \"ServiceAccount\". If the Authorizer does not recognized the kind value, the Authorizer should report an error.", "type": "string" }, "name": { "description": "Name of the object being referenced.", "type": "string" }, "namespace": { "description": "Namespace of the referenced object. If the object kind is non-namespace, such as \"User\" or \"Group\", and this value is not empty the Authorizer should report an error.", "type": "string" } } }, "v1.Sysctl": { "description": "Sysctl defines a kernel parameter to be set", "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": { "description": "TCPSocketAction describes an action based on opening a socket", "required": [ "port" ], "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": "string" }, "port": { "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.", "$ref": "#/definitions/intstr.IntOrString" } } }, "v1.Taint": { "description": "The node this Taint is attached to has the \"effect\" on any pod that does not tolerate the Taint.", "required": [ "key", "effect" ], "properties": { "effect": { "description": "Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.", "type": "string" }, "key": { "description": "Required. The taint key to be applied to a node.", "type": "string" }, "timeAdded": { "description": "TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.", "$ref": "#/definitions/v1.Time" }, "value": { "description": "The taint value corresponding to the taint key.", "type": "string" } } }, "v1.Time": { "required": [ "Time" ], "properties": { "Time": { "type": "string", "format": "date-time" } } }, "v1.TypeMeta": { "description": "TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" } } }, "v1.TypedLocalObjectReference": { "description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.", "required": [ "apiGroup", "kind", "name" ], "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.", "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": { "required": [ "apiGroup", "kind", "name" ], "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.", "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 Note 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. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "type": "string" } } }, "v1.Volume": { "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "required": [ "name" ], "properties": { "awsElasticBlockStore": { "description": "awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "$ref": "#/definitions/v1.AWSElasticBlockStoreVolumeSource" }, "azureDisk": { "description": "azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.", "$ref": "#/definitions/v1.AzureDiskVolumeSource" }, "azureFile": { "description": "azureFile represents an Azure File Service mount on the host and bind mount to the pod.", "$ref": "#/definitions/v1.AzureFileVolumeSource" }, "cephfs": { "description": "cephFS represents a Ceph FS mount on the host that shares a pod's lifetime", "$ref": "#/definitions/v1.CephFSVolumeSource" }, "cinder": { "description": "cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md", "$ref": "#/definitions/v1.CinderVolumeSource" }, "configMap": { "description": "configMap represents a configMap that should populate this volume", "$ref": "#/definitions/v1.ConfigMapVolumeSource" }, "csi": { "description": "csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).", "$ref": "#/definitions/v1.CSIVolumeSource" }, "downwardAPI": { "description": "downwardAPI represents downward API about the pod that should populate this volume", "$ref": "#/definitions/v1.DownwardAPIVolumeSource" }, "emptyDir": { "description": "emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "$ref": "#/definitions/v1.EmptyDirVolumeSource" }, "ephemeral": { "description": "ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.\n\nUse this if: a) the volume is only needed while the pod runs, b) 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 d) 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 APIs for volumes that persist for longer than the lifecycle of an individual pod.\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.\n\nA pod can use both types of ephemeral volumes and persistent volumes at the same time.", "$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.", "$ref": "#/definitions/v1.FCVolumeSource" }, "flexVolume": { "description": "flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.", "$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", "$ref": "#/definitions/v1.FlockerVolumeSource" }, "gcePersistentDisk": { "description": "gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "$ref": "#/definitions/v1.GCEPersistentDiskVolumeSource" }, "gitRepo": { "description": "gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.", "$ref": "#/definitions/v1.GitRepoVolumeSource" }, "glusterfs": { "description": "glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md", "$ref": "#/definitions/v1.GlusterfsVolumeSource" }, "hostPath": { "description": "hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "$ref": "#/definitions/v1.HostPathVolumeSource" }, "iscsi": { "description": "iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md", "$ref": "#/definitions/v1.ISCSIVolumeSource" }, "name": { "description": "name of the volume. Must be a DNS_LABEL and unique within the pod. More 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 More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "$ref": "#/definitions/v1.NFSVolumeSource" }, "persistentVolumeClaim": { "description": "persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "$ref": "#/definitions/v1.PersistentVolumeClaimVolumeSource" }, "photonPersistentDisk": { "description": "photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine", "$ref": "#/definitions/v1.PhotonPersistentDiskVolumeSource" }, "portworxVolume": { "description": "portworxVolume represents a portworx volume attached and mounted on kubelets host machine", "$ref": "#/definitions/v1.PortworxVolumeSource" }, "projected": { "description": "projected items for all in one resources secrets, configmaps, and downward API", "$ref": "#/definitions/v1.ProjectedVolumeSource" }, "quobyte": { "description": "quobyte represents a Quobyte mount on the host that shares a pod's lifetime", "$ref": "#/definitions/v1.QuobyteVolumeSource" }, "rbd": { "description": "rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md", "$ref": "#/definitions/v1.RBDVolumeSource" }, "scaleIO": { "description": "scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.", "$ref": "#/definitions/v1.ScaleIOVolumeSource" }, "secret": { "description": "secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret", "$ref": "#/definitions/v1.SecretVolumeSource" }, "storageos": { "description": "storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.", "$ref": "#/definitions/v1.StorageOSVolumeSource" }, "vsphereVolume": { "description": "vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine", "$ref": "#/definitions/v1.VsphereVirtualDiskVolumeSource" } } }, "v1.VolumeMountStatus": { "description": "VolumeMountStatus shows status of volume mounts.", "required": [ "name", "mountPath" ], "properties": { "mountPath": { "description": "MountPath corresponds to the original VolumeMount.", "type": "string" }, "name": { "description": "Name corresponds to the name of the original VolumeMount.", "type": "string" }, "readOnly": { "description": "ReadOnly corresponds to the original VolumeMount.", "type": "boolean" }, "recursiveReadOnly": { "description": "RecursiveReadOnly must be set to Disabled, Enabled, or unspecified (for non-readonly mounts). An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled, depending on the mount result.", "type": "string" } } }, "v1.VolumeProjection": { "description": "Projection that may be projected along with other supported volume types", "properties": { "clusterTrustBundle": { "description": "ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field of 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 combination of signer name and a label selector.\n\nKubelet performs aggressive normalization of the PEM contents written into the pod filesystem. Esoteric PEM features such as inter-block comments and block headers are stripped. Certificates are deduplicated. The ordering of certificates within the file is arbitrary, and Kubelet may change the order over time.", "$ref": "#/definitions/v1.ClusterTrustBundleProjection" }, "configMap": { "description": "configMap information about the configMap data to project", "$ref": "#/definitions/v1.ConfigMapProjection" }, "downwardAPI": { "description": "downwardAPI information about the downwardAPI data to project", "$ref": "#/definitions/v1.DownwardAPIProjection" }, "secret": { "description": "secret information about the secret data to project", "$ref": "#/definitions/v1.SecretProjection" }, "serviceAccountToken": { "description": "serviceAccountToken is information about the serviceAccountToken data to project", "$ref": "#/definitions/v1.ServiceAccountTokenProjection" } } }, "v1.VolumeResourceRequirements": { "description": "VolumeResourceRequirements describes the storage resource requirements for a volume.", "properties": { "limits": { "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } }, "requests": { "description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": "object", "additionalProperties": { "$ref": "#/definitions/resource.Quantity" } } } }, "v1.VsphereVirtualDiskVolumeSource": { "description": "Represents a vSphere volume resource.", "required": [ "volumePath" ], "properties": { "fsType": { "description": "fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "storagePolicyID": { "description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.", "type": "string" }, "storagePolicyName": { "description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.", "type": "string" }, "volumePath": { "description": "volumePath is the path that identifies vSphere volume vmdk", "type": "string" } } }, "v1.WindowsSecurityContextOptions": { "description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.", "type": "string" }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": "string" }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.", "type": "boolean" }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", "type": "string" } } }, "validation.AppNameValidity": { "required": [ "valid" ], "properties": { "valid": { "type": "boolean" } } }, "validation.AppNameValiditySpec": { "required": [ "name", "namespace" ], "properties": { "name": { "type": "string" }, "namespace": { "type": "string" } } }, "validation.ImageReferenceValidity": { "required": [ "valid", "reason" ], "properties": { "reason": { "type": "string" }, "valid": { "type": "boolean" } } }, "validation.ImageReferenceValiditySpec": { "required": [ "reference" ], "properties": { "reference": { "type": "string" } } }, "validation.ProtocolValidity": { "required": [ "valid" ], "properties": { "valid": { "type": "boolean" } } }, "validation.ProtocolValiditySpec": { "required": [ "protocol", "isExternal" ], "properties": { "isExternal": { "type": "boolean" }, "protocol": { "type": "string" } } } } }