From b1477ce16ce7f90bdad27ca11c6435ba354d625d Mon Sep 17 00:00:00 2001 From: Himenon Date: Fri, 13 Aug 2021 10:49:44 +0900 Subject: [PATCH 1/3] chore: add argo-rollout openapi sample --- scripts/testCodeGen.ts | 4 + test/argo-rollout/index.json | 4431 ++++++++++++++++++++++++++++++++++ 2 files changed, 4435 insertions(+) create mode 100644 test/argo-rollout/index.json diff --git a/scripts/testCodeGen.ts b/scripts/testCodeGen.ts index bd6088d3..0affc842 100644 --- a/scripts/testCodeGen.ts +++ b/scripts/testCodeGen.ts @@ -113,6 +113,10 @@ const main = () => { }); generateTypedefWithTemplateCode("test/infer.domain/index.yml", "test/code/typedef-with-template/infer.domain.ts", false, { sync: false }); + generateTypedefWithTemplateCode("test/argo-rollout/index.json", "test/code/typedef-with-template/argo-rollout.ts", false, { + sync: false, + }); + generateSplitCode("test/api.test.domain/index.yml", "test/code/split"); generateParameter("test/api.test.domain/index.yml", "test/code/parameter/api.test.domain.json"); diff --git a/test/argo-rollout/index.json b/test/argo-rollout/index.json new file mode 100644 index 00000000..f34a237a --- /dev/null +++ b/test/argo-rollout/index.json @@ -0,0 +1,4431 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "pkg/apiclient/rollout/rollout.proto", + "version": "version not set" + }, + "paths": { + "/api/v1/namespace": { + "get": { + "operationId": "RolloutService_GetNamespace", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.NamespaceInfo" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/info": { + "get": { + "operationId": "RolloutService_ListRolloutInfos", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.RolloutInfoList" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/info/watch": { + "get": { + "operationId": "RolloutService_WatchRolloutInfos", + "responses": { + "200": { + "description": "A successful response.(streaming responses)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/rollout.RolloutWatchEvent" + }, + "error": { + "$ref": "#/components/schemas/grpc.gateway.runtime.StreamError" + } + }, + "title": "Stream result of rollout.RolloutWatchEvent" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{name}/abort": { + "put": { + "operationId": "RolloutService_AbortRollout", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.Rollout" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.AbortRolloutRequest" + } + } + }, + "required": true + }, + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{name}/info": { + "get": { + "operationId": "RolloutService_GetRolloutInfo", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.RolloutInfo" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{name}/info/watch": { + "get": { + "operationId": "RolloutService_WatchRolloutInfo", + "responses": { + "200": { + "description": "A successful response.(streaming responses)", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/rollout.RolloutInfo" + }, + "error": { + "$ref": "#/components/schemas/grpc.gateway.runtime.StreamError" + } + }, + "title": "Stream result of rollout.RolloutInfo" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{name}/promote": { + "put": { + "operationId": "RolloutService_PromoteRollout", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.Rollout" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.PromoteRolloutRequest" + } + } + }, + "required": true + }, + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{name}/restart": { + "put": { + "operationId": "RolloutService_RestartRollout", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.Rollout" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.RestartRolloutRequest" + } + } + }, + "required": true + }, + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{name}/retry": { + "put": { + "operationId": "RolloutService_RetryRollout", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.Rollout" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.RetryRolloutRequest" + } + } + }, + "required": true + }, + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{rollout}/set/{container}/{image}/{tag}": { + "put": { + "operationId": "RolloutService_SetRolloutImage", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.Rollout" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "rollout", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "container", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "image", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tag", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.SetImageRequest" + } + } + }, + "required": true + }, + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/rollouts/{namespace}/{rollout}/undo/{revision}": { + "put": { + "operationId": "RolloutService_UndoRollout", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.Rollout" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "parameters": [ + { + "name": "namespace", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "rollout", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "revision", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.UndoRolloutRequest" + } + } + }, + "required": true + }, + "tags": [ + "RolloutService" + ] + } + }, + "/api/v1/version": { + "get": { + "operationId": "RolloutService_Version", + "responses": { + "200": { + "description": "A successful response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rollout.VersionInfo" + } + } + } + }, + "default": { + "description": "An unexpected error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/grpc.gateway.runtime.Error" + } + } + } + } + }, + "tags": [ + "RolloutService" + ] + } + } + }, + "components": { + "schemas": { + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.ALBTrafficRouting": { + "type": "object", + "properties": { + "ingress": { + "type": "string", + "title": "Ingress refers to the name of an `Ingress` resource in the same namespace as the `Rollout`" + }, + "servicePort": { + "type": "integer", + "format": "int32", + "title": "ServicePort refers to the port that the Ingress action should route traffic to" + }, + "rootService": { + "type": "string", + "title": "RootService references the service in the ingress to the controller should add the action to" + }, + "annotationPrefix": { + "type": "string", + "title": "AnnotationPrefix has to match the configured annotation prefix on the alb ingress controller\n+optional" + } + }, + "title": "ALBTrafficRouting configuration for ALB ingress controller to control traffic routing" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AmbassadorTrafficRouting": { + "type": "object", + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Mappings refer to the name of the Ambassador Mappings used to route traffic to the\nservice" + } + }, + "title": "AmbassadorTrafficRouting defines the configuration required to use Ambassador as traffic\nrouter" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AnalysisRunArgument": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name argument name" + }, + "value": { + "type": "string", + "title": "Value a hardcoded value for the argument. This field is a one of field with valueFrom" + }, + "valueFrom": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.ArgumentValueFrom" + } + }, + "title": "AnalysisRunArgument argument to add to analysisRun" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AnalysisRunStrategy": { + "type": "object", + "properties": { + "successfulRunHistoryLimit": { + "type": "integer", + "format": "int32", + "title": "SuccessfulRunHistoryLimit limits the number of old successful analysis runs and experiments to be retained in a history" + }, + "unsuccessfulRunHistoryLimit": { + "type": "integer", + "format": "int32", + "title": "UnsuccessfulRunHistoryLimit limits the number of old unsuccessful analysis runs and experiments to be retained in a history.\nStages for unsuccessful: \"Error\", \"Failed\", \"Inconclusive\"" + } + }, + "title": "AnalysisRunStrategy configuration for the analysis runs and experiments to retain" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AntiAffinity": { + "type": "object", + "properties": { + "preferredDuringSchedulingIgnoredDuringExecution": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PreferredDuringSchedulingIgnoredDuringExecution" + }, + "requiredDuringSchedulingIgnoredDuringExecution": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RequiredDuringSchedulingIgnoredDuringExecution" + } + }, + "title": "AntiAffinity defines which inter-pod scheduling rule to use for anti-affinity injection" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.ArgumentValueFrom": { + "type": "object", + "properties": { + "podTemplateHashValue": { + "type": "string", + "title": "PodTemplateHashValue gets the value from one of the children ReplicaSet's Pod Template Hash" + }, + "fieldRef": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.FieldRef" + } + }, + "title": "ArgumentValueFrom defines references to fields within resources to grab for the value (i.e. Pod Template Hash)" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.BlueGreenStatus": { + "type": "object", + "properties": { + "previewSelector": { + "type": "string", + "title": "PreviewSelector indicates which replicas set the preview service is serving traffic to\n+optional" + }, + "activeSelector": { + "type": "string", + "title": "ActiveSelector indicates which replicas set the active service is serving traffic to\n+optional" + }, + "scaleUpPreviewCheckPoint": { + "type": "boolean", + "title": "ScaleUpPreviewCheckPoint indicates that the Replicaset receiving traffic from the preview service is ready to be scaled up after the rollout is unpaused\n+optional" + }, + "prePromotionAnalysisRunStatus": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisRunStatus" + }, + "postPromotionAnalysisRunStatus": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisRunStatus" + } + }, + "title": "BlueGreenStatus status fields that only pertain to the blueGreen rollout" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.BlueGreenStrategy": { + "type": "object", + "properties": { + "activeService": { + "type": "string", + "description": "Name of the service that the rollout modifies as the active service." + }, + "previewService": { + "type": "string", + "title": "Name of the service that the rollout modifies as the preview service.\n+optional" + }, + "previewReplicaCount": { + "type": "integer", + "format": "int32", + "title": "PreviewReplicaCount is the number of replicas to run for the preview stack before the\nswitchover. Once the rollout is resumed the desired replicaset will be full scaled up before the switch occurs\n+optional" + }, + "autoPromotionEnabled": { + "type": "boolean", + "title": "AutoPromotionEnabled indicates if the rollout should automatically promote the new ReplicaSet\nto the active service or enter a paused state. If not specified, the default value is true.\n+optional" + }, + "autoPromotionSeconds": { + "type": "integer", + "format": "int32", + "title": "AutoPromotionSeconds is a duration in seconds in which to delay auto-promotion (default: 0).\nThe countdown begins after the preview ReplicaSet have reached full availability.\nThis option is ignored if autoPromotionEnabled is set to false.\n+optional" + }, + "maxUnavailable": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.util.intstr.IntOrString" + }, + "scaleDownDelaySeconds": { + "type": "integer", + "format": "int32", + "title": "ScaleDownDelaySeconds adds a delay before scaling down the previous replicaset.\nIf omitted, the Rollout waits 30 seconds before scaling down the previous ReplicaSet.\nA minimum of 30 seconds is recommended to ensure IP table propagation across the nodes in\na cluster. See https://github.com/argoproj/argo-rollouts/issues/19#issuecomment-476329960 for\nmore information\n+optional" + }, + "scaleDownDelayRevisionLimit": { + "type": "integer", + "format": "int32", + "title": "ScaleDownDelayRevisionLimit limits the number of old RS that can run at one time before getting scaled down\n+optional" + }, + "prePromotionAnalysis": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysis" + }, + "antiAffinity": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AntiAffinity" + }, + "postPromotionAnalysis": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysis" + }, + "previewMetadata": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PodTemplateMetadata" + }, + "activeMetadata": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PodTemplateMetadata" + }, + "abortScaleDownDelaySeconds": { + "type": "integer", + "format": "int32", + "title": "AbortScaleDownDelaySeconds adds a delay in second before scaling down the preview replicaset\nif update is aborted. 0 means not to scale down.\nDefault is 30 second\n+optional" + } + }, + "title": "BlueGreenStrategy defines parameters for Blue Green deployment" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.CanaryStatus": { + "type": "object", + "properties": { + "currentStepAnalysisRunStatus": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisRunStatus" + }, + "currentBackgroundAnalysisRunStatus": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisRunStatus" + }, + "currentExperiment": { + "type": "string", + "title": "CurrentExperiment indicates the running experiment" + } + }, + "title": "CanaryStatus status fields that only pertain to the canary rollout" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.CanaryStep": { + "type": "object", + "properties": { + "setWeight": { + "type": "integer", + "format": "int32", + "title": "SetWeight sets what percentage of the newRS should receive" + }, + "pause": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutPause" + }, + "experiment": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutExperimentStep" + }, + "analysis": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysis" + }, + "setCanaryScale": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.SetCanaryScale" + } + }, + "description": "CanaryStep defines a step of a canary deployment." + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.CanaryStrategy": { + "type": "object", + "properties": { + "canaryService": { + "type": "string", + "title": "CanaryService holds the name of a service which selects pods with canary version and don't select any pods with stable version.\n+optional" + }, + "stableService": { + "type": "string", + "title": "StableService holds the name of a service which selects pods with stable version and don't select any pods with canary version.\n+optional" + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.CanaryStep" + }, + "title": "Steps define the order of phases to execute the canary deployment\n+optional" + }, + "trafficRouting": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutTrafficRouting" + }, + "maxUnavailable": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.util.intstr.IntOrString" + }, + "maxSurge": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.util.intstr.IntOrString" + }, + "analysis": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisBackground" + }, + "antiAffinity": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AntiAffinity" + }, + "canaryMetadata": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PodTemplateMetadata" + }, + "stableMetadata": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PodTemplateMetadata" + }, + "scaleDownDelaySeconds": { + "type": "integer", + "format": "int32", + "title": "ScaleDownDelaySeconds adds a delay before scaling down the previous ReplicaSet when the\ncanary strategy is used with traffic routing (default 30 seconds). A delay in scaling down\nthe previous ReplicaSet is needed after switching the stable service selector to point to\nthe new ReplicaSet, in order to give time for traffic providers to re-target the new pods.\nThis value is ignored with basic, replica-weighted canary without traffic routing.\n+optional" + }, + "scaleDownDelayRevisionLimit": { + "type": "integer", + "format": "int32", + "title": "ScaleDownDelayRevisionLimit limits the number of old RS that can run at one time before getting scaled down\n+optional" + }, + "abortScaleDownDelaySeconds": { + "type": "integer", + "format": "int32", + "title": "AbortScaleDownDelaySeconds adds a delay in second before scaling down the canary pods when update\nis aborted for canary strategy with traffic routing (not applicable for basic canary).\n0 means canary pods are not scaled down.\nDefault is 30 seconds.\n+optional" + } + }, + "title": "CanaryStrategy defines parameters for a Replica Based Canary" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.FieldRef": { + "type": "object", + "properties": { + "fieldPath": { + "type": "string", + "title": "Required: Path of the field to select in the specified API version" + } + } + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioDestinationRule": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name holds the name of the DestinationRule" + }, + "canarySubsetName": { + "type": "string", + "title": "CanarySubsetName is the subset name to modify labels with canary ReplicaSet pod template hash value" + }, + "stableSubsetName": { + "type": "string", + "title": "StableSubsetName is the subset name to modify labels with stable ReplicaSet pod template hash value" + } + }, + "title": "IstioDestinationRule is a reference to an Istio DestinationRule to modify and shape traffic" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioTrafficRouting": { + "type": "object", + "properties": { + "virtualService": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioVirtualService" + }, + "destinationRule": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioDestinationRule" + } + }, + "title": "IstioTrafficRouting configuration for Istio service mesh to enable fine grain configuration" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioVirtualService": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name holds the name of the VirtualService" + }, + "routes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Routes are list of routes within VirtualService to edit. If omitted, VirtualService must have a single route" + } + }, + "title": "IstioVirtualService holds information on the virtual service the rollout needs to modify" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.NginxTrafficRouting": { + "type": "object", + "properties": { + "annotationPrefix": { + "type": "string", + "title": "AnnotationPrefix has to match the configured annotation prefix on the nginx ingress controller\n+optional" + }, + "stableIngress": { + "type": "string", + "title": "StableIngress refers to the name of an `Ingress` resource in the same namespace as the `Rollout`" + }, + "additionalIngressAnnotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "+optional" + } + }, + "title": "NginxTrafficRouting configuration for Nginx ingress controller to control traffic routing" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.ObjectRef": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "title": "API Version of the referent" + }, + "kind": { + "type": "string", + "title": "Kind of the referent" + }, + "name": { + "type": "string", + "title": "Name of the referent" + } + }, + "title": "ObjectRef holds a references to the Kubernetes object" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PauseCondition": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "startTime": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + } + }, + "title": "PauseCondition the reason for a pause and when it started" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PodTemplateMetadata": { + "type": "object", + "properties": { + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Labels Additional labels to add to the experiment\n+optional" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Annotations additional annotations to add to the experiment\n+optional" + } + }, + "title": "PodTemplateMetadata extra labels to add to the template" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PreferredDuringSchedulingIgnoredDuringExecution": { + "type": "object", + "properties": { + "weight": { + "type": "integer", + "format": "int32", + "description": "Weight associated with matching the corresponding podAffinityTerm, in the range 1-100." + } + }, + "title": "PreferredDuringSchedulingIgnoredDuringExecution defines the weight of the anti-affinity injection" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RequiredDuringSchedulingIgnoredDuringExecution": { + "type": "object", + "title": "RequiredDuringSchedulingIgnoredDuringExecution defines inter-pod scheduling rule to be RequiredDuringSchedulingIgnoredDuringExecution" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.Rollout": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "spec": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutSpec" + }, + "status": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutStatus" + } + }, + "title": "Rollout is a specification for a Rollout resource" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysis": { + "type": "object", + "properties": { + "templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisTemplate" + }, + "title": "Templates reference to a list of analysis templates to combine for an AnalysisRun" + }, + "args": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AnalysisRunArgument" + }, + "title": "Args the arguments that will be added to the AnalysisRuns\n+patchMergeKey=name\n+patchStrategy=merge" + } + }, + "title": "RolloutAnalysis defines a template that is used to create a analysisRun" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisBackground": { + "type": "object", + "properties": { + "rolloutAnalysis": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysis" + }, + "startingStep": { + "type": "integer", + "format": "int32", + "title": "StartingStep indicates which step the background analysis should start on\nIf not listed, controller defaults to 0" + } + }, + "title": "RolloutAnalysisBackground defines a template that is used to create a background analysisRun" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisRunStatus": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutAnalysisTemplate": { + "type": "object", + "properties": { + "templateName": { + "type": "string", + "title": "TemplateName name of template to use in AnalysisRun\n+optional" + }, + "clusterScope": { + "type": "boolean", + "title": "Whether to look for the templateName at cluster scope or namespace scope\n+optional" + } + } + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutCondition": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of deployment condition." + }, + "status": { + "type": "string", + "description": "Phase of the condition, one of True, False, Unknown." + }, + "lastUpdateTime": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "lastTransitionTime": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "reason": { + "type": "string", + "description": "The reason for the condition's last transition." + }, + "message": { + "type": "string", + "description": "A human readable message indicating details about the transition." + } + }, + "description": "RolloutCondition describes the state of a rollout at a certain point." + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutExperimentStep": { + "type": "object", + "properties": { + "templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutExperimentTemplate" + }, + "title": "Templates what templates that should be added to the experiment. Should be non-nil\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "duration": { + "type": "string", + "title": "Duration is a duration string (e.g. 30s, 5m, 1h) that the experiment should run for\n+optional" + }, + "analyses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutExperimentStepAnalysisTemplateRef" + }, + "title": "Analyses reference which analysis templates to run with the experiment\n+patchMergeKey=name\n+patchStrategy=merge" + } + }, + "title": "RolloutExperimentStep defines a template that is used to create a experiment for a step" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutExperimentStepAnalysisTemplateRef": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name is a name for this analysis template invocation" + }, + "templateName": { + "type": "string", + "title": "TemplateName reference of the AnalysisTemplate name used by the Experiment to create the run" + }, + "clusterScope": { + "type": "boolean", + "title": "Whether to look for the templateName at cluster scope or namespace scope\n+optional" + }, + "args": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AnalysisRunArgument" + }, + "title": "Args the arguments that will be added to the AnalysisRuns\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "requiredForCompletion": { + "type": "boolean", + "title": "RequiredForCompletion blocks the Experiment from completing until the analysis has completed" + } + } + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutExperimentTemplate": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name description of template that passed to the template" + }, + "specRef": { + "type": "string", + "title": "SpecRef indicates where the rollout should get the RS template from" + }, + "replicas": { + "type": "integer", + "format": "int32", + "title": "Replicas replica count for the template\n+optional" + }, + "metadata": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PodTemplateMetadata" + }, + "selector": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector" + } + }, + "title": "RolloutExperimentTemplate defines the template used to create experiments for the Rollout's experiment canary step" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutPause": { + "type": "object", + "properties": { + "duration": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.util.intstr.IntOrString" + } + }, + "title": "RolloutPause defines a pause stage for a rollout" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutSpec": { + "type": "object", + "properties": { + "replicas": { + "type": "integer", + "format": "int32", + "title": "Number of desired pods. This is a pointer to distinguish between explicit\nzero and not specified. Defaults to 1.\n+optional" + }, + "selector": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector" + }, + "template": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodTemplateSpec" + }, + "workloadRef": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.ObjectRef" + }, + "minReadySeconds": { + "type": "integer", + "format": "int32", + "title": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing, for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n+optional" + }, + "strategy": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutStrategy" + }, + "revisionHistoryLimit": { + "type": "integer", + "format": "int32", + "title": "The number of old ReplicaSets to retain. If unspecified, will retain 10 old ReplicaSets" + }, + "paused": { + "type": "boolean", + "description": "Paused pauses the rollout at its current step." + }, + "progressDeadlineSeconds": { + "type": "integer", + "format": "int32", + "description": "ProgressDeadlineSeconds The maximum time in seconds for a rollout to\nmake progress before it is considered to be failed. Argo Rollouts will\ncontinue to process failed rollouts and a condition with a\nProgressDeadlineExceeded reason will be surfaced in the rollout status.\nNote that progress will not be estimated during the time a rollout is paused.\nDefaults to 600s." + }, + "restartAt": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "analysis": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AnalysisRunStrategy" + } + }, + "title": "RolloutSpec is the spec for a Rollout resource" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutStatus": { + "type": "object", + "properties": { + "abort": { + "type": "boolean", + "title": "Abort cancel the current rollout progression" + }, + "pauseConditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.PauseCondition" + }, + "title": "PauseConditions indicates why the rollout is currently paused" + }, + "controllerPause": { + "type": "boolean", + "description": "ControllerPause indicates the controller has paused the rollout. It is set to true when\nthe controller adds a pause condition. This field helps to discern the scenario where a\nrollout was resumed after being paused by the controller (e.g. via the plugin). In that\nsituation, the pauseConditions would have been cleared , but controllerPause would still be\nset to true." + }, + "abortedAt": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "currentPodHash": { + "type": "string", + "title": "CurrentPodHash the hash of the current pod template\n+optional" + }, + "currentStepHash": { + "type": "string", + "title": "CurrentStepHash the hash of the current list of steps for the current strategy. This is used to detect when the\nlist of current steps change\n+optional" + }, + "replicas": { + "type": "integer", + "format": "int32", + "title": "Total number of non-terminated pods targeted by this rollout (their labels match the selector).\n+optional" + }, + "updatedReplicas": { + "type": "integer", + "format": "int32", + "title": "Total number of non-terminated pods targeted by this rollout that have the desired template spec.\n+optional" + }, + "readyReplicas": { + "type": "integer", + "format": "int32", + "title": "Total number of ready pods targeted by this rollout.\n+optional" + }, + "availableReplicas": { + "type": "integer", + "format": "int32", + "title": "Total number of available pods (ready for at least minReadySeconds) targeted by this rollout.\n+optional" + }, + "currentStepIndex": { + "type": "integer", + "format": "int32", + "title": "CurrentStepIndex defines the current step of the rollout is on. If the current step index is null, the\ncontroller will execute the rollout.\n+optional" + }, + "collisionCount": { + "type": "integer", + "format": "int32", + "title": "Count of hash collisions for the Rollout. The Rollout controller uses this\nfield as a collision avoidance mechanism when it needs to create the name for the\nnewest ReplicaSet.\n+optional" + }, + "observedGeneration": { + "type": "string", + "title": "The generation observed by the rollout controller from metadata.generation\n+optional" + }, + "workloadObservedGeneration": { + "type": "string", + "title": "The generation of referenced workload observed by the rollout controller\n+optional" + }, + "conditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutCondition" + }, + "title": "Conditions a list of conditions a rollout can have.\n+optional" + }, + "canary": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.CanaryStatus" + }, + "blueGreen": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.BlueGreenStatus" + }, + "HPAReplicas": { + "type": "integer", + "format": "int32", + "title": "HPAReplicas the number of non-terminated replicas that are receiving active traffic\n+optional" + }, + "selector": { + "type": "string", + "title": "Selector that identifies the pods that are receiving active traffic\n+optional" + }, + "stableRS": { + "type": "string", + "title": "StableRS indicates the replicaset that has successfully rolled out\n+optional" + }, + "restartedAt": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "promoteFull": { + "type": "boolean", + "description": "PromoteFull indicates if the rollout should perform a full promotion, skipping analysis and pauses." + }, + "phase": { + "type": "string", + "title": "Phase is the rollout phase. Clients should only rely on the value if status.observedGeneration equals metadata.generation" + }, + "message": { + "type": "string", + "title": "Message provides details on why the rollout is in its current phase" + } + }, + "title": "RolloutStatus is the status for a Rollout resource" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutStrategy": { + "type": "object", + "properties": { + "blueGreen": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.BlueGreenStrategy" + }, + "canary": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.CanaryStrategy" + } + }, + "title": "RolloutStrategy defines strategy to apply during next rollout" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.RolloutTrafficRouting": { + "type": "object", + "properties": { + "istio": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.IstioTrafficRouting" + }, + "nginx": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.NginxTrafficRouting" + }, + "alb": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.ALBTrafficRouting" + }, + "smi": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.SMITrafficRouting" + }, + "ambassador": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.AmbassadorTrafficRouting" + } + }, + "title": "RolloutTrafficRouting hosts all the different configuration for supported service meshes to enable more fine-grained traffic routing" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.SMITrafficRouting": { + "type": "object", + "properties": { + "rootService": { + "type": "string", + "title": "RootService holds the name of that clients use to communicate.\n+optional" + }, + "trafficSplitName": { + "type": "string", + "title": "TrafficSplitName holds the name of the TrafficSplit.\n+optional" + } + }, + "title": "SMITrafficRouting configuration for TrafficSplit Custom Resource to control traffic routing" + }, + "github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.SetCanaryScale": { + "type": "object", + "properties": { + "weight": { + "type": "integer", + "format": "int32", + "title": "Weight sets the percentage of replicas the newRS should have\n+optional" + }, + "replicas": { + "type": "integer", + "format": "int32", + "title": "Replicas sets the number of replicas the newRS should have\n+optional" + }, + "matchTrafficWeight": { + "type": "boolean", + "title": "MatchTrafficWeight cancels out previously set Replicas or Weight, effectively activating SetWeight\n+optional" + } + }, + "title": "SetCanaryScale defines how to scale the newRS without changing traffic weight" + }, + "google.protobuf.Any": { + "type": "object", + "properties": { + "type_url": { + "type": "string" + }, + "value": { + "type": "string", + "format": "byte" + } + } + }, + "grpc.gateway.runtime.Error": { + "type": "object", + "properties": { + "error": { + "type": "string" + }, + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/google.protobuf.Any" + } + } + } + }, + "grpc.gateway.runtime.StreamError": { + "type": "object", + "properties": { + "grpc_code": { + "type": "integer", + "format": "int32" + }, + "http_code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + }, + "http_status": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/google.protobuf.Any" + } + } + } + }, + "k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource": { + "type": "object", + "properties": { + "volumeID": { + "type": "string", + "title": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + }, + "fsType": { + "type": "string", + "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "partition": { + "type": "integer", + "format": "int32", + "title": "The partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\".\nIf omitted, the default is \"false\".\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional" + } + }, + "description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk\nmust also be in the same AWS zone as the kubelet. An AWS EBS disk\ncan only be mounted as read/write once. AWS EBS volumes support\nownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.Affinity": { + "type": "object", + "properties": { + "nodeAffinity": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.NodeAffinity" + }, + "podAffinity": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodAffinity" + }, + "podAntiAffinity": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodAntiAffinity" + } + }, + "description": "Affinity is a group of affinity scheduling rules." + }, + "k8s.io.api.core.v1.AzureDiskVolumeSource": { + "type": "object", + "properties": { + "diskName": { + "type": "string", + "title": "The Name of the data disk in the blob storage" + }, + "diskURI": { + "type": "string", + "title": "The URI the data disk in the blob storage" + }, + "cachingMode": { + "type": "string", + "title": "Host Caching mode: None, Read Only, Read Write.\n+optional" + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "kind": { + "type": "string", + "title": "Expected values 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" + } + }, + "description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod." + }, + "k8s.io.api.core.v1.AzureFileVolumeSource": { + "type": "object", + "properties": { + "secretName": { + "type": "string", + "title": "the name of secret that contains Azure Storage Account Name and Key" + }, + "shareName": { + "type": "string", + "title": "Share Name" + }, + "readOnly": { + "type": "boolean", + "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod." + }, + "k8s.io.api.core.v1.CSIVolumeSource": { + "type": "object", + "properties": { + "driver": { + "type": "string", + "description": "Driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster." + }, + "readOnly": { + "type": "boolean", + "title": "Specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional" + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.\n+optional" + }, + "volumeAttributes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "VolumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.\n+optional" + }, + "nodePublishSecretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + } + }, + "title": "Represents a source location of a volume to mount, managed by an external CSI driver" + }, + "k8s.io.api.core.v1.Capabilities": { + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Added capabilities\n+optional" + }, + "drop": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Removed capabilities\n+optional" + } + }, + "description": "Adds and removes POSIX capabilities from running containers." + }, + "k8s.io.api.core.v1.CephFSVolumeSource": { + "type": "object", + "properties": { + "monitors": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + }, + "path": { + "type": "string", + "title": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional" + }, + "user": { + "type": "string", + "title": "Optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "secretFile": { + "type": "string", + "title": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "readOnly": { + "type": "boolean", + "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional" + } + }, + "description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod\nCephfs volumes do not support ownership management or SELinux relabeling." + }, + "k8s.io.api.core.v1.CinderVolumeSource": { + "type": "object", + "properties": { + "volumeID": { + "type": "string", + "title": "volume id used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional" + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + } + }, + "description": "Represents a cinder volume resource in Openstack.\nA Cinder volume must exist before mounting to a container.\nThe volume must also be in the same region as the kubelet.\nCinder volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.ConfigMapEnvSource": { + "type": "object", + "properties": { + "localObjectReference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "optional": { + "type": "boolean", + "title": "Specify whether the ConfigMap must be defined\n+optional" + } + }, + "description": "ConfigMapEnvSource selects a ConfigMap to populate the environment\nvariables with.\n\nThe contents of the target ConfigMap's Data field will represent the\nkey-value pairs as environment variables." + }, + "k8s.io.api.core.v1.ConfigMapKeySelector": { + "type": "object", + "properties": { + "localObjectReference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "key": { + "type": "string", + "description": "The key to select." + }, + "optional": { + "type": "boolean", + "title": "Specify whether the ConfigMap or its key must be defined\n+optional" + } + }, + "description": "Selects a key from a ConfigMap." + }, + "k8s.io.api.core.v1.ConfigMapProjection": { + "type": "object", + "properties": { + "localObjectReference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.KeyToPath" + }, + "title": "If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "optional": { + "type": "boolean", + "title": "Specify whether the ConfigMap or its keys must be defined\n+optional" + } + }, + "description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a\nprojected volume as files using the keys in the Data field as the file names,\nunless the items element is populated with specific mappings of keys to paths.\nNote that this is identical to a configmap volume source without the default\nmode." + }, + "k8s.io.api.core.v1.ConfigMapVolumeSource": { + "type": "object", + "properties": { + "localObjectReference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.KeyToPath" + }, + "title": "If unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "defaultMode": { + "type": "integer", + "format": "int32", + "title": "Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + }, + "optional": { + "type": "boolean", + "title": "Specify whether the ConfigMap or its keys must be defined\n+optional" + } + }, + "description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a\nvolume as files using the keys in the Data field as the file names, unless\nthe items element is populated with specific mappings of keys to paths.\nConfigMap volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.Container": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + }, + "image": { + "type": "string", + "title": "Docker image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional" + }, + "command": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Entrypoint array. Not executed within a shell.\nThe docker image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Arguments to the entrypoint.\nThe docker image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "title": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ContainerPort" + }, + "title": "List of ports to expose from the container. Exposing a port here gives\nthe system additional information about the network connections a\ncontainer uses, but is primarily informational. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol" + }, + "envFrom": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EnvFromSource" + }, + "title": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EnvVar" + }, + "title": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ResourceRequirements" + }, + "volumeMounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.VolumeMount" + }, + "title": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.VolumeDevice" + }, + "title": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Probe" + }, + "readinessProbe": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Probe" + }, + "startupProbe": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Probe" + }, + "lifecycle": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Lifecycle" + }, + "terminationMessagePath": { + "type": "string", + "title": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "title": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "title": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SecurityContext" + }, + "stdin": { + "type": "boolean", + "title": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "title": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "title": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + } + }, + "description": "A single application container that you want to run within a pod." + }, + "k8s.io.api.core.v1.ContainerPort": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional" + }, + "hostPort": { + "type": "integer", + "format": "int32", + "title": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional" + }, + "containerPort": { + "type": "integer", + "format": "int32", + "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + }, + "protocol": { + "type": "string", + "title": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".\n+optional\n+default=\"TCP\"" + }, + "hostIP": { + "type": "string", + "title": "What host IP to bind the external port to.\n+optional" + } + }, + "description": "ContainerPort represents a network port in a single container." + }, + "k8s.io.api.core.v1.DownwardAPIProjection": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.DownwardAPIVolumeFile" + }, + "title": "Items is a list of DownwardAPIVolume file\n+optional" + } + }, + "description": "Represents downward API info for projecting into a projected volume.\nNote that this is identical to a downwardAPI volume source without the default\nmode." + }, + "k8s.io.api.core.v1.DownwardAPIVolumeFile": { + "type": "object", + "properties": { + "path": { + "type": "string", + "title": "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 '..'" + }, + "fieldRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ObjectFieldSelector" + }, + "resourceFieldRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ResourceFieldSelector" + }, + "mode": { + "type": "integer", + "format": "int32", + "title": "Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "title": "DownwardAPIVolumeFile represents information to create the file containing the pod field" + }, + "k8s.io.api.core.v1.DownwardAPIVolumeSource": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.DownwardAPIVolumeFile" + }, + "title": "Items is a list of downward API volume file\n+optional" + }, + "defaultMode": { + "type": "integer", + "format": "int32", + "title": "Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "description": "DownwardAPIVolumeSource represents a volume containing downward API info.\nDownward API volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.EmptyDirVolumeSource": { + "type": "object", + "properties": { + "medium": { + "type": "string", + "title": "What type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional" + }, + "sizeLimit": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.api.resource.Quantity" + } + }, + "description": "Represents an empty directory for a pod.\nEmpty directory volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.EnvFromSource": { + "type": "object", + "properties": { + "prefix": { + "type": "string", + "title": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.\n+optional" + }, + "configMapRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ConfigMapEnvSource" + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SecretEnvSource" + } + }, + "title": "EnvFromSource represents the source of a set of ConfigMaps" + }, + "k8s.io.api.core.v1.EnvVar": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the environment variable. Must be a C_IDENTIFIER." + }, + "value": { + "type": "string", + "title": "Variable references $(VAR_NAME) are expanded\nusing the previous defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. The $(VAR_NAME)\nsyntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped\nreferences will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional" + }, + "valueFrom": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EnvVarSource" + } + }, + "description": "EnvVar represents an environment variable present in a Container." + }, + "k8s.io.api.core.v1.EnvVarSource": { + "type": "object", + "properties": { + "fieldRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ObjectFieldSelector" + }, + "resourceFieldRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ResourceFieldSelector" + }, + "configMapKeyRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ConfigMapKeySelector" + }, + "secretKeyRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SecretKeySelector" + } + }, + "description": "EnvVarSource represents a source for the value of an EnvVar." + }, + "k8s.io.api.core.v1.EphemeralContainer": { + "type": "object", + "properties": { + "ephemeralContainerCommon": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EphemeralContainerCommon" + }, + "targetContainerName": { + "type": "string", + "title": "If set, the name of the container from PodSpec that this ephemeral container targets.\nThe ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.\nIf not set then the ephemeral container is run in whatever namespaces are shared\nfor the pod. Note that the container runtime must support this feature.\n+optional" + } + }, + "description": "An EphemeralContainer is a container that may be added temporarily to an existing pod for\nuser-initiated activities such as debugging. Ephemeral containers have no resource or\nscheduling guarantees, and they will not be restarted when they exit or when a pod is\nremoved or restarted. If an ephemeral container causes a pod to exceed its resource\nallocation, the pod may be evicted.\nEphemeral containers may not be added by directly updating the pod spec. They must be added\nvia the pod's ephemeralcontainers subresource, and they will appear in the pod spec\nonce added.\nThis is an alpha feature enabled by the EphemeralContainers feature flag." + }, + "k8s.io.api.core.v1.EphemeralContainerCommon": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the ephemeral container specified as a DNS_LABEL.\nThis name must be unique among all containers, init containers and ephemeral containers." + }, + "image": { + "type": "string", + "title": "Docker image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images" + }, + "command": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Entrypoint array. Not executed within a shell.\nThe docker image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "args": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Arguments to the entrypoint.\nThe docker image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax\ncan be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\nCannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional" + }, + "workingDir": { + "type": "string", + "title": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional" + }, + "ports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ContainerPort" + }, + "description": "Ports are not allowed for ephemeral containers." + }, + "envFrom": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EnvFromSource" + }, + "title": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.\n+optional" + }, + "env": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EnvVar" + }, + "title": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "resources": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ResourceRequirements" + }, + "volumeMounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.VolumeMount" + }, + "title": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge" + }, + "volumeDevices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.VolumeDevice" + }, + "title": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+optional" + }, + "livenessProbe": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Probe" + }, + "readinessProbe": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Probe" + }, + "startupProbe": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Probe" + }, + "lifecycle": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Lifecycle" + }, + "terminationMessagePath": { + "type": "string", + "title": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional" + }, + "terminationMessagePolicy": { + "type": "string", + "title": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.\n+optional" + }, + "imagePullPolicy": { + "type": "string", + "title": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional" + }, + "securityContext": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SecurityContext" + }, + "stdin": { + "type": "boolean", + "title": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional" + }, + "stdinOnce": { + "type": "boolean", + "title": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional" + }, + "tty": { + "type": "boolean", + "title": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional" + } + }, + "description": "EphemeralContainerCommon is a copy of all fields in Container to be inlined in\nEphemeralContainer. This separate type allows easy conversion from EphemeralContainer\nto Container and allows separate documentation for the fields of EphemeralContainer.\nWhen a new field is added to Container it must be added here as well." + }, + "k8s.io.api.core.v1.EphemeralVolumeSource": { + "type": "object", + "properties": { + "volumeClaimTemplate": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PersistentVolumeClaimTemplate" + }, + "readOnly": { + "type": "boolean", + "title": "Specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional" + } + }, + "description": "Represents an ephemeral volume that is handled by a normal storage driver." + }, + "k8s.io.api.core.v1.ExecAction": { + "type": "object", + "properties": { + "command": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional" + } + }, + "description": "ExecAction describes a \"run in container\" action." + }, + "k8s.io.api.core.v1.FCVolumeSource": { + "type": "object", + "properties": { + "targetWWNs": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Optional: FC target worldwide names (WWNs)\n+optional" + }, + "lun": { + "type": "integer", + "format": "int32", + "title": "Optional: FC target lun number\n+optional" + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "wwids": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.\n+optional" + } + }, + "description": "Represents a Fibre Channel volume.\nFibre Channel volumes can only be mounted as read/write once.\nFibre Channel volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.FlexVolumeSource": { + "type": "object", + "properties": { + "driver": { + "type": "string", + "description": "Driver is the name of the driver to use for this volume." + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional" + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "readOnly": { + "type": "boolean", + "title": "Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "options": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Optional: Extra command options if any.\n+optional" + } + }, + "description": "FlexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin." + }, + "k8s.io.api.core.v1.FlockerVolumeSource": { + "type": "object", + "properties": { + "datasetName": { + "type": "string", + "title": "Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated\n+optional" + }, + "datasetUUID": { + "type": "string", + "title": "UUID of the dataset. This is unique identifier of a Flocker dataset\n+optional" + } + }, + "description": "Represents a Flocker volume mounted by the Flocker agent.\nOne and only one of datasetName and datasetUUID should be set.\nFlocker volumes do not support ownership management or SELinux relabeling." + }, + "k8s.io.api.core.v1.GCEPersistentDiskVolumeSource": { + "type": "object", + "properties": { + "pdName": { + "type": "string", + "title": "Unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + }, + "fsType": { + "type": "string", + "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "partition": { + "type": "integer", + "format": "int32", + "title": "The partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional" + } + }, + "description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must\nalso be in the same GCE project and zone as the kubelet. A GCE PD\ncan only be mounted as read/write once or read-only many times. GCE\nPDs support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.GitRepoVolumeSource": { + "type": "object", + "properties": { + "repository": { + "type": "string", + "title": "Repository URL" + }, + "revision": { + "type": "string", + "title": "Commit hash for the specified revision.\n+optional" + }, + "directory": { + "type": "string", + "title": "Target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.\n+optional" + } + }, + "description": "Represents a volume that is populated with the contents of a git repository.\nGit repo volumes do not support ownership management.\nGit repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container." + }, + "k8s.io.api.core.v1.GlusterfsVolumeSource": { + "type": "object", + "properties": { + "endpoints": { + "type": "string", + "title": "EndpointsName is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + }, + "path": { + "type": "string", + "title": "Path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + }, + "readOnly": { + "type": "boolean", + "title": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional" + } + }, + "description": "Represents a Glusterfs mount that lasts the lifetime of a pod.\nGlusterfs volumes do not support ownership management or SELinux relabeling." + }, + "k8s.io.api.core.v1.HTTPGetAction": { + "type": "object", + "properties": { + "path": { + "type": "string", + "title": "Path to access on the HTTP server.\n+optional" + }, + "port": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.util.intstr.IntOrString" + }, + "host": { + "type": "string", + "title": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional" + }, + "scheme": { + "type": "string", + "title": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional" + }, + "httpHeaders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.HTTPHeader" + }, + "title": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional" + } + }, + "description": "HTTPGetAction describes an action based on HTTP Get requests." + }, + "k8s.io.api.core.v1.HTTPHeader": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "The header field name" + }, + "value": { + "type": "string", + "title": "The header field value" + } + }, + "title": "HTTPHeader describes a custom header to be used in HTTP probes" + }, + "k8s.io.api.core.v1.Handler": { + "type": "object", + "properties": { + "exec": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ExecAction" + }, + "httpGet": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.HTTPGetAction" + }, + "tcpSocket": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.TCPSocketAction" + } + }, + "description": "Handler defines a specific action that should be taken\nTODO: pass structured data to these actions, and document that data here." + }, + "k8s.io.api.core.v1.HostAlias": { + "type": "object", + "properties": { + "ip": { + "type": "string", + "description": "IP address of the host file entry." + }, + "hostnames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Hostnames for the above IP address." + } + }, + "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file." + }, + "k8s.io.api.core.v1.HostPathVolumeSource": { + "type": "object", + "properties": { + "path": { + "type": "string", + "title": "Path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + }, + "type": { + "type": "string", + "title": "Type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n+optional" + } + }, + "description": "Represents a host path mapped into a pod.\nHost path volumes do not support ownership management or SELinux relabeling." + }, + "k8s.io.api.core.v1.ISCSIVolumeSource": { + "type": "object", + "properties": { + "targetPortal": { + "type": "string", + "description": "iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + }, + "iqn": { + "type": "string", + "description": "Target iSCSI Qualified Name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "iSCSI Target Lun number." + }, + "iscsiInterface": { + "type": "string", + "title": "iSCSI Interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+optional" + }, + "fsType": { + "type": "string", + "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional" + }, + "portals": { + "type": "array", + "items": { + "type": "string" + }, + "title": "iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).\n+optional" + }, + "chapAuthDiscovery": { + "type": "boolean", + "title": "whether support iSCSI Discovery CHAP authentication\n+optional" + }, + "chapAuthSession": { + "type": "boolean", + "title": "whether support iSCSI Session CHAP authentication\n+optional" + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "initiatorName": { + "type": "string", + "title": "Custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection.\n+optional" + } + }, + "description": "Represents an ISCSI disk.\nISCSI volumes can only be mounted as read/write once.\nISCSI volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.KeyToPath": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The key to project." + }, + "path": { + "type": "string", + "description": "The relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + }, + "mode": { + "type": "integer", + "format": "int32", + "title": "Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "description": "Maps a string key to a path within a volume." + }, + "k8s.io.api.core.v1.Lifecycle": { + "type": "object", + "properties": { + "postStart": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Handler" + }, + "preStop": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Handler" + } + }, + "description": "Lifecycle describes actions that the management system should take in response to container lifecycle\nevents. For the PostStart and PreStop lifecycle handlers, management of the container blocks\nuntil the action is complete, unless the container process fails, in which case the handler is aborted." + }, + "k8s.io.api.core.v1.LocalObjectReference": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Add other useful fields. apiVersion, kind, uid?\n+optional" + } + }, + "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace." + }, + "k8s.io.api.core.v1.NFSVolumeSource": { + "type": "object", + "properties": { + "server": { + "type": "string", + "title": "Server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "path": { + "type": "string", + "title": "Path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + }, + "readOnly": { + "type": "boolean", + "title": "ReadOnly here will force\nthe NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional" + } + }, + "description": "Represents an NFS mount that lasts the lifetime of a pod.\nNFS volumes do not support ownership management or SELinux relabeling." + }, + "k8s.io.api.core.v1.NodeAffinity": { + "type": "object", + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.NodeSelector" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PreferredSchedulingTerm" + }, + "title": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "description": "Node affinity is a group of node affinity scheduling rules." + }, + "k8s.io.api.core.v1.NodeSelector": { + "type": "object", + "properties": { + "nodeSelectorTerms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.NodeSelectorTerm" + }, + "description": "Required. A list of node selector terms. The terms are ORed." + } + }, + "description": "A node selector represents the union of the results of one or more label queries\nover a set of nodes; that is, it represents the OR of the selectors represented\nby the node selector terms." + }, + "k8s.io.api.core.v1.NodeSelectorRequirement": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The label key that the selector applies to." + }, + "operator": { + "type": "string", + "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "title": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.\n+optional" + } + }, + "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values." + }, + "k8s.io.api.core.v1.NodeSelectorTerm": { + "type": "object", + "properties": { + "matchExpressions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.NodeSelectorRequirement" + }, + "title": "A list of node selector requirements by node's labels.\n+optional" + }, + "matchFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.NodeSelectorRequirement" + }, + "title": "A list of node selector requirements by node's fields.\n+optional" + } + }, + "description": "A null or empty node selector term matches no objects. The requirements of\nthem are ANDed.\nThe TopologySelectorTerm type implements a subset of the NodeSelectorTerm." + }, + "k8s.io.api.core.v1.ObjectFieldSelector": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "title": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional" + }, + "fieldPath": { + "type": "string", + "description": "Path of the field to select in the specified API version." + } + }, + "description": "ObjectFieldSelector selects an APIVersioned field of an object." + }, + "k8s.io.api.core.v1.PersistentVolumeClaimSpec": { + "type": "object", + "properties": { + "accessModes": { + "type": "array", + "items": { + "type": "string" + }, + "title": "AccessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1\n+optional" + }, + "selector": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector" + }, + "resources": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ResourceRequirements" + }, + "volumeName": { + "type": "string", + "title": "VolumeName is the binding reference to the PersistentVolume backing this claim.\n+optional" + }, + "storageClassName": { + "type": "string", + "title": "Name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1\n+optional" + }, + "volumeMode": { + "type": "string", + "title": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.\n+optional" + }, + "dataSource": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.TypedLocalObjectReference" + } + }, + "title": "PersistentVolumeClaimSpec describes the common attributes of storage devices\nand allows a Source for provider-specific attributes" + }, + "k8s.io.api.core.v1.PersistentVolumeClaimTemplate": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "spec": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PersistentVolumeClaimSpec" + } + }, + "description": "PersistentVolumeClaimTemplate is used to produce\nPersistentVolumeClaim objects as part of an EphemeralVolumeSource." + }, + "k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource": { + "type": "object", + "properties": { + "claimName": { + "type": "string", + "title": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + }, + "readOnly": { + "type": "boolean", + "title": "Will force the ReadOnly setting in VolumeMounts.\nDefault false.\n+optional" + } + }, + "description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.\nThis volume finds the bound PV and mounts that volume for the pod. A\nPersistentVolumeClaimVolumeSource is, essentially, a wrapper around another\ntype of volume that is owned by someone else (the system)." + }, + "k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource": { + "type": "object", + "properties": { + "pdID": { + "type": "string", + "title": "ID that identifies Photon Controller persistent disk" + }, + "fsType": { + "type": "string", + "description": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + } + }, + "description": "Represents a Photon Controller persistent disk resource." + }, + "k8s.io.api.core.v1.PodAffinity": { + "type": "object", + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodAffinityTerm" + }, + "title": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.WeightedPodAffinityTerm" + }, + "title": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "description": "Pod affinity is a group of inter pod affinity scheduling rules." + }, + "k8s.io.api.core.v1.PodAffinityTerm": { + "type": "object", + "properties": { + "labelSelector": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector" + }, + "namespaces": { + "type": "array", + "items": { + "type": "string" + }, + "title": "namespaces specifies which namespaces the labelSelector applies to (matches against);\nnull or empty list means \"this pod's namespace\"\n+optional" + }, + "topologyKey": { + "type": "string", + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + } + }, + "title": "Defines a set of pods (namely those matching the labelSelector\nrelative to the given namespace(s)) that this pod should be\nco-located (affinity) or not co-located (anti-affinity) with,\nwhere co-located is defined as running on a node whose value of\nthe label with key matches that of any node on which\na pod of the set of pods is running" + }, + "k8s.io.api.core.v1.PodAntiAffinity": { + "type": "object", + "properties": { + "requiredDuringSchedulingIgnoredDuringExecution": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodAffinityTerm" + }, + "title": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional" + }, + "preferredDuringSchedulingIgnoredDuringExecution": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.WeightedPodAffinityTerm" + }, + "title": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional" + } + }, + "description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules." + }, + "k8s.io.api.core.v1.PodDNSConfig": { + "type": "object", + "properties": { + "nameservers": { + "type": "array", + "items": { + "type": "string" + }, + "title": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed.\n+optional" + }, + "searches": { + "type": "array", + "items": { + "type": "string" + }, + "title": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed.\n+optional" + }, + "options": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodDNSConfigOption" + }, + "title": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy.\n+optional" + } + }, + "description": "PodDNSConfig defines the DNS parameters of a pod in addition to\nthose generated from DNSPolicy." + }, + "k8s.io.api.core.v1.PodDNSConfigOption": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Required." + }, + "value": { + "type": "string", + "title": "+optional" + } + }, + "description": "PodDNSConfigOption defines DNS resolver options of a pod." + }, + "k8s.io.api.core.v1.PodReadinessGate": { + "type": "object", + "properties": { + "conditionType": { + "type": "string", + "description": "ConditionType refers to a condition in the pod's condition list with matching type." + } + }, + "title": "PodReadinessGate contains the reference to a pod condition" + }, + "k8s.io.api.core.v1.PodSecurityContext": { + "type": "object", + "properties": { + "seLinuxOptions": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SELinuxOptions" + }, + "windowsOptions": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.WindowsSecurityContextOptions" + }, + "runAsUser": { + "type": "string", + "format": "int64", + "title": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\n+optional" + }, + "runAsGroup": { + "type": "string", + "format": "int64", + "title": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\n+optional" + }, + "runAsNonRoot": { + "type": "boolean", + "title": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "supplementalGroups": { + "type": "array", + "items": { + "type": "string", + "format": "int64" + }, + "title": "A list of groups applied to the first process run in each container, in addition\nto the container's primary GID. If unspecified, no groups will be added to\nany container.\n+optional" + }, + "fsGroup": { + "type": "string", + "format": "int64", + "description": "1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\n+optional", + "title": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:" + }, + "sysctls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Sysctl" + }, + "title": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\n+optional" + }, + "fsGroupChangePolicy": { + "type": "string", + "title": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\n+optional" + }, + "seccompProfile": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SeccompProfile" + } + }, + "description": "PodSecurityContext holds pod-level security attributes and common container settings.\nSome fields are also present in container.securityContext. Field values of\ncontainer.securityContext take precedence over field values of PodSecurityContext." + }, + "k8s.io.api.core.v1.PodSpec": { + "type": "object", + "properties": { + "volumes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Volume" + }, + "title": "List of volumes that can be mounted by containers belonging to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes\n+optional\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys" + }, + "initContainers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Container" + }, + "title": "List of initialization containers belonging to the pod.\nInit containers are executed in order prior to containers being started. If any\ninit container fails, the pod is considered to have failed and is handled according\nto its restartPolicy. The name for an init container or normal container must be\nunique among all containers.\nInit containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.\nThe resourceRequirements of an init container are taken into account during scheduling\nby finding the highest request/limit for each resource type, and then using the max of\nof that value or the sum of the normal containers. Limits are applied to init containers\nin a similar fashion.\nInit containers cannot currently be added or removed.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "containers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Container" + }, + "title": "List of containers belonging to the pod.\nContainers cannot currently be added or removed.\nThere must be at least one container in a Pod.\nCannot be updated.\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "ephemeralContainers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EphemeralContainer" + }, + "title": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing\npod to perform user-initiated actions such as debugging. This list cannot be specified when\ncreating a pod, and it cannot be modified by updating the pod spec. In order to add an\nephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.\nThis field is alpha-level and is only honored by servers that enable the EphemeralContainers feature.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "restartPolicy": { + "type": "string", + "title": "Restart policy for all containers within the pod.\nOne of Always, OnFailure, Never.\nDefault to Always.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy\n+optional" + }, + "terminationGracePeriodSeconds": { + "type": "string", + "format": "int64", + "title": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates delete immediately.\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional" + }, + "activeDeadlineSeconds": { + "type": "string", + "format": "int64", + "title": "Optional duration in seconds the pod may be active on the node relative to\nStartTime before the system will actively try to mark it failed and kill associated containers.\nValue must be a positive integer.\n+optional" + }, + "dnsPolicy": { + "type": "string", + "title": "Set DNS policy for the pod.\nDefaults to \"ClusterFirst\".\nValid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.\nDNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.\nTo have DNS options set along with hostNetwork, you have to specify DNS policy\nexplicitly to 'ClusterFirstWithHostNet'.\n+optional" + }, + "nodeSelector": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "NodeSelector is a selector which must be true for the pod to fit on a node.\nSelector which must match a node's labels for the pod to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n+optional" + }, + "serviceAccountName": { + "type": "string", + "title": "ServiceAccountName is the name of the ServiceAccount to use to run this pod.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional" + }, + "serviceAccount": { + "type": "string", + "title": "DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.\nDeprecated: Use serviceAccountName instead.\n+k8s:conversion-gen=false\n+optional" + }, + "automountServiceAccountToken": { + "type": "boolean", + "title": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.\n+optional" + }, + "nodeName": { + "type": "string", + "title": "NodeName is a request to schedule this pod onto a specific node. If it is non-empty,\nthe scheduler simply schedules this pod onto that node, assuming that it fits resource\nrequirements.\n+optional" + }, + "hostNetwork": { + "type": "boolean", + "title": "Host networking requested for this pod. Use the host's network namespace.\nIf this option is set, the ports that will be used must be specified.\nDefault to false.\n+k8s:conversion-gen=false\n+optional" + }, + "hostPID": { + "type": "boolean", + "title": "Use the host's pid namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "hostIPC": { + "type": "boolean", + "title": "Use the host's ipc namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "shareProcessNamespace": { + "type": "boolean", + "title": "Share a single process namespace between all of the containers in a pod.\nWhen this is set containers will be able to view and signal processes from other containers\nin the same pod, and the first process in each container will not be assigned PID 1.\nHostPID and ShareProcessNamespace cannot both be set.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional" + }, + "securityContext": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodSecurityContext" + }, + "imagePullSecrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "title": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.\nIf specified, these secrets will be passed to individual puller implementations for them to use. For example,\nin the case of docker, only DockerConfig type secrets are honored.\nMore info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod\n+optional\n+patchMergeKey=name\n+patchStrategy=merge" + }, + "hostname": { + "type": "string", + "title": "Specifies the hostname of the Pod\nIf not specified, the pod's hostname will be set to a system-defined value.\n+optional" + }, + "subdomain": { + "type": "string", + "title": "If specified, the fully qualified Pod hostname will be \"...svc.\".\nIf not specified, the pod will not have a domainname at all.\n+optional" + }, + "affinity": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Affinity" + }, + "schedulerName": { + "type": "string", + "title": "If specified, the pod will be dispatched by specified scheduler.\nIf not specified, the pod will be dispatched by default scheduler.\n+optional" + }, + "tolerations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Toleration" + }, + "title": "If specified, the pod's tolerations.\n+optional" + }, + "hostAliases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.HostAlias" + }, + "title": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts\nfile if specified. This is only valid for non-hostNetwork pods.\n+optional\n+patchMergeKey=ip\n+patchStrategy=merge" + }, + "priorityClassName": { + "type": "string", + "title": "If specified, indicates the pod's priority. \"system-node-critical\" and\n\"system-cluster-critical\" are two special keywords which indicate the\nhighest priorities with the former being the highest priority. Any other\nname must be defined by creating a PriorityClass object with that name.\nIf not specified, the pod priority will be default or zero if there is no\ndefault.\n+optional" + }, + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority value. Various system components use this field to find the\npriority of the pod. When Priority Admission Controller is enabled, it\nprevents users from setting this field. The admission controller populates\nthis field from PriorityClassName.\nThe higher the value, the higher the priority.\n+optional" + }, + "dnsConfig": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodDNSConfig" + }, + "readinessGates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodReadinessGate" + }, + "title": "If specified, all readiness gates will be evaluated for pod readiness.\nA pod is ready when all its containers are ready AND\nall conditions specified in the readiness gates have status equal to \"True\"\nMore info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md\n+optional" + }, + "runtimeClassName": { + "type": "string", + "title": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used\nto run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.\nIf unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an\nempty definition that uses the default runtime handler.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md\nThis is a beta feature as of Kubernetes v1.14.\n+optional" + }, + "enableServiceLinks": { + "type": "boolean", + "title": "EnableServiceLinks indicates whether information about services should be injected into pod's\nenvironment variables, matching the syntax of Docker links.\nOptional: Defaults to true.\n+optional" + }, + "preemptionPolicy": { + "type": "string", + "title": "PreemptionPolicy is the Policy for preempting pods with lower priority.\nOne of Never, PreemptLowerPriority.\nDefaults to PreemptLowerPriority if unset.\nThis field is beta-level, gated by the NonPreemptingPriority feature-gate.\n+optional" + }, + "overhead": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.api.resource.Quantity" + }, + "title": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.\nThis field will be autopopulated at admission time by the RuntimeClass admission controller. If\nthe RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests.\nThe RuntimeClass admission controller will reject Pod create requests which have the overhead already\nset. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value\ndefined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md\nThis field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.\n+optional" + }, + "topologySpreadConstraints": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.TopologySpreadConstraint" + }, + "title": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nAll topologySpreadConstraints are ANDed.\n+optional\n+patchMergeKey=topologyKey\n+patchStrategy=merge\n+listType=map\n+listMapKey=topologyKey\n+listMapKey=whenUnsatisfiable" + }, + "setHostnameAsFQDN": { + "type": "boolean", + "title": "If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).\nIn Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).\nIn Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\\\SYSTEM\\\\CurrentControlSet\\\\Services\\\\Tcpip\\\\Parameters to FQDN.\nIf a pod does not have FQDN, this has no effect.\nDefault to false.\n+optional" + } + }, + "description": "PodSpec is a description of a pod." + }, + "k8s.io.api.core.v1.PodTemplateSpec": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "spec": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodSpec" + } + }, + "title": "PodTemplateSpec describes the data a pod should have when created from a template" + }, + "k8s.io.api.core.v1.PortworxVolumeSource": { + "type": "object", + "properties": { + "volumeID": { + "type": "string", + "title": "VolumeID uniquely identifies a Portworx volume" + }, + "fsType": { + "type": "string", + "description": "FSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + }, + "readOnly": { + "type": "boolean", + "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "description": "PortworxVolumeSource represents a Portworx volume resource." + }, + "k8s.io.api.core.v1.PreferredSchedulingTerm": { + "type": "object", + "properties": { + "weight": { + "type": "integer", + "format": "int32", + "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100." + }, + "preference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.NodeSelectorTerm" + } + }, + "description": "An empty preferred scheduling term matches all objects with implicit weight 0\n(i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op)." + }, + "k8s.io.api.core.v1.Probe": { + "type": "object", + "properties": { + "handler": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Handler" + }, + "initialDelaySeconds": { + "type": "integer", + "format": "int32", + "title": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "timeoutSeconds": { + "type": "integer", + "format": "int32", + "title": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional" + }, + "periodSeconds": { + "type": "integer", + "format": "int32", + "title": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional" + }, + "successThreshold": { + "type": "integer", + "format": "int32", + "title": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional" + }, + "failureThreshold": { + "type": "integer", + "format": "int32", + "title": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional" + } + }, + "description": "Probe describes a health check to be performed against a container to determine whether it is\nalive or ready to receive traffic." + }, + "k8s.io.api.core.v1.ProjectedVolumeSource": { + "type": "object", + "properties": { + "sources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.VolumeProjection" + }, + "title": "list of volume projections\n+optional" + }, + "defaultMode": { + "type": "integer", + "format": "int32", + "title": "Mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + } + }, + "title": "Represents a projected volume source" + }, + "k8s.io.api.core.v1.QuobyteVolumeSource": { + "type": "object", + "properties": { + "registry": { + "type": "string", + "title": "Registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes" + }, + "volume": { + "type": "string", + "description": "Volume is a string that references an already created Quobyte volume by name." + }, + "readOnly": { + "type": "boolean", + "title": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.\n+optional" + }, + "user": { + "type": "string", + "title": "User to map volume access to\nDefaults to serivceaccount user\n+optional" + }, + "group": { + "type": "string", + "title": "Group to map volume access to\nDefault is no group\n+optional" + }, + "tenant": { + "type": "string", + "title": "Tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin\n+optional" + } + }, + "description": "Represents a Quobyte mount that lasts the lifetime of a pod.\nQuobyte volumes do not support ownership management or SELinux relabeling." + }, + "k8s.io.api.core.v1.RBDVolumeSource": { + "type": "object", + "properties": { + "monitors": { + "type": "array", + "items": { + "type": "string" + }, + "title": "A collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + }, + "image": { + "type": "string", + "title": "The rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + }, + "fsType": { + "type": "string", + "title": "Filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional" + }, + "pool": { + "type": "string", + "title": "The rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "user": { + "type": "string", + "title": "The rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "keyring": { + "type": "string", + "title": "Keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "readOnly": { + "type": "boolean", + "title": "ReadOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional" + } + }, + "description": "Represents a Rados Block Device mount that lasts the lifetime of a pod.\nRBD volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.ResourceFieldSelector": { + "type": "object", + "properties": { + "containerName": { + "type": "string", + "title": "Container name: required for volumes, optional for env vars\n+optional" + }, + "resource": { + "type": "string", + "title": "Required: resource to select" + }, + "divisor": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.api.resource.Quantity" + } + }, + "title": "ResourceFieldSelector represents container resources (cpu, memory) and their output format" + }, + "k8s.io.api.core.v1.ResourceRequirements": { + "type": "object", + "properties": { + "limits": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.api.resource.Quantity" + }, + "title": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional" + }, + "requests": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.api.resource.Quantity" + }, + "title": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/\n+optional" + } + }, + "description": "ResourceRequirements describes the compute resource requirements." + }, + "k8s.io.api.core.v1.SELinuxOptions": { + "type": "object", + "properties": { + "user": { + "type": "string", + "title": "User is a SELinux user label that applies to the container.\n+optional" + }, + "role": { + "type": "string", + "title": "Role is a SELinux role label that applies to the container.\n+optional" + }, + "type": { + "type": "string", + "title": "Type is a SELinux type label that applies to the container.\n+optional" + }, + "level": { + "type": "string", + "title": "Level is SELinux level label that applies to the container.\n+optional" + } + }, + "title": "SELinuxOptions are the labels to be applied to the container" + }, + "k8s.io.api.core.v1.ScaleIOVolumeSource": { + "type": "object", + "properties": { + "gateway": { + "type": "string", + "description": "The host address of the ScaleIO API Gateway." + }, + "system": { + "type": "string", + "description": "The name of the storage system as configured in ScaleIO." + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "sslEnabled": { + "type": "boolean", + "title": "Flag to enable/disable SSL communication with Gateway, default false\n+optional" + }, + "protectionDomain": { + "type": "string", + "title": "The name of the ScaleIO Protection Domain for the configured storage.\n+optional" + }, + "storagePool": { + "type": "string", + "title": "The ScaleIO Storage Pool associated with the protection domain.\n+optional" + }, + "storageMode": { + "type": "string", + "title": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume already created in the ScaleIO system\nthat is associated with this volume source." + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + } + }, + "title": "ScaleIOVolumeSource represents a persistent ScaleIO volume" + }, + "k8s.io.api.core.v1.SeccompProfile": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Localhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.\n+unionDiscriminator", + "title": "type indicates which kind of seccomp profile will be applied.\nValid options are:" + }, + "localhostProfile": { + "type": "string", + "title": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust only be set if type is \"Localhost\".\n+optional" + } + }, + "title": "SeccompProfile defines a pod/container's seccomp profile settings.\nOnly one profile source may be set.\n+union" + }, + "k8s.io.api.core.v1.SecretEnvSource": { + "type": "object", + "properties": { + "localObjectReference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "optional": { + "type": "boolean", + "title": "Specify whether the Secret must be defined\n+optional" + } + }, + "description": "SecretEnvSource selects a Secret to populate the environment\nvariables with.\n\nThe contents of the target Secret's Data field will represent the\nkey-value pairs as environment variables." + }, + "k8s.io.api.core.v1.SecretKeySelector": { + "type": "object", + "properties": { + "localObjectReference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "key": { + "type": "string", + "description": "The key of the secret to select from. Must be a valid secret key." + }, + "optional": { + "type": "boolean", + "title": "Specify whether the Secret or its key must be defined\n+optional" + } + }, + "description": "SecretKeySelector selects a key of a Secret." + }, + "k8s.io.api.core.v1.SecretProjection": { + "type": "object", + "properties": { + "localObjectReference": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.KeyToPath" + }, + "title": "If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "optional": { + "type": "boolean", + "title": "Specify whether the Secret or its key must be defined\n+optional" + } + }, + "description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a\nprojected volume as files using the keys in the Data field as the file names.\nNote that this is identical to a secret volume source without the default\nmode." + }, + "k8s.io.api.core.v1.SecretVolumeSource": { + "type": "object", + "properties": { + "secretName": { + "type": "string", + "title": "Name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.KeyToPath" + }, + "title": "If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional" + }, + "defaultMode": { + "type": "integer", + "format": "int32", + "title": "Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional" + }, + "optional": { + "type": "boolean", + "title": "Specify whether the Secret or its keys must be defined\n+optional" + } + }, + "description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume\nas files using the keys in the Data field as the file names.\nSecret volumes support ownership management and SELinux relabeling." + }, + "k8s.io.api.core.v1.SecurityContext": { + "type": "object", + "properties": { + "capabilities": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.Capabilities" + }, + "privileged": { + "type": "boolean", + "title": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\n+optional" + }, + "seLinuxOptions": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SELinuxOptions" + }, + "windowsOptions": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.WindowsSecurityContextOptions" + }, + "runAsUser": { + "type": "string", + "format": "int64", + "title": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "runAsGroup": { + "type": "string", + "format": "int64", + "title": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "runAsNonRoot": { + "type": "boolean", + "title": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + }, + "readOnlyRootFilesystem": { + "type": "boolean", + "title": "Whether this container has a read-only root filesystem.\nDefault is false.\n+optional" + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "title": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\n+optional" + }, + "procMount": { + "type": "string", + "title": "procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\n+optional" + }, + "seccompProfile": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SeccompProfile" + } + }, + "description": "SecurityContext holds security configuration that will be applied to a container.\nSome fields are present in both SecurityContext and PodSecurityContext. When both\nare set, the values in SecurityContext take precedence." + }, + "k8s.io.api.core.v1.ServiceAccountTokenProjection": { + "type": "object", + "properties": { + "audience": { + "type": "string", + "title": "Audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.\n+optional" + }, + "expirationSeconds": { + "type": "string", + "format": "int64", + "title": "ExpirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.\n+optional" + }, + "path": { + "type": "string", + "description": "Path is the path relative to the mount point of the file to project the\ntoken into." + } + }, + "description": "ServiceAccountTokenProjection represents a projected service account token\nvolume. This projection can be used to insert a service account token into\nthe pods runtime filesystem for use against APIs (Kubernetes API Server or\notherwise)." + }, + "k8s.io.api.core.v1.StorageOSVolumeSource": { + "type": "object", + "properties": { + "volumeName": { + "type": "string", + "description": "VolumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace." + }, + "volumeNamespace": { + "type": "string", + "title": "VolumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional" + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "readOnly": { + "type": "boolean", + "title": "Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional" + }, + "secretRef": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.LocalObjectReference" + } + }, + "description": "Represents a StorageOS persistent volume resource." + }, + "k8s.io.api.core.v1.Sysctl": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name of a property to set" + }, + "value": { + "type": "string", + "title": "Value of a property to set" + } + }, + "title": "Sysctl defines a kernel parameter to be set" + }, + "k8s.io.api.core.v1.TCPSocketAction": { + "type": "object", + "properties": { + "port": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.util.intstr.IntOrString" + }, + "host": { + "type": "string", + "title": "Optional: Host name to connect to, defaults to the pod IP.\n+optional" + } + }, + "title": "TCPSocketAction describes an action based on opening a socket" + }, + "k8s.io.api.core.v1.Toleration": { + "type": "object", + "properties": { + "key": { + "type": "string", + "title": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.\n+optional" + }, + "operator": { + "type": "string", + "title": "Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\n+optional" + }, + "value": { + "type": "string", + "title": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.\n+optional" + }, + "effect": { + "type": "string", + "title": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\n+optional" + }, + "tolerationSeconds": { + "type": "string", + "format": "int64", + "title": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.\n+optional" + } + }, + "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator ." + }, + "k8s.io.api.core.v1.TopologySpreadConstraint": { + "type": "object", + "properties": { + "maxSkew": { + "type": "integer", + "format": "int32", + "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 1/1/0:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P | P | |\n+-------+-------+-------+\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1;\nscheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed." + }, + "topologyKey": { + "type": "string", + "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nIt's a required field." + }, + "whenUnsatisfiable": { + "type": "string", + "description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assigment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P P | P | P |\n+-------+-------+-------+\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field." + }, + "labelSelector": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector" + } + }, + "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology." + }, + "k8s.io.api.core.v1.TypedLocalObjectReference": { + "type": "object", + "properties": { + "apiGroup": { + "type": "string", + "title": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional" + }, + "kind": { + "type": "string", + "title": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "title": "Name is the name of resource being referenced" + } + }, + "description": "TypedLocalObjectReference contains enough information to let you locate the\ntyped referenced object inside the same namespace." + }, + "k8s.io.api.core.v1.Volume": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Volume's name.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names" + }, + "volumeSource": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.VolumeSource" + } + }, + "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod." + }, + "k8s.io.api.core.v1.VolumeDevice": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "name must match the name of a persistentVolumeClaim in the pod" + }, + "devicePath": { + "type": "string", + "description": "devicePath is the path inside of the container that the device will be mapped to." + } + }, + "description": "volumeDevice describes a mapping of a raw block device within a container." + }, + "k8s.io.api.core.v1.VolumeMount": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "This must match the Name of a Volume." + }, + "readOnly": { + "type": "boolean", + "title": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional" + }, + "mountPath": { + "type": "string", + "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'." + }, + "subPath": { + "type": "string", + "title": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional" + }, + "mountPropagation": { + "type": "string", + "title": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\n+optional" + }, + "subPathExpr": { + "type": "string", + "title": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\n+optional" + } + }, + "description": "VolumeMount describes a mounting of a Volume within a container." + }, + "k8s.io.api.core.v1.VolumeProjection": { + "type": "object", + "properties": { + "secret": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SecretProjection" + }, + "downwardAPI": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.DownwardAPIProjection" + }, + "configMap": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ConfigMapProjection" + }, + "serviceAccountToken": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ServiceAccountTokenProjection" + } + }, + "title": "Projection that may be projected along with other supported volume types" + }, + "k8s.io.api.core.v1.VolumeSource": { + "type": "object", + "properties": { + "hostPath": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.HostPathVolumeSource" + }, + "emptyDir": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EmptyDirVolumeSource" + }, + "gcePersistentDisk": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.GCEPersistentDiskVolumeSource" + }, + "awsElasticBlockStore": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource" + }, + "gitRepo": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.GitRepoVolumeSource" + }, + "secret": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.SecretVolumeSource" + }, + "nfs": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.NFSVolumeSource" + }, + "iscsi": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ISCSIVolumeSource" + }, + "glusterfs": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.GlusterfsVolumeSource" + }, + "persistentVolumeClaim": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource" + }, + "rbd": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.RBDVolumeSource" + }, + "flexVolume": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.FlexVolumeSource" + }, + "cinder": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.CinderVolumeSource" + }, + "cephfs": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.CephFSVolumeSource" + }, + "flocker": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.FlockerVolumeSource" + }, + "downwardAPI": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.DownwardAPIVolumeSource" + }, + "fc": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.FCVolumeSource" + }, + "azureFile": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.AzureFileVolumeSource" + }, + "configMap": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ConfigMapVolumeSource" + }, + "vsphereVolume": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource" + }, + "quobyte": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.QuobyteVolumeSource" + }, + "azureDisk": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.AzureDiskVolumeSource" + }, + "photonPersistentDisk": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource" + }, + "projected": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ProjectedVolumeSource" + }, + "portworxVolume": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PortworxVolumeSource" + }, + "scaleIO": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.ScaleIOVolumeSource" + }, + "storageos": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.StorageOSVolumeSource" + }, + "csi": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.CSIVolumeSource" + }, + "ephemeral": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.EphemeralVolumeSource" + } + }, + "description": "Represents the source of a volume to mount.\nOnly one of its members may be specified." + }, + "k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource": { + "type": "object", + "properties": { + "volumePath": { + "type": "string", + "title": "Path that identifies vSphere volume vmdk" + }, + "fsType": { + "type": "string", + "title": "Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional" + }, + "storagePolicyName": { + "type": "string", + "title": "Storage Policy Based Management (SPBM) profile name.\n+optional" + }, + "storagePolicyID": { + "type": "string", + "title": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.\n+optional" + } + }, + "description": "Represents a vSphere volume resource." + }, + "k8s.io.api.core.v1.WeightedPodAffinityTerm": { + "type": "object", + "properties": { + "weight": { + "type": "integer", + "format": "int32", + "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100." + }, + "podAffinityTerm": { + "$ref": "#/components/schemas/k8s.io.api.core.v1.PodAffinityTerm" + } + }, + "title": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)" + }, + "k8s.io.api.core.v1.WindowsSecurityContextOptions": { + "type": "object", + "properties": { + "gmsaCredentialSpecName": { + "type": "string", + "title": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\n+optional" + }, + "gmsaCredentialSpec": { + "type": "string", + "title": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\n+optional" + }, + "runAsUserName": { + "type": "string", + "title": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional" + } + }, + "description": "WindowsSecurityContextOptions contain Windows-specific options and credentials." + }, + "k8s.io.apimachinery.pkg.api.resource.Quantity": { + "type": "object", + "properties": { + "string": { + "type": "string" + } + }, + "description": "Quantity is a fixed-point representation of a number.\nIt provides convenient marshaling/unmarshaling in JSON and YAML,\nin addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n ::= \n (Note that may be empty, from the \"\" case in .)\n ::= 0 | 1 | ... | 9\n ::= | \n ::= | . | . | .\n ::= \"+\" | \"-\"\n ::= | \n ::= | | \n ::= Ki | Mi | Gi | Ti | Pi | Ei\n (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n ::= m | \"\" | k | M | G | T | P | E\n (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n ::= \"e\" | \"E\" \n\nNo matter which of the three exponent forms is used, no quantity may represent\na number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal\nplaces. Numbers larger or more precise will be capped or rounded up.\n(E.g.: 0.1m will rounded up to 1m.)\nThis may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix\nit had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\".\nThis means that Exponent/suffix will be adjusted up or down (with a\ncorresponding increase or decrease in Mantissa) such that:\n a. No precision is lost\n b. No fractional digits will be emitted\n c. The exponent (or suffix) is as large as possible.\nThe sign will be omitted unless the number is negative.\n\nExamples:\n 1.5 will be serialized as \"1500m\"\n 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a\nfloating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed,\nbut will be re-emitted in their canonical form. (So always use canonical\nform, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without\nwriting some sort of special handling code in the hopes that that will\ncause implementors to also use a fixed point implementation.\n\n+protobuf=true\n+protobuf.embed=string\n+protobuf.options.marshal=false\n+protobuf.options.(gogoproto.goproto_stringer)=false\n+k8s:deepcopy-gen=true\n+k8s:openapi-gen=true" + }, + "k8s.io.apimachinery.pkg.apis.meta.v1.FieldsV1": { + "type": "object", + "properties": { + "Raw": { + "type": "string", + "format": "byte", + "description": "Raw is the underlying serialization of this object." + } + }, + "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,\nor a string representing a sub-field or item. The string will follow one of these four formats:\n'f:', where is the name of a field in a struct, or key in a map\n'v:', where is the exact json formatted value of a list item\n'i:', where is position of a item in a list\n'k:', where is a map of a list item's key fields to their unique values\nIf a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff\n+protobuf.options.(gogoproto.goproto_stringer)=false" + }, + "k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector": { + "type": "object", + "properties": { + "matchLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional" + }, + "matchExpressions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement" + }, + "title": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional" + } + }, + "title": "A label selector is a label query over a set of resources. The result of matchLabels and\nmatchExpressions are ANDed. An empty label selector matches all objects. A null\nlabel selector matches no objects.\n+structType=atomic" + }, + "k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": { + "type": "object", + "properties": { + "key": { + "type": "string", + "title": "key is the label key that the selector applies to.\n+patchMergeKey=key\n+patchStrategy=merge" + }, + "operator": { + "type": "string", + "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "title": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.\n+optional" + } + }, + "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values." + }, + "k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry": { + "type": "object", + "properties": { + "manager": { + "type": "string", + "description": "Manager is an identifier of the workflow managing these fields." + }, + "operation": { + "type": "string", + "description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.\nThe only valid values for this field are 'Apply' and 'Update'." + }, + "apiVersion": { + "type": "string", + "description": "APIVersion defines the version of this resource that this field set\napplies to. The format is \"group/version\" just like the top-level\nAPIVersion field. It is necessary to track the version of a field\nset because it cannot be automatically converted." + }, + "time": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "fieldsType": { + "type": "string", + "title": "FieldsType is the discriminator for the different fields format and version.\nThere is currently only one possible value: \"FieldsV1\"" + }, + "fieldsV1": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.FieldsV1" + } + }, + "description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource\nthat the fieldset applies to." + }, + "k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta": { + "type": "object", + "properties": { + "name": { + "type": "string", + "title": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names\n+optional" + }, + "generateName": { + "type": "string", + "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will\nNOT return a 409 - instead, it will either return 201 Created or 500 with Reason\nServerTimeout indicating a unique name could not be found in the time allotted, and the client\nshould retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional" + }, + "namespace": { + "type": "string", + "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/namespaces\n+optional" + }, + "selfLink": { + "type": "string", + "description": "SelfLink is a URL representing this object.\nPopulated by the system.\nRead-only.\n\nDEPRECATED\nKubernetes will stop propagating this field in 1.20 release and the field is planned\nto be removed in 1.21 release.\n+optional" + }, + "uid": { + "type": "string", + "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids\n+optional" + }, + "resourceVersion": { + "type": "string", + "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional" + }, + "generation": { + "type": "string", + "format": "int64", + "title": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional" + }, + "creationTimestamp": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "deletionTimestamp": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.Time" + }, + "deletionGracePeriodSeconds": { + "type": "string", + "format": "int64", + "title": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels\n+optional" + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "title": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations\n+optional" + }, + "ownerReferences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference" + }, + "title": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge" + }, + "finalizers": { + "type": "array", + "items": { + "type": "string" + }, + "title": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge" + }, + "clusterName": { + "type": "string", + "title": "The name of the cluster which the object belongs to.\nThis is used to distinguish resources with same name and namespace in different clusters.\nThis field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.\n+optional" + }, + "managedFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry" + }, + "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional" + } + }, + "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects\nusers must create." + }, + "k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference": { + "type": "object", + "properties": { + "apiVersion": { + "type": "string", + "description": "API version of the referent." + }, + "kind": { + "type": "string", + "title": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + }, + "name": { + "type": "string", + "title": "Name of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + }, + "uid": { + "type": "string", + "title": "UID of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids" + }, + "controller": { + "type": "boolean", + "title": "If true, this reference points to the managing controller.\n+optional" + }, + "blockOwnerDeletion": { + "type": "boolean", + "title": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional" + } + }, + "description": "OwnerReference contains enough information to let you identify an owning\nobject. An owning object must be in the same namespace as the dependent, or\nbe cluster-scoped, so there is no namespace field." + }, + "k8s.io.apimachinery.pkg.apis.meta.v1.Time": { + "type": "object", + "properties": { + "seconds": { + "type": "string", + "format": "int64", + "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive." + }, + "nanos": { + "type": "integer", + "format": "int32", + "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context." + } + }, + "description": "Time is a wrapper around time.Time which supports correct\nmarshaling to YAML and JSON. Wrappers are provided for many\nof the factory methods that the time package offers.\n\n+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false" + }, + "k8s.io.apimachinery.pkg.util.intstr.IntOrString": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "int64" + }, + "intVal": { + "type": "integer", + "format": "int32" + }, + "strVal": { + "type": "string" + } + }, + "description": "+protobuf=true\n+protobuf.options.(gogoproto.goproto_stringer)=false\n+k8s:openapi-gen=true", + "title": "IntOrString is a type that can hold an int32 or a string. When used in\nJSON or YAML marshalling and unmarshalling, it produces or consumes the\ninner type. This allows you to have, for example, a JSON field that can\naccept a name or number.\nTODO: Rename to Int32OrString" + }, + "rollout.AbortRolloutRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + } + } + }, + "rollout.AnalysisRunInfo": { + "type": "object", + "properties": { + "objectMeta": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "icon": { + "type": "string" + }, + "revision": { + "type": "integer", + "format": "int32" + }, + "status": { + "type": "string" + }, + "successful": { + "type": "integer", + "format": "int32" + }, + "failed": { + "type": "integer", + "format": "int32" + }, + "inconclusive": { + "type": "integer", + "format": "int32" + }, + "error": { + "type": "integer", + "format": "int32" + }, + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.JobInfo" + } + } + } + }, + "rollout.ContainerInfo": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "image": { + "type": "string" + } + } + }, + "rollout.ExperimentInfo": { + "type": "object", + "properties": { + "objectMeta": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "icon": { + "type": "string" + }, + "revision": { + "type": "integer", + "format": "int32" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "replicaSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.ReplicaSetInfo" + } + }, + "analysisRuns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.AnalysisRunInfo" + } + } + } + }, + "rollout.JobInfo": { + "type": "object", + "properties": { + "objectMeta": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "status": { + "type": "string" + }, + "icon": { + "type": "string" + } + } + }, + "rollout.NamespaceInfo": { + "type": "object", + "properties": { + "namespace": { + "type": "string" + }, + "availableNamespaces": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "rollout.PodInfo": { + "type": "object", + "properties": { + "objectMeta": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "status": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "ready": { + "type": "string" + }, + "restarts": { + "type": "integer", + "format": "int32" + } + } + }, + "rollout.PromoteRolloutRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "full": { + "type": "boolean" + } + } + }, + "rollout.ReplicaSetInfo": { + "type": "object", + "properties": { + "objectMeta": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "status": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "revision": { + "type": "integer", + "format": "int32" + }, + "stable": { + "type": "boolean" + }, + "canary": { + "type": "boolean" + }, + "active": { + "type": "boolean" + }, + "preview": { + "type": "boolean" + }, + "replicas": { + "type": "integer", + "format": "int32" + }, + "available": { + "type": "integer", + "format": "int32" + }, + "template": { + "type": "string" + }, + "scaleDownDeadline": { + "type": "string" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "pods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.PodInfo" + } + } + } + }, + "rollout.RestartRolloutRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + } + } + }, + "rollout.RetryRolloutRequest": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + } + } + }, + "rollout.RolloutInfo": { + "type": "object", + "properties": { + "objectMeta": { + "$ref": "#/components/schemas/k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "strategy": { + "type": "string" + }, + "step": { + "type": "string" + }, + "setWeight": { + "type": "string" + }, + "actualWeight": { + "type": "string" + }, + "ready": { + "type": "integer", + "format": "int32" + }, + "current": { + "type": "integer", + "format": "int32" + }, + "desired": { + "type": "integer", + "format": "int32" + }, + "updated": { + "type": "integer", + "format": "int32" + }, + "available": { + "type": "integer", + "format": "int32" + }, + "restartedAt": { + "type": "string" + }, + "generation": { + "type": "string" + }, + "replicaSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.ReplicaSetInfo" + } + }, + "experiments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.ExperimentInfo" + } + }, + "analysisRuns": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.AnalysisRunInfo" + } + }, + "containers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.ContainerInfo" + } + }, + "steps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/github.com.argoproj.argo_rollouts.pkg.apis.rollouts.v1alpha1.CanaryStep" + } + } + } + }, + "rollout.RolloutInfoList": { + "type": "object", + "properties": { + "rollouts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/rollout.RolloutInfo" + } + } + } + }, + "rollout.RolloutWatchEvent": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "rolloutInfo": { + "$ref": "#/components/schemas/rollout.RolloutInfo" + } + } + }, + "rollout.SetImageRequest": { + "type": "object", + "properties": { + "rollout": { + "type": "string" + }, + "container": { + "type": "string" + }, + "image": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "namespace": { + "type": "string" + } + } + }, + "rollout.UndoRolloutRequest": { + "type": "object", + "properties": { + "rollout": { + "type": "string" + }, + "revision": { + "type": "string", + "format": "int64" + }, + "namespace": { + "type": "string" + } + } + }, + "rollout.VersionInfo": { + "type": "object", + "properties": { + "rolloutsVersion": { + "type": "string" + } + } + } + } + } +} \ No newline at end of file From 9ec58c4212f08e44593d76d34b8ad641ace6405a Mon Sep 17 00:00:00 2001 From: Himenon Date: Fri, 13 Aug 2021 13:11:26 +0900 Subject: [PATCH 2/3] fix: schema Added support for cases where schemas name contains '.' --- scripts/testCodeGen.ts | 30 +++++++++---------- src/internal/OpenApiTools/ConverterContext.ts | 8 +++++ src/internal/OpenApiTools/TypeNodeContext.ts | 8 ++--- src/internal/OpenApiTools/Walker/Store.ts | 12 +++++++- src/internal/OpenApiTools/toTypeNode.ts | 2 +- 5 files changed, 39 insertions(+), 21 deletions(-) diff --git a/scripts/testCodeGen.ts b/scripts/testCodeGen.ts index 0affc842..8e91ba71 100644 --- a/scripts/testCodeGen.ts +++ b/scripts/testCodeGen.ts @@ -98,29 +98,29 @@ const generateParameter = (inputFilename: string, outputFilename: string) => { }; const main = () => { - generateTypedefCodeOnly("test/api.test.domain/index.yml", "test/code/typedef-only/api.test.domain.ts", true); - generateTypedefCodeOnly("test/infer.domain/index.yml", "test/code/typedef-only/infer.domain.ts", false); + // generateTypedefCodeOnly("test/api.test.domain/index.yml", "test/code/typedef-only/api.test.domain.ts", true); + // generateTypedefCodeOnly("test/infer.domain/index.yml", "test/code/typedef-only/infer.domain.ts", false); - generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/api.test.domain.ts", true, { sync: false }); - generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/sync-api.test.domain.ts", true, { sync: true }); - generateTemplateCodeOnly("test/infer.domain/index.yml", "test/code/template-only/infer.domain.ts", false, { sync: true }); + // generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/api.test.domain.ts", true, { sync: false }); + // generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/sync-api.test.domain.ts", true, { sync: true }); + // generateTemplateCodeOnly("test/infer.domain/index.yml", "test/code/template-only/infer.domain.ts", false, { sync: true }); - generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/api.test.domain.ts", true, { - sync: false, - }); - generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/sync-api.test.domain.ts", true, { - sync: true, - }); - generateTypedefWithTemplateCode("test/infer.domain/index.yml", "test/code/typedef-with-template/infer.domain.ts", false, { sync: false }); + // generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/api.test.domain.ts", true, { + // sync: false, + // }); + // generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/sync-api.test.domain.ts", true, { + // sync: true, + // }); + // generateTypedefWithTemplateCode("test/infer.domain/index.yml", "test/code/typedef-with-template/infer.domain.ts", false, { sync: false }); generateTypedefWithTemplateCode("test/argo-rollout/index.json", "test/code/typedef-with-template/argo-rollout.ts", false, { sync: false, }); - generateSplitCode("test/api.test.domain/index.yml", "test/code/split"); + // generateSplitCode("test/api.test.domain/index.yml", "test/code/split"); - generateParameter("test/api.test.domain/index.yml", "test/code/parameter/api.test.domain.json"); - generateParameter("test/infer.domain/index.yml", "test/code/parameter/infer.domain.json"); + // generateParameter("test/api.test.domain/index.yml", "test/code/parameter/api.test.domain.json"); + // generateParameter("test/infer.domain/index.yml", "test/code/parameter/infer.domain.json"); }; main(); diff --git a/src/internal/OpenApiTools/ConverterContext.ts b/src/internal/OpenApiTools/ConverterContext.ts index 819b7f4c..fe925af8 100644 --- a/src/internal/OpenApiTools/ConverterContext.ts +++ b/src/internal/OpenApiTools/ConverterContext.ts @@ -16,6 +16,10 @@ export interface Types { * import/exportなどの予約語も裁く */ escapeDeclarationText: (text: string) => string; + /** + * Schemas.A.B.Cに対するEscape + */ + escapeReferenceDeclarationText: (text: string) => string; /** * 非破壊: PropertySignatureのname用のescape */ @@ -54,6 +58,10 @@ export const create = (): Types => { return convertString(operationId); }, escapeDeclarationText: (text: string) => { + return convertReservedWord(convertString(text).replace(/\./g, "$")); + }, + escapeReferenceDeclarationText: (text: string) => { + // console.log(`escapeDeclarationText3: ${text}` + `-> ${convertReservedWord(convertString(text))}`.padStart(100, " ")); return convertReservedWord(convertString(text)); }, escapePropertySignatureName: (text: string) => { diff --git a/src/internal/OpenApiTools/TypeNodeContext.ts b/src/internal/OpenApiTools/TypeNodeContext.ts index 0270a813..0f7bfdb6 100644 --- a/src/internal/OpenApiTools/TypeNodeContext.ts +++ b/src/internal/OpenApiTools/TypeNodeContext.ts @@ -25,7 +25,7 @@ const generatePath = (entryPoint: string, currentPoint: string, referencePath: s }; }; -const calculateReferencePath = (store: Walker.Store, base: string, pathArray: string[]): ToTypeNode.ResolveReferencePath => { +const calculateReferencePath = (store: Walker.Store, base: string, pathArray: string[], converterContext: ConverterContext.Types,): ToTypeNode.ResolveReferencePath => { let names: string[] = []; let unresolvedPaths: string[] = []; pathArray.reduce((previous, lastPath, index) => { @@ -67,8 +67,8 @@ const calculateReferencePath = (store: Walker.Store, base: string, pathArray: st throw new DevelopmentError("Local Reference Error \n" + JSON.stringify({ pathArray, names, base }, null, 2)); } return { - name: names.join("."), - maybeResolvedName: names.concat(unresolvedPaths).join("."), + name: names.map(converterContext.escapeDeclarationText).join("."), + maybeResolvedName: names.concat(unresolvedPaths).map(converterContext.escapeDeclarationText).join("."), unresolvedPaths, }; }; @@ -81,7 +81,7 @@ export const create = ( ): ToTypeNode.Context => { const resolveReferencePath: ToTypeNode.Context["resolveReferencePath"] = (currentPoint, referencePath) => { const { pathArray, base } = generatePath(entryPoint, currentPoint, referencePath); - return calculateReferencePath(store, base, pathArray); + return calculateReferencePath(store, base, pathArray, converterContext); }; const setReferenceHandler: ToTypeNode.Context["setReferenceHandler"] = (currentPoint, reference) => { if (store.hasStatement(reference.path, ["interface", "typeAlias"])) { diff --git a/src/internal/OpenApiTools/Walker/Store.ts b/src/internal/OpenApiTools/Walker/Store.ts index 4c141706..728f705b 100644 --- a/src/internal/OpenApiTools/Walker/Store.ts +++ b/src/internal/OpenApiTools/Walker/Store.ts @@ -1,5 +1,6 @@ import * as Path from "path"; +import * as fs from "fs"; import { Tree } from "@himenon/path-oriented-data-structure"; import Dot from "dot-prop"; import ts from "typescript"; @@ -50,7 +51,8 @@ class Store { }); } public getRootStatements(): ts.Statement[] { - // fs.writeFileSync("debug/tree.json", JSON.stringify(operator.getHierarchy(), null, 2), { encoding: "utf-8" }); + // Debug Point + fs.writeFileSync("debug/tree.json", JSON.stringify(this.operator.getHierarchy(), null, 2), { encoding: "utf-8" }); const statements = Def.componentNames.reduce((statements, componentName) => { const treeOfNamespace = this.getChildByPaths(componentName, "namespace"); if (treeOfNamespace) { @@ -78,6 +80,14 @@ class Store { throw new UnSupportError(`componentsから始まっていません。path=${path}`); } const targetPath = Path.posix.relative("components", path); + // すでにinterfaceとして登録がある場合はスキップ + if (this.hasStatement(targetPath, ["interface"])) { + return; + } + // もしTypeAlias同じスコープに登録されている場合、既存のTypeAliasを削除する + if (this.hasStatement(targetPath, ["typeAlias"])) { + this.operator.remove(targetPath, "typeAlias"); + } this.operator.set(targetPath, Structure.createInstance(statement)); } public getStatement(path: string, kind: T): Structure.DataStructure.GetChild | undefined { diff --git a/src/internal/OpenApiTools/toTypeNode.ts b/src/internal/OpenApiTools/toTypeNode.ts index 76014ca1..1b6fdfb3 100644 --- a/src/internal/OpenApiTools/toTypeNode.ts +++ b/src/internal/OpenApiTools/toTypeNode.ts @@ -97,7 +97,7 @@ export const convert: Convert = ( // Type Aliasを作成 (or すでにある場合は作成しない) context.setReferenceHandler(currentPoint, reference); const { maybeResolvedName } = context.resolveReferencePath(currentPoint, reference.path); - return factory.TypeReferenceNode.create({ name: converterContext.escapeDeclarationText(maybeResolvedName) }); + return factory.TypeReferenceNode.create({ name: converterContext.escapeReferenceDeclarationText(maybeResolvedName) }); } // サポートしているディレクトリに対して存在する場合 if (reference.componentName) { From c60eb418982c33a711ddfe47a2672646dd7e2a87 Mon Sep 17 00:00:00 2001 From: Himenon Date: Fri, 13 Aug 2021 13:39:45 +0900 Subject: [PATCH 3/3] test: update snapshot --- scripts/testCodeGen.ts | 30 +- src/internal/OpenApiTools/ConverterContext.ts | 1 + src/internal/OpenApiTools/Walker/Store.ts | 5 +- .../OpenApiTools/components/Schemas.ts | 4 +- .../typedef-with-template-test.ts.snap | 2000 +++++++++++++++++ test/__tests__/typedef-with-template-test.ts | 5 + 6 files changed, 2025 insertions(+), 20 deletions(-) diff --git a/scripts/testCodeGen.ts b/scripts/testCodeGen.ts index 8e91ba71..0affc842 100644 --- a/scripts/testCodeGen.ts +++ b/scripts/testCodeGen.ts @@ -98,29 +98,29 @@ const generateParameter = (inputFilename: string, outputFilename: string) => { }; const main = () => { - // generateTypedefCodeOnly("test/api.test.domain/index.yml", "test/code/typedef-only/api.test.domain.ts", true); - // generateTypedefCodeOnly("test/infer.domain/index.yml", "test/code/typedef-only/infer.domain.ts", false); + generateTypedefCodeOnly("test/api.test.domain/index.yml", "test/code/typedef-only/api.test.domain.ts", true); + generateTypedefCodeOnly("test/infer.domain/index.yml", "test/code/typedef-only/infer.domain.ts", false); - // generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/api.test.domain.ts", true, { sync: false }); - // generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/sync-api.test.domain.ts", true, { sync: true }); - // generateTemplateCodeOnly("test/infer.domain/index.yml", "test/code/template-only/infer.domain.ts", false, { sync: true }); + generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/api.test.domain.ts", true, { sync: false }); + generateTemplateCodeOnly("test/api.test.domain/index.yml", "test/code/template-only/sync-api.test.domain.ts", true, { sync: true }); + generateTemplateCodeOnly("test/infer.domain/index.yml", "test/code/template-only/infer.domain.ts", false, { sync: true }); - // generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/api.test.domain.ts", true, { - // sync: false, - // }); - // generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/sync-api.test.domain.ts", true, { - // sync: true, - // }); - // generateTypedefWithTemplateCode("test/infer.domain/index.yml", "test/code/typedef-with-template/infer.domain.ts", false, { sync: false }); + generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/api.test.domain.ts", true, { + sync: false, + }); + generateTypedefWithTemplateCode("test/api.test.domain/index.yml", "test/code/typedef-with-template/sync-api.test.domain.ts", true, { + sync: true, + }); + generateTypedefWithTemplateCode("test/infer.domain/index.yml", "test/code/typedef-with-template/infer.domain.ts", false, { sync: false }); generateTypedefWithTemplateCode("test/argo-rollout/index.json", "test/code/typedef-with-template/argo-rollout.ts", false, { sync: false, }); - // generateSplitCode("test/api.test.domain/index.yml", "test/code/split"); + generateSplitCode("test/api.test.domain/index.yml", "test/code/split"); - // generateParameter("test/api.test.domain/index.yml", "test/code/parameter/api.test.domain.json"); - // generateParameter("test/infer.domain/index.yml", "test/code/parameter/infer.domain.json"); + generateParameter("test/api.test.domain/index.yml", "test/code/parameter/api.test.domain.json"); + generateParameter("test/infer.domain/index.yml", "test/code/parameter/infer.domain.json"); }; main(); diff --git a/src/internal/OpenApiTools/ConverterContext.ts b/src/internal/OpenApiTools/ConverterContext.ts index fe925af8..2dcd8513 100644 --- a/src/internal/OpenApiTools/ConverterContext.ts +++ b/src/internal/OpenApiTools/ConverterContext.ts @@ -58,6 +58,7 @@ export const create = (): Types => { return convertString(operationId); }, escapeDeclarationText: (text: string) => { + // console.log(`escapeDeclarationText: ${text}` + `-> ${convertReservedWord(convertString(text).replace(/\./g, "$"))}`.padStart(100, " ")); return convertReservedWord(convertString(text).replace(/\./g, "$")); }, escapeReferenceDeclarationText: (text: string) => { diff --git a/src/internal/OpenApiTools/Walker/Store.ts b/src/internal/OpenApiTools/Walker/Store.ts index 728f705b..8c8c77c1 100644 --- a/src/internal/OpenApiTools/Walker/Store.ts +++ b/src/internal/OpenApiTools/Walker/Store.ts @@ -1,6 +1,5 @@ import * as Path from "path"; -import * as fs from "fs"; import { Tree } from "@himenon/path-oriented-data-structure"; import Dot from "dot-prop"; import ts from "typescript"; @@ -51,8 +50,8 @@ class Store { }); } public getRootStatements(): ts.Statement[] { - // Debug Point - fs.writeFileSync("debug/tree.json", JSON.stringify(this.operator.getHierarchy(), null, 2), { encoding: "utf-8" }); + // Debug Point: 抽象的なデータ構造全体を把握するために出力すると良い + // fs.writeFileSync("debug/tree.json", JSON.stringify(this.operator.getHierarchy(), null, 2), { encoding: "utf-8" }); const statements = Def.componentNames.reduce((statements, componentName) => { const treeOfNamespace = this.getChildByPaths(componentName, "namespace"); if (treeOfNamespace) { diff --git a/src/internal/OpenApiTools/components/Schemas.ts b/src/internal/OpenApiTools/components/Schemas.ts index 861056f0..e50e2d50 100644 --- a/src/internal/OpenApiTools/components/Schemas.ts +++ b/src/internal/OpenApiTools/components/Schemas.ts @@ -53,7 +53,7 @@ export const generateNamespace = ( export: true, name: convertContext.escapeDeclarationText(name), type: factory.TypeReferenceNode.create({ - name: convertContext.escapeDeclarationText(maybeResolvedName), + name: convertContext.escapeReferenceDeclarationText(maybeResolvedName), }), }), }); @@ -81,7 +81,7 @@ export const generateNamespace = ( name: convertContext.escapeDeclarationText(name), comment: reference.data.description, type: factory.TypeReferenceNode.create({ - name: convertContext.escapeDeclarationText(context.resolveReferencePath(currentPoint, reference.path).name), + name: convertContext.escapeReferenceDeclarationText(context.resolveReferencePath(currentPoint, reference.path).name), }), }), }); diff --git a/test/__tests__/__snapshots__/typedef-with-template-test.ts.snap b/test/__tests__/__snapshots__/typedef-with-template-test.ts.snap index 8abb83a3..e146f40e 100644 --- a/test/__tests__/__snapshots__/typedef-with-template-test.ts.snap +++ b/test/__tests__/__snapshots__/typedef-with-template-test.ts.snap @@ -438,6 +438,2006 @@ export class Client { " `; +exports[`Typedef with template argo-rollout 1`] = ` +"// +// Generated by @himenon/openapi-typescript-code-generator +// +// OpenApi : 3.0.0 +// +// + + +export namespace Schemas { + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$ALBTrafficRouting { + ingress?: string; + servicePort?: number; + rootService?: string; + annotationPrefix?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AmbassadorTrafficRouting { + mappings?: string[]; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AnalysisRunArgument { + name?: string; + value?: string; + valueFrom?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$ArgumentValueFrom; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AnalysisRunStrategy { + successfulRunHistoryLimit?: number; + unsuccessfulRunHistoryLimit?: number; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AntiAffinity { + preferredDuringSchedulingIgnoredDuringExecution?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PreferredDuringSchedulingIgnoredDuringExecution; + requiredDuringSchedulingIgnoredDuringExecution?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RequiredDuringSchedulingIgnoredDuringExecution; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$ArgumentValueFrom { + podTemplateHashValue?: string; + fieldRef?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$FieldRef; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$BlueGreenStatus { + previewSelector?: string; + activeSelector?: string; + scaleUpPreviewCheckPoint?: boolean; + prePromotionAnalysisRunStatus?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisRunStatus; + postPromotionAnalysisRunStatus?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisRunStatus; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$BlueGreenStrategy { + /** Name of the service that the rollout modifies as the active service. */ + activeService?: string; + previewService?: string; + previewReplicaCount?: number; + autoPromotionEnabled?: boolean; + autoPromotionSeconds?: number; + maxUnavailable?: Schemas.k8s$io$apimachinery$pkg$util$intstr$IntOrString; + scaleDownDelaySeconds?: number; + scaleDownDelayRevisionLimit?: number; + prePromotionAnalysis?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysis; + antiAffinity?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AntiAffinity; + postPromotionAnalysis?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysis; + previewMetadata?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PodTemplateMetadata; + activeMetadata?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PodTemplateMetadata; + abortScaleDownDelaySeconds?: number; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$CanaryStatus { + currentStepAnalysisRunStatus?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisRunStatus; + currentBackgroundAnalysisRunStatus?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisRunStatus; + currentExperiment?: string; + } + /** CanaryStep defines a step of a canary deployment. */ + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$CanaryStep { + setWeight?: number; + pause?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutPause; + experiment?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutExperimentStep; + analysis?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysis; + setCanaryScale?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$SetCanaryScale; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$CanaryStrategy { + canaryService?: string; + stableService?: string; + steps?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$CanaryStep[]; + trafficRouting?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutTrafficRouting; + maxUnavailable?: Schemas.k8s$io$apimachinery$pkg$util$intstr$IntOrString; + maxSurge?: Schemas.k8s$io$apimachinery$pkg$util$intstr$IntOrString; + analysis?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisBackground; + antiAffinity?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AntiAffinity; + canaryMetadata?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PodTemplateMetadata; + stableMetadata?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PodTemplateMetadata; + scaleDownDelaySeconds?: number; + scaleDownDelayRevisionLimit?: number; + abortScaleDownDelaySeconds?: number; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$FieldRef { + fieldPath?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$IstioDestinationRule { + name?: string; + canarySubsetName?: string; + stableSubsetName?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$IstioTrafficRouting { + virtualService?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$IstioVirtualService; + destinationRule?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$IstioDestinationRule; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$IstioVirtualService { + name?: string; + routes?: string[]; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$NginxTrafficRouting { + annotationPrefix?: string; + stableIngress?: string; + additionalIngressAnnotations?: { + [key: string]: string; + }; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$ObjectRef { + apiVersion?: string; + kind?: string; + name?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PauseCondition { + reason?: string; + startTime?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PodTemplateMetadata { + labels?: { + [key: string]: string; + }; + annotations?: { + [key: string]: string; + }; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PreferredDuringSchedulingIgnoredDuringExecution { + /** Weight associated with matching the corresponding podAffinityTerm, in the range 1-100. */ + weight?: number; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RequiredDuringSchedulingIgnoredDuringExecution { + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$Rollout { + metadata?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + spec?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutSpec; + status?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutStatus; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysis { + templates?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisTemplate[]; + args?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AnalysisRunArgument[]; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisBackground { + rolloutAnalysis?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysis; + startingStep?: number; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisRunStatus { + name?: string; + status?: string; + message?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutAnalysisTemplate { + templateName?: string; + clusterScope?: boolean; + } + /** RolloutCondition describes the state of a rollout at a certain point. */ + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutCondition { + /** Type of deployment condition. */ + type?: string; + /** Phase of the condition, one of True, False, Unknown. */ + status?: string; + lastUpdateTime?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + lastTransitionTime?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + /** The reason for the condition's last transition. */ + reason?: string; + /** A human readable message indicating details about the transition. */ + message?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutExperimentStep { + templates?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutExperimentTemplate[]; + duration?: string; + analyses?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutExperimentStepAnalysisTemplateRef[]; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutExperimentStepAnalysisTemplateRef { + name?: string; + templateName?: string; + clusterScope?: boolean; + args?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AnalysisRunArgument[]; + requiredForCompletion?: boolean; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutExperimentTemplate { + name?: string; + specRef?: string; + replicas?: number; + metadata?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PodTemplateMetadata; + selector?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelector; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutPause { + duration?: Schemas.k8s$io$apimachinery$pkg$util$intstr$IntOrString; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutSpec { + replicas?: number; + selector?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelector; + template?: Schemas.k8s$io$api$core$v1$PodTemplateSpec; + workloadRef?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$ObjectRef; + minReadySeconds?: number; + strategy?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutStrategy; + revisionHistoryLimit?: number; + /** Paused pauses the rollout at its current step. */ + paused?: boolean; + /** + * ProgressDeadlineSeconds The maximum time in seconds for a rollout to + * make progress before it is considered to be failed. Argo Rollouts will + * continue to process failed rollouts and a condition with a + * ProgressDeadlineExceeded reason will be surfaced in the rollout status. + * Note that progress will not be estimated during the time a rollout is paused. + * Defaults to 600s. + */ + progressDeadlineSeconds?: number; + restartAt?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + analysis?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AnalysisRunStrategy; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutStatus { + abort?: boolean; + pauseConditions?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$PauseCondition[]; + /** + * ControllerPause indicates the controller has paused the rollout. It is set to true when + * the controller adds a pause condition. This field helps to discern the scenario where a + * rollout was resumed after being paused by the controller (e.g. via the plugin). In that + * situation, the pauseConditions would have been cleared , but controllerPause would still be + * set to true. + */ + controllerPause?: boolean; + abortedAt?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + currentPodHash?: string; + currentStepHash?: string; + replicas?: number; + updatedReplicas?: number; + readyReplicas?: number; + availableReplicas?: number; + currentStepIndex?: number; + collisionCount?: number; + observedGeneration?: string; + workloadObservedGeneration?: string; + conditions?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutCondition[]; + canary?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$CanaryStatus; + blueGreen?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$BlueGreenStatus; + HPAReplicas?: number; + selector?: string; + stableRS?: string; + restartedAt?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + /** PromoteFull indicates if the rollout should perform a full promotion, skipping analysis and pauses. */ + promoteFull?: boolean; + phase?: string; + message?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutStrategy { + blueGreen?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$BlueGreenStrategy; + canary?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$CanaryStrategy; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$RolloutTrafficRouting { + istio?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$IstioTrafficRouting; + nginx?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$NginxTrafficRouting; + alb?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$ALBTrafficRouting; + smi?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$SMITrafficRouting; + ambassador?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$AmbassadorTrafficRouting; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$SMITrafficRouting { + rootService?: string; + trafficSplitName?: string; + } + export interface github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$SetCanaryScale { + weight?: number; + replicas?: number; + matchTrafficWeight?: boolean; + } + export interface google$protobuf$Any { + type_url?: string; + value?: string; + } + export interface grpc$gateway$runtime$Error { + error?: string; + code?: number; + message?: string; + details?: Schemas.google$protobuf$Any[]; + } + export interface grpc$gateway$runtime$StreamError { + grpc_code?: number; + http_code?: number; + message?: string; + http_status?: string; + details?: Schemas.google$protobuf$Any[]; + } + /** + * Represents a Persistent Disk resource in AWS. + * + * An 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. + */ + export interface k8s$io$api$core$v1$AWSElasticBlockStoreVolumeSource { + volumeID?: string; + fsType?: string; + partition?: number; + readOnly?: boolean; + } + /** Affinity is a group of affinity scheduling rules. */ + export interface k8s$io$api$core$v1$Affinity { + nodeAffinity?: Schemas.k8s$io$api$core$v1$NodeAffinity; + podAffinity?: Schemas.k8s$io$api$core$v1$PodAffinity; + podAntiAffinity?: Schemas.k8s$io$api$core$v1$PodAntiAffinity; + } + /** AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. */ + export interface k8s$io$api$core$v1$AzureDiskVolumeSource { + diskName?: string; + diskURI?: string; + cachingMode?: string; + fsType?: string; + readOnly?: boolean; + kind?: string; + } + /** AzureFile represents an Azure File Service mount on the host and bind mount to the pod. */ + export interface k8s$io$api$core$v1$AzureFileVolumeSource { + secretName?: string; + shareName?: string; + readOnly?: boolean; + } + export interface k8s$io$api$core$v1$CSIVolumeSource { + /** + * 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. + */ + driver?: string; + readOnly?: boolean; + fsType?: string; + volumeAttributes?: { + [key: string]: string; + }; + nodePublishSecretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + } + /** Adds and removes POSIX capabilities from running containers. */ + export interface k8s$io$api$core$v1$Capabilities { + add?: string[]; + drop?: string[]; + } + /** + * Represents a Ceph Filesystem mount that lasts the lifetime of a pod + * Cephfs volumes do not support ownership management or SELinux relabeling. + */ + export interface k8s$io$api$core$v1$CephFSVolumeSource { + monitors?: string[]; + path?: string; + user?: string; + secretFile?: string; + secretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + readOnly?: boolean; + } + /** + * 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. + */ + export interface k8s$io$api$core$v1$CinderVolumeSource { + volumeID?: string; + fsType?: string; + readOnly?: boolean; + secretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + } + /** + * ConfigMapEnvSource selects a ConfigMap to populate the environment + * variables with. + * + * The contents of the target ConfigMap's Data field will represent the + * key-value pairs as environment variables. + */ + export interface k8s$io$api$core$v1$ConfigMapEnvSource { + localObjectReference?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + optional?: boolean; + } + /** Selects a key from a ConfigMap. */ + export interface k8s$io$api$core$v1$ConfigMapKeySelector { + localObjectReference?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + /** The key to select. */ + key?: string; + optional?: boolean; + } + /** + * Adapts a ConfigMap into a projected volume. + * + * The 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. + */ + export interface k8s$io$api$core$v1$ConfigMapProjection { + localObjectReference?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + items?: Schemas.k8s$io$api$core$v1$KeyToPath[]; + optional?: boolean; + } + /** + * Adapts a ConfigMap into a volume. + * + * The 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. + */ + export interface k8s$io$api$core$v1$ConfigMapVolumeSource { + localObjectReference?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + items?: Schemas.k8s$io$api$core$v1$KeyToPath[]; + defaultMode?: number; + optional?: boolean; + } + /** A single application container that you want to run within a pod. */ + export interface k8s$io$api$core$v1$Container { + /** + * Name of the container specified as a DNS_LABEL. + * Each container in a pod must have a unique name (DNS_LABEL). + * Cannot be updated. + */ + name?: string; + image?: string; + command?: string[]; + args?: string[]; + workingDir?: string; + ports?: Schemas.k8s$io$api$core$v1$ContainerPort[]; + envFrom?: Schemas.k8s$io$api$core$v1$EnvFromSource[]; + env?: Schemas.k8s$io$api$core$v1$EnvVar[]; + resources?: Schemas.k8s$io$api$core$v1$ResourceRequirements; + volumeMounts?: Schemas.k8s$io$api$core$v1$VolumeMount[]; + volumeDevices?: Schemas.k8s$io$api$core$v1$VolumeDevice[]; + livenessProbe?: Schemas.k8s$io$api$core$v1$Probe; + readinessProbe?: Schemas.k8s$io$api$core$v1$Probe; + startupProbe?: Schemas.k8s$io$api$core$v1$Probe; + lifecycle?: Schemas.k8s$io$api$core$v1$Lifecycle; + terminationMessagePath?: string; + terminationMessagePolicy?: string; + imagePullPolicy?: string; + securityContext?: Schemas.k8s$io$api$core$v1$SecurityContext; + stdin?: boolean; + stdinOnce?: boolean; + tty?: boolean; + } + /** ContainerPort represents a network port in a single container. */ + export interface k8s$io$api$core$v1$ContainerPort { + name?: string; + hostPort?: number; + /** + * Number of port to expose on the pod's IP address. + * This must be a valid port number, 0 < x < 65536. + */ + containerPort?: number; + protocol?: string; + hostIP?: string; + } + /** + * Represents downward API info for projecting into a projected volume. + * Note that this is identical to a downwardAPI volume source without the default + * mode. + */ + export interface k8s$io$api$core$v1$DownwardAPIProjection { + items?: Schemas.k8s$io$api$core$v1$DownwardAPIVolumeFile[]; + } + export interface k8s$io$api$core$v1$DownwardAPIVolumeFile { + path?: string; + fieldRef?: Schemas.k8s$io$api$core$v1$ObjectFieldSelector; + resourceFieldRef?: Schemas.k8s$io$api$core$v1$ResourceFieldSelector; + mode?: number; + } + /** + * DownwardAPIVolumeSource represents a volume containing downward API info. + * Downward API volumes support ownership management and SELinux relabeling. + */ + export interface k8s$io$api$core$v1$DownwardAPIVolumeSource { + items?: Schemas.k8s$io$api$core$v1$DownwardAPIVolumeFile[]; + defaultMode?: number; + } + /** + * Represents an empty directory for a pod. + * Empty directory volumes support ownership management and SELinux relabeling. + */ + export interface k8s$io$api$core$v1$EmptyDirVolumeSource { + medium?: string; + sizeLimit?: Schemas.k8s$io$apimachinery$pkg$api$resource$Quantity; + } + export interface k8s$io$api$core$v1$EnvFromSource { + prefix?: string; + configMapRef?: Schemas.k8s$io$api$core$v1$ConfigMapEnvSource; + secretRef?: Schemas.k8s$io$api$core$v1$SecretEnvSource; + } + /** EnvVar represents an environment variable present in a Container. */ + export interface k8s$io$api$core$v1$EnvVar { + /** Name of the environment variable. Must be a C_IDENTIFIER. */ + name?: string; + value?: string; + valueFrom?: Schemas.k8s$io$api$core$v1$EnvVarSource; + } + /** EnvVarSource represents a source for the value of an EnvVar. */ + export interface k8s$io$api$core$v1$EnvVarSource { + fieldRef?: Schemas.k8s$io$api$core$v1$ObjectFieldSelector; + resourceFieldRef?: Schemas.k8s$io$api$core$v1$ResourceFieldSelector; + configMapKeyRef?: Schemas.k8s$io$api$core$v1$ConfigMapKeySelector; + secretKeyRef?: Schemas.k8s$io$api$core$v1$SecretKeySelector; + } + /** + * An EphemeralContainer is a container that may be added temporarily to an existing pod for + * user-initiated activities such as debugging. Ephemeral containers have no resource or + * scheduling guarantees, and they will not be restarted when they exit or when a pod is + * removed or restarted. If an ephemeral container causes a pod to exceed its resource + * allocation, the pod may be evicted. + * Ephemeral containers may not be added by directly updating the pod spec. They must be added + * via the pod's ephemeralcontainers subresource, and they will appear in the pod spec + * once added. + * This is an alpha feature enabled by the EphemeralContainers feature flag. + */ + export interface k8s$io$api$core$v1$EphemeralContainer { + ephemeralContainerCommon?: Schemas.k8s$io$api$core$v1$EphemeralContainerCommon; + targetContainerName?: string; + } + /** + * EphemeralContainerCommon is a copy of all fields in Container to be inlined in + * EphemeralContainer. This separate type allows easy conversion from EphemeralContainer + * to Container and allows separate documentation for the fields of EphemeralContainer. + * When a new field is added to Container it must be added here as well. + */ + export interface k8s$io$api$core$v1$EphemeralContainerCommon { + /** + * Name of the ephemeral container specified as a DNS_LABEL. + * This name must be unique among all containers, init containers and ephemeral containers. + */ + name?: string; + image?: string; + command?: string[]; + args?: string[]; + workingDir?: string; + /** Ports are not allowed for ephemeral containers. */ + ports?: Schemas.k8s$io$api$core$v1$ContainerPort[]; + envFrom?: Schemas.k8s$io$api$core$v1$EnvFromSource[]; + env?: Schemas.k8s$io$api$core$v1$EnvVar[]; + resources?: Schemas.k8s$io$api$core$v1$ResourceRequirements; + volumeMounts?: Schemas.k8s$io$api$core$v1$VolumeMount[]; + volumeDevices?: Schemas.k8s$io$api$core$v1$VolumeDevice[]; + livenessProbe?: Schemas.k8s$io$api$core$v1$Probe; + readinessProbe?: Schemas.k8s$io$api$core$v1$Probe; + startupProbe?: Schemas.k8s$io$api$core$v1$Probe; + lifecycle?: Schemas.k8s$io$api$core$v1$Lifecycle; + terminationMessagePath?: string; + terminationMessagePolicy?: string; + imagePullPolicy?: string; + securityContext?: Schemas.k8s$io$api$core$v1$SecurityContext; + stdin?: boolean; + stdinOnce?: boolean; + tty?: boolean; + } + /** Represents an ephemeral volume that is handled by a normal storage driver. */ + export interface k8s$io$api$core$v1$EphemeralVolumeSource { + volumeClaimTemplate?: Schemas.k8s$io$api$core$v1$PersistentVolumeClaimTemplate; + readOnly?: boolean; + } + /** ExecAction describes a \\"run in container\\" action. */ + export interface k8s$io$api$core$v1$ExecAction { + command?: string[]; + } + /** + * 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. + */ + export interface k8s$io$api$core$v1$FCVolumeSource { + targetWWNs?: string[]; + lun?: number; + fsType?: string; + readOnly?: boolean; + wwids?: string[]; + } + /** + * FlexVolume represents a generic volume resource that is + * provisioned/attached using an exec based plugin. + */ + export interface k8s$io$api$core$v1$FlexVolumeSource { + /** Driver is the name of the driver to use for this volume. */ + driver?: string; + fsType?: string; + secretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + readOnly?: boolean; + options?: { + [key: string]: string; + }; + } + /** + * 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. + */ + export interface k8s$io$api$core$v1$FlockerVolumeSource { + datasetName?: string; + datasetUUID?: string; + } + /** + * Represents a Persistent Disk resource in Google Compute Engine. + * + * A 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. + */ + export interface k8s$io$api$core$v1$GCEPersistentDiskVolumeSource { + pdName?: string; + fsType?: string; + partition?: number; + readOnly?: boolean; + } + /** + * 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. + * + * 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. + */ + export interface k8s$io$api$core$v1$GitRepoVolumeSource { + repository?: string; + revision?: string; + directory?: string; + } + /** + * Represents a Glusterfs mount that lasts the lifetime of a pod. + * Glusterfs volumes do not support ownership management or SELinux relabeling. + */ + export interface k8s$io$api$core$v1$GlusterfsVolumeSource { + endpoints?: string; + path?: string; + readOnly?: boolean; + } + /** HTTPGetAction describes an action based on HTTP Get requests. */ + export interface k8s$io$api$core$v1$HTTPGetAction { + path?: string; + port?: Schemas.k8s$io$apimachinery$pkg$util$intstr$IntOrString; + host?: string; + scheme?: string; + httpHeaders?: Schemas.k8s$io$api$core$v1$HTTPHeader[]; + } + export interface k8s$io$api$core$v1$HTTPHeader { + name?: string; + value?: string; + } + /** + * Handler defines a specific action that should be taken + * TODO: pass structured data to these actions, and document that data here. + */ + export interface k8s$io$api$core$v1$Handler { + exec?: Schemas.k8s$io$api$core$v1$ExecAction; + httpGet?: Schemas.k8s$io$api$core$v1$HTTPGetAction; + tcpSocket?: Schemas.k8s$io$api$core$v1$TCPSocketAction; + } + /** + * HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the + * pod's hosts file. + */ + export interface k8s$io$api$core$v1$HostAlias { + /** IP address of the host file entry. */ + ip?: string; + /** Hostnames for the above IP address. */ + hostnames?: string[]; + } + /** + * Represents a host path mapped into a pod. + * Host path volumes do not support ownership management or SELinux relabeling. + */ + export interface k8s$io$api$core$v1$HostPathVolumeSource { + path?: string; + type?: string; + } + /** + * Represents an ISCSI disk. + * ISCSI volumes can only be mounted as read/write once. + * ISCSI volumes support ownership management and SELinux relabeling. + */ + export interface k8s$io$api$core$v1$ISCSIVolumeSource { + /** + * 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). + */ + targetPortal?: string; + /** Target iSCSI Qualified Name. */ + iqn?: string; + /** iSCSI Target Lun number. */ + lun?: number; + iscsiInterface?: string; + fsType?: string; + readOnly?: boolean; + portals?: string[]; + chapAuthDiscovery?: boolean; + chapAuthSession?: boolean; + secretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + initiatorName?: string; + } + /** Maps a string key to a path within a volume. */ + export interface k8s$io$api$core$v1$KeyToPath { + /** The key to project. */ + key?: string; + /** + * 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 '..'. + */ + path?: string; + mode?: number; + } + /** + * Lifecycle describes actions that the management system should take in response to container lifecycle + * events. For the PostStart and PreStop lifecycle handlers, management of the container blocks + * until the action is complete, unless the container process fails, in which case the handler is aborted. + */ + export interface k8s$io$api$core$v1$Lifecycle { + postStart?: Schemas.k8s$io$api$core$v1$Handler; + preStop?: Schemas.k8s$io$api$core$v1$Handler; + } + /** + * LocalObjectReference contains enough information to let you locate the + * referenced object inside the same namespace. + */ + export interface k8s$io$api$core$v1$LocalObjectReference { + name?: string; + } + /** + * Represents an NFS mount that lasts the lifetime of a pod. + * NFS volumes do not support ownership management or SELinux relabeling. + */ + export interface k8s$io$api$core$v1$NFSVolumeSource { + server?: string; + path?: string; + readOnly?: boolean; + } + /** Node affinity is a group of node affinity scheduling rules. */ + export interface k8s$io$api$core$v1$NodeAffinity { + requiredDuringSchedulingIgnoredDuringExecution?: Schemas.k8s$io$api$core$v1$NodeSelector; + preferredDuringSchedulingIgnoredDuringExecution?: Schemas.k8s$io$api$core$v1$PreferredSchedulingTerm[]; + } + /** + * A node selector represents the union of the results of one or more label queries + * over a set of nodes; that is, it represents the OR of the selectors represented + * by the node selector terms. + */ + export interface k8s$io$api$core$v1$NodeSelector { + /** Required. A list of node selector terms. The terms are ORed. */ + nodeSelectorTerms?: Schemas.k8s$io$api$core$v1$NodeSelectorTerm[]; + } + /** + * A node selector requirement is a selector that contains values, a key, and an operator + * that relates the key and values. + */ + export interface k8s$io$api$core$v1$NodeSelectorRequirement { + /** The label key that the selector applies to. */ + key?: string; + /** + * Represents a key's relationship to a set of values. + * Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + */ + operator?: string; + values?: string[]; + } + /** + * A null or empty node selector term matches no objects. The requirements of + * them are ANDed. + * The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + */ + export interface k8s$io$api$core$v1$NodeSelectorTerm { + matchExpressions?: Schemas.k8s$io$api$core$v1$NodeSelectorRequirement[]; + matchFields?: Schemas.k8s$io$api$core$v1$NodeSelectorRequirement[]; + } + /** ObjectFieldSelector selects an APIVersioned field of an object. */ + export interface k8s$io$api$core$v1$ObjectFieldSelector { + apiVersion?: string; + /** Path of the field to select in the specified API version. */ + fieldPath?: string; + } + export interface k8s$io$api$core$v1$PersistentVolumeClaimSpec { + accessModes?: string[]; + selector?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelector; + resources?: Schemas.k8s$io$api$core$v1$ResourceRequirements; + volumeName?: string; + storageClassName?: string; + volumeMode?: string; + dataSource?: Schemas.k8s$io$api$core$v1$TypedLocalObjectReference; + } + /** + * PersistentVolumeClaimTemplate is used to produce + * PersistentVolumeClaim objects as part of an EphemeralVolumeSource. + */ + export interface k8s$io$api$core$v1$PersistentVolumeClaimTemplate { + metadata?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + spec?: Schemas.k8s$io$api$core$v1$PersistentVolumeClaimSpec; + } + /** + * 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). + */ + export interface k8s$io$api$core$v1$PersistentVolumeClaimVolumeSource { + claimName?: string; + readOnly?: boolean; + } + /** Represents a Photon Controller persistent disk resource. */ + export interface k8s$io$api$core$v1$PhotonPersistentDiskVolumeSource { + pdID?: string; + /** + * 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. + */ + fsType?: string; + } + /** Pod affinity is a group of inter pod affinity scheduling rules. */ + export interface k8s$io$api$core$v1$PodAffinity { + requiredDuringSchedulingIgnoredDuringExecution?: Schemas.k8s$io$api$core$v1$PodAffinityTerm[]; + preferredDuringSchedulingIgnoredDuringExecution?: Schemas.k8s$io$api$core$v1$WeightedPodAffinityTerm[]; + } + export interface k8s$io$api$core$v1$PodAffinityTerm { + labelSelector?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelector; + namespaces?: string[]; + /** + * This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching + * the labelSelector in the specified namespaces, where co-located is defined as running on a node + * whose value of the label with key topologyKey matches that of any node on which any of the + * selected pods is running. + * Empty topologyKey is not allowed. + */ + topologyKey?: string; + } + /** Pod anti affinity is a group of inter pod anti affinity scheduling rules. */ + export interface k8s$io$api$core$v1$PodAntiAffinity { + requiredDuringSchedulingIgnoredDuringExecution?: Schemas.k8s$io$api$core$v1$PodAffinityTerm[]; + preferredDuringSchedulingIgnoredDuringExecution?: Schemas.k8s$io$api$core$v1$WeightedPodAffinityTerm[]; + } + /** + * PodDNSConfig defines the DNS parameters of a pod in addition to + * those generated from DNSPolicy. + */ + export interface k8s$io$api$core$v1$PodDNSConfig { + nameservers?: string[]; + searches?: string[]; + options?: Schemas.k8s$io$api$core$v1$PodDNSConfigOption[]; + } + /** PodDNSConfigOption defines DNS resolver options of a pod. */ + export interface k8s$io$api$core$v1$PodDNSConfigOption { + /** Required. */ + name?: string; + value?: string; + } + export interface k8s$io$api$core$v1$PodReadinessGate { + /** ConditionType refers to a condition in the pod's condition list with matching type. */ + conditionType?: string; + } + /** + * 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. + */ + export interface k8s$io$api$core$v1$PodSecurityContext { + seLinuxOptions?: Schemas.k8s$io$api$core$v1$SELinuxOptions; + windowsOptions?: Schemas.k8s$io$api$core$v1$WindowsSecurityContextOptions; + runAsUser?: string; + runAsGroup?: string; + runAsNonRoot?: boolean; + supplementalGroups?: string[]; + /** + * 1. 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---- + * + * If unset, the Kubelet will not modify the ownership and permissions of any volume. + * +optional + */ + fsGroup?: string; + sysctls?: Schemas.k8s$io$api$core$v1$Sysctl[]; + fsGroupChangePolicy?: string; + seccompProfile?: Schemas.k8s$io$api$core$v1$SeccompProfile; + } + /** PodSpec is a description of a pod. */ + export interface k8s$io$api$core$v1$PodSpec { + volumes?: Schemas.k8s$io$api$core$v1$Volume[]; + initContainers?: Schemas.k8s$io$api$core$v1$Container[]; + containers?: Schemas.k8s$io$api$core$v1$Container[]; + ephemeralContainers?: Schemas.k8s$io$api$core$v1$EphemeralContainer[]; + restartPolicy?: string; + terminationGracePeriodSeconds?: string; + activeDeadlineSeconds?: string; + dnsPolicy?: string; + nodeSelector?: { + [key: string]: string; + }; + serviceAccountName?: string; + serviceAccount?: string; + automountServiceAccountToken?: boolean; + nodeName?: string; + hostNetwork?: boolean; + hostPID?: boolean; + hostIPC?: boolean; + shareProcessNamespace?: boolean; + securityContext?: Schemas.k8s$io$api$core$v1$PodSecurityContext; + imagePullSecrets?: Schemas.k8s$io$api$core$v1$LocalObjectReference[]; + hostname?: string; + subdomain?: string; + affinity?: Schemas.k8s$io$api$core$v1$Affinity; + schedulerName?: string; + tolerations?: Schemas.k8s$io$api$core$v1$Toleration[]; + hostAliases?: Schemas.k8s$io$api$core$v1$HostAlias[]; + priorityClassName?: string; + priority?: number; + dnsConfig?: Schemas.k8s$io$api$core$v1$PodDNSConfig; + readinessGates?: Schemas.k8s$io$api$core$v1$PodReadinessGate[]; + runtimeClassName?: string; + enableServiceLinks?: boolean; + preemptionPolicy?: string; + overhead?: { + [key: string]: Schemas.k8s$io$apimachinery$pkg$api$resource$Quantity; + }; + topologySpreadConstraints?: Schemas.k8s$io$api$core$v1$TopologySpreadConstraint[]; + setHostnameAsFQDN?: boolean; + } + export interface k8s$io$api$core$v1$PodTemplateSpec { + metadata?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + spec?: Schemas.k8s$io$api$core$v1$PodSpec; + } + /** PortworxVolumeSource represents a Portworx volume resource. */ + export interface k8s$io$api$core$v1$PortworxVolumeSource { + volumeID?: string; + /** + * 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. + */ + fsType?: string; + readOnly?: boolean; + } + /** + * An empty preferred scheduling term matches all objects with implicit weight 0 + * (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). + */ + export interface k8s$io$api$core$v1$PreferredSchedulingTerm { + /** Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. */ + weight?: number; + preference?: Schemas.k8s$io$api$core$v1$NodeSelectorTerm; + } + /** + * Probe describes a health check to be performed against a container to determine whether it is + * alive or ready to receive traffic. + */ + export interface k8s$io$api$core$v1$Probe { + handler?: Schemas.k8s$io$api$core$v1$Handler; + initialDelaySeconds?: number; + timeoutSeconds?: number; + periodSeconds?: number; + successThreshold?: number; + failureThreshold?: number; + } + export interface k8s$io$api$core$v1$ProjectedVolumeSource { + sources?: Schemas.k8s$io$api$core$v1$VolumeProjection[]; + defaultMode?: number; + } + /** + * Represents a Quobyte mount that lasts the lifetime of a pod. + * Quobyte volumes do not support ownership management or SELinux relabeling. + */ + export interface k8s$io$api$core$v1$QuobyteVolumeSource { + registry?: string; + /** Volume is a string that references an already created Quobyte volume by name. */ + volume?: string; + readOnly?: boolean; + user?: string; + group?: string; + tenant?: string; + } + /** + * Represents a Rados Block Device mount that lasts the lifetime of a pod. + * RBD volumes support ownership management and SELinux relabeling. + */ + export interface k8s$io$api$core$v1$RBDVolumeSource { + monitors?: string[]; + image?: string; + fsType?: string; + pool?: string; + user?: string; + keyring?: string; + secretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + readOnly?: boolean; + } + export interface k8s$io$api$core$v1$ResourceFieldSelector { + containerName?: string; + resource?: string; + divisor?: Schemas.k8s$io$apimachinery$pkg$api$resource$Quantity; + } + /** ResourceRequirements describes the compute resource requirements. */ + export interface k8s$io$api$core$v1$ResourceRequirements { + limits?: { + [key: string]: Schemas.k8s$io$apimachinery$pkg$api$resource$Quantity; + }; + requests?: { + [key: string]: Schemas.k8s$io$apimachinery$pkg$api$resource$Quantity; + }; + } + export interface k8s$io$api$core$v1$SELinuxOptions { + user?: string; + role?: string; + type?: string; + level?: string; + } + export interface k8s$io$api$core$v1$ScaleIOVolumeSource { + /** The host address of the ScaleIO API Gateway. */ + gateway?: string; + /** The name of the storage system as configured in ScaleIO. */ + system?: string; + secretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + sslEnabled?: boolean; + protectionDomain?: string; + storagePool?: string; + storageMode?: string; + /** + * The name of a volume already created in the ScaleIO system + * that is associated with this volume source. + */ + volumeName?: string; + fsType?: string; + readOnly?: boolean; + } + export interface k8s$io$api$core$v1$SeccompProfile { + /** + * Localhost - 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. + * +unionDiscriminator + */ + type?: string; + localhostProfile?: string; + } + /** + * SecretEnvSource selects a Secret to populate the environment + * variables with. + * + * The contents of the target Secret's Data field will represent the + * key-value pairs as environment variables. + */ + export interface k8s$io$api$core$v1$SecretEnvSource { + localObjectReference?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + optional?: boolean; + } + /** SecretKeySelector selects a key of a Secret. */ + export interface k8s$io$api$core$v1$SecretKeySelector { + localObjectReference?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + /** The key of the secret to select from. Must be a valid secret key. */ + key?: string; + optional?: boolean; + } + /** + * Adapts a secret into a projected volume. + * + * The 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. + */ + export interface k8s$io$api$core$v1$SecretProjection { + localObjectReference?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + items?: Schemas.k8s$io$api$core$v1$KeyToPath[]; + optional?: boolean; + } + /** + * Adapts a Secret into a volume. + * + * The 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. + */ + export interface k8s$io$api$core$v1$SecretVolumeSource { + secretName?: string; + items?: Schemas.k8s$io$api$core$v1$KeyToPath[]; + defaultMode?: number; + optional?: boolean; + } + /** + * 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. + */ + export interface k8s$io$api$core$v1$SecurityContext { + capabilities?: Schemas.k8s$io$api$core$v1$Capabilities; + privileged?: boolean; + seLinuxOptions?: Schemas.k8s$io$api$core$v1$SELinuxOptions; + windowsOptions?: Schemas.k8s$io$api$core$v1$WindowsSecurityContextOptions; + runAsUser?: string; + runAsGroup?: string; + runAsNonRoot?: boolean; + readOnlyRootFilesystem?: boolean; + allowPrivilegeEscalation?: boolean; + procMount?: string; + seccompProfile?: Schemas.k8s$io$api$core$v1$SeccompProfile; + } + /** + * 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). + */ + export interface k8s$io$api$core$v1$ServiceAccountTokenProjection { + audience?: string; + expirationSeconds?: string; + /** + * Path is the path relative to the mount point of the file to project the + * token into. + */ + path?: string; + } + /** Represents a StorageOS persistent volume resource. */ + export interface k8s$io$api$core$v1$StorageOSVolumeSource { + /** + * VolumeName is the human-readable name of the StorageOS volume. Volume + * names are only unique within a namespace. + */ + volumeName?: string; + volumeNamespace?: string; + fsType?: string; + readOnly?: boolean; + secretRef?: Schemas.k8s$io$api$core$v1$LocalObjectReference; + } + export interface k8s$io$api$core$v1$Sysctl { + name?: string; + value?: string; + } + export interface k8s$io$api$core$v1$TCPSocketAction { + port?: Schemas.k8s$io$apimachinery$pkg$util$intstr$IntOrString; + host?: string; + } + /** + * The pod this Toleration is attached to tolerates any taint that matches + * the triple using the matching operator . + */ + export interface k8s$io$api$core$v1$Toleration { + key?: string; + operator?: string; + value?: string; + effect?: string; + tolerationSeconds?: string; + } + /** TopologySpreadConstraint specifies how to spread matching pods among the given topology. */ + export interface k8s$io$api$core$v1$TopologySpreadConstraint { + /** + * MaxSkew describes the degree to which pods may be unevenly distributed. + * When \`whenUnsatisfiable=DoNotSchedule\`, it is the maximum permitted difference + * between the number of matching pods in the target topology and the global minimum. + * For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same + * labelSelector spread as 1/1/0: + * +-------+-------+-------+ + * | zone1 | zone2 | zone3 | + * +-------+-------+-------+ + * | P | P | | + * +-------+-------+-------+ + * - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; + * scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) + * violate MaxSkew(1). + * - if MaxSkew is 2, incoming pod can be scheduled onto any zone. + * When \`whenUnsatisfiable=ScheduleAnyway\`, it is used to give higher precedence + * to topologies that satisfy it. + * It's a required field. Default value is 1 and 0 is not allowed. + */ + maxSkew?: number; + /** + * TopologyKey is the key of node labels. Nodes that have a label with this key + * and identical values are considered to be in the same topology. + * We consider each as a \\"bucket\\", and try to put balanced number + * of pods into each bucket. + * It's a required field. + */ + topologyKey?: string; + /** + * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy + * the spread constraint. + * - DoNotSchedule (default) tells the scheduler not to schedule it. + * - ScheduleAnyway tells the scheduler to schedule the pod in any location, + * but giving higher precedence to topologies that would help reduce the + * skew. + * A constraint is considered \\"Unsatisfiable\\" for an incoming pod + * if and only if every possible node assigment for that pod would violate + * \\"MaxSkew\\" on some topology. + * For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same + * labelSelector spread as 3/1/1: + * +-------+-------+-------+ + * | zone1 | zone2 | zone3 | + * +-------+-------+-------+ + * | P P P | P | P | + * +-------+-------+-------+ + * If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled + * to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies + * MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler + * won't make it *more* imbalanced. + * It's a required field. + */ + whenUnsatisfiable?: string; + labelSelector?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelector; + } + /** + * TypedLocalObjectReference contains enough information to let you locate the + * typed referenced object inside the same namespace. + */ + export interface k8s$io$api$core$v1$TypedLocalObjectReference { + apiGroup?: string; + kind?: string; + name?: string; + } + /** Volume represents a named volume in a pod that may be accessed by any container in the pod. */ + export interface k8s$io$api$core$v1$Volume { + name?: string; + volumeSource?: Schemas.k8s$io$api$core$v1$VolumeSource; + } + /** volumeDevice describes a mapping of a raw block device within a container. */ + export interface k8s$io$api$core$v1$VolumeDevice { + name?: string; + /** devicePath is the path inside of the container that the device will be mapped to. */ + devicePath?: string; + } + /** VolumeMount describes a mounting of a Volume within a container. */ + export interface k8s$io$api$core$v1$VolumeMount { + /** This must match the Name of a Volume. */ + name?: string; + readOnly?: boolean; + /** + * Path within the container at which the volume should be mounted. Must + * not contain ':'. + */ + mountPath?: string; + subPath?: string; + mountPropagation?: string; + subPathExpr?: string; + } + export interface k8s$io$api$core$v1$VolumeProjection { + secret?: Schemas.k8s$io$api$core$v1$SecretProjection; + downwardAPI?: Schemas.k8s$io$api$core$v1$DownwardAPIProjection; + configMap?: Schemas.k8s$io$api$core$v1$ConfigMapProjection; + serviceAccountToken?: Schemas.k8s$io$api$core$v1$ServiceAccountTokenProjection; + } + /** + * Represents the source of a volume to mount. + * Only one of its members may be specified. + */ + export interface k8s$io$api$core$v1$VolumeSource { + hostPath?: Schemas.k8s$io$api$core$v1$HostPathVolumeSource; + emptyDir?: Schemas.k8s$io$api$core$v1$EmptyDirVolumeSource; + gcePersistentDisk?: Schemas.k8s$io$api$core$v1$GCEPersistentDiskVolumeSource; + awsElasticBlockStore?: Schemas.k8s$io$api$core$v1$AWSElasticBlockStoreVolumeSource; + gitRepo?: Schemas.k8s$io$api$core$v1$GitRepoVolumeSource; + secret?: Schemas.k8s$io$api$core$v1$SecretVolumeSource; + nfs?: Schemas.k8s$io$api$core$v1$NFSVolumeSource; + iscsi?: Schemas.k8s$io$api$core$v1$ISCSIVolumeSource; + glusterfs?: Schemas.k8s$io$api$core$v1$GlusterfsVolumeSource; + persistentVolumeClaim?: Schemas.k8s$io$api$core$v1$PersistentVolumeClaimVolumeSource; + rbd?: Schemas.k8s$io$api$core$v1$RBDVolumeSource; + flexVolume?: Schemas.k8s$io$api$core$v1$FlexVolumeSource; + cinder?: Schemas.k8s$io$api$core$v1$CinderVolumeSource; + cephfs?: Schemas.k8s$io$api$core$v1$CephFSVolumeSource; + flocker?: Schemas.k8s$io$api$core$v1$FlockerVolumeSource; + downwardAPI?: Schemas.k8s$io$api$core$v1$DownwardAPIVolumeSource; + fc?: Schemas.k8s$io$api$core$v1$FCVolumeSource; + azureFile?: Schemas.k8s$io$api$core$v1$AzureFileVolumeSource; + configMap?: Schemas.k8s$io$api$core$v1$ConfigMapVolumeSource; + vsphereVolume?: Schemas.k8s$io$api$core$v1$VsphereVirtualDiskVolumeSource; + quobyte?: Schemas.k8s$io$api$core$v1$QuobyteVolumeSource; + azureDisk?: Schemas.k8s$io$api$core$v1$AzureDiskVolumeSource; + photonPersistentDisk?: Schemas.k8s$io$api$core$v1$PhotonPersistentDiskVolumeSource; + projected?: Schemas.k8s$io$api$core$v1$ProjectedVolumeSource; + portworxVolume?: Schemas.k8s$io$api$core$v1$PortworxVolumeSource; + scaleIO?: Schemas.k8s$io$api$core$v1$ScaleIOVolumeSource; + storageos?: Schemas.k8s$io$api$core$v1$StorageOSVolumeSource; + csi?: Schemas.k8s$io$api$core$v1$CSIVolumeSource; + ephemeral?: Schemas.k8s$io$api$core$v1$EphemeralVolumeSource; + } + /** Represents a vSphere volume resource. */ + export interface k8s$io$api$core$v1$VsphereVirtualDiskVolumeSource { + volumePath?: string; + fsType?: string; + storagePolicyName?: string; + storagePolicyID?: string; + } + export interface k8s$io$api$core$v1$WeightedPodAffinityTerm { + /** + * weight associated with matching the corresponding podAffinityTerm, + * in the range 1-100. + */ + weight?: number; + podAffinityTerm?: Schemas.k8s$io$api$core$v1$PodAffinityTerm; + } + /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ + export interface k8s$io$api$core$v1$WindowsSecurityContextOptions { + gmsaCredentialSpecName?: string; + gmsaCredentialSpec?: string; + runAsUserName?: string; + } + /** + * Quantity is a fixed-point representation of a number. + * It provides convenient marshaling/unmarshaling in JSON and YAML, + * in addition to String() and AsInt64() accessors. + * + * The serialization format is: + * + * ::= + * (Note that may be empty, from the \\"\\" case in .) + * ::= 0 | 1 | ... | 9 + * ::= | + * ::= | . | . | . + * ::= \\"+\\" | \\"-\\" + * ::= | + * ::= | | + * ::= Ki | Mi | Gi | Ti | Pi | Ei + * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) + * ::= m | \\"\\" | k | M | G | T | P | E + * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) + * ::= \\"e\\" | \\"E\\" + * + * No matter which of the three exponent forms is used, no quantity may represent + * a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal + * places. Numbers larger or more precise will be capped or rounded up. + * (E.g.: 0.1m will rounded up to 1m.) + * This may be extended in the future if we require larger or smaller quantities. + * + * When a Quantity is parsed from a string, it will remember the type of suffix + * it had, and will use the same type again when it is serialized. + * + * Before serializing, Quantity will be put in \\"canonical form\\". + * This means that Exponent/suffix will be adjusted up or down (with a + * corresponding increase or decrease in Mantissa) such that: + * a. No precision is lost + * b. No fractional digits will be emitted + * c. The exponent (or suffix) is as large as possible. + * The sign will be omitted unless the number is negative. + * + * Examples: + * 1.5 will be serialized as \\"1500m\\" + * 1.5Gi will be serialized as \\"1536Mi\\" + * + * Note that the quantity will NEVER be internally represented by a + * floating point number. That is the whole point of this exercise. + * + * Non-canonical values will still parse as long as they are well formed, + * but will be re-emitted in their canonical form. (So always use canonical + * form, or don't diff.) + * + * This format is intended to make it difficult to use these numbers without + * writing some sort of special handling code in the hopes that that will + * cause implementors to also use a fixed point implementation. + * + * +protobuf=true + * +protobuf.embed=string + * +protobuf.options.marshal=false + * +protobuf.options.(gogoproto.goproto_stringer)=false + * +k8s:deepcopy-gen=true + * +k8s:openapi-gen=true + */ + export interface k8s$io$apimachinery$pkg$api$resource$Quantity { + string?: string; + } + /** + * FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. + * + * Each 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:', where is the name of a field in a struct, or key in a map + * 'v:', where is the exact json formatted value of a list item + * 'i:', where is position of a item in a list + * 'k:', where 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. + * + * The exact format is defined in sigs.k8s.io/structured-merge-diff + * +protobuf.options.(gogoproto.goproto_stringer)=false + */ + export interface k8s$io$apimachinery$pkg$apis$meta$v1$FieldsV1 { + /** Raw is the underlying serialization of this object. */ + Raw?: string; + } + export interface k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelector { + matchLabels?: { + [key: string]: string; + }; + matchExpressions?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelectorRequirement[]; + } + /** + * A label selector requirement is a selector that contains values, a key, and an operator that + * relates the key and values. + */ + export interface k8s$io$apimachinery$pkg$apis$meta$v1$LabelSelectorRequirement { + key?: string; + /** + * operator represents a key's relationship to a set of values. + * Valid operators are In, NotIn, Exists and DoesNotExist. + */ + operator?: string; + values?: string[]; + } + /** + * ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource + * that the fieldset applies to. + */ + export interface k8s$io$apimachinery$pkg$apis$meta$v1$ManagedFieldsEntry { + /** Manager is an identifier of the workflow managing these fields. */ + manager?: string; + /** + * Operation is the type of operation which lead to this ManagedFieldsEntry being created. + * The only valid values for this field are 'Apply' and 'Update'. + */ + operation?: string; + /** + * 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. + */ + apiVersion?: string; + time?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + fieldsType?: string; + fieldsV1?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$FieldsV1; + } + /** + * ObjectMeta is metadata that all persisted resources must have, which includes all objects + * users must create. + */ + export interface k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta { + name?: string; + /** + * 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. + * + * If this field is specified and the generated name exists, the server will + * NOT return a 409 - instead, it will either return 201 Created or 500 with Reason + * ServerTimeout indicating a unique name could not be found in the time allotted, and the client + * should retry (optionally after the time indicated in the Retry-After header). + * + * Applied only if Name is not specified. + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency + * +optional + */ + generateName?: string; + /** + * 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. + * + * Must be a DNS_LABEL. + * Cannot be updated. + * More info: http://kubernetes.io/docs/user-guide/namespaces + * +optional + */ + namespace?: string; + /** + * SelfLink is a URL representing this object. + * Populated by the system. + * Read-only. + * + * DEPRECATED + * Kubernetes will stop propagating this field in 1.20 release and the field is planned + * to be removed in 1.21 release. + * +optional + */ + selfLink?: string; + /** + * 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. + * + * Populated by the system. + * Read-only. + * More info: http://kubernetes.io/docs/user-guide/identifiers#uids + * +optional + */ + uid?: string; + /** + * 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. + * + * Populated 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 + * +optional + */ + resourceVersion?: string; + generation?: string; + creationTimestamp?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + deletionTimestamp?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$Time; + deletionGracePeriodSeconds?: string; + labels?: { + [key: string]: string; + }; + annotations?: { + [key: string]: string; + }; + ownerReferences?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$OwnerReference[]; + finalizers?: string[]; + clusterName?: string; + /** + * 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. + * + * +optional + */ + managedFields?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ManagedFieldsEntry[]; + } + /** + * 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. + */ + export interface k8s$io$apimachinery$pkg$apis$meta$v1$OwnerReference { + /** API version of the referent. */ + apiVersion?: string; + kind?: string; + name?: string; + uid?: string; + controller?: boolean; + blockOwnerDeletion?: boolean; + } + /** + * Time is a wrapper around time.Time which supports correct + * marshaling to YAML and JSON. Wrappers are provided for many + * of the factory methods that the time package offers. + * + * +protobuf.options.marshal=false + * +protobuf.as=Timestamp + * +protobuf.options.(gogoproto.goproto_stringer)=false + */ + export interface k8s$io$apimachinery$pkg$apis$meta$v1$Time { + /** + * Represents seconds of UTC time since Unix epoch + * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to + * 9999-12-31T23:59:59Z inclusive. + */ + seconds?: string; + /** + * Non-negative fractions of a second at nanosecond resolution. Negative + * second values with fractions must still have non-negative nanos values + * that count forward in time. Must be from 0 to 999,999,999 + * inclusive. This field may be limited in precision depending on context. + */ + nanos?: number; + } + /** + * +protobuf=true + * +protobuf.options.(gogoproto.goproto_stringer)=false + * +k8s:openapi-gen=true + */ + export interface k8s$io$apimachinery$pkg$util$intstr$IntOrString { + type?: string; + intVal?: number; + strVal?: string; + } + export interface rollout$AbortRolloutRequest { + name?: string; + namespace?: string; + } + export interface rollout$AnalysisRunInfo { + objectMeta?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + icon?: string; + revision?: number; + status?: string; + successful?: number; + failed?: number; + inconclusive?: number; + error?: number; + jobs?: Schemas.rollout$JobInfo[]; + } + export interface rollout$ContainerInfo { + name?: string; + image?: string; + } + export interface rollout$ExperimentInfo { + objectMeta?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + icon?: string; + revision?: number; + status?: string; + message?: string; + replicaSets?: Schemas.rollout$ReplicaSetInfo[]; + analysisRuns?: Schemas.rollout$AnalysisRunInfo[]; + } + export interface rollout$JobInfo { + objectMeta?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + status?: string; + icon?: string; + } + export interface rollout$NamespaceInfo { + namespace?: string; + availableNamespaces?: string[]; + } + export interface rollout$PodInfo { + objectMeta?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + status?: string; + icon?: string; + ready?: string; + restarts?: number; + } + export interface rollout$PromoteRolloutRequest { + name?: string; + namespace?: string; + full?: boolean; + } + export interface rollout$ReplicaSetInfo { + objectMeta?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + status?: string; + icon?: string; + revision?: number; + stable?: boolean; + canary?: boolean; + active?: boolean; + preview?: boolean; + replicas?: number; + available?: number; + template?: string; + scaleDownDeadline?: string; + images?: string[]; + pods?: Schemas.rollout$PodInfo[]; + } + export interface rollout$RestartRolloutRequest { + name?: string; + namespace?: string; + } + export interface rollout$RetryRolloutRequest { + name?: string; + namespace?: string; + } + export interface rollout$RolloutInfo { + objectMeta?: Schemas.k8s$io$apimachinery$pkg$apis$meta$v1$ObjectMeta; + status?: string; + message?: string; + icon?: string; + strategy?: string; + step?: string; + setWeight?: string; + actualWeight?: string; + ready?: number; + current?: number; + desired?: number; + updated?: number; + available?: number; + restartedAt?: string; + generation?: string; + replicaSets?: Schemas.rollout$ReplicaSetInfo[]; + experiments?: Schemas.rollout$ExperimentInfo[]; + analysisRuns?: Schemas.rollout$AnalysisRunInfo[]; + containers?: Schemas.rollout$ContainerInfo[]; + steps?: Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$CanaryStep[]; + } + export interface rollout$RolloutInfoList { + rollouts?: Schemas.rollout$RolloutInfo[]; + } + export interface rollout$RolloutWatchEvent { + type?: string; + rolloutInfo?: Schemas.rollout$RolloutInfo; + } + export interface rollout$SetImageRequest { + rollout?: string; + container?: string; + image?: string; + tag?: string; + namespace?: string; + } + export interface rollout$UndoRolloutRequest { + rollout?: string; + revision?: string; + namespace?: string; + } + export interface rollout$VersionInfo { + rolloutsVersion?: string; + } +} +export interface Response$RolloutService_GetNamespace$Status$200 { + \\"application/json\\": Schemas.rollout$NamespaceInfo; +} +export interface Response$RolloutService_GetNamespace$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_ListRolloutInfos { + namespace: string; +} +export interface Response$RolloutService_ListRolloutInfos$Status$200 { + \\"application/json\\": Schemas.rollout$RolloutInfoList; +} +export interface Response$RolloutService_ListRolloutInfos$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_WatchRolloutInfos { + namespace: string; +} +export interface Response$RolloutService_WatchRolloutInfos$Status$200 { + \\"application/json\\": { + result?: Schemas.rollout$RolloutWatchEvent; + error?: Schemas.grpc$gateway$runtime$StreamError; + }; +} +export interface Response$RolloutService_WatchRolloutInfos$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_AbortRollout { + namespace: string; + name: string; +} +export interface RequestBody$RolloutService_AbortRollout { + \\"application/json\\": Schemas.rollout$AbortRolloutRequest; +} +export interface Response$RolloutService_AbortRollout$Status$200 { + \\"application/json\\": Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$Rollout; +} +export interface Response$RolloutService_AbortRollout$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_GetRolloutInfo { + namespace: string; + name: string; +} +export interface Response$RolloutService_GetRolloutInfo$Status$200 { + \\"application/json\\": Schemas.rollout$RolloutInfo; +} +export interface Response$RolloutService_GetRolloutInfo$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_WatchRolloutInfo { + namespace: string; + name: string; +} +export interface Response$RolloutService_WatchRolloutInfo$Status$200 { + \\"application/json\\": { + result?: Schemas.rollout$RolloutInfo; + error?: Schemas.grpc$gateway$runtime$StreamError; + }; +} +export interface Response$RolloutService_WatchRolloutInfo$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_PromoteRollout { + namespace: string; + name: string; +} +export interface RequestBody$RolloutService_PromoteRollout { + \\"application/json\\": Schemas.rollout$PromoteRolloutRequest; +} +export interface Response$RolloutService_PromoteRollout$Status$200 { + \\"application/json\\": Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$Rollout; +} +export interface Response$RolloutService_PromoteRollout$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_RestartRollout { + namespace: string; + name: string; +} +export interface RequestBody$RolloutService_RestartRollout { + \\"application/json\\": Schemas.rollout$RestartRolloutRequest; +} +export interface Response$RolloutService_RestartRollout$Status$200 { + \\"application/json\\": Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$Rollout; +} +export interface Response$RolloutService_RestartRollout$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_RetryRollout { + namespace: string; + name: string; +} +export interface RequestBody$RolloutService_RetryRollout { + \\"application/json\\": Schemas.rollout$RetryRolloutRequest; +} +export interface Response$RolloutService_RetryRollout$Status$200 { + \\"application/json\\": Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$Rollout; +} +export interface Response$RolloutService_RetryRollout$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_SetRolloutImage { + namespace: string; + rollout: string; + container: string; + image: string; + tag: string; +} +export interface RequestBody$RolloutService_SetRolloutImage { + \\"application/json\\": Schemas.rollout$SetImageRequest; +} +export interface Response$RolloutService_SetRolloutImage$Status$200 { + \\"application/json\\": Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$Rollout; +} +export interface Response$RolloutService_SetRolloutImage$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Parameter$RolloutService_UndoRollout { + namespace: string; + rollout: string; + revision: string; +} +export interface RequestBody$RolloutService_UndoRollout { + \\"application/json\\": Schemas.rollout$UndoRolloutRequest; +} +export interface Response$RolloutService_UndoRollout$Status$200 { + \\"application/json\\": Schemas.github$com$argoproj$argo_rollouts$pkg$apis$rollouts$v1alpha1$Rollout; +} +export interface Response$RolloutService_UndoRollout$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export interface Response$RolloutService_Version$Status$200 { + \\"application/json\\": Schemas.rollout$VersionInfo; +} +export interface Response$RolloutService_Version$Status$default { + \\"application/json\\": Schemas.grpc$gateway$runtime$Error; +} +export type ResponseContentType$RolloutService_GetNamespace = keyof Response$RolloutService_GetNamespace$Status$200; +export type ResponseContentType$RolloutService_ListRolloutInfos = keyof Response$RolloutService_ListRolloutInfos$Status$200; +export interface Params$RolloutService_ListRolloutInfos { + parameter: Parameter$RolloutService_ListRolloutInfos; +} +export type ResponseContentType$RolloutService_WatchRolloutInfos = keyof Response$RolloutService_WatchRolloutInfos$Status$200; +export interface Params$RolloutService_WatchRolloutInfos { + parameter: Parameter$RolloutService_WatchRolloutInfos; +} +export type RequestContentType$RolloutService_AbortRollout = keyof RequestBody$RolloutService_AbortRollout; +export type ResponseContentType$RolloutService_AbortRollout = keyof Response$RolloutService_AbortRollout$Status$200; +export interface Params$RolloutService_AbortRollout { + parameter: Parameter$RolloutService_AbortRollout; + requestBody: RequestBody$RolloutService_AbortRollout[\\"application/json\\"]; +} +export type ResponseContentType$RolloutService_GetRolloutInfo = keyof Response$RolloutService_GetRolloutInfo$Status$200; +export interface Params$RolloutService_GetRolloutInfo { + parameter: Parameter$RolloutService_GetRolloutInfo; +} +export type ResponseContentType$RolloutService_WatchRolloutInfo = keyof Response$RolloutService_WatchRolloutInfo$Status$200; +export interface Params$RolloutService_WatchRolloutInfo { + parameter: Parameter$RolloutService_WatchRolloutInfo; +} +export type RequestContentType$RolloutService_PromoteRollout = keyof RequestBody$RolloutService_PromoteRollout; +export type ResponseContentType$RolloutService_PromoteRollout = keyof Response$RolloutService_PromoteRollout$Status$200; +export interface Params$RolloutService_PromoteRollout { + parameter: Parameter$RolloutService_PromoteRollout; + requestBody: RequestBody$RolloutService_PromoteRollout[\\"application/json\\"]; +} +export type RequestContentType$RolloutService_RestartRollout = keyof RequestBody$RolloutService_RestartRollout; +export type ResponseContentType$RolloutService_RestartRollout = keyof Response$RolloutService_RestartRollout$Status$200; +export interface Params$RolloutService_RestartRollout { + parameter: Parameter$RolloutService_RestartRollout; + requestBody: RequestBody$RolloutService_RestartRollout[\\"application/json\\"]; +} +export type RequestContentType$RolloutService_RetryRollout = keyof RequestBody$RolloutService_RetryRollout; +export type ResponseContentType$RolloutService_RetryRollout = keyof Response$RolloutService_RetryRollout$Status$200; +export interface Params$RolloutService_RetryRollout { + parameter: Parameter$RolloutService_RetryRollout; + requestBody: RequestBody$RolloutService_RetryRollout[\\"application/json\\"]; +} +export type RequestContentType$RolloutService_SetRolloutImage = keyof RequestBody$RolloutService_SetRolloutImage; +export type ResponseContentType$RolloutService_SetRolloutImage = keyof Response$RolloutService_SetRolloutImage$Status$200; +export interface Params$RolloutService_SetRolloutImage { + parameter: Parameter$RolloutService_SetRolloutImage; + requestBody: RequestBody$RolloutService_SetRolloutImage[\\"application/json\\"]; +} +export type RequestContentType$RolloutService_UndoRollout = keyof RequestBody$RolloutService_UndoRollout; +export type ResponseContentType$RolloutService_UndoRollout = keyof Response$RolloutService_UndoRollout$Status$200; +export interface Params$RolloutService_UndoRollout { + parameter: Parameter$RolloutService_UndoRollout; + requestBody: RequestBody$RolloutService_UndoRollout[\\"application/json\\"]; +} +export type ResponseContentType$RolloutService_Version = keyof Response$RolloutService_Version$Status$200; +export type HttpMethod = \\"GET\\" | \\"PUT\\" | \\"POST\\" | \\"DELETE\\" | \\"OPTIONS\\" | \\"HEAD\\" | \\"PATCH\\" | \\"TRACE\\"; +export interface ObjectLike { + [key: string]: any; +} +export interface QueryParameter { + value: any; + style?: \\"form\\" | \\"spaceDelimited\\" | \\"pipeDelimited\\" | \\"deepObject\\"; + explode: boolean; +} +export interface QueryParameters { + [key: string]: QueryParameter; +} +export type SuccessResponses = Response$RolloutService_GetNamespace$Status$200 | Response$RolloutService_ListRolloutInfos$Status$200 | Response$RolloutService_WatchRolloutInfos$Status$200 | Response$RolloutService_AbortRollout$Status$200 | Response$RolloutService_GetRolloutInfo$Status$200 | Response$RolloutService_WatchRolloutInfo$Status$200 | Response$RolloutService_PromoteRollout$Status$200 | Response$RolloutService_RestartRollout$Status$200 | Response$RolloutService_RetryRollout$Status$200 | Response$RolloutService_SetRolloutImage$Status$200 | Response$RolloutService_UndoRollout$Status$200 | Response$RolloutService_Version$Status$200; +export namespace ErrorResponse { + export type RolloutService_GetNamespace = void; + export type RolloutService_ListRolloutInfos = void; + export type RolloutService_WatchRolloutInfos = void; + export type RolloutService_AbortRollout = void; + export type RolloutService_GetRolloutInfo = void; + export type RolloutService_WatchRolloutInfo = void; + export type RolloutService_PromoteRollout = void; + export type RolloutService_RestartRollout = void; + export type RolloutService_RetryRollout = void; + export type RolloutService_SetRolloutImage = void; + export type RolloutService_UndoRollout = void; + export type RolloutService_Version = void; +} +export interface ApiClient { + request: (httpMethod: HttpMethod, url: string, headers: ObjectLike | any, requestBody: ObjectLike | any, queryParameters: QueryParameters | undefined, options?: RequestOption) => Promise; +} +export class Client { + private baseUrl: string; + constructor(private apiClient: ApiClient, baseUrl: string) { this.baseUrl = baseUrl.replace(/\\\\/$/, \\"\\"); } + public async RolloutService_GetNamespace(option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/namespace\`; + const headers = { + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option); + } + public async RolloutService_ListRolloutInfos(params: Params$RolloutService_ListRolloutInfos, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/info\`; + const headers = { + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option); + } + public async RolloutService_WatchRolloutInfos(params: Params$RolloutService_WatchRolloutInfos, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/info/watch\`; + const headers = { + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option); + } + public async RolloutService_AbortRollout(params: Params$RolloutService_AbortRollout, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.name}/abort\`; + const headers = { + \\"Content-Type\\": \\"application/json\\", + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"PUT\\", url, headers, params.requestBody, undefined, option); + } + public async RolloutService_GetRolloutInfo(params: Params$RolloutService_GetRolloutInfo, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.name}/info\`; + const headers = { + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option); + } + public async RolloutService_WatchRolloutInfo(params: Params$RolloutService_WatchRolloutInfo, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.name}/info/watch\`; + const headers = { + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option); + } + public async RolloutService_PromoteRollout(params: Params$RolloutService_PromoteRollout, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.name}/promote\`; + const headers = { + \\"Content-Type\\": \\"application/json\\", + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"PUT\\", url, headers, params.requestBody, undefined, option); + } + public async RolloutService_RestartRollout(params: Params$RolloutService_RestartRollout, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.name}/restart\`; + const headers = { + \\"Content-Type\\": \\"application/json\\", + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"PUT\\", url, headers, params.requestBody, undefined, option); + } + public async RolloutService_RetryRollout(params: Params$RolloutService_RetryRollout, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.name}/retry\`; + const headers = { + \\"Content-Type\\": \\"application/json\\", + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"PUT\\", url, headers, params.requestBody, undefined, option); + } + public async RolloutService_SetRolloutImage(params: Params$RolloutService_SetRolloutImage, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.rollout}/set/\${params.parameter.container}/\${params.parameter.image}/\${params.parameter.tag}\`; + const headers = { + \\"Content-Type\\": \\"application/json\\", + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"PUT\\", url, headers, params.requestBody, undefined, option); + } + public async RolloutService_UndoRollout(params: Params$RolloutService_UndoRollout, option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/rollouts/\${params.parameter.namespace}/\${params.parameter.rollout}/undo/\${params.parameter.revision}\`; + const headers = { + \\"Content-Type\\": \\"application/json\\", + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"PUT\\", url, headers, params.requestBody, undefined, option); + } + public async RolloutService_Version(option?: RequestOption): Promise { + const url = this.baseUrl + \`/api/v1/version\`; + const headers = { + Accept: \\"application/json\\" + }; + return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option); + } +} +" +`; + exports[`Typedef with template async-api.test.domain 1`] = ` "// // Generated by @himenon/openapi-typescript-code-generator diff --git a/test/__tests__/typedef-with-template-test.ts b/test/__tests__/typedef-with-template-test.ts index 598d5349..8db97434 100644 --- a/test/__tests__/typedef-with-template-test.ts +++ b/test/__tests__/typedef-with-template-test.ts @@ -19,4 +19,9 @@ describe("Typedef with template", () => { const text = Utils.replaceVersionInfo(generateCode); expect(text).toMatchSnapshot(); }); + test("argo-rollout", () => { + const generateCode = fs.readFileSync(path.join(__dirname, "../code/typedef-with-template/argo-rollout.ts"), { encoding: "utf-8" }); + const text = Utils.replaceVersionInfo(generateCode); + expect(text).toMatchSnapshot(); + }); });