{ "swagger": "2.0", "info": { "description": "REST API for Kargo", "title": "Kargo API", "contact": {}, "version": "v1alpha1" }, "basePath": "/", "paths": { "/v1beta1/login": { "post": { "description": "Authenticate as the admin user if enabled.", "produces": [ "application/json" ], "tags": [ "System" ], "summary": "Admin login", "operationId": "AdminLogin", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AdminLoginResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects": { "get": { "description": "List all Projects resources. Supports server-side filtering by\nname substring, by UID, and by namespaces mapped to the\nauthenticated user's ServiceAccounts, plus offset-based\npagination.", "produces": [ "application/json" ], "tags": [ "Core", "Cluster-Scoped Resource" ], "summary": "List projects", "operationId": "ListProjects", "parameters": [ { "type": "boolean", "description": "Only return Projects whose namespaces are mapped to the user's ServiceAccounts.", "name": "mine", "in": "query" }, { "type": "string", "description": "Case-insensitive substring filter applied to the Project name.", "name": "filter", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Return only Projects whose UID matches one of the given values.", "name": "uid", "in": "query" }, { "type": "integer", "description": "Maximum number of Projects to return. Defaults to all matching Projects.", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "Zero-indexed page number used together with pageSize.", "name": "page", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListProjectsResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}": { "get": { "description": "Retrieve a Project resource.", "produces": [ "application/json" ], "tags": [ "Core", "Cluster-Scoped Resource" ], "summary": "Retrieve a Project resource", "operationId": "GetProject", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "Project custom resource (github.com/akuity/kargo/api/v1alpha1.Project)", "schema": { "$ref": "#/definitions/Project" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a Project resource and its associated namespace.", "tags": [ "Core", "Cluster-Scoped Resource" ], "summary": "Delete a Project", "operationId": "DeleteProject", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/analysis-runs/{analysis-run}": { "get": { "description": "Retrieve an AnalysisRun resource from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Verifications", "Project-Level" ], "summary": "Retrieve an AnalysisRun", "operationId": "GetAnalysisRun", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "AnalysisRun name", "name": "analysis-run", "in": "path", "required": true } ], "responses": { "200": { "description": "AnalysisRun custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.AnalysisRun)", "schema": { "$ref": "#/definitions/RolloutsAnalysisRun" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/analysis-runs/{analysis-run}/logs": { "get": { "description": "Stream logs from an AnalysisRun job as Server-Sent Events (SSE).", "produces": [ "text/event-stream" ], "tags": [ "Verifications", "Project-Level" ], "summary": "Stream AnalysisRun logs", "operationId": "GetAnalysisRunLogs", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "AnalysisRun name", "name": "analysis-run", "in": "path", "required": true }, { "type": "string", "description": "Metric name", "name": "metricName", "in": "query" }, { "type": "string", "description": "Container name", "name": "containerName", "in": "query" } ], "responses": { "200": { "description": "Log stream (SSE)", "schema": { "type": "string" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/analysis-templates": { "get": { "description": "List AnalysisTemplate resources from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Verifications", "Project-Level" ], "summary": "List AnalysisTemplates", "operationId": "ListAnalysisTemplates", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "AnalysisTemplateList custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.AnalysisTemplateList)", "schema": { "$ref": "#/definitions/RolloutsAnalysisTemplateList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/analysis-templates/{analysis-template}": { "get": { "description": "Retrieve an AnalysisTemplate resource from a project's\nnamespace.", "produces": [ "application/json" ], "tags": [ "Verifications", "Project-Level" ], "summary": "Retrieve an AnalysisTemplate", "operationId": "GetAnalysisTemplate", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "AnalysisTemplate name", "name": "analysis-template", "in": "path", "required": true } ], "responses": { "200": { "description": "AnalysisTemplate custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.AnalysisTemplate)", "schema": { "$ref": "#/definitions/RolloutsAnalysisTemplate" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete an AnalysisTemplate resource from a project's namespace.", "tags": [ "Verifications", "Project-Level" ], "summary": "Delete an AnalysisTemplate", "operationId": "DeleteAnalysisTemplate", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "AnalysisTemplate name", "name": "analysis-template", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/api-tokens": { "get": { "description": "List project-level API tokens. Returns a Kubernetes SecretList\nresource containing heavily redacted Secrets.", "produces": [ "application/json" ], "tags": [ "Rbac", "Credentials", "Project-Level" ], "summary": "List project-level API tokens", "operationId": "ListProjectAPITokens", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Role name filter", "name": "role", "in": "query" } ], "responses": { "200": { "description": "SecretList resource (k8s.io/api/core/v1.SecretList)", "schema": { "$ref": "#/definitions/V1SecretList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/api-tokens/{apitoken}": { "get": { "description": "Retrieve a project-level API token by name. Returns a heavily\nredacted Kubernetes Secret resource.", "produces": [ "application/json" ], "tags": [ "Rbac", "Credentials", "Project-Level" ], "summary": "Retrieve a project-level API token", "operationId": "GetProjectAPIToken", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "API token name", "name": "apitoken", "in": "path", "required": true } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a project-level API token from a project's namespace.", "tags": [ "Rbac", "Credentials", "Project-Level" ], "summary": "Delete a project-level API token", "operationId": "DeleteProjectAPIToken", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "API token name", "name": "apitoken", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/config": { "get": { "description": "Retrieve the single ProjectConfig resource from a project's\nnamespace.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level", "Config", "Singleton" ], "summary": "Retrieve ProjectConfig", "operationId": "GetProjectConfig", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "ProjectConfig custom resource", "schema": { "$ref": "#/definitions/ProjectConfig" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete the single ProjectConfig resource from a project's\nnamespace.", "tags": [ "Core", "Project-Level", "Config", "Singleton" ], "summary": "Delete a ProjectConfig resource", "operationId": "DeleteProjectConfig", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/config/refresh": { "post": { "description": "Refresh the single ProjectConfig resource in a project's\nnamespace. Refreshing enqueues the resource for reconciliation\nby its corresponding controller.", "produces": [ "application/json" ], "tags": [ "Core", "Config", "Project-Level", "Singleton" ], "summary": "Refresh ProjectConfig", "operationId": "RefreshProjectConfig", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/configmaps": { "get": { "description": "List ConfigMap resources from a project's namespace. Returns a\nKubernetes ConfigMapList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Project-Level" ], "summary": "List project-level ConfigMaps", "operationId": "ListProjectConfigMaps", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "ConfigMapList resource (k8s.io/api/core/v1.ConfigMapList)", "schema": { "$ref": "#/definitions/V1ConfigMapList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create a ConfigMap in a project's namespace. Returns the created\nKubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Project-Level" ], "summary": "Create a project-level ConfigMap", "operationId": "CreateProjectConfigMap", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "description": "ConfigMap", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateConfigMapRequest" } } ], "responses": { "201": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/configmaps/{configmap}": { "get": { "description": "Retrieve a ConfigMap by name from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Project-Level" ], "summary": "Retrieve a project-level ConfigMap", "operationId": "GetProjectConfigMap", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace a ConfigMap in a project's namespace. All existing data\nis replaced. Returns the updated Kubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Project-Level" ], "summary": "Replace a project-level ConfigMap", "operationId": "UpdateProjectConfigMap", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true }, { "description": "ConfigMap", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateConfigMapRequest" } } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a ConfigMap from a project's namespace.", "tags": [ "Core", "Generic Config", "Project-Level" ], "summary": "Delete a project-level ConfigMap", "operationId": "DeleteProjectConfigMap", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch a ConfigMap in a project's namespace. Merges provided data\nwith existing data. Use removeKeys to delete specific keys.\nReturns the updated Kubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Project-Level" ], "summary": "Patch a project-level ConfigMap", "operationId": "PatchProjectConfigMap", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true }, { "description": "ConfigMap patch", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchConfigMapRequest" } } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/events": { "get": { "description": "List Kubernetes Events from a project's namespace. Returns a\nKubernetes EventList resource.", "produces": [ "application/json" ], "tags": [ "Events", "Project-Level" ], "summary": "List project-level Kubernetes Events", "operationId": "ListProjectEvents", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "EventList resource (k8s.io/api/core/v1.EventList)", "schema": { "$ref": "#/definitions/V1EventList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/freight": { "get": { "description": "Query and filter Freight resources from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Query Freight", "operationId": "QueryFreightsRest", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name to get available freight for", "name": "stage", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Warehouse names to get freight from", "name": "origins", "in": "query" }, { "type": "string", "description": "Group filter", "name": "group", "in": "query" }, { "type": "string", "description": "Group by (image_repo, git_repo, chart_repo)", "name": "groupBy", "in": "query" }, { "type": "string", "description": "Order by (first_seen, tag)", "name": "orderBy", "in": "query" }, { "type": "boolean", "description": "Reverse order", "name": "reverse", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/pkg_server.queryFreightsResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/freight/{freight-name-or-alias}": { "get": { "description": "Retrieve a Freight resource from a project's namespace by name\nor alias.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Retrieve a Freight resource", "operationId": "GetFreight", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Freight name or alias", "name": "freight-name-or-alias", "in": "path", "required": true } ], "responses": { "200": { "description": "Freight custom resource (github.com/akuity/kargo/api/v1alpha1.Freight)", "schema": { "$ref": "#/definitions/Freight" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a Freight resource from a project's namespace by name or\nalias.", "tags": [ "Core", "Project-Level" ], "summary": "Delete a Freight resource", "operationId": "DeleteFreight", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Freight name or alias", "name": "freight-name-or-alias", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/freight/{freight-name-or-alias}/alias": { "patch": { "description": "Patch a Freight resource's human-friendly alias.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Patch a Freight resource's alias", "operationId": "PatchFreightAlias", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Freight name or alias", "name": "freight-name-or-alias", "in": "path", "required": true }, { "type": "string", "description": "New alias", "name": "newAlias", "in": "query", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/freight/{freight-name-or-alias}/approve": { "post": { "description": "Approve Freight for promotion to a Stage.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Approve Freight for promotion to a Stage", "operationId": "ApproveFreight", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Freight name or alias", "name": "freight-name-or-alias", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "query", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/freight/{freight-name-or-alias}/links": { "get": { "description": "Retrieve evaluated deep links for a Freight resource, combining\ncluster-level links from ClusterConfig and project-level links\nfrom ProjectConfig.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Retrieve deep links for a Freight resource", "operationId": "GetFreightLinks", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Freight name or alias", "name": "freight-name-or-alias", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetFreightLinksResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/generic-credentials": { "get": { "description": "List project-level generic credentials. Returns a Kubernetes\nSecretList resource containing heavily redacted Secrets.", "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Project-Level" ], "summary": "List project-level generic credentials", "operationId": "ListProjectGenericCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "SecretList resource (k8s.io/api/core/v1.SecretList)", "schema": { "$ref": "#/definitions/V1SecretList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create project-level generic credentials. Returns a heavily\nredacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Project-Level" ], "summary": "Create project-level generic credentials", "operationId": "CreateProjectGenericCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "description": "Generic credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateGenericCredentialsRequest" } } ], "responses": { "201": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/generic-credentials/{generic-credentials}": { "get": { "description": "Retrieve project-level generic credentials by name. Returns a\nheavily redacted Kubernetes Secret resource.", "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Project-Level" ], "summary": "Retrieve project-level generic credentials", "operationId": "GetProjectGenericCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Credentials name", "name": "generic-credentials", "in": "path", "required": true } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace project-level generic credentials. All existing data is\nreplaced. Returns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Project-Level" ], "summary": "Replace project-level generic credentials", "operationId": "UpdateProjectGenericCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true }, { "description": "GenericCredentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateGenericCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete generic credentials from a project's namespace.", "tags": [ "Credentials", "Generic Credentials", "Project-Level" ], "summary": "Delete project-level generic credentials", "operationId": "DeleteProjectGenericCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch project-level generic credentials. Merges provided data\nwith existing data. Use removeKeys to delete specific keys.\nReturns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Project-Level" ], "summary": "Patch project-level generic credentials", "operationId": "PatchProjectGenericCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true }, { "description": "GenericCredentials patch", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchGenericCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/images": { "get": { "description": "List container images referenced by Freight resources in a\nproject's namespace.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "List container images", "operationId": "ListImages", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/TagMap" } } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/promotion-tasks": { "get": { "description": "List PromotionTask resources from a project's namespace. Returns\na PromotionTaskList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "List PromotionTasks", "operationId": "ListPromotionTasks", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "PromotionTaskList custom resource (github.com/akuity/kargo/api/v1alpha1.PromotionTaskList)", "schema": { "$ref": "#/definitions/PromotionTaskList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/promotion-tasks/{promotion-task}": { "get": { "description": "Retrieve a PromotionTask resource from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Retrieve a PromotionTask", "operationId": "GetPromotionTask", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "PromotionTask name", "name": "promotion-task", "in": "path", "required": true } ], "responses": { "200": { "description": "PromotionTask custom resource", "schema": { "$ref": "#/definitions/PromotionTask" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/promotions": { "get": { "description": "List Promotion resources from a project's namespace. Returns a\nPromotionList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "List Promotions", "operationId": "ListPromotions", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage filter", "name": "stage", "in": "query" } ], "responses": { "200": { "description": "PromotionList custom resource", "schema": { "$ref": "#/definitions/PromotionList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/promotions/{promotion}": { "get": { "description": "Retrieve a Promotion resource from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Retrieve a Promotion", "operationId": "GetPromotion", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Promotion name", "name": "promotion", "in": "path", "required": true } ], "responses": { "200": { "description": "Promotion custom resource (github.com/akuity/kargo/api/v1alpha1.Promotion)", "schema": { "$ref": "#/definitions/Promotion" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/promotions/{promotion}/abort": { "post": { "description": "Abort a running Promotion.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Abort a Promotion", "operationId": "AbortPromotion", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Promotion name", "name": "promotion", "in": "path", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/promotions/{promotion}/refresh": { "post": { "description": "Refresh a Promotion resource in a project's namespace.\nRefreshing enqueues the resource for reconciliation by its\ncorresponding controller.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Refresh a Promotion", "operationId": "RefreshPromotion", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Promotion name", "name": "promotion", "in": "path", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/repo-credentials": { "get": { "description": "List project-level repository credentials. Returns a SecretList\nresource containing heavily redacted Secrets.", "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Project-Level" ], "summary": "List project-level repository credentials", "operationId": "ListProjectRepoCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "SecretList resource (k8s.io/api/core/v1.SecretList)", "schema": { "$ref": "#/definitions/V1SecretList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create project-level repository credentials. Returns a heavily\nredacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Project-Level" ], "summary": "Create project-level repository credentials", "operationId": "CreateProjectRepoCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "description": "Credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateRepoCredentialsRequest" } } ], "responses": { "201": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/repo-credentials/{repo-credentials}": { "get": { "description": "Retrieve project-level repository credentials by name. Returns a\nheavily redacted Kubernetes Secret resource.", "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Project-Level" ], "summary": "Retrieve project-level repository credentials", "operationId": "GetProjectRepoCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Credentials name", "name": "repo-credentials", "in": "path", "required": true } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace project-level repository credentials. All fields are replaced.\nReturns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Project-Level" ], "summary": "Replace project-level repository credentials", "operationId": "UpdateProjectRepoCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Repo credentials name", "name": "repo-credentials", "in": "path", "required": true }, { "description": "Credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateRepoCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete repository credentials from a project's namespace.", "tags": [ "Credentials", "Repo Credentials", "Project-Level" ], "summary": "Delete project-level repository credentials", "operationId": "DeleteProjectRepoCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Credentials name", "name": "repo-credentials", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch project-level repository credentials. Only provided fields\nare updated. Returns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Project-Level" ], "summary": "Patch project-level repository credentials", "operationId": "PatchProjectRepoCredentials", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Repo credentials name", "name": "repo-credentials", "in": "path", "required": true }, { "description": "Credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchRepoCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/roles": { "get": { "description": "List project-level Kargo Role virtual resources. Returns a\nRoleList resource.", "produces": [ "application/json" ], "tags": [ "Rbac", "Project-Level" ], "summary": "List project-level Kargo Role virtual resources", "operationId": "ListProjectRoles", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "RoleList custom resource (rbacapi.RoleList) or underlying resources", "schema": {} } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create a project-level Kargo Role virtual resource by creating\nthe underlying Kubernetes ServiceAccount, Role, and RoleBinding\nresources.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Rbac", "Project-Level" ], "summary": "Create a project-level Kargo Role virtual resource", "operationId": "CreateProjectRole", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "description": "Role resource (github.com/akuity/kargo/api/rbac/v1alpha1.Role)", "name": "body", "in": "body", "required": true, "schema": {} } ], "responses": { "201": { "description": "Role resource (github.com/akuity/kargo/api/rbac/v1alpha1.Role)", "schema": { "$ref": "#/definitions/RbacRole" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/roles/grants": { "post": { "description": "Grant a project-level Kargo Role to users or grant permissions\nto a project-level Kargo Role.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Rbac", "Project-Level" ], "summary": "Grant permissions", "operationId": "Grant", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "description": "Grant request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GrantRequest" } } ], "responses": { "200": { "description": "Role resource (github.com/akuity/kargo/api/rbac/v1alpha1.Role)", "schema": { "$ref": "#/definitions/RbacRole" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/roles/revocations": { "post": { "description": "Revoke a project-level Kargo Role from users or revoke\npermissions from a project-level Kargo Role.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Rbac", "Project-Level" ], "summary": "Revoke permissions", "operationId": "Revoke", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "description": "Revoke request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RevokeRequest" } } ], "responses": { "200": { "description": "Role resource (github.com/akuity/kargo/api/rbac/v1alpha1.Role)", "schema": { "$ref": "#/definitions/RbacRole" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/roles/{role}": { "get": { "description": "Retrieve a project-level Kargo Role virtual resource by name.\nReturns a Kargo Role virtual resource or its underlying\nKubernetes resources.", "produces": [ "application/json" ], "tags": [ "Rbac", "Project-Level" ], "summary": "Retrieve a project-level Kargo Role virtual resource", "operationId": "GetProjectRole", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Role name", "name": "role", "in": "path", "required": true } ], "responses": { "200": { "description": "Role resource (k8s.io/api/rbac/v1.Role) or its underlying Kubernetes resources", "schema": {} } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Update a project-level Kargo Role virtual resource by updating\nthe underlying Kubernetes ServiceAccount, Role, and RoleBinding\nresources.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Rbac", "Project-Level" ], "summary": "Update a project-level Kargo Role virtual resource", "operationId": "UpdateRole", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Role name", "name": "role", "in": "path", "required": true }, { "description": "Role resource (github.com/akuity/kargo/api/rbac/v1alpha1.Role)", "name": "body", "in": "body", "required": true, "schema": {} } ], "responses": { "200": { "description": "Role resource (github.com/akuity/kargo/api/rbac/v1alpha1.Role)", "schema": { "$ref": "#/definitions/RbacRole" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a project-level Kargo Role virtual resource by deleting\nthe underlying Kubernetes ServiceAccount, Role, and RoleBinding\nresources from the project's namespace.", "tags": [ "Rbac", "Project-Level" ], "summary": "Delete a project-level Kargo Role virtual resource", "operationId": "DeleteProjectRole", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Role name", "name": "role", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/roles/{role}/api-tokens": { "post": { "description": "Create a project-level API token associated with a Kargo Role\nvirtual resource. Returns a Kubernetes Secret resource\nrepresenting the token. Store it securely. The token is not\nretrievable via the Kargo API after creation except in a\nredacted form.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Rbac", "Credentials", "Project-Level" ], "summary": "Create a project-level API token", "operationId": "CreateProjectAPIToken", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Role name", "name": "role", "in": "path", "required": true }, { "description": "Token", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateAPITokenRequest" } } ], "responses": { "201": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages": { "get": { "description": "List Stage resources from a project's namespace. Returns a\nStageList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "List Stages", "operationId": "ListStages", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Warehouse names to filter Stages by", "name": "freightOrigins", "in": "query" } ], "responses": { "200": { "description": "StageList custom resource (github.com/akuity/kargo/api/v1alpha1.StageList)", "schema": { "$ref": "#/definitions/StageList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages/{stage}": { "get": { "description": "Retrieve a Stage resource from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Retrieve a Stage", "operationId": "GetStage", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true } ], "responses": { "200": { "description": "Stage custom resource (github.com/akuity/kargo/api/v1alpha1.Stage)", "schema": { "$ref": "#/definitions/Stage" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a Stage resource from a project's namespace.", "tags": [ "Core", "Project-Level" ], "summary": "Delete a Stage", "operationId": "DeleteStage", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages/{stage}/links": { "get": { "description": "Retrieve evaluated deep links for a Stage resource, combining\ncluster-level links from ClusterConfig and project-level links\nfrom ProjectConfig.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Retrieve deep links for a Stage resource", "operationId": "GetStageLinks", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetStageLinksResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages/{stage}/promotions": { "post": { "description": "Create a Promotion resource to transition a specified Stage into\nthe state represented by the specified Freight.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Promote to Stage", "operationId": "PromoteToStage", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true }, { "description": "Promote request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PromoteToStageRequest" } } ], "responses": { "201": { "description": "Promotion resource (github.com/akuity/kargo/api/v1alpha1.Promotion)", "schema": { "$ref": "#/definitions/Promotion" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages/{stage}/promotions/downstream": { "post": { "description": "Creates a Promotion resource for each of a Stage's immediately\ndownstream Stages.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Promote downstream", "operationId": "PromoteDownstream", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true }, { "description": "Promote request", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PromoteDownstreamRequest" } } ], "responses": { "201": { "description": "Promotions created", "schema": {} } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages/{stage}/refresh": { "post": { "description": "Refresh a Stage resource in a project's namespace. Refreshing\nenqueues the resource for reconciliation by its corresponding\ncontroller.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Refresh a Stage", "operationId": "RefreshStage", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages/{stage}/verification": { "post": { "description": "Trigger re-verification of the Freight currently in use by a\nStage.", "produces": [ "application/json" ], "tags": [ "Verifications", "Project-Level" ], "summary": "Reverify Freight", "operationId": "Reverify", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/stages/{stage}/verification/abort": { "post": { "description": "Abort a running Verification process.", "produces": [ "application/json" ], "tags": [ "Verifications", "Project-Level" ], "summary": "Abort a running Verification process", "operationId": "AbortVerification", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Stage name", "name": "stage", "in": "path", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/warehouses": { "get": { "description": "List Warehouse resources from a project's namespace. Returns a\nWarehouseList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "List Warehouses", "operationId": "ListWarehouses", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true } ], "responses": { "200": { "description": "WarehouseList custom resource", "schema": { "$ref": "#/definitions/WarehouseList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/warehouses/{warehouse}": { "get": { "description": "Retrieve a Warehouse resource from a project's namespace.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Retrieve a Warehouse", "operationId": "GetWarehouse", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Warehouse name", "name": "warehouse", "in": "path", "required": true } ], "responses": { "200": { "description": "Warehouse custom resource (github.com/akuity/kargo/api/v1alpha1.Warehouse)", "schema": { "$ref": "#/definitions/Warehouse" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a Warehouse resource from a project's namespace.", "tags": [ "Core", "Project-Level" ], "summary": "Delete a Warehouse", "operationId": "DeleteWarehouse", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Warehouse name", "name": "warehouse", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/projects/{project}/warehouses/{warehouse}/refresh": { "post": { "description": "Refresh a Warehouse resource in a project's namespace.\nRefreshing enqueues the resource for reconciliation by its\ncorresponding controller.", "produces": [ "application/json" ], "tags": [ "Core", "Project-Level" ], "summary": "Refresh a Warehouse", "operationId": "RefreshWarehouse", "parameters": [ { "type": "string", "description": "Project name", "name": "project", "in": "path", "required": true }, { "type": "string", "description": "Warehouse name", "name": "warehouse", "in": "path", "required": true } ], "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/resources": { "put": { "description": "Update (or optionally, upsert) one or more Kargo resources from", "consumes": [ "text/plain" ], "produces": [ "application/json" ], "tags": [ "Resources" ], "summary": "Update resources", "operationId": "UpdateResource", "parameters": [ { "type": "boolean", "description": "If true, create a resource if it does not exist", "name": "upsert", "in": "query" }, { "description": "YAML or JSON manifest(s)", "name": "manifest", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Update results", "schema": { "$ref": "#/definitions/CreateOrUpdateResourceResponse" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create one or more Kargo resources from YAML or JSON manifests.", "consumes": [ "text/plain" ], "produces": [ "application/json" ], "tags": [ "Resources" ], "summary": "Create resources", "operationId": "CreateResource", "parameters": [ { "description": "YAML or JSON manifest(s)", "name": "manifest", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created successfully", "schema": { "$ref": "#/definitions/CreateResourceResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/ResourceErrorResponse" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete one or more Kargo resources using namespaces and names\nobtained from YAML or JSON manifests.", "consumes": [ "text/plain" ], "produces": [ "application/json" ], "tags": [ "Resources" ], "summary": "Delete resources", "operationId": "DeleteResource", "parameters": [ { "description": "YAML or JSON manifest(s)", "name": "manifest", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteResourceResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/cluster-analysis-templates": { "get": { "description": "List ClusterAnalysisTemplate resources. Returns a\nClusterAnalysisTemplateList resource.", "produces": [ "application/json" ], "tags": [ "Verifications", "Shared", "Cluster-Scoped Resource" ], "summary": "List ClusterAnalysisTemplates", "operationId": "ListClusterAnalysisTemplates", "responses": { "200": { "description": "ClusterAnalysisTemplateList custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.ClusterAnalysisTemplateList)", "schema": { "$ref": "#/definitions/RolloutsClusterAnalysisTemplateList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/cluster-analysis-templates/{cluster-analysis-template}": { "get": { "description": "Retrieve a ClusterAnalysisTemplate by name.", "produces": [ "application/json" ], "tags": [ "Verifications", "Shared", "Cluster-Scoped Resource" ], "summary": "Retrieve a ClusterAnalysisTemplate", "operationId": "GetClusterAnalysisTemplate", "parameters": [ { "type": "string", "description": "ClusterAnalysisTemplate name", "name": "cluster-analysis-template", "in": "path", "required": true } ], "responses": { "200": { "description": "ClusterAnalysisTemplate custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.ClusterAnalysisTemplate)", "schema": { "$ref": "#/definitions/RolloutsClusterAnalysisTemplate" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a ClusterAnalysisTemplate resource.", "tags": [ "Verifications", "Shared", "Cluster-Scoped Resource" ], "summary": "Delete a ClusterAnalysisTemplate", "operationId": "DeleteClusterAnalysisTemplate", "parameters": [ { "type": "string", "description": "ClusterAnalysisTemplate name", "name": "cluster-analysis-template", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/cluster-promotion-tasks": { "get": { "description": "List ClusterPromotionTask resources. Returns a\nClusterPromotionTaskList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Shared", "Cluster-Scoped Resource" ], "summary": "List ClusterPromotionTasks", "operationId": "ListClusterPromotionTasks", "responses": { "200": { "description": "ClusterPromotionTaskList custom resource (github.com/akuity/kargo/api/v1alpha1.ClusterPromotionTaskList)", "schema": { "$ref": "#/definitions/ClusterPromotionTaskList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/cluster-promotion-tasks/{cluster-promotion-task}": { "get": { "description": "Retrieve a ClusterPromotionTask by name.", "produces": [ "application/json" ], "tags": [ "Core", "Shared", "Cluster-Scoped Resource" ], "summary": "Retrieve a ClusterPromotionTask", "operationId": "GetClusterPromotionTask", "parameters": [ { "type": "string", "description": "ClusterPromotionTask name", "name": "cluster-promotion-task", "in": "path", "required": true } ], "responses": { "200": { "description": "ClusterPromotionTask custom resource (github.com/akuity/kargo/api/v1alpha1.ClusterPromotionTask)", "schema": { "$ref": "#/definitions/ClusterPromotionTask" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/configmaps": { "get": { "description": "List shared ConfigMap resources referenceable by all projects.\nReturns a Kubernetes ConfigMapList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Shared" ], "summary": "List shared ConfigMaps", "operationId": "ListSharedConfigMaps", "responses": { "200": { "description": "ConfigMapList resource (k8s.io/api/core/v1.ConfigMapList)", "schema": { "$ref": "#/definitions/V1ConfigMapList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create a shared ConfigMap referenceable by all projects. Returns\nthe created Kubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Shared" ], "summary": "Create a shared ConfigMap", "operationId": "CreateSharedConfigMap", "parameters": [ { "description": "ConfigMap", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateConfigMapRequest" } } ], "responses": { "201": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/configmaps/{configmap}": { "get": { "description": "Retrieve a shared ConfigMap by name.", "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Shared" ], "summary": "Retrieve a shared ConfigMap", "operationId": "GetSharedConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace a shared ConfigMap. All existing data is replaced.\nReturns the updated Kubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Shared" ], "summary": "Replace a shared ConfigMap", "operationId": "UpdateSharedConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true }, { "description": "ConfigMap", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateConfigMapRequest" } } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a shared ConfigMap.", "tags": [ "Core", "Generic Config", "Shared" ], "summary": "Delete a shared ConfigMap", "operationId": "DeleteSharedConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch a shared ConfigMap. Merges provided data\nwith existing data. Use removeKeys to delete specific keys.\nReturns the updated Kubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "Shared" ], "summary": "Patch a shared ConfigMap", "operationId": "PatchSharedConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true }, { "description": "ConfigMap patch", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchConfigMapRequest" } } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/generic-credentials": { "get": { "description": "List shared generic credentials. Returns a Kubernetes SecretList\nresource containing heavily redacted Secrets.", "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Shared" ], "summary": "List shared generic credentials", "operationId": "ListSharedGenericCredentials", "responses": { "200": { "description": "SecretList resource (k8s.io/api/core/v1.SecretList)", "schema": { "$ref": "#/definitions/V1SecretList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create shared generic credentials referenceable by all\nprojects. Returns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Shared" ], "summary": "Create shared generic credentials", "operationId": "CreateSharedGenericCredentials", "parameters": [ { "description": "Generic credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateGenericCredentialsRequest" } } ], "responses": { "201": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/generic-credentials/{generic-credentials}": { "get": { "description": "Retrieve shared generic credentials by name. Returns a\nheavily redacted Kubernetes Secret resource.", "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Shared" ], "summary": "Retrieve shared generic credentials", "operationId": "GetSharedGenericCredentials", "parameters": [ { "type": "string", "description": "Credentials name", "name": "generic-credentials", "in": "path", "required": true } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace shared generic credentials. All existing data is replaced.\nReturns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Shared" ], "summary": "Replace shared generic credentials", "operationId": "UpdateSharedGenericCredentials", "parameters": [ { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true }, { "description": "GenericCredentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateGenericCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete shared generic credentials.", "tags": [ "Credentials", "Generic Credentials", "Shared" ], "summary": "Delete shared generic credentials", "operationId": "DeleteSharedGenericCredentials", "parameters": [ { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch shared generic credentials. Merges provided data\nwith existing data. Use removeKeys to delete specific keys.\nReturns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "Shared" ], "summary": "Patch shared generic credentials", "operationId": "PatchSharedGenericCredentials", "parameters": [ { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true }, { "description": "GenericCredentials patch", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchGenericCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/repo-credentials": { "get": { "description": "List shared repository credentials. Returns a SecretList\nresource containing heavily redacted Secrets.", "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Shared" ], "summary": "List shared repository credentials", "operationId": "ListSharedRepoCredentials", "responses": { "200": { "description": "SecretList resource (k8s.io/api/core/v1.SecretList)", "schema": { "$ref": "#/definitions/V1SecretList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create shared repository credentials. Returns a heavily\nredacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Shared" ], "summary": "Create shared repository credentials", "operationId": "CreateSharedRepoCredentials", "parameters": [ { "description": "Credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateRepoCredentialsRequest" } } ], "responses": { "201": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/shared/repo-credentials/{repo-credentials}": { "get": { "description": "Retrieve shared repository credentials by name. Returns a\nheavily redacted Kubernetes Secret resource.", "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Shared" ], "summary": "Retrieve shared repository credentials", "operationId": "GetSharedRepoCredentials", "parameters": [ { "type": "string", "description": "Credentials name", "name": "repo-credentials", "in": "path", "required": true } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace shared repository credentials. All fields are replaced.\nReturns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Shared" ], "summary": "Replace shared repository credentials", "operationId": "UpdateSharedRepoCredentials", "parameters": [ { "type": "string", "description": "Repo credentials name", "name": "repo-credentials", "in": "path", "required": true }, { "description": "Credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateRepoCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete shared repository credentials.", "tags": [ "Credentials", "Repo Credentials", "Shared" ], "summary": "Delete shared repository credentials", "operationId": "DeleteSharedRepoCredentials", "parameters": [ { "type": "string", "description": "Credentials name", "name": "repo-credentials", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch shared repository credentials. Only provided fields\nare updated. Returns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Repo Credentials", "Shared" ], "summary": "Patch shared repository credentials", "operationId": "PatchSharedRepoCredentials", "parameters": [ { "type": "string", "description": "Repo credentials name", "name": "repo-credentials", "in": "path", "required": true }, { "description": "Credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchRepoCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/api-tokens": { "get": { "description": "List system-level API tokens. Returns a Kubernetes SecretList\nresource containing heavily redacted Secrets.", "produces": [ "application/json" ], "tags": [ "Rbac", "Credentials", "System-Level" ], "summary": "List system-level API tokens", "operationId": "ListSystemAPITokens", "parameters": [ { "type": "string", "description": "Role name filter", "name": "role", "in": "query" } ], "responses": { "200": { "description": "SecretList resource (k8s.io/api/core/v1.SecretList)", "schema": { "$ref": "#/definitions/V1SecretList" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/api-tokens/{apitoken}": { "get": { "description": "Retrieve a system-level API token by name. Returns a heavily\nredacted Kubernetes Secret resource.", "produces": [ "application/json" ], "tags": [ "Rbac", "Credentials", "System-Level" ], "summary": "Retrieve a system-level API token", "operationId": "GetSystemAPIToken", "parameters": [ { "type": "string", "description": "API token name", "name": "apitoken", "in": "path", "required": true } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a system-level API token.", "tags": [ "Rbac", "Credentials", "System-Level" ], "summary": "Delete a system-level API token", "operationId": "DeleteSystemAPIToken", "parameters": [ { "type": "string", "description": "API token name", "name": "apitoken", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/cluster-config": { "get": { "description": "Retrieve the single ClusterConfig resource.", "produces": [ "application/json" ], "tags": [ "System", "Config", "Cluster-Scoped Resource", "Singleton" ], "summary": "Retrieve the ClusterConfig", "operationId": "GetClusterConfig", "responses": { "200": { "description": "ClusterConfig custom resource", "schema": { "$ref": "#/definitions/ClusterConfig" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Deletes the single ClusterConfig resource.", "tags": [ "System", "Config", "Cluster-Scoped Resource", "Singleton" ], "summary": "Delete the ClusterConfig", "operationId": "DeleteClusterConfig", "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/cluster-config/refresh": { "post": { "description": "Refresh the single ClusterConfig resource. Refreshing enqueues\nthe resource for reconciliation by its corresponding controller.", "produces": [ "application/json" ], "tags": [ "System", "Config", "Cluster-Scoped Resource", "Singleton" ], "summary": "Refresh the ClusterConfig", "operationId": "RefreshClusterConfig", "responses": { "200": { "description": "Success" } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/configmaps": { "get": { "description": "List system-level ConfigMap resources. Returns a Kubernetes\nConfigMapList resource.", "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "System-Level" ], "summary": "List system-level ConfigMaps", "operationId": "ListSystemConfigMaps", "responses": { "200": { "description": "ConfigMapList resource (k8s.io/api/core/v1.ConfigMapList)", "schema": { "$ref": "#/definitions/V1ConfigMapList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create a system-level ConfigMap. Returns the created Kubernetes\nConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "System-Level" ], "summary": "Create a system-level ConfigMap", "operationId": "CreateSystemConfigMap", "parameters": [ { "description": "ConfigMap", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateConfigMapRequest" } } ], "responses": { "201": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/configmaps/{configmap}": { "get": { "description": "Retrieve a system-level ConfigMap by name.", "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "System-Level" ], "summary": "Retrieve a system-level ConfigMap", "operationId": "GetSystemConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace a system-level ConfigMap. All existing data is replaced.\nReturns the updated Kubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "System-Level" ], "summary": "Replace a system-level ConfigMap", "operationId": "UpdateSystemConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true }, { "description": "ConfigMap", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateConfigMapRequest" } } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete a system-level ConfigMap.", "tags": [ "Core", "Generic Config", "System-Level" ], "summary": "Delete a system-level ConfigMap", "operationId": "DeleteSystemConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch a system-level ConfigMap. Merges provided data\nwith existing data. Use removeKeys to delete specific keys.\nReturns the updated Kubernetes ConfigMap resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Core", "Generic Config", "System-Level" ], "summary": "Patch a system-level ConfigMap", "operationId": "PatchSystemConfigMap", "parameters": [ { "type": "string", "description": "ConfigMap name", "name": "configmap", "in": "path", "required": true }, { "description": "ConfigMap patch", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchConfigMapRequest" } } ], "responses": { "200": { "description": "ConfigMap resource (k8s.io/api/core/v1.ConfigMap)", "schema": { "$ref": "#/definitions/V1ConfigMap" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/controller-heartbeats": { "get": { "description": "Get the most recent heartbeat from every controller that has\nreported in. Any controller not represented in the response has\nnever reported a heartbeat and can therefore be assumed by the\ncaller to be dead or nonexistent.", "produces": [ "application/json" ], "tags": [ "System" ], "summary": "Get controller heartbeats", "operationId": "GetControllerHeartbeats", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetControllerHeartbeatsResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/generic-credentials": { "get": { "description": "List system-level generic credentials. Returns a Kubernetes\nSecretList resource containing heavily redacted Secrets.", "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "System-Level" ], "summary": "List system-level generic credentials", "operationId": "ListSystemGenericCredentials", "responses": { "200": { "description": "SecretList resource (k8s.io/api/core/v1.SecretList)", "schema": { "$ref": "#/definitions/V1SecretList" } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "description": "Create system-level generic credentials. Returns a heavily\nredacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "System-Level" ], "summary": "Create system-level generic credentials", "operationId": "CreateSystemGenericCredentials", "parameters": [ { "description": "Generic credentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateGenericCredentialsRequest" } } ], "responses": { "201": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/generic-credentials/{generic-credentials}": { "get": { "description": "Retrieve system-level generic credentials by name. Returns a\nheavily redacted Kubernetes Secret resource.", "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "System-Level" ], "summary": "Retrieve system-level generic credentials", "operationId": "GetSystemGenericCredentials", "parameters": [ { "type": "string", "description": "Credentials name", "name": "generic-credentials", "in": "path", "required": true } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "description": "Replace system-level generic credentials. All existing data is\nreplaced. Returns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "System-Level" ], "summary": "Replace system-level generic credentials", "operationId": "UpdateSystemGenericCredentials", "parameters": [ { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true }, { "description": "GenericCredentials", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateGenericCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "description": "Delete system-level generic credentials.", "tags": [ "Credentials", "Generic Credentials", "System-Level" ], "summary": "Delete system-level generic credentials", "operationId": "DeleteSystemGenericCredentials", "parameters": [ { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true } ], "responses": { "204": { "description": "Deleted successfully" } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "description": "Patch system-level generic credentials. Merges provided data\nwith existing data. Use removeKeys to delete specific keys.\nReturns a heavily redacted Kubernetes Secret resource.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Credentials", "Generic Credentials", "System-Level" ], "summary": "Patch system-level generic credentials", "operationId": "PatchSystemGenericCredentials", "parameters": [ { "type": "string", "description": "Generic credentials name", "name": "generic-credentials", "in": "path", "required": true }, { "description": "GenericCredentials patch", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PatchGenericCredentialsRequest" } } ], "responses": { "200": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/public-server-config": { "get": { "description": "Retrieve information a client may need to know about how the\nKargo API server is configured in order to proceed with\nauthentication.", "produces": [ "application/json" ], "tags": [ "System", "Config" ], "summary": "Retrieve public server configuration", "operationId": "GetPublicConfig", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PublicConfig" } } } } }, "/v1beta1/system/roles": { "get": { "description": "List system-level Kargo Role virtual resources. Returns a\nRoleList resource.", "produces": [ "application/json" ], "tags": [ "Rbac", "System-Level" ], "summary": "List system-level Kargo Role virtual resources", "operationId": "ListSystemRoles", "responses": { "200": { "description": "RoleList custom resource (rbacapi.RoleList) or underlying resources", "schema": {} } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/roles/{role}": { "get": { "description": "Retrieve a system-level Kargo Role virtual resource by name.\nReturns a Kargo Role virtual resource or its underlying\nKubernetes resources.", "produces": [ "application/json" ], "tags": [ "Rbac", "System-Level" ], "summary": "Retrieve a system-level Kargo Role virtual resource", "operationId": "GetSystemRole", "parameters": [ { "type": "string", "description": "Role name", "name": "role", "in": "path", "required": true } ], "responses": { "200": { "description": "Role resource (k8s.io/api/rbac/v1.Role) or its underlying Kubernetes resources", "schema": {} } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/roles/{role}/api-tokens": { "post": { "description": "Create a system-level API token associated with a system-level\nKargo Role virtual resource. Returns a Kubernetes Secret\nresource representing the token. Store it securely. The token\nis not retrievable via the Kargo API after creation except in\na redacted form.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Rbac", "Credentials", "System-Level" ], "summary": "Create a system-level API token", "operationId": "CreateSystemAPIToken", "parameters": [ { "type": "string", "description": "Role name", "name": "role", "in": "path", "required": true }, { "description": "Token", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateAPITokenRequest" } } ], "responses": { "201": { "description": "Secret resource (k8s.io/api/core/v1.Secret)", "schema": { "$ref": "#/definitions/V1Secret" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/server-config": { "get": { "description": "Retrieve information a client may need to know about how the\nKargo API server is configured.", "produces": [ "application/json" ], "tags": [ "System", "Config" ], "summary": "Retrieve server configuration", "operationId": "GetConfig", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetConfigResponse" } } }, "security": [ { "BearerAuth": [] } ] } }, "/v1beta1/system/server-version": { "get": { "description": "Retrieve API Server version information.", "produces": [ "application/json" ], "tags": [ "System" ], "summary": "Retrieve API Server version information", "operationId": "GetVersionInfo", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VersionInfo" } } }, "security": [ { "BearerAuth": [] } ] } } }, "definitions": { "AdminLoginResponse": { "type": "object", "properties": { "idToken": { "type": "string" } } }, "ArgoCDShard": { "type": "object", "properties": { "namespace": { "type": "string" }, "url": { "type": "string" } } }, "Claim": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "CreateAPITokenRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "CreateConfigMapRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string" }, "name": { "type": "string" }, "replicate": { "type": "boolean" } } }, "CreateGenericCredentialsRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string" }, "name": { "type": "string" }, "replicate": { "type": "boolean" }, "type": { "description": "Type is the Kubernetes Secret type (e.g. \"Opaque\" or\n\"kubernetes.io/dockerconfigjson\"). It is immutable, so it may only be set\nat creation time. When empty, Kubernetes defaults it to \"Opaque\".", "type": "string" } } }, "CreateOrUpdateResourceResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/CreateOrUpdateResourceResult" } } } }, "CreateOrUpdateResourceResult": { "type": "object", "properties": { "createdResourceManifest": { "type": "object", "additionalProperties": {} }, "error": { "type": "string" }, "updatedResourceManifest": { "type": "object", "additionalProperties": {} } } }, "CreateRepoCredentialsRequest": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "password": { "description": "#nosec G117 -- Request data is unmarshaled into this struct, but the struct\nis never marshaled and transmitted to anywhere.", "type": "string" }, "repoUrl": { "type": "string" }, "repoUrlIsRegex": { "type": "boolean" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "CreateResourceResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/CreateResourceResult" } } } }, "CreateResourceResult": { "type": "object", "properties": { "createdResourceManifest": { "type": "object", "additionalProperties": {} }, "error": { "type": "string" } } }, "DeleteResourceResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/definitions/DeleteResourceResult" } } } }, "DeleteResourceResult": { "type": "object", "properties": { "deletedResourceManifest": { "type": "object", "additionalProperties": {} }, "error": { "type": "string" } } }, "GetConfigResponse": { "type": "object", "properties": { "argocdShards": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ArgoCDShard" } }, "hasAnalysisRunLogsUrlTemplate": { "type": "boolean" }, "kargoNamespace": { "type": "string" }, "secretManagementEnabled": { "type": "boolean" }, "sharedResourcesNamespace": { "type": "string" }, "systemResourcesNamespace": { "type": "string" } } }, "GetControllerHeartbeatsResponse": { "type": "object", "properties": { "defaultController": { "description": "DefaultController is the name of the default controller. The default\ncontroller is often unnamed, so an empty string is a valid value. This is\nincluded in the response to give clients a canonical identity to associate\nwith Stages that have no explicit `spec.controller`.", "type": "string" }, "heartbeats": { "description": "Heartbeats is the most recent heartbeat from every controller that has\nreported in indexed by controller name.", "type": "object", "additionalProperties": { "$ref": "#/definitions/Heartbeat" } } } }, "GetFreightLinksResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } }, "links": { "type": "array", "items": { "$ref": "#/definitions/ResolvedLink" } } } }, "GetStageLinksResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } }, "links": { "type": "array", "items": { "$ref": "#/definitions/ResolvedLink" } } } }, "GrantRequest": { "type": "object", "properties": { "resourceDetails": { "$ref": "#/definitions/ResourceDetails" }, "role": { "type": "string" }, "userClaims": { "$ref": "#/definitions/UserClaims" } } }, "Heartbeat": { "type": "object", "properties": { "controller": { "description": "Controller is the name of the controller as reported in the Lease's\nkargoapi.LabelKeyController label. This may be empty if the controller that\nproduced the heartbeat was unnamed.", "type": "string" }, "status": { "description": "Status is point-in-time liveness synthesized from a heartbeat record.", "allOf": [ { "$ref": "#/definitions/HeartbeatStatus" } ] }, "timestamp": { "description": "Timestamp is the timestamp of the heartbeat. nil when the underlying record\ncarried no parseable timestamp.", "type": "string" } } }, "HeartbeatStatus": { "type": "string", "enum": [ "Alive", "Dead" ], "x-enum-varnames": [ "StatusAlive", "StatusDead" ] }, "ImageStageMap": { "type": "object", "properties": { "stages": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } }, "ListProjectsResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Project" } }, "total": { "type": "integer" } } }, "OIDCConfig": { "type": "object", "properties": { "cliClientId": { "type": "string" }, "clientId": { "type": "string" }, "issuerUrl": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "PatchConfigMapRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string" }, "removeKeys": { "type": "array", "items": { "type": "string" } } } }, "PatchGenericCredentialsRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string" }, "removeKeys": { "type": "array", "items": { "type": "string" } } } }, "PatchRepoCredentialsRequest": { "type": "object", "properties": { "description": { "type": "string" }, "password": { "description": "#nosec G117 -- Request data is unmarshaled into this struct, but the struct\nis never marshaled and transmitted to anywhere.", "type": "string" }, "repoUrl": { "type": "string" }, "repoUrlIsRegex": { "type": "boolean" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "PromoteDownstreamRequest": { "type": "object", "properties": { "freight": { "type": "string" }, "freightAlias": { "type": "string" } } }, "PromoteToStageRequest": { "type": "object", "properties": { "freight": { "type": "string" }, "freightAlias": { "type": "string" }, "origin": { "description": "Origin is the canonical Freight origin key (e.g. \"Warehouse/foo\"). When\nset, the promotion webhook resolves it to the current auto-promotion\ncandidate. Exactly one of Freight, FreightAlias, or Origin must be set.", "type": "string" } } }, "PublicConfig": { "type": "object", "properties": { "adminAccountEnabled": { "type": "boolean" }, "oidcConfig": { "$ref": "#/definitions/OIDCConfig" }, "skipAuth": { "type": "boolean" } } }, "ResolvedLink": { "type": "object", "properties": { "description": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" } } }, "ResourceDetails": { "type": "object", "properties": { "resourceName": { "type": "string" }, "resourceType": { "type": "string" }, "verbs": { "type": "array", "items": { "type": "string" } } } }, "ResourceErrorResponse": { "type": "object", "properties": { "error": { "type": "string" } } }, "RevokeRequest": { "type": "object", "properties": { "resourceDetails": { "$ref": "#/definitions/ResourceDetails" }, "role": { "type": "string" }, "userClaims": { "$ref": "#/definitions/UserClaims" } } }, "TagMap": { "type": "object", "properties": { "tags": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ImageStageMap" } } } }, "UpdateConfigMapRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string" }, "replicate": { "type": "boolean" } } }, "UpdateGenericCredentialsRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" } }, "description": { "type": "string" }, "replicate": { "type": "boolean" } } }, "UpdateRepoCredentialsRequest": { "type": "object", "properties": { "description": { "type": "string" }, "password": { "description": "#nosec G117 -- Request data is unmarshaled into this struct, but the struct\nis never marshaled and transmitted to anywhere.", "type": "string" }, "repoUrl": { "type": "string" }, "repoUrlIsRegex": { "type": "boolean" }, "type": { "type": "string" }, "username": { "type": "string" } } }, "UserClaims": { "type": "object", "properties": { "claims": { "type": "array", "items": { "$ref": "#/definitions/Claim" } } } }, "VersionInfo": { "type": "object", "properties": { "buildDate": { "description": "BuildDate is the date/time on which the application was built.", "type": "string" }, "compiler": { "description": "Compiler indicates what Go compiler was used for the build.", "type": "string" }, "gitCommit": { "description": "GitCommit is the ID (sha) of the last commit to the application's source\ncode that is included in this build.", "type": "string" }, "gitTreeDirty": { "description": "GitTreeDirty is true if the application's source code contained\nuncommitted changes at the time it was built; otherwise it is false.", "type": "boolean" }, "goVersion": { "description": "GoVersion is the version of Go that was used to build the application.", "type": "string" }, "platform": { "description": "Platform indicates the OS and CPU architecture for which the application\nwas built.", "type": "string" }, "version": { "description": "Version is a human-friendly version string.", "type": "string" } } }, "RbacRole": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "claims": { "type": "array", "items": { "$ref": "#/definitions/Claim" } }, "kargoManaged": { "type": "boolean" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "rules": { "type": "array", "items": { "$ref": "#/definitions/V1PolicyRule" } } } }, "RolloutsAnalysisRun": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "$ref": "#/definitions/RolloutsAnalysisRunSpec" }, "status": { "$ref": "#/definitions/RolloutsAnalysisRunStatus" } } }, "RolloutsAnalysisRunSpec": { "type": "object", "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/RolloutsArgument" } }, "dryRun": { "type": "array", "items": { "$ref": "#/definitions/RolloutsDryRun" } }, "measurementRetention": { "type": "array", "items": { "$ref": "#/definitions/RolloutsMeasurementRetention" } }, "metrics": { "type": "array", "items": { "$ref": "#/definitions/RolloutsMetric" } }, "terminate": { "type": "boolean" }, "ttlStrategy": { "$ref": "#/definitions/RolloutsTTLStrategy" } } }, "RolloutsAnalysisRunStatus": { "type": "object", "properties": { "completedAt": { "type": "string" }, "dryRunSummary": { "$ref": "#/definitions/RolloutsRunSummary" }, "message": { "type": "string" }, "metricResults": { "type": "array", "items": { "$ref": "#/definitions/RolloutsMetricResult" } }, "phase": { "type": "string" }, "runSummary": { "$ref": "#/definitions/RolloutsRunSummary" }, "startedAt": { "type": "string" } } }, "RolloutsAnalysisTemplate": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "$ref": "#/definitions/RolloutsAnalysisTemplateSpec" } } }, "RolloutsAnalysisTemplateList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/RolloutsAnalysisTemplate" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ListMeta" } } }, "RolloutsAnalysisTemplateRef": { "type": "object", "properties": { "clusterScope": { "type": "boolean" }, "templateName": { "type": "string" } } }, "RolloutsAnalysisTemplateSpec": { "type": "object", "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/RolloutsArgument" } }, "dryRun": { "type": "array", "items": { "$ref": "#/definitions/RolloutsDryRun" } }, "measurementRetention": { "type": "array", "items": { "$ref": "#/definitions/RolloutsMeasurementRetention" } }, "metrics": { "type": "array", "items": { "$ref": "#/definitions/RolloutsMetric" } }, "templates": { "type": "array", "items": { "$ref": "#/definitions/RolloutsAnalysisTemplateRef" } } } }, "RolloutsArgument": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "valueFrom": { "$ref": "#/definitions/RolloutsValueFrom" } } }, "RolloutsAuthentication": { "type": "object", "properties": { "oauth2": { "$ref": "#/definitions/RolloutsOAuth2Config" }, "sigv4": { "$ref": "#/definitions/RolloutsSigv4Config" } } }, "RolloutsCloudWatchMetric": { "type": "object", "properties": { "interval": { "type": "string" }, "metricDataQueries": { "type": "array", "items": { "$ref": "#/definitions/RolloutsCloudWatchMetricDataQuery" } } } }, "RolloutsCloudWatchMetricDataQuery": { "type": "object", "properties": { "expression": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "metricStat": { "$ref": "#/definitions/RolloutsCloudWatchMetricStat" }, "period": {}, "returnData": { "type": "boolean" } } }, "RolloutsCloudWatchMetricStat": { "type": "object", "properties": { "metric": { "$ref": "#/definitions/RolloutsCloudWatchMetricStatMetric" }, "period": {}, "stat": { "type": "string" }, "unit": { "type": "string" } } }, "RolloutsCloudWatchMetricStatMetric": { "type": "object", "properties": { "dimensions": { "type": "array", "items": { "$ref": "#/definitions/RolloutsCloudWatchMetricStatMetricDimension" } }, "metricName": { "type": "string" }, "namespace": { "type": "string" } } }, "RolloutsCloudWatchMetricStatMetricDimension": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "RolloutsClusterAnalysisTemplate": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "$ref": "#/definitions/RolloutsAnalysisTemplateSpec" } } }, "RolloutsClusterAnalysisTemplateList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/RolloutsClusterAnalysisTemplate" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ListMeta" } } }, "RolloutsDatadogMetric": { "type": "object", "properties": { "aggregator": { "type": "string" }, "apiVersion": { "type": "string" }, "formula": { "type": "string" }, "interval": { "type": "string" }, "queries": { "type": "object", "additionalProperties": { "type": "string" } }, "query": { "type": "string" }, "secretRef": { "$ref": "#/definitions/RolloutsSecretRef" } } }, "RolloutsDryRun": { "type": "object", "properties": { "metricName": { "type": "string" } } }, "RolloutsFieldRef": { "type": "object", "properties": { "fieldPath": { "description": "Required: Path of the field to select in the specified API version", "type": "string" } } }, "RolloutsGraphiteMetric": { "type": "object", "properties": { "address": { "type": "string" }, "query": { "type": "string" } } }, "RolloutsInfluxdbMetric": { "type": "object", "properties": { "profile": { "type": "string" }, "query": { "type": "string" } } }, "RolloutsJobMetric": { "type": "object", "properties": { "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "$ref": "#/definitions/V1JobSpec" } } }, "RolloutsKayentaMetric": { "type": "object", "properties": { "address": { "type": "string" }, "application": { "type": "string" }, "canaryConfigName": { "type": "string" }, "configurationAccountName": { "type": "string" }, "lookback": { "type": "boolean" }, "metricsAccountName": { "type": "string" }, "scopes": { "type": "array", "items": { "$ref": "#/definitions/RolloutsKayentaScope" } }, "storageAccountName": { "type": "string" }, "threshold": { "$ref": "#/definitions/RolloutsKayentaThreshold" } } }, "RolloutsKayentaScope": { "type": "object", "properties": { "controlScope": { "$ref": "#/definitions/RolloutsScopeDetail" }, "experimentScope": { "$ref": "#/definitions/RolloutsScopeDetail" }, "name": { "type": "string" } } }, "RolloutsKayentaThreshold": { "type": "object", "properties": { "marginal": { "type": "integer" }, "pass": { "type": "integer" } } }, "RolloutsMeasurement": { "type": "object", "properties": { "finishedAt": { "type": "string" }, "message": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "phase": { "type": "string" }, "resumeAt": { "type": "string" }, "startedAt": { "type": "string" }, "value": { "type": "string" } } }, "RolloutsMeasurementRetention": { "type": "object", "properties": { "limit": { "type": "integer" }, "metricName": { "type": "string" } } }, "RolloutsMetric": { "type": "object", "properties": { "consecutiveErrorLimit": {}, "consecutiveSuccessLimit": {}, "count": {}, "failureCondition": { "type": "string" }, "failureLimit": {}, "inconclusiveLimit": {}, "initialDelay": { "type": "string" }, "interval": { "type": "string" }, "name": { "type": "string" }, "provider": { "$ref": "#/definitions/RolloutsMetricProvider" }, "successCondition": { "type": "string" } } }, "RolloutsMetricProvider": { "type": "object", "properties": { "cloudWatch": { "$ref": "#/definitions/RolloutsCloudWatchMetric" }, "datadog": { "$ref": "#/definitions/RolloutsDatadogMetric" }, "graphite": { "$ref": "#/definitions/RolloutsGraphiteMetric" }, "influxdb": { "$ref": "#/definitions/RolloutsInfluxdbMetric" }, "job": { "$ref": "#/definitions/RolloutsJobMetric" }, "kayenta": { "$ref": "#/definitions/RolloutsKayentaMetric" }, "newRelic": { "$ref": "#/definitions/RolloutsNewRelicMetric" }, "plugin": { "type": "object", "additionalProperties": { "type": "string", "format": "byte" } }, "prometheus": { "$ref": "#/definitions/RolloutsPrometheusMetric" }, "skywalking": { "$ref": "#/definitions/RolloutsSkyWalkingMetric" }, "wavefront": { "$ref": "#/definitions/RolloutsWavefrontMetric" }, "web": { "$ref": "#/definitions/RolloutsWebMetric" } } }, "RolloutsMetricResult": { "type": "object", "properties": { "consecutiveError": { "type": "integer" }, "consecutiveSuccess": { "type": "integer" }, "count": { "type": "integer" }, "dryRun": { "type": "boolean" }, "error": { "type": "integer" }, "failed": { "type": "integer" }, "inconclusive": { "type": "integer" }, "measurements": { "type": "array", "items": { "$ref": "#/definitions/RolloutsMeasurement" } }, "message": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "phase": { "type": "string" }, "successful": { "type": "integer" } } }, "RolloutsNewRelicMetric": { "type": "object", "properties": { "profile": { "type": "string" }, "query": { "type": "string" }, "timeout": { "type": "integer" } } }, "RolloutsOAuth2Config": { "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "tokenUrl": { "type": "string" } } }, "RolloutsPrometheusMetric": { "type": "object", "properties": { "address": { "type": "string" }, "authentication": { "$ref": "#/definitions/RolloutsAuthentication" }, "headers": { "type": "array", "items": { "$ref": "#/definitions/RolloutsWebMetricHeader" } }, "insecure": { "type": "boolean" }, "query": { "type": "string" }, "rangeQuery": { "$ref": "#/definitions/RolloutsPrometheusRangeQueryArgs" }, "timeout": { "type": "integer" } } }, "RolloutsPrometheusRangeQueryArgs": { "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "step": { "type": "string" } } }, "RolloutsRunSummary": { "type": "object", "properties": { "count": { "type": "integer" }, "error": { "type": "integer" }, "failed": { "type": "integer" }, "inconclusive": { "type": "integer" }, "successful": { "type": "integer" } } }, "RolloutsScopeDetail": { "type": "object", "properties": { "end": { "type": "string" }, "region": { "type": "string" }, "scope": { "type": "string" }, "start": { "type": "string" }, "step": { "type": "integer" } } }, "RolloutsSecretKeyRef": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "RolloutsSecretRef": { "type": "object", "properties": { "name": { "type": "string" }, "namespaced": { "type": "boolean" } } }, "RolloutsSigv4Config": { "type": "object", "properties": { "profile": { "type": "string" }, "region": { "type": "string" }, "roleArn": { "type": "string" } } }, "RolloutsSkyWalkingMetric": { "type": "object", "properties": { "address": { "type": "string" }, "interval": { "type": "string" }, "query": { "type": "string" } } }, "RolloutsTTLStrategy": { "type": "object", "properties": { "secondsAfterCompletion": { "type": "integer" }, "secondsAfterFailure": { "type": "integer" }, "secondsAfterSuccess": { "type": "integer" } } }, "RolloutsValueFrom": { "type": "object", "properties": { "fieldRef": { "$ref": "#/definitions/RolloutsFieldRef" }, "secretKeyRef": { "$ref": "#/definitions/RolloutsSecretKeyRef" } } }, "RolloutsWavefrontMetric": { "type": "object", "properties": { "address": { "type": "string" }, "query": { "type": "string" } } }, "RolloutsWebMetric": { "type": "object", "properties": { "authentication": { "$ref": "#/definitions/RolloutsAuthentication" }, "body": { "type": "string" }, "headers": { "type": "array", "items": { "$ref": "#/definitions/RolloutsWebMetricHeader" } }, "insecure": { "type": "boolean" }, "jsonBody": { "type": "array", "items": { "type": "integer" } }, "jsonPath": { "type": "string" }, "method": { "type": "string" }, "timeoutSeconds": { "type": "integer" }, "url": { "description": "URL is the address of the web metric", "type": "string" } } }, "RolloutsWebMetricHeader": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "AnalysisRunArgument": { "type": "object", "properties": { "name": { "description": "Name is the name of the argument.\n\n+kubebuilder:validation:Required", "type": "string" }, "value": { "description": "Value is the value of the argument.\n\n+kubebuilder:validation:Required", "type": "string" } }, "required": [ "name", "value" ] }, "AnalysisRunMetadata": { "type": "object", "properties": { "annotations": { "description": "Additional annotations to apply to an AnalysisRun.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "Additional labels to apply to an AnalysisRun.", "type": "object", "additionalProperties": { "type": "string" } } } }, "AnalysisRunReference": { "type": "object", "properties": { "name": { "description": "Name is the name of the AnalysisRun.", "type": "string" }, "namespace": { "description": "Namespace is the namespace of the AnalysisRun.", "type": "string" }, "phase": { "description": "Phase is the last observed phase of the AnalysisRun referenced by Name.", "type": "string" } } }, "AnalysisTemplateReference": { "type": "object", "properties": { "kind": { "description": "Kind is the type of the AnalysisTemplate. Can be either AnalysisTemplate or\nClusterAnalysisTemplate, default is AnalysisTemplate.\n\n+kubebuilder:validation:Optional\n+kubebuilder:validation:Enum=AnalysisTemplate;ClusterAnalysisTemplate", "type": "string" }, "name": { "description": "Name is the name of the AnalysisTemplate in the same project/namespace as\nthe Stage.\n\n+kubebuilder:validation:Required", "type": "string" } }, "required": [ "name" ] }, "ApprovedStage": { "type": "object", "properties": { "approvedAt": { "description": "ApprovedAt is the time at which the Freight was approved for the Stage.", "type": "string" } } }, "ArtifactReference": { "type": "object", "properties": { "artifactType": { "description": "ArtifactType specifies the type of artifact this is. Often, but not always,\nit will be the media type (MIME type) of the artifact referenced by this\nArtifactReference.\n\n+kubebuilder:validation:MinLength=1", "type": "string" }, "metadata": { "description": "Metadata is a JSON object containing a mostly opaque collection of artifact\nattributes. (It must be an object. It may not be a list or a scalar value.)\n\"Mostly\" because Kargo may understand how to interpret some documented,\nwell-known, top-level keys. Those aside, this metadata is only understood\nby a corresponding Subscriber implementation that created it.\n\n+optional" }, "subscriptionName": { "description": "SubscriptionName is the name of the Subscription that discovered this\nartifact.\n\n+kubebuilder:validation:MinLength=1", "type": "string" }, "version": { "description": "Version identifies a specific revision of this artifact.\n\n+kubebuilder:validation:MinLength=1", "type": "string" } } }, "ArtifactoryWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe Secret's data map is expected to contain a `secret-token` key whose\nvalue is the shared secret used to authenticate the webhook requests sent\nby JFrog Artifactory. For more information please refer to the JFrog\nArtifactory documentation:\n https://jfrog.com/help/r/jfrog-platform-administration-documentation/webhooks\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "virtualRepoName": { "description": "VirtualRepoName is the name of an Artifactory virtual repository.\n\nWhen unspecified, the Artifactory webhook receiver depends on the value of\nthe webhook payload's `data.repo_key` field when inferring the URL of the\nrepository from which the webhook originated, which will always be an\nArtifactory \"local repository.\" In cases where a Warehouse subscribes to\nsuch a repository indirectly via a \"virtual repository,\" there will be a\ndiscrepancy between the inferred (local) repository URL and the URL\nactually used by the subscription, which can prevent the receiver from\nidentifying such a Warehouse as one in need of refreshing. When specified,\nthe value of the VirtualRepoName field supersedes the value of the webhook\npayload's `data.repo_key` field to compensate for that discrepancy.\n\nIn practice, when using virtual repositories, a separate Artifactory\nwebhook receiver should be configured for each, but one such receiver can\nhandle inbound webhooks from any number of local repositories that are\naggregated by that virtual repository. For example, if a virtual repository\n`proj-virtual` aggregates container images from all of the `proj`\nArtifactory project's local image repositories, with a single webhook\nconfigured to post to a single receiver configured for the `proj-virtual`\nvirtual repository, an image pushed to\n`example.frog.io/proj-//image`, will cause that\nreceiver to refresh all Warehouses subscribed to\n`example.frog.io/proj-virtual//image`.\n\n+optional", "type": "string" } }, "required": [ "secretRef" ] }, "AutoPromotionHold": { "type": "object", "properties": { "actor": { "description": "Actor identifies the user who triggered the hold.", "type": "string" }, "createdAt": { "description": "CreatedAt is the creation timestamp of the Promotion that established this\nhold.", "type": "string" }, "freightName": { "description": "FreightName is the name of the Freight selected when the hold was created.", "type": "string" }, "origin": { "description": "Origin describes the FreightOrigin pinned by this hold. It matches the\nenclosing map key.", "allOf": [ { "$ref": "#/definitions/FreightOrigin" } ] }, "promotionName": { "description": "PromotionName is the name of the Promotion that established this hold.\nStored here as a paper trail that survives Promotion garbage collection.", "type": "string" } } }, "AutoPromotionOptions": { "type": "object", "properties": { "selectionPolicy": { "description": "SelectionPolicy specifies the rules for identifying new Freight that is\neligible for auto-promotion to this Stage. This field is optional. When\nleft unspecified, the field is implicitly treated as if its value were\n\"NewestFreight\".\n\nAccepted Values:\n\n- \"NewestFreight\": The newest Freight that is available to the Stage is\n eligible for auto-promotion.\n\n- \"MatchUpstream\": Only the Freight currently used immediately upstream\n from this Stage is eligible for auto-promotion. This policy may only\n be applied when the Stage has exactly one upstream Stage.", "type": "string" } } }, "AutoRollbackConfig": { "type": "object", "properties": { "onPromotion": { "description": "OnPromotion is the list of terminal Promotion phases that should trigger\nan automated rollback. Only Failed and Errored are accepted. Note that\nunsuccessful promotions (as opposed to unsuccessful verifications) may not\nnecessarily indicate a problem with the Freight, since promotions might fail\ndue to transient issues with the deployment itself (network, credential\nexpirations, etc...). Defaults to [].\n\n+optional\n+listType=set\n+kubebuilder:validation:MaxItems=2\n+kubebuilder:validation:XValidation:message=\"onPromotion[0] must be Failed or Errored\",rule=\"self.size() == 0 || self[0] == 'Failed' || self[0] == 'Errored'\"\n+kubebuilder:validation:XValidation:message=\"onPromotion[1] must be Failed or Errored\",rule=\"self.size() <= 1 || self[1] == 'Failed' || self[1] == 'Errored'\"", "type": "array", "items": { "type": "string" } }, "onVerification": { "description": "OnVerification is the list of terminal verification phases that should\ntrigger an automated rollback. Only Failed and Error are accepted (note:\n\"Error\", not \"Errored\" as in onPromotion). When absent or empty,\ndefaults to [Failed].\n\n+optional\n+listType=set\n+kubebuilder:validation:MaxItems=2\n+kubebuilder:validation:XValidation:message=\"onVerification[0] must be Failed or Error\",rule=\"self.size() == 0 || self[0] == 'Failed' || self[0] == 'Error'\"\n+kubebuilder:validation:XValidation:message=\"onVerification[1] must be Failed or Error\",rule=\"self.size() <= 1 || self[1] == 'Failed' || self[1] == 'Error'\"", "type": "array", "items": { "type": "string" } } } }, "AzureWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe Secret's data map is expected to contain a `secret` key whose value\ndoes NOT need to be shared directly with Azure when registering a webhook.\nIt is used only by Kargo to create a complex, hard-to-guess URL,\nwhich implicitly serves as a shared secret. For more information about\nAzure webhooks, please refer to the Azure documentation:\n\n Azure Container Registry:\n\thttps://learn.microsoft.com/en-us/azure/container-registry/container-registry-repositories\n\n Azure DevOps:\n\thttp://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "BitbucketWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe Secret's data map is expected to contain a `secret` key whose\nvalue is the shared secret used to authenticate the webhook requests sent\nby Bitbucket. For more information please refer to the Bitbucket\ndocumentation:\n https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "Chart": { "type": "object", "properties": { "name": { "description": "Name specifies the name of the chart.", "type": "string" }, "repoURL": { "description": "RepoURL specifies the URL of a Helm chart repository. Classic chart\nrepositories (using HTTP/S) can contain differently named charts. When this\nfield points to such a repository, the Name field will specify the name of\nthe chart within the repository. In the case of a repository within an OCI\nregistry, the URL implicitly points to a specific chart and the Name field\nwill be empty.", "type": "string" }, "subscriptionName": { "description": "SubscriptionName is the name of the subscription that discovered this\nchart. This field is only populated if the subscription was assigned\na name.", "type": "string" }, "version": { "description": "Version specifies a particular version of the chart.", "type": "string" } } }, "ChartDiscoveryResult": { "type": "object", "properties": { "name": { "description": "Name is the name of the Helm chart, as specified in the ChartSubscription.", "type": "string" }, "repoURL": { "description": "RepoURL is the repository URL of the Helm chart, as specified in the\nChartSubscription.\n\n+kubebuilder:validation:MinLength=1", "type": "string" }, "semverConstraint": { "description": "SemverConstraint is the constraint for which versions were discovered.\nThis field is optional, and only populated if the ChartSubscription\nspecifies a SemverConstraint.", "type": "string" }, "subscriptionName": { "description": "SubscriptionName is the optional human-readable name of the subscription\nthat produced this discovery result.\n\n+optional", "type": "string" }, "versions": { "description": "Versions is a list of versions discovered by the Warehouse for the\nChartSubscription. An empty list indicates that the discovery operation was\nsuccessful, but no versions matching the ChartSubscription criteria were\nfound.\n\n+optional", "type": "array", "items": { "type": "string" } } } }, "ClusterConfig": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "description": "Spec describes the configuration of a cluster.", "allOf": [ { "$ref": "#/definitions/ClusterConfigSpec" } ] }, "status": { "description": "Status describes the current status of a ClusterConfig.", "allOf": [ { "$ref": "#/definitions/ClusterConfigStatus" } ] } } }, "ClusterConfigSpec": { "type": "object", "properties": { "freightLinks": { "description": "FreightLinks defines deep links shown when viewing any Freight resource\nacross all projects in the cluster. Project-level FreightLinks defined\nin ProjectConfig are shown in addition to these.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DeepLink" } }, "gitClient": { "description": "GitClient describes cluster-level configuration for Kargo's Git client,\nincluding committer identity and an optional signing key. If set, these\nvalues take precedence over any configuration provided at install time\nvia the Helm chart.\n+optional", "allOf": [ { "$ref": "#/definitions/GitClientConfig" } ] }, "promotionWindows": { "description": "PromotionWindows defines time windows that gate promotions across the\ncluster. Each window may narrow its scope with a projectSelector and/or\nstageSelector. A Stage's effective schedule is the union of matching\nwindows defined here and any project-level windows in ProjectConfig.\n\nKargo Enterprise only: This field is ignored in Kargo OSS.\n\n+optional\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/PromotionWindow" } }, "stageLinks": { "description": "StageLinks defines deep links shown when viewing any Stage resource\nacross all projects in the cluster. Project-level StageLinks defined in\nProjectConfig are shown in addition to these.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DeepLink" } }, "webhookReceivers": { "description": "WebhookReceivers describes cluster-scoped webhook receivers used for\nprocessing events from various external platforms", "type": "array", "items": { "$ref": "#/definitions/WebhookReceiverConfig" } } } }, "ClusterConfigStatus": { "type": "object", "properties": { "conditions": { "description": "Conditions contains the last observations of the ClusterConfig's current\nstate.\n\n+patchMergeKey=type\n+patchStrategy=merge\n+listType=map\n+listMapKey=type", "type": "array", "items": { "$ref": "#/definitions/V1Condition" } }, "lastHandledRefresh": { "description": "LastHandledRefresh holds the value of the most recent AnnotationKeyRefresh\nannotation that was handled by the controller. This field can be used to\ndetermine whether the request to refresh the resource has been handled.\n+optional", "type": "string" }, "observedGeneration": { "description": "ObservedGeneration represents the .metadata.generation that this\nClusterConfig was reconciled against.", "type": "integer" }, "webhookReceivers": { "description": "WebhookReceivers describes the status of cluster-scoped webhook receivers.", "type": "array", "items": { "$ref": "#/definitions/WebhookReceiverDetails" } } } }, "ClusterPromotionTask": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "description": "Spec describes the desired transition of a specific Stage into a specific\nFreight.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/PromotionTaskSpec" } ] } }, "required": [ "spec" ] }, "ClusterPromotionTaskList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/ClusterPromotionTask" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ListMeta" } } }, "CurrentStage": { "type": "object", "properties": { "since": { "description": "Since is the time at which the Stage most recently started using the\nFreight. This can be used to calculate how long the Freight has been in use\nby the Stage.", "type": "string" } } }, "DeepLink": { "type": "object", "properties": { "description": { "description": "Description is an optional human-readable summary shown alongside the\nlink.\n\n+optional", "type": "string" }, "if": { "description": "If is an optional expression condition. When set, the link is only shown\nwhen the expression evaluates to true.\n\n+optional", "type": "string" }, "title": { "description": "Title is the display label for the link.\n\n+kubebuilder:validation:MinLength=1", "type": "string" }, "url": { "description": "URL is an expression that resolves to the link's href.\n\n+kubebuilder:validation:MinLength=1", "type": "string" } } }, "DiscoveredArtifacts": { "type": "object", "properties": { "charts": { "description": "Charts holds the charts discovered by the Warehouse for the chart\nsubscriptions.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/ChartDiscoveryResult" } }, "discoveredAt": { "description": "DiscoveredAt is the time at which the Warehouse discovered the artifacts.\n\n+optional", "type": "string" }, "git": { "description": "Git holds the commits discovered by the Warehouse for the Git\nsubscriptions.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/GitDiscoveryResult" } }, "images": { "description": "Images holds the image references discovered by the Warehouse for the\nimage subscriptions.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/ImageDiscoveryResult" } }, "results": { "description": "Results holds the artifact references discovered by the Warehouse.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DiscoveryResult" } } } }, "DiscoveredCommit": { "type": "object", "properties": { "author": { "description": "Author is the author of the commit.", "type": "string" }, "branch": { "description": "Branch is the branch in which the commit was found. This field is\noptional, and populated based on the CommitSelectionStrategy of the\nGitSubscription.", "type": "string" }, "committer": { "description": "Committer is the person who committed the commit.", "type": "string" }, "creatorDate": { "description": "CreatorDate is the commit creation date as specified by the commit, or\nthe tagger date if the commit belongs to an annotated tag.", "type": "string" }, "id": { "description": "ID is the identifier of the commit. This typically is a SHA-1 hash.\n\n+kubebuilder:validation:MinLength=1", "type": "string" }, "subject": { "description": "Subject is the subject of the commit (i.e. the first line of the commit\nmessage).", "type": "string" }, "tag": { "description": "Tag is the tag that resolved to this commit. This field is optional, and\npopulated based on the CommitSelectionStrategy of the GitSubscription.", "type": "string" } } }, "DiscoveredImageReference": { "type": "object", "properties": { "annotations": { "description": "Annotations is a map of key-value pairs that provide additional\ninformation about the image.", "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "CreatedAt is the time the image was created. This field is optional, and\nnot populated for every ImageSelectionStrategy.", "type": "string" }, "digest": { "description": "Digest is the digest of the image.\n\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:Pattern=`^[a-z0-9]+:[a-f0-9]+$`\n+akuity:test-kubebuilder-pattern=Digest", "type": "string" }, "tag": { "description": "Tag is the tag of the image.\n\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:MaxLength=128\n+kubebuilder:validation:Pattern=`^[\\w.\\-\\_]+$`\n+akuity:test-kubebuilder-pattern=Tag", "type": "string" } } }, "DiscoveredRef": { "type": "object", "properties": { "id": { "description": "ID is the identifier of the object the ref points to, typically a SHA-1\nhash. For an annotated tag this is the tag object's ID, not the commit it\ndereferences to, because the value is obtained via git ls-remote --refs.\nThis is immaterial to its sole use -- change detection -- since the value\nmoves whenever the ref is re-pointed and is only ever compared against\nother values obtained the same way.\n\n+kubebuilder:validation:MinLength=1", "type": "string" }, "name": { "description": "Name is the short name of the ref (e.g. a tag name such as \"v1.2.3\"),\nwithout its \"refs/tags/\" or \"refs/heads/\" prefix.\n\n+kubebuilder:validation:MinLength=1", "type": "string" } } }, "DiscoveryResult": { "type": "object", "properties": { "artifactReferences": { "description": "ArtifactReferences is a list of references to specific versions of an\nartifact.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/ArtifactReference" } }, "name": { "description": "SubscriptionName is the name of the Subscription that discovered these\nresults.\n\n+kubebuilder:validation:MinLength=1", "type": "string" } } }, "DockerHubWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nThe Secret's data map is expected to contain a `secret` key whose value\ndoes NOT need to be shared directly with Docker Hub when registering a\nwebhook. It is used only by Kargo to create a complex, hard-to-guess URL,\nwhich implicitly serves as a shared secret. For more information about\nDocker Hub webhooks, please refer to the Docker documentation:\n https://docs.docker.com/docker-hub/webhooks/\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "ExpressionVariable": { "type": "object", "properties": { "name": { "description": "Name is the name of the variable.\n\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:Pattern=^[a-zA-Z_]\\w*$", "type": "string" }, "value": { "description": "Value is the value of the variable. It is allowed to utilize expressions\nin the value.\nSee https://docs.kargo.io/user-guide/reference-docs/expressions for details.", "type": "string" } } }, "Freight": { "type": "object", "properties": { "alias": { "description": "Alias is a human-friendly alias for a piece of Freight. This is an optional\nfield. A defaulting webhook will sync this field with the value of the\nkargo.akuity.io/alias label. When the alias label is not present or differs\nfrom the value of this field, the defaulting webhook will set the label to\nthe value of this field. If the alias label is present and this field is\nempty, the defaulting webhook will set the value of this field to the value\nof the alias label. If this field is empty and the alias label is not\npresent, the defaulting webhook will choose an available alias and assign\nit to both the field and label.", "type": "string" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "artifacts": { "description": "Artifacts describes specific versions of artifacts other\nthan Git repository commits, container images, and Helm charts.", "type": "array", "items": { "$ref": "#/definitions/ArtifactReference" } }, "charts": { "description": "Charts describes specific versions of specific Helm charts.", "type": "array", "items": { "$ref": "#/definitions/Chart" } }, "commits": { "description": "Commits describes specific Git repository commits.", "type": "array", "items": { "$ref": "#/definitions/GitCommit" } }, "discoveredAt": { "description": "DiscoveredAt is the time at which this Freight was discovered/created.\nA defaulting webhook initializes this to the creation time of the Freight.\n\n+optional", "type": "string" }, "images": { "description": "Images describes specific versions of specific container images.", "type": "array", "items": { "$ref": "#/definitions/Image" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "origin": { "description": "Origin describes a kind of Freight in terms of its origin.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/FreightOrigin" } ] }, "status": { "description": "Status describes the current status of this Freight.", "allOf": [ { "$ref": "#/definitions/FreightStatus" } ] } }, "required": [ "origin" ] }, "FreightCollection": { "type": "object", "properties": { "id": { "description": "ID is a unique and deterministically calculated identifier for the\nFreightCollection. It is updated on each use of the UpdateOrPush method.", "type": "string" }, "items": { "description": "Freight is a map of FreightReference objects, indexed by their Warehouse\norigin.", "type": "object", "additionalProperties": { "$ref": "#/definitions/FreightReference" } }, "verificationHistory": { "description": "VerificationHistory is a stack of recent VerificationInfo. By default,\nthe last ten VerificationInfo are stored.", "type": "array", "items": { "$ref": "#/definitions/VerificationInfo" } } } }, "FreightCreationCriteria": { "type": "object", "properties": { "expression": { "description": "Expression is an expr-lang expression that must evaluate to true for\nFreight to be created automatically from new artifacts following discovery.", "type": "string" } } }, "FreightOrigin": { "type": "object", "properties": { "kind": { "description": "Kind is the kind of resource from which Freight may have originated. At\npresent, this can only be \"Warehouse\".\n\n+kubebuilder:validation:Required", "type": "string" }, "name": { "description": "Name is the name of the resource of the kind indicated by the Kind field\nfrom which Freight may originate.\n\n+kubebuilder:validation:Required", "type": "string" } }, "required": [ "kind", "name" ] }, "FreightReference": { "type": "object", "properties": { "artifacts": { "description": "Artifacts describes specific versions of artifacts other\nthan Git repository commits, container images, and Helm charts.", "type": "array", "items": { "$ref": "#/definitions/ArtifactReference" } }, "charts": { "description": "Charts describes specific versions of specific Helm charts.", "type": "array", "items": { "$ref": "#/definitions/Chart" } }, "commits": { "description": "Commits describes specific Git repository commits.", "type": "array", "items": { "$ref": "#/definitions/GitCommit" } }, "images": { "description": "Images describes specific versions of specific container images.", "type": "array", "items": { "$ref": "#/definitions/Image" } }, "name": { "description": "Name is a system-assigned identifier derived deterministically from\nthe contents of the Freight. I.e., two pieces of Freight can be compared\nfor equality by comparing their Names.", "type": "string" }, "origin": { "description": "Origin describes a kind of Freight in terms of its origin.", "allOf": [ { "$ref": "#/definitions/FreightOrigin" } ] } } }, "FreightRequest": { "type": "object", "properties": { "origin": { "description": "Origin specifies from where the requested Freight must have originated.\nThis is a required field.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/FreightOrigin" } ] }, "sources": { "description": "Sources describes where the requested Freight may be obtained from. This is\na required field.", "allOf": [ { "$ref": "#/definitions/FreightSources" } ] } }, "required": [ "origin" ] }, "FreightSources": { "type": "object", "properties": { "autoPromotionOptions": { "description": "AutoPromotionOptions specifies options pertaining to auto-promotion. These\nsettings have no effect if auto-promotion is not enabled for this Stage at\nthe ProjectConfig level.", "allOf": [ { "$ref": "#/definitions/AutoPromotionOptions" } ] }, "availabilityStrategy": { "description": "AvailabilityStrategy specifies the semantics for how requested Freight is\nmade available to the Stage. This field is optional. When left unspecified,\nthe field is implicitly treated as if its value were \"OneOf\".\n\nAccepted Values:\n\n- \"All\": Freight must be verified and, if applicable, soaked in all\n upstream Stages to be considered available for promotion.\n- \"OneOf\": Freight must be verified and, if applicable, soaked in at least\n one upstream Stage to be considered available for promotion.\n- \"\": Treated the same as \"OneOf\".\n\n+kubebuilder:validation:Optional", "type": "string" }, "direct": { "description": "Direct indicates the requested Freight may be obtained directly from the\nWarehouse from which it originated. If this field's value is false, then\nthe value of the Stages field must be non-empty. i.e. Between the two\nfields, at least one source must be specified.", "type": "boolean" }, "requiredSoakTime": { "description": "RequiredSoakTime specifies a minimum duration for which the requested\nFreight must have continuously occupied (\"soaked in\") in an upstream Stage\nbefore becoming available for promotion to this Stage. This is an optional\nfield. If nil or zero, no soak time is required. Any soak time requirement\nis in ADDITION to the requirement that Freight be verified in an upstream\nStage to become available for promotion to this Stage, although a manual\napproval for promotion to this Stage will supersede any soak time\nrequirement.\n\n+kubebuilder:validation:Type=string\n+kubebuilder:validation:Pattern=`^([0-9]+(\\.[0-9]+)?(s|m|h))+$`\n+akuity:test-kubebuilder-pattern=Duration", "type": "string" }, "stages": { "description": "Stages identifies other \"upstream\" Stages as potential sources of the\nrequested Freight. If this field's value is empty, then the value of the\nDirect field must be true. i.e. Between the two fields, at least on source\nmust be specified.", "type": "array", "items": { "type": "string" } } } }, "FreightStatus": { "type": "object", "properties": { "approvedFor": { "description": "ApprovedFor describes the Stages for which this Freight has been approved\npreemptively/manually by a user. This is useful for hotfixes, where one\nmight wish to promote a piece of Freight to a given Stage without\ntransiting the entire pipeline.", "type": "object", "additionalProperties": { "$ref": "#/definitions/ApprovedStage" } }, "currentlyIn": { "description": "CurrentlyIn describes the Stages in which this Freight is currently in use.", "type": "object", "additionalProperties": { "$ref": "#/definitions/CurrentStage" } }, "metadata": { "description": "Metadata is a map of arbitrary metadata associated with the Freight.\nThis is useful for storing additional information about the Freight\nor Promotion that can be shared across steps or stages.", "type": "object", "additionalProperties": {} }, "verifiedIn": { "description": "VerifiedIn describes the Stages in which this Freight has been verified\nthrough promotion and subsequent health checks.", "type": "object", "additionalProperties": { "$ref": "#/definitions/VerifiedStage" } } } }, "GenericWebhookAction": { "type": "object", "properties": { "action": { "description": "ActionType indicates the type of action to be performed. `Refresh` is the\nonly currently supported action.\n\n+kubebuilder:validation:Enum=Refresh;", "type": "string" }, "parameters": { "description": "Parameters contains additional, action-specific parameters. Values may be\nstatic or extracted from the request using expressions.\n\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "targetSelectionCriteria": { "description": "TargetSelectionCriteria is a list of selection criteria for the resources on which the\naction should be performed.\n\n+kubebuilder:validation:MinItems=1", "type": "array", "items": { "$ref": "#/definitions/GenericWebhookTargetSelectionCriteria" } }, "whenExpression": { "description": "WhenExpression defines criteria that a request must meet to run this\naction.\n\n+optional", "type": "string" } } }, "GenericWebhookReceiverConfig": { "type": "object", "properties": { "actions": { "description": "Actions is a list of actions to be performed when a webhook event is received.\n\n+kubebuilder:validation:MinItems=1", "type": "array", "items": { "$ref": "#/definitions/GenericWebhookAction" } }, "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe Secret's data map is expected to contain a `secret` key whose value\ndoes NOT need to be shared directly with the sender. It is used only by\nKargo to create a complex, hard-to-guess URL, which implicitly serves as a\nshared secret.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "GenericWebhookTargetSelectionCriteria": { "type": "object", "properties": { "indexSelector": { "description": "IndexSelector is a selector used to identify cached target resources by cache key.\nIf used with LabelSelector and/or Name, the results are the combined (logical AND) of all the criteria.\n\n+optional", "allOf": [ { "$ref": "#/definitions/IndexSelector" } ] }, "kind": { "description": "Kind is the kind of the target resource.\n\n+kubebuilder:validation:Enum=Warehouse;", "type": "string" }, "labelSelector": { "description": "LabelSelector is a label selector to identify the target resources.\nIf used with IndexSelector and/or Name, the results are the combined (logical AND) of all the criteria.\n\n+optional", "allOf": [ { "$ref": "#/definitions/V1LabelSelector" } ] }, "name": { "description": "Name is the name of the target resource. If LabelSelector and/or IndexSelectors\nare also specified, the results are the combined (logical AND) of the criteria.\n\n+optional", "type": "string" } } }, "GitClientConfig": { "type": "object", "properties": { "email": { "description": "Email is the email address used for Git commits made by Kargo.\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:Format=\"email\"", "type": "string" }, "name": { "description": "Name is the name used for Git commits made by Kargo.\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinLength=1", "type": "string" }, "signingKeySecret": { "description": "SigningKeySecret references a Secret in the system namespace containing\na GPG signing key for commit signing. The Secret must contain a data\nkey named \"signingKey\" with the GPG private key material.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "email", "name" ] }, "GitCommit": { "type": "object", "properties": { "author": { "description": "Author is the author of the commit.", "type": "string" }, "branch": { "description": "Branch denotes the branch of the repository where this commit was found.", "type": "string" }, "committer": { "description": "Committer is the person who committed the commit.", "type": "string" }, "id": { "description": "ID is the ID of a specific commit in the Git repository specified by\nRepoURL.", "type": "string" }, "message": { "description": "Message is the message associated with the commit. At present, this only\ncontains the first line (subject) of the commit message.", "type": "string" }, "repoURL": { "description": "RepoURL is the URL of a Git repository.", "type": "string" }, "subscriptionName": { "description": "SubscriptionName is the name of the subscription that discovered this\ncommit. This field is only populated if the subscription was assigned\na name.", "type": "string" }, "tag": { "description": "Tag denotes a tag in the repository that matched selection criteria and\nresolved to this commit.", "type": "string" } } }, "GitDiscoveryRefs": { "type": "object", "properties": { "branchHead": { "description": "BranchHead is the unfiltered commit ID at the tip of the subscribed branch.\nIt is populated for branch-based selection strategies (NewestFromBranch).\nBecause it records the branch tip before any path filtering, an unchanged\nvalue guarantees the path-filtered selection cannot have changed either.\n\n+optional", "type": "string" }, "tags": { "description": "Tags is the set of tags that satisfied the GitSubscription's name-based\nfilters (semver and/or regex), paired with the commit IDs they reference,\nsorted by tag name for a stable comparison. It is populated for tag-based\nselection strategies (NewestTag, SemVer, Lexical). Path filtering is\napplied later, during selection, and does not affect this set.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DiscoveredRef" } } } }, "GitDiscoveryResult": { "type": "object", "properties": { "commits": { "description": "Commits is a list of commits discovered by the Warehouse for the\nGitSubscription. An empty list indicates that the discovery operation was\nsuccessful, but no commits matching the GitSubscription criteria were found.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DiscoveredCommit" } }, "observedRefs": { "description": "ObservedRefs records the raw remote ref state observed at the most recent\nsuccessful discovery, after name-based filtering but before path filtering\nor commit selection. The Warehouse uses it to short-circuit discovery: at\nthe start of a reconcile, a single git ls-remote call yields the current\nref state, and if it matches this field, nothing relevant has moved and the\npreviously selected Commits remain valid -- so an expensive clone and\nhistory walk can be skipped entirely. This field is optional; when absent\n(e.g. on a Warehouse that predates this feature), discovery falls through to\na full clone and repopulates it.\n\n+optional", "allOf": [ { "$ref": "#/definitions/GitDiscoveryRefs" } ] }, "repoURL": { "description": "RepoURL is the repository URL of the GitSubscription.\n\nTODO(v1.13.0): Remove SSH/SCP-style URL support from this pattern.\n\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:Pattern=`(?:^(ssh|https?)://(?:([\\w-]+)(:(.+))?@)?([\\w-]+(?:\\.[\\w-]+)*)(?::(\\d{1,5}))?(/.*)$)|(?:^([\\w-]+)@([\\w+]+(?:\\.[\\w-]+)*):(/?.*))`\n+akuity:test-kubebuilder-pattern=GitRepoURLPattern", "type": "string" }, "subscriptionName": { "description": "SubscriptionName is the optional human-readable name of the subscription\nthat produced this discovery result.\n\n+optional", "type": "string" } } }, "GitHubWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe Secret's data map is expected to contain a `secret` key whose value is\nthe shared secret used to authenticate the webhook requests sent by GitHub.\nFor more information please refer to GitHub documentation:\n https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "GitLabWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe secret is expected to contain a `secret-token` key containing the\nshared secret specified when registering the webhook in GitLab. For more\ninformation about this token, please refer to the GitLab documentation:\n https://docs.gitlab.com/user/project/integrations/webhooks/\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "GiteaWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe Secret's data map is expected to contain a `secret` key whose value is\nthe shared secret used to authenticate the webhook requests sent by Gitea.\nFor more information please refer to the Gitea documentation:\n https://docs.gitea.io/en-us/webhooks/\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "HarborWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe secret is expected to contain an `auth-header` key containing the \"auth\nheader\" specified when registering the webhook in Harbor. For more\ninformation, please refer to the Harbor documentation:\n https://goharbor.io/docs/main/working-with-projects/project-configuration/configure-webhooks/\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "Health": { "type": "object", "properties": { "config": { "description": "Config is the opaque configuration of all health checks performed on this\nStage." }, "issues": { "description": "Issues clarifies why a Stage in any state other than Healthy is in that\nstate. This field will always be the empty when a Stage is Healthy.", "type": "array", "items": { "type": "string" } }, "output": { "description": "Output is the opaque output of all health checks performed on this Stage." }, "status": { "description": "Status describes the health of the Stage.", "type": "string" } } }, "HealthCheckStep": { "type": "object", "properties": { "config": { "description": "Config is the configuration for the directive." }, "uses": { "description": "Uses identifies a runner that can execute this step.\n\n+kubebuilder:validation:MinLength=1", "type": "string" } } }, "HealthStats": { "type": "object", "properties": { "healthy": { "description": "Healthy contains the number of resources that are explicitly healthy.", "type": "integer" } } }, "Image": { "type": "object", "properties": { "annotations": { "description": "Annotations is a map of arbitrary metadata for the image.", "type": "object", "additionalProperties": { "type": "string" } }, "digest": { "description": "Digest identifies a specific version of the image in the repository\nspecified by RepoURL. This is a more precise identifier than Tag.", "type": "string" }, "repoURL": { "description": "RepoURL describes the repository in which the image can be found.", "type": "string" }, "subscriptionName": { "description": "SubscriptionName is the name of the subscription that discovered this\nimage. This field is only populated if the subscription was assigned\na name.", "type": "string" }, "tag": { "description": "Tag identifies a specific version of the image in the repository specified\nby RepoURL.", "type": "string" } } }, "ImageDiscoveryResult": { "type": "object", "properties": { "platform": { "description": "Platform is the target platform constraint of the ImageSubscription\nfor which references were discovered. This field is optional, and\nonly populated if the ImageSubscription specifies a Platform.", "type": "string" }, "references": { "description": "References is a list of image references discovered by the Warehouse for\nthe ImageSubscription. An empty list indicates that the discovery\noperation was successful, but no images matching the ImageSubscription\ncriteria were found.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DiscoveredImageReference" } }, "repoURL": { "description": "RepoURL is the repository URL of the image, as specified in the\nImageSubscription.\n\n+kubebuilder:validation:MinLength=1", "type": "string" }, "subscriptionName": { "description": "SubscriptionName is the optional human-readable name of the subscription\nthat produced this discovery result.\n\n+optional", "type": "string" } } }, "IndexSelector": { "type": "object", "properties": { "matchIndices": { "description": "MatchIndices is a list of index selector requirements.\n\n+kubebuilder:validation:MinItems=1", "type": "array", "items": { "$ref": "#/definitions/IndexSelectorRequirement" } } } }, "IndexSelectorRequirement": { "type": "object", "properties": { "key": { "description": "Key is the key of the index.\n\n+kubebuilder:validation:Enum=subscribedURLs;receiverPaths", "type": "string" }, "operator": { "description": "Operator indicates the operation that should be used to evaluate\nwhether the selection requirement is satisfied.\n\nkubebuilder:validation:Enum=Equal;NotEqual;", "type": "string" }, "value": { "description": "Value can be a static string or an expression that will be evaluated.\n\nkubebuilder:validation:Required", "type": "string" } } }, "Project": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "status": { "description": "Status describes the Project's current status.", "allOf": [ { "$ref": "#/definitions/ProjectStatus" } ] } } }, "ProjectConfig": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "description": "Spec describes the configuration of a Project.", "allOf": [ { "$ref": "#/definitions/ProjectConfigSpec" } ] }, "status": { "description": "Status describes the current status of a ProjectConfig.", "allOf": [ { "$ref": "#/definitions/ProjectConfigStatus" } ] } } }, "ProjectConfigSpec": { "type": "object", "properties": { "freightLinks": { "description": "FreightLinks defines deep links shown when viewing Freight resources\nwithin this project. These are shown in addition to any cluster-level\nFreightLinks defined in ClusterConfig.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DeepLink" } }, "promotionPolicies": { "description": "PromotionPolicies defines policies governing the promotion of Freight to\nspecific Stages within the Project.", "type": "array", "items": { "$ref": "#/definitions/PromotionPolicy" } }, "promotionWindows": { "description": "PromotionWindows defines time windows that gate promotions for Stages in\nthis Project. A Stage's effective schedule is the union of matching windows\ndefined here and any cluster-level windows in ClusterConfig.\n\nKargo Enterprise only: This field is ignored in Kargo OSS.\n\n+optional\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/PromotionWindow" } }, "stageLinks": { "description": "StageLinks defines deep links shown when viewing Stage resources within\nthis project. These are shown in addition to any cluster-level\nStageLinks defined in ClusterConfig.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/DeepLink" } }, "webhookReceivers": { "description": "WebhookReceivers describes Project-specific webhook receivers used for\nprocessing events from various external platforms", "type": "array", "items": { "$ref": "#/definitions/WebhookReceiverConfig" } } } }, "ProjectConfigStatus": { "type": "object", "properties": { "conditions": { "description": "Conditions contains the last observations of the Project Config's current\nstate.\n\n+patchMergeKey=type\n+patchStrategy=merge\n+listType=map\n+listMapKey=type", "type": "array", "items": { "$ref": "#/definitions/V1Condition" } }, "lastHandledRefresh": { "description": "LastHandledRefresh holds the value of the most recent AnnotationKeyRefresh\nannotation that was handled by the controller. This field can be used to\ndetermine whether the request to refresh the resource has been handled.\n+optional", "type": "string" }, "observedGeneration": { "description": "ObservedGeneration represents the .metadata.generation that this\nProjectConfig was reconciled against.", "type": "integer" }, "webhookReceivers": { "description": "WebhookReceivers describes the status of Project-specific webhook\nreceivers.", "type": "array", "items": { "$ref": "#/definitions/WebhookReceiverDetails" } } } }, "ProjectStats": { "type": "object", "properties": { "stages": { "description": "Stages contains a summary of the collective state of the Project's Stages.", "allOf": [ { "$ref": "#/definitions/StageStats" } ] }, "warehouses": { "description": "Warehouses contains a summary of the collective state of the Project's\nWarehouses.", "allOf": [ { "$ref": "#/definitions/WarehouseStats" } ] } } }, "ProjectStatus": { "type": "object", "properties": { "conditions": { "description": "Conditions contains the last observations of the Project's current\nstate.\n+patchMergeKey=type\n+patchStrategy=merge\n+listType=map\n+listMapKey=type", "type": "array", "items": { "$ref": "#/definitions/V1Condition" } }, "stats": { "description": "Stats contains a summary of the collective state of a Project's\nconstituent resources.", "allOf": [ { "$ref": "#/definitions/ProjectStats" } ] } } }, "Promotion": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "description": "Spec describes the desired transition of a specific Stage into a specific\nFreight.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/PromotionSpec" } ] }, "status": { "description": "Status describes the current state of the transition represented by this\nPromotion.", "allOf": [ { "$ref": "#/definitions/PromotionStatus" } ] } }, "required": [ "spec" ] }, "PromotionList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/Promotion" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ListMeta" } } }, "PromotionPolicy": { "type": "object", "properties": { "autoPromotionEnabled": { "description": "AutoPromotionEnabled indicates whether new Freight can automatically be\npromoted into the Stage referenced by the Stage field. Note: There are may\nbe other conditions also required for an auto-promotion to occur. This\nfield defaults to false, but is commonly set to true for Stages that\nsubscribe to Warehouses instead of other, upstream Stages. This allows\nusers to define Stages that are automatically updated as soon as new\nartifacts are detected.", "type": "boolean" }, "autoRollback": { "description": "AutoRollback describes the conditions under which this Stage should\nautomatically roll back to the last known-good (verified) Freight. When\nnil, auto-rollback is disabled.\n\nKargo Enterprise only: This field is ignored in Kargo OSS.", "allOf": [ { "$ref": "#/definitions/AutoRollbackConfig" } ] }, "stage": { "description": "Stage is the name of the Stage to which this policy applies.\n\nDeprecated: Use StageSelector instead.\n\n+kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "stageSelector": { "description": "StageSelector is a selector that matches the Stage resource to which\nthis policy applies.", "allOf": [ { "$ref": "#/definitions/PromotionPolicySelector" } ] } } }, "PromotionPolicySelector": { "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1LabelSelectorRequirement" } }, "matchLabels": { "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "description": "Name is the name of the resource to which this policy applies.\n\nIt can be an exact name, a regex pattern (with prefix \"regex:\"), or a\nglob pattern (with prefix \"glob:\").\n\nWhen both Name and LabelSelector are specified, the Name is ANDed with\nthe LabelSelector. I.e., the resource must match both the Name and\nLabelSelector to be selected by this policy.\n\nNOTE: Using a specific exact name is the most secure option. Pattern\nmatching via regex or glob can be exploited by users with permissions to\nmatch promotion policies that weren't intended to apply to their\nresources. For example, a user could create a resource with a name\ndeliberately crafted to match the pattern, potentially bypassing intended\npromotion controls.\n\n+optional", "type": "string" } } }, "PromotionReference": { "type": "object", "properties": { "finishedAt": { "description": "FinishedAt is the time at which the Promotion was completed.", "type": "string" }, "freight": { "description": "Freight is the freight being promoted.", "allOf": [ { "$ref": "#/definitions/FreightReference" } ] }, "name": { "description": "Name is the name of the Promotion.", "type": "string" }, "status": { "description": "Status is the (optional) status of the Promotion.", "allOf": [ { "$ref": "#/definitions/PromotionStatus" } ] } } }, "PromotionSpec": { "type": "object", "properties": { "freight": { "description": "Freight specifies the piece of Freight to be promoted into the Stage.\nExactly one of Freight or Origin must be set.\n\n+kubebuilder:validation:Optional\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:MaxLength=253\n+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n+akuity:test-kubebuilder-pattern=KubernetesName", "type": "string" }, "origin": { "description": "Origin, when set, identifies the FreightOrigin whose auto-promotion\ncandidate should be promoted. The mutating webhook resolves this to the\ncandidate Freight for that origin and fills Freight before the Promotion\nis persisted. Exactly one of Freight or Origin must be set.\n\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/FreightOrigin" } ] }, "stage": { "description": "Stage specifies the name of the Stage to which this Promotion\napplies. The Stage referenced by this field MUST be in the same\nnamespace as the Promotion.\n\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:MaxLength=253\n+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n+akuity:test-kubebuilder-pattern=KubernetesName", "type": "string" }, "steps": { "description": "Steps specifies the directives to be executed as part of this Promotion.\nThe order in which the directives are executed is the order in which they\nare listed in this field.\n\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinItems=1\n+kubebuilder:validation:items:XValidation:message=\"Promotion step must have uses set and must not reference a task\",rule=\"has(self.uses) && !has(self.task)\"", "type": "array", "items": { "$ref": "#/definitions/PromotionStep" } }, "target": { "description": "Target optionally names the Target, within the Promotion's own Project\n(namespace), that this Promotion promotes Freight to. Targets allow a\nsingle Stage to govern -- and promote Freight to -- multiple destinations.\nWhen set, the named Target must be one that the referenced Stage governs,\ni.e. one selected by the Stage's targetSelectors.\n\nWhen empty (the default), the Promotion promotes to the Stage itself. This\npreserves the behavior of Promotions created before Targets existed:\nclassic Stages -- those without targetSelectors -- govern no Targets, so\ntheir Promotions leave this field empty.\n\n+kubebuilder:validation:Optional\n+kubebuilder:validation:MaxLength=253\n+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n+akuity:test-kubebuilder-pattern=KubernetesName", "type": "string" }, "vars": { "description": "Vars is a list of variables that can be referenced by expressions in\npromotion steps.", "type": "array", "items": { "$ref": "#/definitions/ExpressionVariable" } } }, "required": [ "stage", "steps" ] }, "PromotionStatus": { "type": "object", "properties": { "currentStep": { "description": "CurrentStep is the index of the current promotion step being executed. This\npermits steps that have already run successfully to be skipped on\nsubsequent reconciliations attempts.", "type": "integer" }, "finishedAt": { "description": "FinishedAt is the time when the promotion was completed.", "type": "string" }, "freight": { "description": "Freight is the detail of the piece of freight that was referenced by this promotion.", "allOf": [ { "$ref": "#/definitions/FreightReference" } ] }, "freightCollection": { "description": "FreightCollection contains the details of the piece of Freight referenced\nby this Promotion as well as any additional Freight that is carried over\nfrom the target Stage's current state.", "allOf": [ { "$ref": "#/definitions/FreightCollection" } ] }, "healthChecks": { "description": "HealthChecks contains the health check directives to be executed after\nthe Promotion has completed.", "type": "array", "items": { "$ref": "#/definitions/HealthCheckStep" } }, "lastHandledRefresh": { "description": "LastHandledRefresh holds the value of the most recent AnnotationKeyRefresh\nannotation that was handled by the controller. This field can be used to\ndetermine whether the request to refresh the resource has been handled.\n+optional", "type": "string" }, "message": { "description": "Message is a display message about the promotion, including any errors\npreventing the Promotion controller from executing this Promotion.\ni.e. If the Phase field has a value of Failed, this field can be expected\nto explain why.", "type": "string" }, "phase": { "description": "Phase describes where the Promotion currently is in its lifecycle.", "type": "string" }, "startedAt": { "description": "StartedAt is the time when the promotion started.", "type": "string" }, "state": { "description": "State stores the state of the promotion process between reconciliation\nattempts." }, "stepExecutionMetadata": { "description": "StepExecutionMetadata tracks metadata pertaining to the execution\nof individual promotion steps.", "type": "array", "items": { "$ref": "#/definitions/StepExecutionMetadata" } } } }, "PromotionStep": { "type": "object", "properties": { "as": { "description": "As is the alias this step can be referred to as.", "type": "string" }, "config": { "description": "Config is opaque configuration for the PromotionStep that is understood\nonly by each PromotionStep's implementation. It is legal to utilize\nexpressions in defining values at any level of this block.\nSee https://docs.kargo.io/user-guide/reference-docs/expressions for details." }, "continueOnError": { "description": "ContinueOnError is a boolean value that, if set to true, will cause the\nPromotion to continue executing the next step even if this step fails. It\nalso will not permit this failure to impact the overall status of the\nPromotion.", "type": "boolean" }, "if": { "description": "If is an optional expression that, if present, must evaluate to a boolean\nvalue. If the expression evaluates to false, the step will be skipped.\nIf the expression does not evaluate to a boolean value, the step will be\nconsidered to have failed.", "type": "string" }, "retry": { "description": "Retry is the retry policy for this step.", "allOf": [ { "$ref": "#/definitions/PromotionStepRetry" } ] }, "task": { "description": "Task is a reference to a PromotionTask that should be inflated into a\nPromotion when it is built from a PromotionTemplate.", "allOf": [ { "$ref": "#/definitions/PromotionTaskReference" } ] }, "uses": { "description": "Uses identifies a runner that can execute this step.\n\n+kubebuilder:validation:Optional\n+kubebuilder:validation:MinLength=1", "type": "string" }, "vars": { "description": "Vars is a list of variables that can be referenced by expressions in\nthe step's Config. The values override the values specified in the\nPromotionSpec.", "type": "array", "items": { "$ref": "#/definitions/ExpressionVariable" } } } }, "PromotionStepRetry": { "type": "object", "properties": { "errorThreshold": { "description": "ErrorThreshold is the number of consecutive times the step must fail (for\nany reason) before retries are abandoned and the entire Promotion is marked\nas failed.\n\nIf this field is set to 0, the effective default will be a step-specific\none. If no step-specific default exists (i.e. is also 0), the effective\ndefault will be the system-wide default of 1.\n\nA value of 1 will cause the Promotion to be marked as failed after just\na single failure; i.e. no retries will be attempted.\n\nThere is no option to specify an infinite number of retries using a value\nsuch as -1.\n\nIn a future release, Kargo is likely to become capable of distinguishing\nbetween recoverable and non-recoverable step failures. At that time, it is\nplanned that unrecoverable failures will not be subject to this threshold\nand will immediately cause the Promotion to be marked as failed without\nfurther condition.", "type": "integer" }, "timeout": { "description": "Timeout is the soft maximum interval in which a step that returns a Running\nstatus (which typically indicates it's waiting for something to happen)\nmay be retried.\n\nThe maximum is a soft one because the check for whether the interval has\nelapsed occurs AFTER the step has run. This effectively means a step may\nrun ONCE beyond the close of the interval.\n\nIf this field is set to nil, the effective default will be a step-specific\none. If no step-specific default exists (i.e. is also nil), the effective\ndefault will be the system-wide default of 0.\n\nA value of 0 will cause the step to be retried indefinitely unless the\nErrorThreshold is reached.", "type": "string" } } }, "PromotionTask": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "description": "Spec describes the composition of a PromotionTask, including the\nvariables available to the task and the steps.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/PromotionTaskSpec" } ] } }, "required": [ "spec" ] }, "PromotionTaskList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/PromotionTask" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ListMeta" } } }, "PromotionTaskReference": { "type": "object", "properties": { "kind": { "description": "Kind is the type of the PromotionTask. Can be either PromotionTask or\nClusterPromotionTask, default is PromotionTask.\n\n+kubebuilder:validation:Optional\n+kubebuilder:validation:Enum=PromotionTask;ClusterPromotionTask", "type": "string" }, "name": { "description": "Name is the name of the (Cluster)PromotionTask.\n\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:MaxLength=253\n+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n+akuity:test-kubebuilder-pattern=KubernetesName", "type": "string" } }, "required": [ "name" ] }, "PromotionTaskSpec": { "type": "object", "properties": { "steps": { "description": "Steps specifies the directives to be executed as part of this\nPromotionTask. The steps as defined here are inflated into a\nPromotion when it is built from a PromotionTemplate.\n\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinItems=1\n+kubebuilder:validation:items:XValidation:message=\"PromotionTask step must have uses set and must not reference another task\",rule=\"has(self.uses) && !has(self.task)\"", "type": "array", "items": { "$ref": "#/definitions/PromotionStep" } }, "vars": { "description": "Vars specifies the variables available to the PromotionTask. The\nvalues of these variables are the default values that can be\noverridden by the step referencing the task.", "type": "array", "items": { "$ref": "#/definitions/ExpressionVariable" } } }, "required": [ "steps" ] }, "PromotionTemplate": { "type": "object", "properties": { "spec": { "$ref": "#/definitions/PromotionTemplateSpec" } } }, "PromotionTemplateSpec": { "type": "object", "properties": { "steps": { "description": "Steps specifies the directives to be executed as part of a Promotion.\nThe order in which the directives are executed is the order in which they\nare listed in this field.\n\n+kubebuilder:validation:MinItems=1\n+kubebuilder:validation:items:XValidation:message=\"PromotionTemplate step must have exactly one of uses or task set\",rule=\"(has(self.uses) ? !has(self.task) : has(self.task))\"\n+kubebuilder:validation:items:XValidation:message=\"PromotionTemplate step referencing a task cannot set continueOnError\",rule=\"!has(self.task) || !has(self.continueOnError)\"\n+kubebuilder:validation:items:XValidation:message=\"PromotionTemplate step referencing a task cannot set retry\",rule=\"!has(self.task) || !has(self.retry)\"", "type": "array", "items": { "$ref": "#/definitions/PromotionStep" } }, "vars": { "description": "Vars is a list of variables that can be referenced by expressions in\npromotion steps.", "type": "array", "items": { "$ref": "#/definitions/ExpressionVariable" } } } }, "PromotionWindow": { "type": "object", "properties": { "dtend": { "description": "DTEnd is the window's end in the same format as DTStart. When combined with\nRRule, DTEnd - DTStart defines the duration of each occurrence. The value\nis parsed and validated by Kargo Enterprise.\n\n+optional", "type": "string" }, "dtstart": { "description": "DTStart is the window's start as an iCal date-time, with an optional\n\"TZID=\" prefix carrying the time zone (e.g.\n\"TZID=America/New_York:20260101T090000\"). The value is parsed and validated\nby Kargo Enterprise.\n\n+optional", "type": "string" }, "kind": { "description": "Kind indicates whether this window allows or denies promotions while it is\nactive.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/PromotionWindowKind" } ] }, "name": { "description": "Name is a symbolic name for the window, unique within its list. It is used\nto identify the window in denial messages and events.\n\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:MaxLength=253\n+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n+akuity:test-kubebuilder-pattern=KubernetesName", "type": "string" }, "projectSelector": { "description": "ProjectSelector selects the Projects this window applies to. It is only\nmeaningful on ClusterConfig windows; on ProjectConfig windows the Project\nis implicit and this field is rejected. When omitted on a ClusterConfig\nwindow, the window applies to all Projects. It reuses\nPromotionPolicySelector, matching Projects by exact name, glob/regex\npattern, or label selector.\n\n+optional", "allOf": [ { "$ref": "#/definitions/PromotionPolicySelector" } ] }, "rrule": { "description": "RRule is an optional RFC 5545 recurrence rule (e.g. \"FREQ=DAILY\") that\nmakes the window recurring. When omitted, the window is a one-shot interval\ndefined by DTStart and DTEnd. The full value is parsed and validated by\nKargo Enterprise.\n\n+optional", "type": "string" }, "stageSelector": { "description": "StageSelector selects the Stages this window applies to. When omitted, the\nwindow applies to all Stages in scope (project-wide on ProjectConfig,\ncluster-wide on ClusterConfig). It reuses PromotionPolicySelector, so it\ncan match by exact name, glob/regex pattern, or label selector.\n\n+optional", "allOf": [ { "$ref": "#/definitions/PromotionPolicySelector" } ] } }, "required": [ "kind", "name" ] }, "PromotionWindowKind": { "type": "string", "enum": [ "Allow", "Deny" ], "x-enum-varnames": [ "PromotionWindowKindAllow", "PromotionWindowKindDeny" ] }, "QuayWebhookReceiverConfig": { "type": "object", "properties": { "secretRef": { "description": "SecretRef contains a reference to a Secret. For Project-scoped webhook\nreceivers, the referenced Secret must be in the same namespace as the\nProjectConfig.\n\nFor cluster-scoped webhook receivers, the referenced Secret must be in the\ndesignated \"system resources\" namespace.\n\nThe Secret's data map is expected to contain a `secret` key whose value\ndoes NOT need to be shared directly with Quay when registering a\nwebhook. It is used only by Kargo to create a complex, hard-to-guess URL,\nwhich implicitly serves as a shared secret. For more information about\nQuay webhooks, please refer to the Quay documentation:\n https://docs.quay.io/guides/notifications.html\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } }, "required": [ "secretRef" ] }, "Stage": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "description": "Spec describes sources of Freight used by the Stage and how to incorporate\nFreight into the Stage.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/StageSpec" } ] }, "status": { "description": "Status describes the Stage's current and recent Freight, health, and more.", "allOf": [ { "$ref": "#/definitions/StageStatus" } ] } }, "required": [ "spec" ] }, "StageList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/Stage" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ListMeta" } } }, "StageSpec": { "type": "object", "properties": { "promotionTemplate": { "description": "PromotionTemplate describes how to incorporate Freight into the Stage\nusing a Promotion.", "allOf": [ { "$ref": "#/definitions/PromotionTemplate" } ] }, "requestedFreight": { "description": "RequestedFreight expresses the Stage's need for certain pieces of Freight,\neach having originated from a particular Warehouse. This list must be\nnon-empty. In the common case, a Stage will request Freight having\noriginated from just one specific Warehouse. In advanced cases, requesting\nFreight from multiple Warehouses provides a method of advancing new\nartifacts of different types through parallel pipelines at different\nspeeds. This can be useful, for instance, if a Stage is home to multiple\nmicroservices that are independently versioned.\n\n+kubebuilder:validation:MinItems=1", "type": "array", "items": { "$ref": "#/definitions/FreightRequest" } }, "shard": { "description": "Shard is the name of the shard that this Stage belongs to. This is an\noptional field. If not specified, the Stage will belong to the default\nshard. A defaulting webhook will sync the value of the\nkargo.akuity.io/shard label with the value of this field. When this field\nis empty, the webhook will ensure that label is absent.", "type": "string" }, "targetSelectors": { "description": "TargetSelectors select the Targets that this Stage governs and promotes\nFreight to, matching Targets by their labels within the Stage's own\nProject. A Target is selected when it matches any selector in this list.\nA Stage may govern any number of Targets this way.\n\nWhen this field is nil (the default), the Stage operates in classic mode:\nit governs a single implicit \"stage-self\" Target that the controller\ncreates and maintains on the Stage's behalf. This preserves the behavior\nof Stages authored before Targets existed. An empty selector in a non-empty\nlist selects all Targets in the Project.\n\n+optional", "type": "array", "items": { "$ref": "#/definitions/V1LabelSelector" } }, "vars": { "description": "Vars is a list of variables that can be referenced anywhere in the\nStageSpec that supports expressions. For example, the PromotionTemplate\nand arguments of the Verification.", "type": "array", "items": { "$ref": "#/definitions/ExpressionVariable" } }, "verification": { "description": "Verification describes how to verify a Stage's current Freight is fit for\npromotion downstream.", "allOf": [ { "$ref": "#/definitions/Verification" } ] } } }, "StageStats": { "type": "object", "properties": { "count": { "description": "Count contains the total number of Stages in the Project.", "type": "integer" }, "health": { "description": "Health contains a summary of the collective health of a Project's Stages.", "allOf": [ { "$ref": "#/definitions/HealthStats" } ] } } }, "StageStatus": { "type": "object", "properties": { "autoPromotionEnabled": { "description": "AutoPromotionEnabled indicates whether automatic promotion is enabled\nfor the Stage based on the ProjectConfig.", "type": "boolean" }, "autoPromotionHolds": { "description": "AutoPromotionHolds records active auto-promotion holds for this Stage. A\nhold is established when a Promotion selects Freight other than the\nauto-promotion candidate for that origin, pausing auto-promotion for that\norigin until explicitly released. Auto-promotions themselves never\nestablish holds. Keys are string representations of FreightOrigins (e.g.\n\"Warehouse/my-warehouse\"); values describe the Promotion that established\nthe hold.", "type": "object", "additionalProperties": { "$ref": "#/definitions/AutoPromotionHold" } }, "conditions": { "description": "Conditions contains the last observations of the Stage's current\nstate.\n+patchMergeKey=type\n+patchStrategy=merge\n+listType=map\n+listMapKey=type", "type": "array", "items": { "$ref": "#/definitions/V1Condition" } }, "currentPromotion": { "description": "CurrentPromotion is a reference to the currently Running promotion.", "allOf": [ { "$ref": "#/definitions/PromotionReference" } ] }, "effectiveAutoPromotionHolds": { "description": "EffectiveAutoPromotionHolds is the set of auto-promotion holds in effect\nright now. It is recomputed every reconciliation from AutoPromotionHolds\nplus the newest in-flight Promotions, and unlike AutoPromotionHolds is not\ndurable. Clients should read this map to reflect current hold state.", "type": "object", "additionalProperties": { "$ref": "#/definitions/AutoPromotionHold" } }, "freightHistory": { "description": "FreightHistory is a list of recent Freight selections that were deployed\nto the Stage. By default, the last ten Freight selections are stored.\nThe first item in the list is the most recent Freight selection and\ncurrently deployed to the Stage, subsequent items are older selections.", "type": "array", "items": { "$ref": "#/definitions/FreightCollection" } }, "freightSummary": { "description": "FreightSummary is human-readable text maintained by the controller that\nsummarizes what Freight is currently deployed to the Stage. For Stages that\nrequest a single piece of Freight AND the request has been fulfilled, this\nfield will simply contain the name of the Freight. For Stages that request\na single piece of Freight AND the request has NOT been fulfilled, or for\nStages that request multiple pieces of Freight, this field will contain a\nsummary of fulfilled/requested Freight. The existence of this field is a\nworkaround for kubectl limitations so that this complex but valuable\ninformation can be displayed in a column in response to `kubectl get\nstages`.", "type": "string" }, "health": { "description": "Health is the Stage's last observed health.", "allOf": [ { "$ref": "#/definitions/Health" } ] }, "lastHandledRefresh": { "description": "LastHandledRefresh holds the value of the most recent AnnotationKeyRefresh\nannotation that was handled by the controller. This field can be used to\ndetermine whether the request to refresh the resource has been handled.\n+optional", "type": "string" }, "lastPromotion": { "description": "LastPromotion is a reference to the last completed promotion.", "allOf": [ { "$ref": "#/definitions/PromotionReference" } ] }, "metadata": { "description": "Metadata is a map of arbitrary metadata associated with the Stage.\nThis is useful for storing additional information about the Stage\nthat can be shared across promotions, verifications, or other processes.", "type": "object", "additionalProperties": {} }, "observedGeneration": { "description": "ObservedGeneration represents the .metadata.generation that this Stage\nstatus was reconciled against.", "type": "integer" } } }, "StepExecutionMetadata": { "type": "object", "properties": { "alias": { "description": "Alias is the alias of the step.", "type": "string" }, "continueOnError": { "description": "ContinueOnError is a boolean value that, if set to true, will cause the\nPromotion to continue executing the next step even if this step fails. It\nalso will not permit this failure to impact the overall status of the\nPromotion.", "type": "boolean" }, "errorCount": { "description": "ErrorCount tracks consecutive failed attempts to execute the step.", "type": "integer" }, "finishedAt": { "description": "FinishedAt is the time at which the final attempt to execute the step\ncompleted.", "type": "string" }, "message": { "description": "Message is a display message about the step, including any errors.", "type": "string" }, "startedAt": { "description": "StartedAt is the time at which the first attempt to execute the step\nbegan.", "type": "string" }, "status": { "description": "Status is the high-level outcome of the step.", "type": "string" } } }, "Verification": { "type": "object", "properties": { "analysisRunMetadata": { "description": "AnalysisRunMetadata contains optional metadata that should be applied to\nall AnalysisRuns.", "allOf": [ { "$ref": "#/definitions/AnalysisRunMetadata" } ] }, "analysisTemplates": { "description": "AnalysisTemplates is a list of AnalysisTemplates from which AnalysisRuns\nshould be created to verify a Stage's current Freight is fit to be promoted\ndownstream.", "type": "array", "items": { "$ref": "#/definitions/AnalysisTemplateReference" } }, "args": { "description": "Args lists arguments that should be added to all AnalysisRuns.", "type": "array", "items": { "$ref": "#/definitions/AnalysisRunArgument" } } } }, "VerificationInfo": { "type": "object", "properties": { "actor": { "description": "Actor is the name of the entity that initiated or aborted the\nVerification process.", "type": "string" }, "analysisRun": { "description": "AnalysisRun is a reference to the Argo Rollouts AnalysisRun that implements\nthe Verification process.", "allOf": [ { "$ref": "#/definitions/AnalysisRunReference" } ] }, "finishTime": { "description": "FinishTime is the time at which the Verification process finished.", "type": "string" }, "id": { "description": "ID is the identifier of the Verification process.", "type": "string" }, "message": { "description": "Message may contain additional information about why the verification\nprocess is in its current phase.", "type": "string" }, "phase": { "description": "Phase describes the current phase of the Verification process. Generally,\nthis will be a reflection of the underlying AnalysisRun's phase, however,\nthere are exceptions to this, such as in the case where an AnalysisRun\ncannot be launched successfully.", "type": "string" }, "startTime": { "description": "StartTime is the time at which the Verification process was started.", "type": "string" } } }, "VerifiedStage": { "type": "object", "properties": { "longestSoak": { "description": "LongestCompletedSoak represents the longest definite time interval wherein\nthe Freight was in CONTINUOUS use by the Stage. This value is updated as\nFreight EXITS the Stage. If the Freight is currently in use by the Stage,\nthe time elapsed since the Freight ENTERED the Stage is its current soak\ntime, which may exceed the value of this field.", "type": "string" }, "verifiedAt": { "description": "VerifiedAt is the time at which the Freight was verified in the Stage.", "type": "string" } } }, "Warehouse": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ObjectMeta" }, "spec": { "description": "Spec describes sources of artifacts.\n\n+kubebuilder:validation:Required", "allOf": [ { "$ref": "#/definitions/WarehouseSpec" } ] }, "status": { "description": "Status describes the Warehouse's most recently observed state.", "allOf": [ { "$ref": "#/definitions/WarehouseStatus" } ] } }, "required": [ "spec" ] }, "WarehouseList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/definitions/Warehouse" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "$ref": "#/definitions/V1ListMeta" } } }, "WarehouseSpec": { "type": "object", "properties": { "freightCreationCriteria": { "description": "FreightCreationCriteria defines criteria that must be satisfied for Freight\nto be created automatically from new artifacts following discovery. This\nfield has no effect when the FreightCreationPolicy is `Manual`.\n\n+kubebuilder:validation:Optional", "allOf": [ { "$ref": "#/definitions/FreightCreationCriteria" } ] }, "freightCreationPolicy": { "description": "FreightCreationPolicy describes how Freight is created by this Warehouse.\nThis field is optional. When left unspecified, the field is implicitly\ntreated as if its value were \"Automatic\".\n\nAccepted values:\n\n- \"Automatic\": New Freight is created automatically when any new artifact\n is discovered.\n- \"Manual\": New Freight is never created automatically.\n\n+kubebuilder:default=Automatic\n+kubebuilder:validation:Optional", "type": "string" }, "interval": { "description": "Interval is the reconciliation interval for this Warehouse. On each\nreconciliation, the Warehouse will discover new artifacts and optionally\nproduce new Freight. This field is optional. When left unspecified, the\nfield is implicitly treated as if its value were \"5m0s\".\n\n+kubebuilder:validation:Type=string\n+kubebuilder:validation:Pattern=`^([0-9]+(\\.[0-9]+)?(s|m|h))+$`\n+kubebuilder:default=\"5m0s\"\n+akuity:test-kubebuilder-pattern=Duration", "type": "string" }, "shard": { "description": "Shard is the name of the shard that this Warehouse belongs to. This is an\noptional field. If not specified, the Warehouse will belong to the default\nshard. A defaulting webhook will sync this field with the value of the\nkargo.akuity.io/shard label. When the shard label is not present or differs\nfrom the value of this field, the defaulting webhook will set the label to\nthe value of this field. If the shard label is present and this field is\nempty, the defaulting webhook will set the value of this field to the value\nof the shard label.", "type": "string" }, "subscriptions": { "description": "Subscriptions describes sources of artifacts to be included in Freight\nproduced by this Warehouse.\n\n+kubebuilder:validation:MinItems=1", "type": "array", "items": {} } } }, "WarehouseStats": { "type": "object", "properties": { "count": { "description": "Count contains the total number of Warehouses in the Project.", "type": "integer" }, "health": { "description": "Health contains a summary of the collective health of a Project's\nWarehouses.", "allOf": [ { "$ref": "#/definitions/HealthStats" } ] } } }, "WarehouseStatus": { "type": "object", "properties": { "conditions": { "description": "Conditions contains the last observations of the Warehouse's current\nstate.\n+patchMergeKey=type\n+patchStrategy=merge\n+listType=map\n+listMapKey=type", "type": "array", "items": { "$ref": "#/definitions/V1Condition" } }, "discoveredArtifacts": { "description": "DiscoveredArtifacts holds the artifacts discovered by the Warehouse.", "allOf": [ { "$ref": "#/definitions/DiscoveredArtifacts" } ] }, "lastFreightID": { "description": "LastFreightID is a reference to the system-assigned identifier (name) of\nthe most recent Freight produced by the Warehouse.", "type": "string" }, "lastHandledRefresh": { "description": "LastHandledRefresh holds the value of the most recent AnnotationKeyRefresh\nannotation that was handled by the controller. This field can be used to\ndetermine whether the request to refresh the resource has been handled.\n+optional", "type": "string" }, "observedGeneration": { "description": "ObservedGeneration represents the .metadata.generation that this Warehouse\nwas reconciled against.", "type": "integer" } } }, "WebhookReceiverConfig": { "type": "object", "properties": { "artifactory": { "description": "Artifactory contains the configuration for a webhook receiver that is\ncompatible with JFrog Artifactory payloads.", "allOf": [ { "$ref": "#/definitions/ArtifactoryWebhookReceiverConfig" } ] }, "azure": { "description": "Azure contains the configuration for a webhook receiver that is compatible\nwith Azure Container Registry (ACR) and Azure DevOps payloads.", "allOf": [ { "$ref": "#/definitions/AzureWebhookReceiverConfig" } ] }, "bitbucket": { "description": "Bitbucket contains the configuration for a webhook receiver that is\ncompatible with Bitbucket payloads.", "allOf": [ { "$ref": "#/definitions/BitbucketWebhookReceiverConfig" } ] }, "dockerhub": { "description": "DockerHub contains the configuration for a webhook receiver that is\ncompatible with DockerHub payloads.", "allOf": [ { "$ref": "#/definitions/DockerHubWebhookReceiverConfig" } ] }, "generic": { "description": "Generic contains the configuration for a generic webhook receiver.", "allOf": [ { "$ref": "#/definitions/GenericWebhookReceiverConfig" } ] }, "gitea": { "description": "Gitea contains the configuration for a webhook receiver that is compatible\nwith Gitea payloads.", "allOf": [ { "$ref": "#/definitions/GiteaWebhookReceiverConfig" } ] }, "github": { "description": "GitHub contains the configuration for a webhook receiver that is compatible\nwith GitHub payloads.", "allOf": [ { "$ref": "#/definitions/GitHubWebhookReceiverConfig" } ] }, "gitlab": { "description": "GitLab contains the configuration for a webhook receiver that is compatible\nwith GitLab payloads.", "allOf": [ { "$ref": "#/definitions/GitLabWebhookReceiverConfig" } ] }, "harbor": { "description": "Harbor contains the configuration for a webhook receiver that is compatible\nwith Harbor payloads.", "allOf": [ { "$ref": "#/definitions/HarborWebhookReceiverConfig" } ] }, "name": { "description": "Name is the name of the webhook receiver.\n\n+kubebuilder:validation:Required\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:MaxLength=253\n+kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`\n+akuity:test-kubebuilder-pattern=KubernetesName", "type": "string" }, "quay": { "description": "Quay contains the configuration for a webhook receiver that is compatible\nwith Quay payloads.", "allOf": [ { "$ref": "#/definitions/QuayWebhookReceiverConfig" } ] } }, "required": [ "name" ] }, "WebhookReceiverDetails": { "type": "object", "properties": { "name": { "description": "Name is the name of the webhook receiver.", "type": "string" }, "path": { "description": "Path is the path to the receiver's webhook endpoint.", "type": "string" }, "url": { "description": "URL includes the full address of the receiver's webhook endpoint.", "type": "string" } } }, "V1Event": { "type": "object", "properties": { "action": { "description": "What action was taken/failed regarding to the Regarding object.\n+optional", "type": "string" }, "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "count": { "description": "The number of times this event has occurred.\n+optional", "type": "integer" }, "eventTime": { "description": "Time when this Event was first observed.\n+optional", "type": "string" }, "firstTimestamp": { "description": "The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)\n+optional", "type": "string" }, "involvedObject": { "description": "The object that this event is about.", "allOf": [ { "$ref": "#/definitions/V1ObjectReference" } ] }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "lastTimestamp": { "description": "The time at which the most recent occurrence of this event was recorded.\n+optional", "type": "string" }, "message": { "description": "A human-readable description of the status of this operation.\nTODO: decide on maximum length.\n+optional", "type": "string" }, "metadata": { "description": "Standard object's metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "allOf": [ { "$ref": "#/definitions/V1ObjectMeta" } ] }, "reason": { "description": "This should be a short, machine understandable string that gives the reason\nfor the transition into the object's current status.\nTODO: provide exact specification for format.\n+optional", "type": "string" }, "related": { "description": "Optional secondary object for more complex actions.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ObjectReference" } ] }, "reportingComponent": { "description": "Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.\n+optional", "type": "string" }, "reportingInstance": { "description": "ID of the controller instance, e.g. `kubelet-xyzf`.\n+optional", "type": "string" }, "series": { "description": "Data about the Event series this event represents or nil if it's a singleton Event.\n+optional", "allOf": [ { "$ref": "#/definitions/V1EventSeries" } ] }, "source": { "description": "The component reporting this event. Should be a short machine understandable string.\n+optional", "allOf": [ { "$ref": "#/definitions/V1EventSource" } ] }, "type": { "description": "Type of this event (Normal, Warning), new types could be added in the future\n+optional", "type": "string" } } }, "V1EventList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "description": "List of events", "type": "array", "items": { "$ref": "#/definitions/V1Event" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "description": "Standard list metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "allOf": [ { "$ref": "#/definitions/V1ListMeta" } ] } } }, "V1EventSeries": { "type": "object", "properties": { "count": { "description": "Number of occurrences in this series up to the last heartbeat time", "type": "integer" }, "lastObservedTime": { "description": "Time of the last occurrence observed", "type": "string" } } }, "V1ResourceClaim": { "type": "object", "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container.", "type": "string" }, "request": { "description": "Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request.\n\n+optional", "type": "string" } } }, "pkg_server.freightGroupList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/definitions/Freight" } } } }, "pkg_server.queryFreightsResponse": { "type": "object", "properties": { "groups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/pkg_server.freightGroupList" } }, "resourceVersion": { "description": "ResourceVersion is the Kubernetes list resourceVersion clients use to\nseed a follow-up Freight watch so the API server does not replay every\nexisting Freight as an ADDED event. It is empty for the stage-scoped\nquery, whose result is assembled from multiple sources rather than a\nsingle watchable namespace list.", "type": "string" } } }, "V1AWSElasticBlockStoreVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "partition": { "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\n+optional", "type": "integer" }, "readOnly": { "description": "readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional", "type": "boolean" }, "volumeID": { "description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": "string" } } }, "V1Affinity": { "type": "object", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.\n+optional", "allOf": [ { "$ref": "#/definitions/V1NodeAffinity" } ] }, "podAffinity": { "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodAffinity" } ] }, "podAntiAffinity": { "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodAntiAffinity" } ] } } }, "V1AppArmorProfile": { "type": "object", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\".\n+optional", "type": "string" }, "type": { "description": "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.\n+unionDiscriminator", "type": "string" } } }, "V1AzureDiskVolumeSource": { "type": "object", "properties": { "cachingMode": { "description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.\n+optional\n+default=ref(AzureDataDiskCachingReadWrite)", "type": "string" }, "diskName": { "description": "diskName is the Name of the data disk in the blob storage", "type": "string" }, "diskURI": { "description": "diskURI is the URI of data disk in the blob storage", "type": "string" }, "fsType": { "description": "fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional\n+default=\"ext4\"", "type": "string" }, "kind": { "description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared\n+default=ref(AzureSharedBlobDisk)", "type": "string" }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional\n+default=false", "type": "boolean" } } }, "V1AzureFileVolumeSource": { "type": "object", "properties": { "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretName": { "description": "secretName is the name of secret that contains Azure Storage Account Name and Key", "type": "string" }, "shareName": { "description": "shareName is the azure share Name", "type": "string" } } }, "V1CSIVolumeSource": { "type": "object", "properties": { "driver": { "description": "driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster.", "type": "string" }, "fsType": { "description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.\n+optional", "type": "string" }, "nodePublishSecretRef": { "description": "nodePublishSecretRef is a reference to the secret object containing\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "readOnly": { "description": "readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write).\n+optional", "type": "boolean" }, "volumeAttributes": { "description": "volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.\n+optional", "type": "object", "additionalProperties": { "type": "string" } } } }, "V1Capabilities": { "type": "object", "properties": { "add": { "description": "Added capabilities\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "drop": { "description": "Removed capabilities\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "V1CephFSVolumeSource": { "type": "object", "properties": { "monitors": { "description": "monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "path": { "description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /\n+optional", "type": "string" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "boolean" }, "secretFile": { "description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "string" }, "secretRef": { "description": "secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "user": { "description": "user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it\n+optional", "type": "string" } } }, "V1CinderVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "volumeID": { "description": "volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" } } }, "V1ClusterTrustBundleProjection": { "type": "object", "properties": { "labelSelector": { "description": "Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\".\n+optional", "allOf": [ { "$ref": "#/definitions/V1LabelSelector" } ] }, "name": { "description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector.\n+optional", "type": "string" }, "optional": { "description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles.\n+optional", "type": "boolean" }, "path": { "description": "Relative path from the volume root to write the bundle.", "type": "string" }, "signerName": { "description": "Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated.\n+optional", "type": "string" } } }, "V1CompletionMode": { "type": "string", "enum": [ "NonIndexed", "Indexed" ], "x-enum-varnames": [ "NonIndexedCompletion", "IndexedCompletion" ] }, "V1Condition": { "type": "object", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.\n+required\n+kubebuilder:validation:Required\n+kubebuilder:validation:Type=string\n+kubebuilder:validation:Format=date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.\n+required\n+kubebuilder:validation:Required\n+kubebuilder:validation:MaxLength=32768", "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.\n+optional\n+kubebuilder:validation:Minimum=0", "type": "integer" }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.\n+required\n+kubebuilder:validation:Required\n+kubebuilder:validation:MaxLength=1024\n+kubebuilder:validation:MinLength=1\n+kubebuilder:validation:Pattern=`^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$`", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.\n+required\n+kubebuilder:validation:Required\n+kubebuilder:validation:Enum=True;False;Unknown", "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)\n+required\n+kubebuilder:validation:Required\n+kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`\n+kubebuilder:validation:MaxLength=316", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ] }, "V1ConfigMap": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "binaryData": { "description": "BinaryData contains the binary data.\nEach key must consist of alphanumeric characters, '-', '_' or '.'.\nBinaryData can contain byte sequences that are not in the UTF-8 range.\nThe keys stored in BinaryData must not overlap with the ones in\nthe Data field, this is enforced during validation process.\nUsing this field will require 1.10+ apiserver and\nkubelet.\n+optional", "type": "object", "additionalProperties": { "type": "string", "format": "byte" } }, "data": { "description": "Data contains the configuration data.\nEach key must consist of alphanumeric characters, '-', '_' or '.'.\nValues with non-UTF-8 byte sequences must use the BinaryData field.\nThe keys stored in Data must not overlap with the keys in\nthe BinaryData field, this is enforced during validation process.\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "immutable": { "description": "Immutable, if set to true, ensures that data stored in the ConfigMap cannot\nbe updated (only object metadata can be modified).\nIf not set to true, the field can be modified at any time.\nDefaulted to nil.\n+optional", "type": "boolean" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "description": "Standard object's metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "allOf": [ { "$ref": "#/definitions/V1ObjectMeta" } ] } } }, "V1ConfigMapEnvSource": { "type": "object", "properties": { "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap must be defined\n+optional", "type": "boolean" } } }, "V1ConfigMapKeySelector": { "type": "object", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined\n+optional", "type": "boolean" } } }, "V1ConfigMapList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "description": "Items is the list of ConfigMaps.", "type": "array", "items": { "$ref": "#/definitions/V1ConfigMap" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "description": "More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "allOf": [ { "$ref": "#/definitions/V1ListMeta" } ] } } }, "V1ConfigMapProjection": { "type": "object", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1KeyToPath" } }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } } }, "V1ConfigMapVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1KeyToPath" } }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined\n+optional", "type": "boolean" } } }, "V1Container": { "type": "object", "properties": { "args": { "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "command": { "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "env": { "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/V1EnvVar" } }, "envFrom": { "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source may consist of any printable ASCII characters except '='.\nWhen 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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1EnvFromSource" } }, "image": { "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional", "type": "string" }, "imagePullPolicy": { "description": "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", "type": "string" }, "lifecycle": { "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.\n+optional", "allOf": [ { "$ref": "#/definitions/V1Lifecycle" } ] }, "livenessProbe": { "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "allOf": [ { "$ref": "#/definitions/V1Probe" } ] }, "name": { "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated.", "type": "string" }, "ports": { "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol", "type": "array", "items": { "$ref": "#/definitions/V1ContainerPort" } }, "readinessProbe": { "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "allOf": [ { "$ref": "#/definitions/V1Probe" } ] }, "resizePolicy": { "description": "Resources resize policy for the container.\nThis field cannot be set on ephemeral containers.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1ContainerResizePolicy" } }, "resources": { "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceRequirements" } ] }, "restartPolicy": { "description": "RestartPolicy defines the restart behavior of individual containers in a pod.\nThis overrides the pod-level restart policy. When this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nAdditionally, setting the RestartPolicy as \"Always\" for the init container will\nhave the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted.\n+optional", "type": "string" }, "restartPolicyRules": { "description": "Represents a list of rules to be checked to determine if the\ncontainer should be restarted on exit. The rules are evaluated in\norder. Once a rule matches a container exit condition, the remaining\nrules are ignored. If no rule matches the container exit condition,\nthe Container-level restart policy determines the whether the container\nis restarted or not. Constraints on the rules:\n- At most 20 rules are allowed.\n- Rules can have the same action.\n- Identical rules are not forbidden in validations.\nWhen rules are specified, container MUST set RestartPolicy explicitly\neven it if matches the Pod's RestartPolicy.\n+featureGate=ContainerRestartRules\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1ContainerRestartRule" } }, "securityContext": { "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/\n+optional", "allOf": [ { "$ref": "#/definitions/V1SecurityContext" } ] }, "startupProbe": { "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "allOf": [ { "$ref": "#/definitions/V1Probe" } ] }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", "type": "boolean" }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", "type": "boolean" }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", "type": "string" }, "terminationMessagePolicy": { "description": "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", "type": "string" }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", "type": "boolean" }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+listType=map\n+listMapKey=devicePath\n+optional", "type": "array", "items": { "$ref": "#/definitions/V1VolumeDevice" } }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge\n+listType=map\n+listMapKey=mountPath", "type": "array", "items": { "$ref": "#/definitions/V1VolumeMount" } }, "workingDir": { "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", "type": "string" } } }, "V1ContainerPort": { "type": "object", "properties": { "containerPort": { "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536.", "type": "integer" }, "hostIP": { "description": "What host IP to bind the external port to.\n+optional", "type": "string" }, "hostPort": { "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.\n+optional", "type": "integer" }, "name": { "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional", "type": "string" }, "protocol": { "description": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".\n+optional\n+default=\"TCP\"", "type": "string" } } }, "V1ContainerResizePolicy": { "type": "object", "properties": { "resourceName": { "description": "Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory.", "type": "string" }, "restartPolicy": { "description": "Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired.", "type": "string" } } }, "V1ContainerRestartRule": { "type": "object", "properties": { "action": { "description": "Specifies the action taken on a container exit if the requirements\nare satisfied. The only possible value is \"Restart\" to restart the\ncontainer.\n+required", "type": "string" }, "exitCodes": { "description": "Represents the exit codes to check on container exits.\n+optional\n+oneOf=when", "allOf": [ { "$ref": "#/definitions/V1ContainerRestartRuleOnExitCodes" } ] } } }, "V1ContainerRestartRuleOnExitCodes": { "type": "object", "properties": { "operator": { "description": "Represents the relationship between the container exit code(s) and the\nspecified values. Possible values are:\n- In: the requirement is satisfied if the container exit code is in the\n set of specified values.\n- NotIn: the requirement is satisfied if the container exit code is\n not in the set of specified values.\n+required", "type": "string" }, "values": { "description": "Specifies the set of values to check for container exit codes.\nAt most 255 elements are allowed.\n+optional\n+listType=set", "type": "array", "items": { "type": "integer" } } } }, "V1DownwardAPIProjection": { "type": "object", "properties": { "items": { "description": "Items is a list of DownwardAPIVolume file\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1DownwardAPIVolumeFile" } } } }, "V1DownwardAPIVolumeFile": { "type": "object", "properties": { "fieldRef": { "description": "Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ObjectFieldSelector" } ] }, "mode": { "description": "Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "path": { "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'", "type": "string" }, "resourceFieldRef": { "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceFieldSelector" } ] } } }, "V1DownwardAPIVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "items": { "description": "Items is a list of downward API volume file\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1DownwardAPIVolumeFile" } } } }, "V1EmptyDirVolumeSource": { "type": "object", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "type": "string" }, "sizeLimit": { "description": "sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "type": "string" } } }, "V1EnvFromSource": { "type": "object", "properties": { "configMapRef": { "description": "The ConfigMap to select from\n+optional", "allOf": [ { "$ref": "#/definitions/V1ConfigMapEnvSource" } ] }, "prefix": { "description": "Optional text to prepend to the name of each environment variable.\nMay consist of any printable ASCII characters except '='.\n+optional", "type": "string" }, "secretRef": { "description": "The Secret to select from\n+optional", "allOf": [ { "$ref": "#/definitions/V1SecretEnvSource" } ] } } }, "V1EnvVar": { "type": "object", "properties": { "name": { "description": "Name of the environment variable.\nMay consist of any printable ASCII characters except '='.", "type": "string" }, "value": { "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".\n+optional", "type": "string" }, "valueFrom": { "description": "Source for the environment variable's value. Cannot be used if value is not empty.\n+optional", "allOf": [ { "$ref": "#/definitions/V1EnvVarSource" } ] } } }, "V1EnvVarSource": { "type": "object", "properties": { "configMapKeyRef": { "description": "Selects a key of a ConfigMap.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ConfigMapKeySelector" } ] }, "fieldRef": { "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ObjectFieldSelector" } ] }, "fileKeyRef": { "description": "FileKeyRef selects a key of the env file.\nRequires the EnvFiles feature gate to be enabled.\n\n+featureGate=EnvFiles\n+optional", "allOf": [ { "$ref": "#/definitions/V1FileKeySelector" } ] }, "resourceFieldRef": { "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceFieldSelector" } ] }, "secretKeyRef": { "description": "Selects a key of a secret in the pod's namespace\n+optional", "allOf": [ { "$ref": "#/definitions/V1SecretKeySelector" } ] } } }, "V1EphemeralContainer": { "type": "object", "properties": { "args": { "description": "Arguments to the entrypoint.\nThe image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "command": { "description": "Entrypoint array. Not executed within a shell.\nThe image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "env": { "description": "List of environment variables to set in the container.\nCannot be updated.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/V1EnvVar" } }, "envFrom": { "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source may consist of any printable ASCII characters except '='.\nWhen 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\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1EnvFromSource" } }, "image": { "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images", "type": "string" }, "imagePullPolicy": { "description": "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", "type": "string" }, "lifecycle": { "description": "Lifecycle is not allowed for ephemeral containers.\n+optional", "allOf": [ { "$ref": "#/definitions/V1Lifecycle" } ] }, "livenessProbe": { "description": "Probes are not allowed for ephemeral containers.\n+optional", "allOf": [ { "$ref": "#/definitions/V1Probe" } ] }, "name": { "description": "Name of the ephemeral container specified as a DNS_LABEL.\nThis name must be unique among all containers, init containers and ephemeral containers.", "type": "string" }, "ports": { "description": "Ports are not allowed for ephemeral containers.\n+optional\n+patchMergeKey=containerPort\n+patchStrategy=merge\n+listType=map\n+listMapKey=containerPort\n+listMapKey=protocol", "type": "array", "items": { "$ref": "#/definitions/V1ContainerPort" } }, "readinessProbe": { "description": "Probes are not allowed for ephemeral containers.\n+optional", "allOf": [ { "$ref": "#/definitions/V1Probe" } ] }, "resizePolicy": { "description": "Resources resize policy for the container.\n+featureGate=InPlacePodVerticalScaling\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1ContainerResizePolicy" } }, "resources": { "description": "Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources\nalready allocated to the pod.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceRequirements" } ] }, "restartPolicy": { "description": "Restart policy for the container to manage the restart behavior of each\ncontainer within a pod.\nYou cannot set this field on ephemeral containers.\n+optional", "type": "string" }, "restartPolicyRules": { "description": "Represents a list of rules to be checked to determine if the\ncontainer should be restarted on exit. You cannot set this field on\nephemeral containers.\n+featureGate=ContainerRestartRules\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1ContainerRestartRule" } }, "securityContext": { "description": "Optional: SecurityContext defines the security options the ephemeral container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\n+optional", "allOf": [ { "$ref": "#/definitions/V1SecurityContext" } ] }, "startupProbe": { "description": "Probes are not allowed for ephemeral containers.\n+optional", "allOf": [ { "$ref": "#/definitions/V1Probe" } ] }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.\n+optional", "type": "boolean" }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false\n+optional", "type": "boolean" }, "targetContainerName": { "description": "If set, the name of the container from PodSpec that this ephemeral container targets.\nThe ephemeral container will be run in the namespaces (IPC, PID, etc) of this container.\nIf not set then the ephemeral container uses the namespaces configured in the Pod spec.\n\nThe container runtime must implement support for this feature. If the runtime does not\nsupport namespace targeting then the result of setting this field is undefined.\n+optional", "type": "string" }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.\n+optional", "type": "string" }, "terminationMessagePolicy": { "description": "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", "type": "string" }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.\n+optional", "type": "boolean" }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container.\n+patchMergeKey=devicePath\n+patchStrategy=merge\n+listType=map\n+listMapKey=devicePath\n+optional", "type": "array", "items": { "$ref": "#/definitions/V1VolumeDevice" } }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers.\nCannot be updated.\n+optional\n+patchMergeKey=mountPath\n+patchStrategy=merge\n+listType=map\n+listMapKey=mountPath", "type": "array", "items": { "$ref": "#/definitions/V1VolumeMount" } }, "workingDir": { "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.\n+optional", "type": "string" } } }, "V1EphemeralVolumeSource": { "type": "object", "properties": { "volumeClaimTemplate": { "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", "allOf": [ { "$ref": "#/definitions/V1PersistentVolumeClaimTemplate" } ] } } }, "V1EventSource": { "type": "object", "properties": { "component": { "description": "Component from which the event is generated.\n+optional", "type": "string" }, "host": { "description": "Node name on which the event is generated.\n+optional", "type": "string" } } }, "V1ExecAction": { "type": "object", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "V1FCVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "lun": { "description": "lun is Optional: FC target lun number\n+optional", "type": "integer" }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "targetWWNs": { "description": "targetWWNs is Optional: FC target worldwide names (WWNs)\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "wwids": { "description": "wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "V1FieldsV1": {}, "V1FileKeySelector": { "type": "object", "properties": { "key": { "description": "The key within the env file. An invalid key will prevent the pod from starting.\nThe keys defined within a source may consist of any printable ASCII characters except '='.\nDuring Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.\n+required", "type": "string" }, "optional": { "description": "Specify whether the file or its key must be defined. If the file or key\ndoes not exist, then the env var is not published.\nIf optional is set to true and the specified key does not exist,\nthe environment variable will not be set in the Pod's containers.\n\nIf optional is set to false and the specified key does not exist,\nan error will be returned during Pod creation.\n+optional\n+default=false", "type": "boolean" }, "path": { "description": "The path within the volume from which to select the file.\nMust be relative and may not contain the '..' path or start with '..'.\n+required", "type": "string" }, "volumeName": { "description": "The name of the volume mount containing the env file.\n+required", "type": "string" } } }, "V1FlexVolumeSource": { "type": "object", "properties": { "driver": { "description": "driver is the name of the driver to use for this volume.", "type": "string" }, "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.\n+optional", "type": "string" }, "options": { "description": "options is Optional: this field holds extra command options if any.\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "readOnly": { "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] } } }, "V1FlockerVolumeSource": { "type": "object", "properties": { "datasetName": { "description": "datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated\n+optional", "type": "string" }, "datasetUUID": { "description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset\n+optional", "type": "string" } } }, "V1GCEPersistentDiskVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "partition": { "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "type": "integer" }, "pdName": { "description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "type": "boolean" } } }, "V1GRPCAction": { "type": "object", "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "type": "integer" }, "service": { "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.\n+optional\n+default=\"\"", "type": "string" } } }, "V1GitRepoVolumeSource": { "type": "object", "properties": { "directory": { "description": "directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.\n+optional", "type": "string" }, "repository": { "description": "repository is the URL", "type": "string" }, "revision": { "description": "revision is the commit hash for the specified revision.\n+optional", "type": "string" } } }, "V1GlusterfsVolumeSource": { "type": "object", "properties": { "endpoints": { "description": "endpoints is the endpoint name that details Glusterfs topology.", "type": "string" }, "path": { "description": "path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "readOnly": { "description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod\n+optional", "type": "boolean" } } }, "V1HTTPGetAction": { "type": "object", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.\n+optional", "type": "string" }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1HTTPHeader" } }, "path": { "description": "Path to access on the HTTP server.\n+optional", "type": "string" }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.\n+optional", "type": "string" } } }, "V1HTTPHeader": { "type": "object", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } } }, "V1HostAlias": { "type": "object", "properties": { "hostnames": { "description": "Hostnames for the above IP address.\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "ip": { "description": "IP address of the host file entry.\n+required", "type": "string" } } }, "V1HostPathVolumeSource": { "type": "object", "properties": { "path": { "description": "path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "type": "string" }, "type": { "description": "type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n+optional", "type": "string" } } }, "V1ISCSIVolumeSource": { "type": "object", "properties": { "chapAuthDiscovery": { "description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication\n+optional", "type": "boolean" }, "chapAuthSession": { "description": "chapAuthSession defines whether support iSCSI Session CHAP authentication\n+optional", "type": "boolean" }, "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "initiatorName": { "description": "initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection.\n+optional", "type": "string" }, "iqn": { "description": "iqn is the target iSCSI Qualified Name.", "type": "string" }, "iscsiInterface": { "description": "iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).\n+optional\n+default=\"default\"", "type": "string" }, "lun": { "description": "lun represents iSCSI Target Lun number.", "type": "integer" }, "portals": { "description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef is the CHAP Secret for iSCSI target and initiator authentication\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "targetPortal": { "description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).", "type": "string" } } }, "V1ImageVolumeSource": { "type": "object", "properties": { "pullPolicy": { "description": "Policy for pulling OCI objects. Possible values are:\nAlways: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.\nNever: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.\nIfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\n+optional", "type": "string" }, "reference": { "description": "Required: Image or artifact reference to be used.\nBehaves in the same way as pod.spec.containers[*].image.\nPull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.\n+optional", "type": "string" } } }, "V1JobSpec": { "type": "object", "properties": { "activeDeadlineSeconds": { "description": "Specifies the duration in seconds relative to the startTime that the job\nmay be continuously active before the system tries to terminate it; value\nmust be positive integer. If a Job is suspended (at creation or through an\nupdate), this timer will effectively be stopped and reset when the Job is\nresumed again.\n+optional", "type": "integer" }, "backoffLimit": { "description": "Specifies the number of retries before marking this job failed.\nDefaults to 6, unless backoffLimitPerIndex (only Indexed Job) is specified.\nWhen backoffLimitPerIndex is specified, backoffLimit defaults to 2147483647.\n+optional", "type": "integer" }, "backoffLimitPerIndex": { "description": "Specifies the limit for the number of retries within an\nindex before marking this index as failed. When enabled the number of\nfailures per index is kept in the pod's\nbatch.kubernetes.io/job-index-failure-count annotation. It can only\nbe set when Job's completionMode=Indexed, and the Pod's restart\npolicy is Never. The field is immutable.\n+optional", "type": "integer" }, "completionMode": { "description": "completionMode specifies how Pod completions are tracked. It can be\n`NonIndexed` (default) or `Indexed`.\n\n`NonIndexed` means that the Job is considered complete when there have\nbeen .spec.completions successfully completed Pods. Each Pod completion is\nhomologous to each other.\n\n`Indexed` means that the Pods of a\nJob get an associated completion index from 0 to (.spec.completions - 1),\navailable in the annotation batch.kubernetes.io/job-completion-index.\nThe Job is considered complete when there is one successfully completed Pod\nfor each index.\nWhen value is `Indexed`, .spec.completions must be specified and\n`.spec.parallelism` must be less than or equal to 10^5.\nIn addition, The Pod name takes the form\n`$(job-name)-$(index)-$(random-string)`,\nthe Pod hostname takes the form `$(job-name)-$(index)`.\n\nMore completion modes can be added in the future.\nIf the Job controller observes a mode that it doesn't recognize, which\nis possible during upgrades due to version skew, the controller\nskips updates for the Job.\n+optional", "allOf": [ { "$ref": "#/definitions/V1CompletionMode" } ] }, "completions": { "description": "Specifies the desired number of successfully finished pods the\njob should be run with. Setting to null means that the success of any\npod signals the success of all pods, and allows parallelism to have any positive\nvalue. Setting to 1 means that parallelism is limited to 1 and the success of that\npod signals the success of the job.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/\n+optional", "type": "integer" }, "managedBy": { "description": "ManagedBy field indicates the controller that manages a Job. The k8s Job\ncontroller reconciles jobs which don't have this field at all or the field\nvalue is the reserved string `kubernetes.io/job-controller`, but skips\nreconciling Jobs with a custom value for this field.\nThe value must be a valid domain-prefixed path (e.g. acme.io/foo) -\nall characters before the first \"/\" must be a valid subdomain as defined\nby RFC 1123. All characters trailing the first \"/\" must be valid HTTP Path\ncharacters as defined by RFC 3986. The value cannot exceed 63 characters.\nThis field is immutable.\n+optional", "type": "string" }, "manualSelector": { "description": "manualSelector controls generation of pod labels and pod selectors.\nLeave `manualSelector` unset unless you are certain what you are doing.\nWhen false or unset, the system pick labels unique to this job\nand appends those labels to the pod template. When true,\nthe user is responsible for picking unique labels and specifying\nthe selector. Failure to pick a unique label may cause this\nand other jobs to not function correctly. However, You may see\n`manualSelector=true` in jobs that were created with the old `extensions/v1beta1`\nAPI.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector\n+optional", "type": "boolean" }, "maxFailedIndexes": { "description": "Specifies the maximal number of failed indexes before marking the Job as\nfailed, when backoffLimitPerIndex is set. Once the number of failed\nindexes exceeds this number the entire Job is marked as Failed and its\nexecution is terminated. When left as null the job continues execution of\nall of its indexes and is marked with the `Complete` Job condition.\nIt can only be specified when backoffLimitPerIndex is set.\nIt can be null or up to completions. It is required and must be\nless than or equal to 10^4 when is completions greater than 10^5.\n+optional", "type": "integer" }, "parallelism": { "description": "Specifies the maximum desired number of pods the job should\nrun at any given time. The actual number of pods running in steady state will\nbe less than this number when ((.spec.completions - .status.successful) < .spec.parallelism),\ni.e. when the work left to do is less than max parallelism.\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/\n+optional", "type": "integer" }, "podFailurePolicy": { "description": "Specifies the policy of handling failed pods. In particular, it allows to\nspecify the set of actions and conditions which need to be\nsatisfied to take the associated action.\nIf empty, the default behaviour applies - the counter of failed pods,\nrepresented by the jobs's .status.failed field, is incremented and it is\nchecked against the backoffLimit. This field cannot be used in combination\nwith restartPolicy=OnFailure.\n\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodFailurePolicy" } ] }, "podReplacementPolicy": { "description": "podReplacementPolicy specifies when to create replacement Pods.\nPossible values are:\n- TerminatingOrFailed means that we recreate pods\n when they are terminating (has a metadata.deletionTimestamp) or failed.\n- Failed means to wait until a previously created Pod is fully terminated (has phase\n Failed or Succeeded) before creating a replacement Pod.\n\nWhen using podFailurePolicy, Failed is the the only allowed value.\nTerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use.\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodReplacementPolicy" } ] }, "selector": { "description": "A label query over pods that should match the pod count.\nNormally, the system sets this field for you.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors\n+optional", "allOf": [ { "$ref": "#/definitions/V1LabelSelector" } ] }, "successPolicy": { "description": "successPolicy specifies the policy when the Job can be declared as succeeded.\nIf empty, the default behavior applies - the Job is declared as succeeded\nonly when the number of succeeded pods equals to the completions.\nWhen the field is specified, it must be immutable and works only for the Indexed Jobs.\nOnce the Job meets the SuccessPolicy, the lingering pods are terminated.\n\n+optional", "allOf": [ { "$ref": "#/definitions/V1SuccessPolicy" } ] }, "suspend": { "description": "suspend specifies whether the Job controller should create Pods or not. If\na Job is created with suspend set to true, no Pods are created by the Job\ncontroller. If a Job is suspended after creation (i.e. the flag goes from\nfalse to true), the Job controller will delete all active Pods associated\nwith this Job. Users must design their workload to gracefully handle this.\nSuspending a Job will reset the StartTime field of the Job, effectively\nresetting the ActiveDeadlineSeconds timer too. Defaults to false.\n\n+optional", "type": "boolean" }, "template": { "description": "Describes the pod that will be created when executing a job.\nThe only allowed template.spec.restartPolicy values are \"Never\" or \"OnFailure\".\nMore info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/", "allOf": [ { "$ref": "#/definitions/V1PodTemplateSpec" } ] }, "ttlSecondsAfterFinished": { "description": "ttlSecondsAfterFinished limits the lifetime of a Job that has finished\nexecution (either Complete or Failed). If this field is set,\nttlSecondsAfterFinished after the Job finishes, it is eligible to be\nautomatically deleted. When the Job is being deleted, its lifecycle\nguarantees (e.g. finalizers) will be honored. If this field is unset,\nthe Job won't be automatically deleted. If this field is set to zero,\nthe Job becomes eligible to be deleted immediately after it finishes.\n+optional", "type": "integer" } } }, "V1KeyToPath": { "type": "object", "properties": { "key": { "description": "key is the key to project.", "type": "string" }, "mode": { "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "path": { "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "type": "string" } } }, "V1LabelSelector": { "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1LabelSelectorRequirement" } }, "matchLabels": { "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\n+optional", "type": "object", "additionalProperties": { "type": "string" } } } }, "V1LabelSelectorRequirement": { "type": "object", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "V1Lifecycle": { "type": "object", "properties": { "postStart": { "description": "PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional", "allOf": [ { "$ref": "#/definitions/V1LifecycleHandler" } ] }, "preStop": { "description": "PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\n+optional", "allOf": [ { "$ref": "#/definitions/V1LifecycleHandler" } ] }, "stopSignal": { "description": "StopSignal defines which signal will be sent to a container when it is being stopped.\nIf not specified, the default is defined by the container runtime in use.\nStopSignal can only be set for Pods with a non-empty .spec.os.name\n+optional", "type": "string" } } }, "V1LifecycleHandler": { "type": "object", "properties": { "exec": { "description": "Exec specifies a command to execute in the container.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ExecAction" } ] }, "httpGet": { "description": "HTTPGet specifies an HTTP GET request to perform.\n+optional", "allOf": [ { "$ref": "#/definitions/V1HTTPGetAction" } ] }, "sleep": { "description": "Sleep represents a duration that the container should sleep.\n+optional", "allOf": [ { "$ref": "#/definitions/V1SleepAction" } ] }, "tcpSocket": { "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor backward compatibility. There is no validation of this field and\nlifecycle hooks will fail at runtime when it is specified.\n+optional", "allOf": [ { "$ref": "#/definitions/V1TCPSocketAction" } ] } } }, "V1ListMeta": { "type": "object", "properties": { "continue": { "description": "continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nconsistent list may not be possible if the server configuration has changed or more than a few\nminutes have passed. The resourceVersion field returned when using this continue value will be\nidentical to the value in the first response, unless you have received this token from an error\nmessage.", "type": "string" }, "remainingItemCount": { "description": "remainingItemCount is the number of subsequent items in the list which are not included in this\nlist response. If the list request contained label or field selectors, then the number of\nremaining items is unknown and the field will be left unset and omitted during serialization.\nIf the list is complete (either because it is not chunking or because this is the last chunk),\nthen there are no more remaining items and this field will be left unset and omitted during\nserialization.\nServers older than v1.15 do not set this field.\nThe intended use of the remainingItemCount is *estimating* the size of a collection. Clients\nshould not rely on the remainingItemCount to be set or to be exact.\n+optional", "type": "integer" }, "resourceVersion": { "description": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "shardInfo": { "description": "shardInfo is set when the list is a filtered subset of the full collection,\nas selected by a shard selector on the request. It echoes back the selector\nso clients can verify which shard they received and merge sharded responses.\nClients should not cache sharded list responses as a full representation\nof the collection.\n\nThis is an alpha field and requires enabling the ShardedListAndWatch feature gate.\n+featureGate=ShardedListAndWatch\n+optional", "allOf": [ { "$ref": "#/definitions/V1ShardInfo" } ] } } }, "V1LocalObjectReference": { "type": "object", "properties": { "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" } } }, "V1ManagedFieldsEntry": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the version of this resource that this field set\napplies to. The format is \"group/version\" just like the top-level\nAPIVersion field. It is necessary to track the version of a field\nset because it cannot be automatically converted.", "type": "string" }, "fieldsType": { "description": "FieldsType is the discriminator for the different fields format and version.\nThere is currently only one possible value: \"FieldsV1\"", "type": "string" }, "fieldsV1": { "description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.\n+optional", "allOf": [ { "$ref": "#/definitions/V1FieldsV1" } ] }, "manager": { "description": "Manager is an identifier of the workflow managing these fields.", "type": "string" }, "operation": { "description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created.\nThe only valid values for this field are 'Apply' and 'Update'.", "type": "string" }, "subresource": { "description": "Subresource is the name of the subresource used to update that object, or\nempty string if the object was updated through the main resource. The\nvalue of this field is used to distinguish between managers, even if they\nshare the same name. For example, a status update will be distinct from a\nregular update using the same manager name.\nNote that the APIVersion field is not related to the Subresource field and\nit always corresponds to the version of the main resource.", "type": "string" }, "time": { "description": "Time is the timestamp of when the ManagedFields entry was added. The\ntimestamp will also be updated if a field is added, the manager\nchanges any of the owned fields value or removes a field. The\ntimestamp does not update when a field is removed from the entry\nbecause another manager took it over.\n+optional", "type": "string" } } }, "V1NFSVolumeSource": { "type": "object", "properties": { "path": { "description": "path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" }, "readOnly": { "description": "readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional", "type": "boolean" }, "server": { "description": "server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" } } }, "V1NodeAffinity": { "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1PreferredSchedulingTerm" } }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node.\n+optional", "allOf": [ { "$ref": "#/definitions/V1NodeSelector" } ] } } }, "V1NodeSelector": { "type": "object", "properties": { "nodeSelectorTerms": { "description": "Required. A list of node selector terms. The terms are ORed.\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1NodeSelectorTerm" } } } }, "V1NodeSelectorRequirement": { "type": "object", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "V1NodeSelectorTerm": { "type": "object", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1NodeSelectorRequirement" } }, "matchFields": { "description": "A list of node selector requirements by node's fields.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1NodeSelectorRequirement" } } } }, "V1ObjectFieldSelector": { "type": "object", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".\n+optional", "type": "string" }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } } }, "V1ObjectMeta": { "type": "object", "properties": { "annotations": { "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "creationTimestamp": { "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system.\nRead-only.\nNull for lists.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "deletionGracePeriodSeconds": { "description": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional", "type": "integer" }, "deletionTimestamp": { "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "type": "string" }, "finalizers": { "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\nFinalizers may be processed and removed in any order. Order is NOT enforced\nbecause it introduces significant risk of stuck finalizers.\nfinalizers is a shared field, any actor with permission can reorder it.\nIf the finalizer list is processed in order, then this can lead to a situation\nin which the component responsible for the first finalizer in the list is\nwaiting for a signal (field value, external system, or other) produced by a\ncomponent responsible for a finalizer later in the list, resulting in a deadlock.\nWithout enforced ordering finalizers are free to order amongst themselves and\nare not vulnerable to ordering changes in the list.\n+optional\n+patchStrategy=merge\n+listType=set", "type": "array", "items": { "type": "string" } }, "generateName": { "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\n+optional", "type": "string" }, "generation": { "description": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional", "type": "integer" }, "labels": { "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "managedFields": { "description": "ManagedFields maps workflow-id and version to the set of fields\nthat are managed by that workflow. This is mostly for internal\nhousekeeping, and users typically shouldn't need to set or\nunderstand this field. A workflow can be the user's name, a\ncontroller's name, or the name of a specific apply path like\n\"ci-cd\". The set of fields is always in the version that the\nworkflow used when modifying the object.\n\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1ManagedFieldsEntry" } }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace defines the space within which each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces\n+optional", "type": "string" }, "ownerReferences": { "description": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge\n+listType=map\n+listMapKey=uid", "type": "array", "items": { "$ref": "#/definitions/V1OwnerReference" } }, "resourceVersion": { "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "selfLink": { "description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.\n+optional", "type": "string" }, "uid": { "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids\n+optional", "type": "string" } } }, "V1ObjectReference": { "type": "object", "properties": { "apiVersion": { "description": "API version of the referent.\n+optional", "type": "string" }, "fieldPath": { "description": "If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object.\nTODO: this design is not final and this field is subject to change in the future.\n+optional", "type": "string" }, "kind": { "description": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional", "type": "string" }, "namespace": { "description": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/\n+optional", "type": "string" }, "resourceVersion": { "description": "Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency\n+optional", "type": "string" }, "uid": { "description": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids\n+optional", "type": "string" } } }, "V1OwnerReference": { "type": "object", "properties": { "apiVersion": { "description": "API version of the referent.", "type": "string" }, "blockOwnerDeletion": { "description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nSee https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion\nfor how the garbage collector interacts with this field and enforces the foreground deletion.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional", "type": "boolean" }, "controller": { "description": "If true, this reference points to the managing controller.\n+optional", "type": "boolean" }, "kind": { "description": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "name": { "description": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names", "type": "string" }, "uid": { "description": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids", "type": "string" } } }, "V1PersistentVolumeClaimSpec": { "type": "object", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "dataSource": { "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.\n+optional", "allOf": [ { "$ref": "#/definitions/V1TypedLocalObjectReference" } ] }, "dataSourceRef": { "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+optional", "allOf": [ { "$ref": "#/definitions/V1TypedObjectReference" } ] }, "resources": { "description": "resources represents the minimum resources the volume should have.\nUsers are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources\n+optional", "allOf": [ { "$ref": "#/definitions/V1VolumeResourceRequirements" } ] }, "selector": { "description": "selector is a label query over volumes to consider for binding.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LabelSelector" } ] }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1\n+optional", "type": "string" }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string or nil value indicates that no\nVolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,\nthis field can be reset to its previous value (including nil) to cancel the modification.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n+featureGate=VolumeAttributesClass\n+optional", "type": "string" }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.\n+optional", "type": "string" }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.\n+optional", "type": "string" } } }, "V1PersistentVolumeClaimTemplate": { "type": "object", "properties": { "metadata": { "description": "May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation.\n\n+optional", "allOf": [ { "$ref": "#/definitions/V1ObjectMeta" } ] }, "spec": { "description": "The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here.", "allOf": [ { "$ref": "#/definitions/V1PersistentVolumeClaimSpec" } ] } } }, "V1PersistentVolumeClaimVolumeSource": { "type": "object", "properties": { "claimName": { "description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "type": "string" }, "readOnly": { "description": "readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false.\n+optional", "type": "boolean" } } }, "V1PhotonPersistentDiskVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "pdID": { "description": "pdID is the ID that identifies Photon Controller persistent disk", "type": "string" } } }, "V1PodAffinity": { "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1WeightedPodAffinityTerm" } }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1PodAffinityTerm" } } } }, "V1PodAffinityTerm": { "type": "object", "properties": { "labelSelector": { "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LabelSelector" } ] }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\n\n+listType=atomic\n+optional", "type": "array", "items": { "type": "string" } }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\n\n+listType=atomic\n+optional", "type": "array", "items": { "type": "string" } }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LabelSelector" } ] }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } } }, "V1PodAntiAffinity": { "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and subtracting\n\"weight\" from the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1WeightedPodAffinityTerm" } }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1PodAffinityTerm" } } } }, "V1PodCertificateProjection": { "type": "object", "properties": { "certificateChainPath": { "description": "Write the certificate chain at this path in the projected volume.\n\nMost applications should use credentialBundlePath. When using keyPath\nand certificateChainPath, your application needs to check that the key\nand leaf certificate are consistent, because it is possible to read the\nfiles mid-rotation.\n\n+optional", "type": "string" }, "credentialBundlePath": { "description": "Write the credential bundle at this path in the projected volume.\n\nThe credential bundle is a single file that contains multiple PEM blocks.\nThe first PEM block is a PRIVATE KEY block, containing a PKCS#8 private\nkey.\n\nThe remaining blocks are CERTIFICATE blocks, containing the issued\ncertificate chain from the signer (leaf and any intermediates).\n\nUsing credentialBundlePath lets your Pod's application code make a single\natomic read that retrieves a consistent key and certificate chain. If you\nproject them to separate files, your application code will need to\nadditionally check that the leaf certificate was issued to the key.\n\n+optional", "type": "string" }, "keyPath": { "description": "Write the key at this path in the projected volume.\n\nMost applications should use credentialBundlePath. When using keyPath\nand certificateChainPath, your application needs to check that the key\nand leaf certificate are consistent, because it is possible to read the\nfiles mid-rotation.\n\n+optional", "type": "string" }, "keyType": { "description": "The type of keypair Kubelet will generate for the pod.\n\nValid values are \"RSA3072\", \"RSA4096\", \"ECDSAP256\", \"ECDSAP384\",\n\"ECDSAP521\", and \"ED25519\".\n\n+required", "type": "string" }, "maxExpirationSeconds": { "description": "maxExpirationSeconds is the maximum lifetime permitted for the\ncertificate.\n\nKubelet copies this value verbatim into the PodCertificateRequests it\ngenerates for this projection.\n\nIf omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver\nwill reject values shorter than 3600 (1 hour). The maximum allowable\nvalue is 7862400 (91 days).\n\nThe signer implementation is then free to issue a certificate with any\nlifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600\nseconds (1 hour). This constraint is enforced by kube-apiserver.\n`kubernetes.io` signers will never issue certificates with a lifetime\nlonger than 24 hours.\n\n+optional", "type": "integer" }, "signerName": { "description": "Kubelet's generated CSRs will be addressed to this signer.\n\n+required", "type": "string" }, "userAnnotations": { "description": "userAnnotations allow pod authors to pass additional information to\nthe signer implementation. Kubernetes does not restrict or validate this\nmetadata in any way.\n\nThese values are copied verbatim into the `spec.unverifiedUserAnnotations` field of\nthe PodCertificateRequest objects that Kubelet creates.\n\nEntries are subject to the same validation as object metadata annotations,\nwith the addition that all keys must be domain-prefixed. No restrictions\nare placed on values, except an overall size limitation on the entire field.\n\nSigners should document the keys and values they support. Signers should\ndeny requests that contain keys they do not recognize.", "type": "object", "additionalProperties": { "type": "string" } } } }, "V1PodDNSConfig": { "type": "object", "properties": { "nameservers": { "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.\nDuplicated nameservers will be removed.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "options": { "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nDuplicated entries will be removed. Resolution options given in Options\nwill override those that appear in the base DNSPolicy.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1PodDNSConfigOption" } }, "searches": { "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.\nDuplicated search paths will be removed.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } } } }, "V1PodDNSConfigOption": { "type": "object", "properties": { "name": { "description": "Name is this DNS resolver option's name.\nRequired.", "type": "string" }, "value": { "description": "Value is this DNS resolver option's value.\n+optional", "type": "string" } } }, "V1PodFailurePolicy": { "type": "object", "properties": { "rules": { "description": "A list of pod failure policy rules. The rules are evaluated in order.\nOnce a rule matches a Pod failure, the remaining of the rules are ignored.\nWhen no rule matches the Pod failure, the default handling applies - the\ncounter of pod failures is incremented and it is checked against\nthe backoffLimit. At most 20 elements are allowed.\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1PodFailurePolicyRule" } } } }, "V1PodFailurePolicyAction": { "type": "string", "enum": [ "FailJob", "FailIndex", "Ignore", "Count" ], "x-enum-varnames": [ "PodFailurePolicyActionFailJob", "PodFailurePolicyActionFailIndex", "PodFailurePolicyActionIgnore", "PodFailurePolicyActionCount" ] }, "V1PodFailurePolicyOnExitCodesOperator": { "type": "string", "enum": [ "In", "NotIn" ], "x-enum-varnames": [ "PodFailurePolicyOnExitCodesOpIn", "PodFailurePolicyOnExitCodesOpNotIn" ] }, "V1PodFailurePolicyOnExitCodesRequirement": { "type": "object", "properties": { "containerName": { "description": "Restricts the check for exit codes to the container with the\nspecified name. When null, the rule applies to all containers.\nWhen specified, it should match one the container or initContainer\nnames in the pod template.\n+optional", "type": "string" }, "operator": { "description": "Represents the relationship between the container exit code(s) and the\nspecified values. Containers completed with success (exit code 0) are\nexcluded from the requirement check. Possible values are:\n\n- In: the requirement is satisfied if at least one container exit code\n (might be multiple if there are multiple containers not restricted\n by the 'containerName' field) is in the set of specified values.\n- NotIn: the requirement is satisfied if at least one container exit code\n (might be multiple if there are multiple containers not restricted\n by the 'containerName' field) is not in the set of specified values.\nAdditional values are considered to be added in the future. Clients should\nreact to an unknown operator by assuming the requirement is not satisfied.", "allOf": [ { "$ref": "#/definitions/V1PodFailurePolicyOnExitCodesOperator" } ] }, "values": { "description": "Specifies the set of values. Each returned container exit code (might be\nmultiple in case of multiple containers) is checked against this set of\nvalues with respect to the operator. The list of values must be ordered\nand must not contain duplicates. Value '0' cannot be used for the In operator.\nAt least one element is required. At most 255 elements are allowed.\n+listType=set", "type": "array", "items": { "type": "integer" } } } }, "V1PodFailurePolicyOnPodConditionsPattern": { "type": "object", "properties": { "status": { "description": "Specifies the required Pod condition status. To match a pod condition\nit is required that the specified status equals the pod condition status.\nDefaults to True.\n+optional", "type": "string" }, "type": { "description": "Specifies the required Pod condition type. To match a pod condition\nit is required that specified type equals the pod condition type.", "type": "string" } } }, "V1PodFailurePolicyRule": { "type": "object", "properties": { "action": { "description": "Specifies the action taken on a pod failure when the requirements are satisfied.\nPossible values are:\n\n- FailJob: indicates that the pod's job is marked as Failed and all\n running pods are terminated.\n- FailIndex: indicates that the pod's index is marked as Failed and will\n not be restarted.\n- Ignore: indicates that the counter towards the .backoffLimit is not\n incremented and a replacement pod is created.\n- Count: indicates that the pod is handled in the default way - the\n counter towards the .backoffLimit is incremented.\nAdditional values are considered to be added in the future. Clients should\nreact to an unknown action by skipping the rule.", "allOf": [ { "$ref": "#/definitions/V1PodFailurePolicyAction" } ] }, "onExitCodes": { "description": "Represents the requirement on the container exit codes.\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodFailurePolicyOnExitCodesRequirement" } ] }, "onPodConditions": { "description": "Represents the requirement on the pod conditions. The requirement is represented\nas a list of pod condition patterns. The requirement is satisfied if at\nleast one pattern matches an actual pod condition. At most 20 elements are allowed.\n+listType=atomic\n+optional", "type": "array", "items": { "$ref": "#/definitions/V1PodFailurePolicyOnPodConditionsPattern" } } } }, "V1PodOS": { "type": "object", "properties": { "name": { "description": "Name is the name of the operating system. The currently supported values are linux and windows.\nAdditional value may be defined in future and can be one of:\nhttps://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration\nClients should expect to handle additional values and treat unrecognized values in this field as os: null", "type": "string" } } }, "V1PodReadinessGate": { "type": "object", "properties": { "conditionType": { "description": "ConditionType refers to a condition in the pod's condition list with matching type.", "type": "string" } } }, "V1PodReplacementPolicy": { "type": "string", "enum": [ "TerminatingOrFailed", "Failed" ], "x-enum-varnames": [ "TerminatingOrFailed", "Failed" ] }, "V1PodResourceClaim": { "type": "object", "properties": { "name": { "description": "Name uniquely identifies this resource claim inside the pod.\nThis must be a DNS_LABEL.", "type": "string" }, "resourceClaimName": { "description": "ResourceClaimName is the name of a ResourceClaim object in the same\nnamespace as this pod.\n\nExactly one of ResourceClaimName and ResourceClaimTemplateName must\nbe set.", "type": "string" }, "resourceClaimTemplateName": { "description": "ResourceClaimTemplateName is the name of a ResourceClaimTemplate\nobject in the same namespace as this pod.\n\nThe template will be used to create a new ResourceClaim, which will\nbe bound to this pod. When this pod is deleted, the ResourceClaim\nwill also be deleted. The pod name and resource name, along with a\ngenerated component, will be used to form a unique name for the\nResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.\n\nWhen the DRAWorkloadResourceClaims feature gate is enabled and the pod\nbelongs to a PodGroup that defines a PodGroupResourceClaim with the same\nName and ResourceClaimTemplateName, this PodResourceClaim resolves to the\nResourceClaim generated for the PodGroup. All pods in the group that\ndefine an equivalent PodResourceClaim matching the\nPodGroupResourceClaim's Name and ResourceClaimTemplateName share the same\ngenerated ResourceClaim. ResourceClaims generated for a PodGroup are\nowned by the PodGroup and their lifecycles are tied to the PodGroup\ninstead of any individual pod.\n\nThis field is immutable and no changes will be made to the\ncorresponding ResourceClaim by the control plane after creating the\nResourceClaim.\n\nExactly one of ResourceClaimName and ResourceClaimTemplateName must\nbe set.", "type": "string" } } }, "V1PodSchedulingGate": { "type": "object", "properties": { "name": { "description": "Name of the scheduling gate.\nEach scheduling gate must have a unique name field.", "type": "string" } } }, "V1PodSchedulingGroup": { "type": "object", "properties": { "podGroupName": { "description": "PodGroupName specifies the name of the standalone PodGroup object\nthat represents the runtime instance of this group.\nMust be a DNS subdomain.\n\n+optional\n+oneOf=GroupSelection", "type": "string" } } }, "V1PodSecurityContext": { "type": "object", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/V1AppArmorProfile" } ] }, "fsGroup": { "description": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "integer" }, "fsGroupChangePolicy": { "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "string" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "integer" }, "seLinuxChangePolicy": { "description": "seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.\nIt has no effect on nodes that do not support SELinux or to volumes does not support SELinux.\nValid values are \"MountOption\" and \"Recursive\".\n\n\"Recursive\" means relabeling of all files on all Pod volumes by the container runtime.\nThis may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.\n\n\"MountOption\" mounts all eligible Pod volumes with `-o context` mount option.\nThis requires all Pods that share the same volume to use the same SELinux label.\nIt is not possible to share the same volume among privileged and unprivileged Pods.\nEligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes\nwhose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their\nCSIDriver instance. Other volumes are always re-labelled recursively.\n\"MountOption\" value is allowed only when SELinuxMount feature gate is enabled.\n\nIf not specified and SELinuxMount feature gate is enabled, \"MountOption\" is used.\nIf not specified and SELinuxMount feature gate is disabled, \"MountOption\" is used for ReadWriteOncePod volumes\nand \"Recursive\" for all other volumes.\n\nThis field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.\n\nAll Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.\nNote that this field cannot be set when spec.os.name is windows.\n+featureGate=SELinuxChangePolicy\n+optional", "type": "string" }, "seLinuxOptions": { "description": "The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/V1SELinuxOptions" } ] }, "seccompProfile": { "description": "The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/V1SeccompProfile" } ] }, "supplementalGroups": { "description": "A list of groups applied to the first process run in each container, in\naddition to the container's primary GID and fsGroup (if specified). If\nthe SupplementalGroupsPolicy feature is enabled, the\nsupplementalGroupsPolicy field determines whether these are in addition\nto or instead of any group memberships defined in the container image.\nIf unspecified, no additional groups are added, though group memberships\ndefined in the container image may still be used, depending on the\nsupplementalGroupsPolicy field.\nNote that this field cannot be set when spec.os.name is windows.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "integer" } }, "supplementalGroupsPolicy": { "description": "Defines how supplemental groups of the first container processes are calculated.\nValid values are \"Merge\" and \"Strict\". If not specified, \"Merge\" is used.\n(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled\nand the container runtime must implement support for this feature.\nNote that this field cannot be set when spec.os.name is windows.\nTODO: update the default value to \"Merge\" when spec.os.name is not windows in v1.34\n+featureGate=SupplementalGroupsPolicy\n+optional", "type": "string" }, "sysctls": { "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1Sysctl" } }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional", "allOf": [ { "$ref": "#/definitions/V1WindowsSecurityContextOptions" } ] } } }, "V1PodSpec": { "type": "object", "properties": { "activeDeadlineSeconds": { "description": "Optional duration in seconds the pod may be active on the node relative to\nStartTime before the system will actively try to mark it failed and kill associated containers.\nValue must be a positive integer.\n+optional", "type": "integer" }, "affinity": { "description": "If specified, the pod's scheduling constraints\n+optional", "allOf": [ { "$ref": "#/definitions/V1Affinity" } ] }, "automountServiceAccountToken": { "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.\n+optional", "type": "boolean" }, "containers": { "description": "List of containers belonging to the pod.\nContainers cannot currently be added or removed.\nThere must be at least one container in a Pod.\nCannot be updated.\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/V1Container" } }, "dnsConfig": { "description": "Specifies the DNS parameters of a pod.\nParameters specified here will be merged to the generated DNS\nconfiguration based on DNSPolicy.\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodDNSConfig" } ] }, "dnsPolicy": { "description": "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", "type": "string" }, "enableServiceLinks": { "description": "EnableServiceLinks indicates whether information about services should be injected into pod's\nenvironment variables, matching the syntax of Docker links.\nOptional: Defaults to true.\n+optional", "type": "boolean" }, "ephemeralContainers": { "description": "List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing\npod to perform user-initiated actions such as debugging. This list cannot be specified when\ncreating a pod, and it cannot be modified by updating the pod spec. In order to add an\nephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.\n+optional\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/V1EphemeralContainer" } }, "hostAliases": { "description": "HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts\nfile if specified.\n+optional\n+patchMergeKey=ip\n+patchStrategy=merge\n+listType=map\n+listMapKey=ip", "type": "array", "items": { "$ref": "#/definitions/V1HostAlias" } }, "hostIPC": { "description": "Use the host's ipc namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostNetwork": { "description": "Host networking requested for this pod. Use the host's network namespace.\nWhen using HostNetwork you should specify ports so the scheduler is aware.\nWhen `hostNetwork` is true, specified `hostPort` fields in port definitions must match `containerPort`,\nand unspecified `hostPort` fields in port definitions are defaulted to match `containerPort`.\nDefault to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostPID": { "description": "Use the host's pid namespace.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostUsers": { "description": "Use the host's user namespace.\nOptional: Default to true.\nIf set to true or not present, the pod will be run in the host user namespace, useful\nfor when the pod needs a feature only available to the host user namespace, such as\nloading a kernel module with CAP_SYS_MODULE.\nWhen set to false, a new userns is created for the pod. Setting false is useful for\nmitigating container breakout vulnerabilities even allowing users to run their\ncontainers as root without actually having root privileges on the host.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "hostname": { "description": "Specifies the hostname of the Pod\nIf not specified, the pod's hostname will be set to a system-defined value.\n+optional", "type": "string" }, "hostnameOverride": { "description": "HostnameOverride specifies an explicit override for the pod's hostname as perceived by the pod.\nThis field only specifies the pod's hostname and does not affect its DNS records.\nWhen this field is set to a non-empty string:\n- It takes precedence over the values set in `hostname` and `subdomain`.\n- The Pod's hostname will be set to this value.\n- `setHostnameAsFQDN` must be nil or set to false.\n- `hostNetwork` must be set to false.\n\nThis field must be a valid DNS subdomain as defined in RFC 1123 and contain at most 64 characters.\nRequires the HostnameOverride feature gate to be enabled.\n\n+featureGate=HostnameOverride\n+optional", "type": "string" }, "imagePullSecrets": { "description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.\nIf specified, these secrets will be passed to individual puller implementations for them to use.\nMore info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod\n+optional\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/V1LocalObjectReference" } }, "initContainers": { "description": "List of initialization containers belonging to the pod.\nInit containers are executed in order prior to containers being started. If any\ninit container fails, the pod is considered to have failed and is handled according\nto its restartPolicy. The name for an init container or normal container must be\nunique among all containers.\nInit containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.\nThe resourceRequirements of an init container are taken into account during scheduling\nby finding the highest request/limit for each resource type, and then using the max of\nthat 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\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/V1Container" } }, "nodeName": { "description": "NodeName indicates in which node this pod is scheduled.\nIf empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName.\nOnce this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod.\nThis field should not be used to express a desire for the pod to be scheduled on a specific node.\nhttps://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename\n+optional", "type": "string" }, "nodeSelector": { "description": "NodeSelector is a selector which must be true for the pod to fit on a node.\nSelector which must match a node's labels for the pod to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n+optional\n+mapType=atomic", "type": "object", "additionalProperties": { "type": "string" } }, "os": { "description": "Specifies the OS of the containers in the pod.\nSome pod and container fields are restricted if this is set.\n\nIf the OS field is set to linux, the following fields must be unset:\n-securityContext.windowsOptions\n\nIf the OS field is set to windows, following fields must be unset:\n- spec.hostPID\n- spec.hostIPC\n- spec.hostUsers\n- spec.resources\n- spec.securityContext.appArmorProfile\n- spec.securityContext.seLinuxOptions\n- spec.securityContext.seccompProfile\n- spec.securityContext.fsGroup\n- spec.securityContext.fsGroupChangePolicy\n- spec.securityContext.sysctls\n- spec.shareProcessNamespace\n- spec.securityContext.runAsUser\n- spec.securityContext.runAsGroup\n- spec.securityContext.supplementalGroups\n- spec.securityContext.supplementalGroupsPolicy\n- spec.containers[*].securityContext.appArmorProfile\n- spec.containers[*].securityContext.seLinuxOptions\n- spec.containers[*].securityContext.seccompProfile\n- spec.containers[*].securityContext.capabilities\n- spec.containers[*].securityContext.readOnlyRootFilesystem\n- spec.containers[*].securityContext.privileged\n- spec.containers[*].securityContext.allowPrivilegeEscalation\n- spec.containers[*].securityContext.procMount\n- spec.containers[*].securityContext.runAsUser\n- spec.containers[*].securityContext.runAsGroup\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodOS" } ] }, "overhead": { "description": "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/688-pod-overhead/README.md\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceList" } ] }, "preemptionPolicy": { "description": "PreemptionPolicy is the Policy for preempting pods with lower priority.\nOne of Never, PreemptLowerPriority.\nDefaults to PreemptLowerPriority if unset.\n+optional", "type": "string" }, "priority": { "description": "The priority value. Various system components use this field to find the\npriority of the pod. When Priority Admission Controller is enabled, it\nprevents users from setting this field. The admission controller populates\nthis field from PriorityClassName.\nThe higher the value, the higher the priority.\n+optional", "type": "integer" }, "priorityClassName": { "description": "If specified, indicates the pod's priority. \"system-node-critical\" and\n\"system-cluster-critical\" are two special keywords which indicate the\nhighest priorities with the former being the highest priority. Any other\nname must be defined by creating a PriorityClass object with that name.\nIf not specified, the pod priority will be default or zero if there is no\ndefault.\n+optional", "type": "string" }, "readinessGates": { "description": "If specified, all readiness gates will be evaluated for pod readiness.\nA pod is ready when all its containers are ready AND\nall conditions specified in the readiness gates have status equal to \"True\"\nMore info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1PodReadinessGate" } }, "resourceClaims": { "description": "ResourceClaims defines which ResourceClaims must be allocated\nand reserved before the Pod is allowed to start. The resources\nwill be made available to those containers which consume them\nby name.\n\nThis is a stable field but requires that the\nDynamicResourceAllocation feature gate is enabled.\n\nThis field is immutable.\n\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional", "type": "array", "items": { "$ref": "#/definitions/V1PodResourceClaim" } }, "resources": { "description": "Resources is the total amount of CPU and Memory resources required by all\ncontainers in the pod. It supports specifying Requests and Limits for\n\"cpu\", \"memory\" and \"hugepages-\" resource names only. ResourceClaims are not supported.\n\nThis field enables fine-grained control over resource allocation for the\nentire pod, allowing resource sharing among containers in a pod.\nTODO: For beta graduation, expand this comment with a detailed explanation.\n\nThis is an alpha field and requires enabling the PodLevelResources feature\ngate.\n\n+featureGate=PodLevelResources\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceRequirements" } ] }, "restartPolicy": { "description": "Restart policy for all containers within the pod.\nOne of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted.\nDefault to Always.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy\n+optional", "type": "string" }, "runtimeClassName": { "description": "RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used\nto run this pod. If no RuntimeClass resource matches the named class, the pod will not be run.\nIf unset or empty, the \"legacy\" RuntimeClass will be used, which is an implicit class with an\nempty definition that uses the default runtime handler.\nMore info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class\n+optional", "type": "string" }, "schedulerName": { "description": "If specified, the pod will be dispatched by specified scheduler.\nIf not specified, the pod will be dispatched by default scheduler.\n+optional", "type": "string" }, "schedulingGates": { "description": "SchedulingGates is an opaque list of values that if specified will block scheduling the pod.\nIf schedulingGates is not empty, the pod will stay in the SchedulingGated state and the\nscheduler will not attempt to schedule the pod.\n\nSchedulingGates can only be set at pod creation time, and be removed only afterwards.\n\n+patchMergeKey=name\n+patchStrategy=merge\n+listType=map\n+listMapKey=name\n+optional", "type": "array", "items": { "$ref": "#/definitions/V1PodSchedulingGate" } }, "schedulingGroup": { "description": "SchedulingGroup provides a reference to the immediate scheduling runtime\ngrouping object that this Pod belongs to.\nThis field is used by the scheduler to identify the group and apply the\ncorrect group scheduling policies. The association with a group also\nimpacts other lifecycle aspects of a Pod that are relevant in a wider context\nof scheduling like preemption, resource attachment, etc. If not specified,\nthe Pod is treated as a single unit in all of these aspects.\nThe group object referenced by this field may not exist at the time the\nPod is created.\nThis field is immutable, but a group object with the same name may be\nrecreated with different policies. Doing this during pod scheduling\nmay result in the placement not conforming to the expected policies.\n\n+featureGate=GenericWorkload\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodSchedulingGroup" } ] }, "securityContext": { "description": "SecurityContext holds pod-level security attributes and common container settings.\nOptional: Defaults to empty. See type description for default values of each field.\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodSecurityContext" } ] }, "serviceAccount": { "description": "DeprecatedServiceAccount is a deprecated alias for ServiceAccountName.\nDeprecated: Use serviceAccountName instead.\n+k8s:conversion-gen=false\n+optional", "type": "string" }, "serviceAccountName": { "description": "ServiceAccountName is the name of the ServiceAccount to use to run this pod.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional", "type": "string" }, "setHostnameAsFQDN": { "description": "If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).\nIn Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).\nIn Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\\\SYSTEM\\\\CurrentControlSet\\\\Services\\\\Tcpip\\\\Parameters to FQDN.\nIf a pod does not have FQDN, this has no effect.\nDefault to false.\n+optional", "type": "boolean" }, "shareProcessNamespace": { "description": "Share a single process namespace between all of the containers in a pod.\nWhen this is set containers will be able to view and signal processes from other containers\nin the same pod, and the first process in each container will not be assigned PID 1.\nHostPID and ShareProcessNamespace cannot both be set.\nOptional: Default to false.\n+k8s:conversion-gen=false\n+optional", "type": "boolean" }, "subdomain": { "description": "If specified, the fully qualified Pod hostname will be \"...svc.\".\nIf not specified, the pod will not have a domainname at all.\n+optional", "type": "string" }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nIf this value is nil, the default grace period will be used instead.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nDefaults to 30 seconds.\n+optional", "type": "integer" }, "tolerations": { "description": "If specified, the pod's tolerations.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1Toleration" } }, "topologySpreadConstraints": { "description": "TopologySpreadConstraints describes how a group of pods ought to spread across topology\ndomains. Scheduler will schedule pods in a way which abides by the constraints.\nAll topologySpreadConstraints are ANDed.\n+optional\n+patchMergeKey=topologyKey\n+patchStrategy=merge\n+listType=map\n+listMapKey=topologyKey\n+listMapKey=whenUnsatisfiable", "type": "array", "items": { "$ref": "#/definitions/V1TopologySpreadConstraint" } }, "volumes": { "description": "List of volumes that can be mounted by containers belonging to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes\n+optional\n+patchMergeKey=name\n+patchStrategy=merge,retainKeys\n+listType=map\n+listMapKey=name", "type": "array", "items": { "$ref": "#/definitions/V1Volume" } } } }, "V1PodTemplateSpec": { "type": "object", "properties": { "metadata": { "description": "Standard object's metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "allOf": [ { "$ref": "#/definitions/V1ObjectMeta" } ] }, "spec": { "description": "Specification of the desired behavior of the pod.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodSpec" } ] } } }, "V1PolicyRule": { "type": "object", "properties": { "apiGroups": { "description": "APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of\nthe enumerated resources in any API group will be allowed. \"\" represents the core API group and \"*\" represents all API groups.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "nonResourceURLs": { "description": "NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path\nSince non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding.\nRules can either apply to API resources (such as \"pods\" or \"secrets\") or non-resource URL paths (such as \"/api\"), but not both.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "resourceNames": { "description": "ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "resources": { "description": "Resources is a list of resources this rule applies to. '*' represents all resources.\n+optional\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "verbs": { "description": "Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.\n+listType=atomic\n+required\n+k8s:alpha(since: \"1.36\")=+k8s:required", "type": "array", "items": { "type": "string" } } } }, "V1PortworxVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "volumeID": { "description": "volumeID uniquely identifies a Portworx volume", "type": "string" } } }, "V1PreferredSchedulingTerm": { "type": "object", "properties": { "preference": { "description": "A node selector term, associated with the corresponding weight.", "allOf": [ { "$ref": "#/definitions/V1NodeSelectorTerm" } ] }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "type": "integer" } } }, "V1Probe": { "type": "object", "properties": { "exec": { "description": "Exec specifies a command to execute in the container.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ExecAction" } ] }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.\n+optional", "type": "integer" }, "grpc": { "description": "GRPC specifies a GRPC HealthCheckRequest.\n+optional", "allOf": [ { "$ref": "#/definitions/V1GRPCAction" } ] }, "httpGet": { "description": "HTTPGet specifies an HTTP GET request to perform.\n+optional", "allOf": [ { "$ref": "#/definitions/V1HTTPGetAction" } ] }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "type": "integer" }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.\n+optional", "type": "integer" }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.\n+optional", "type": "integer" }, "tcpSocket": { "description": "TCPSocket specifies a connection to a TCP port.\n+optional", "allOf": [ { "$ref": "#/definitions/V1TCPSocketAction" } ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\n+optional", "type": "integer" }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\n+optional", "type": "integer" } } }, "V1ProjectedVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "sources": { "description": "sources is the list of volume projections. Each entry in this list\nhandles one source.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1VolumeProjection" } } } }, "V1QuobyteVolumeSource": { "type": "object", "properties": { "group": { "description": "group to map volume access to\nDefault is no group\n+optional", "type": "string" }, "readOnly": { "description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.\n+optional", "type": "boolean" }, "registry": { "description": "registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes", "type": "string" }, "tenant": { "description": "tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin\n+optional", "type": "string" }, "user": { "description": "user to map volume access to\nDefaults to serivceaccount user\n+optional", "type": "string" }, "volume": { "description": "volume is a string that references an already created Quobyte volume by name.", "type": "string" } } }, "V1RBDVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine\n+optional", "type": "string" }, "image": { "description": "image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" }, "keyring": { "description": "keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional\n+default=\"/etc/ceph/keyring\"", "type": "string" }, "monitors": { "description": "monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+listType=atomic", "type": "array", "items": { "type": "string" } }, "pool": { "description": "pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional\n+default=\"rbd\"", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef is name of the authentication secret for RBDUser. If provided\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "user": { "description": "user is the rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it\n+optional\n+default=\"admin\"", "type": "string" } } }, "V1ResourceFieldSelector": { "type": "object", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars\n+optional", "type": "string" }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"\n+optional", "type": "string" }, "resource": { "description": "Required: resource to select", "type": "string" } } }, "V1ResourceList": { "type": "object", "additionalProperties": { "type": "string" } }, "V1ResourceRequirements": { "type": "object", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.\n\n+listType=map\n+listMapKey=name\n+featureGate=DynamicResourceAllocation\n+optional", "type": "array", "items": { "$ref": "#/definitions/V1ResourceClaim" } }, "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceList" } ] }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceList" } ] } } }, "V1SELinuxOptions": { "type": "object", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.\n+optional", "type": "string" }, "role": { "description": "Role is a SELinux role label that applies to the container.\n+optional", "type": "string" }, "type": { "description": "Type is a SELinux type label that applies to the container.\n+optional", "type": "string" }, "user": { "description": "User is a SELinux user label that applies to the container.\n+optional", "type": "string" } } }, "V1ScaleIOVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".\n+optional\n+default=\"xfs\"", "type": "string" }, "gateway": { "description": "gateway is the host address of the ScaleIO API Gateway.", "type": "string" }, "protectionDomain": { "description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.\n+optional", "type": "string" }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail.", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "sslEnabled": { "description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false\n+optional", "type": "boolean" }, "storageMode": { "description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.\n+optional\n+default=\"ThinProvisioned\"", "type": "string" }, "storagePool": { "description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.\n+optional", "type": "string" }, "system": { "description": "system is the name of the storage system as configured in ScaleIO.", "type": "string" }, "volumeName": { "description": "volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source.", "type": "string" } } }, "V1SeccompProfile": { "type": "object", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.\n+optional", "type": "string" }, "type": { "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.\n+unionDiscriminator", "type": "string" } } }, "V1Secret": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "data": { "description": "Data contains the secret data. Each key must consist of alphanumeric\ncharacters, '-', '_' or '.'. The serialized form of the secret data is a\nbase64 encoded string, representing the arbitrary (possibly non-string)\ndata value here. Described in https://tools.ietf.org/html/rfc4648#section-4\n+optional", "type": "object", "additionalProperties": { "type": "string", "format": "byte" } }, "immutable": { "description": "Immutable, if set to true, ensures that data stored in the Secret cannot\nbe updated (only object metadata can be modified).\nIf not set to true, the field can be modified at any time.\nDefaulted to nil.\n+optional", "type": "boolean" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "description": "Standard object's metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata\n+optional", "allOf": [ { "$ref": "#/definitions/V1ObjectMeta" } ] }, "stringData": { "description": "stringData allows specifying non-binary secret data in string form.\nIt is provided as a write-only input field for convenience.\nAll keys and values are merged into the data field on write, overwriting any existing values.\nThe stringData field is never output when reading from the API.\n+k8s:conversion-gen=false\n+optional", "type": "object", "additionalProperties": { "type": "string" } }, "type": { "description": "Used to facilitate programmatic handling of secret data.\nMore info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types\n+optional", "type": "string" } } }, "V1SecretEnvSource": { "type": "object", "properties": { "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "Specify whether the Secret must be defined\n+optional", "type": "boolean" } } }, "V1SecretKeySelector": { "type": "object", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "Specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } } }, "V1SecretList": { "type": "object", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources\n+optional", "type": "string" }, "items": { "description": "Items is a list of secret objects.\nMore info: https://kubernetes.io/docs/concepts/configuration/secret", "type": "array", "items": { "$ref": "#/definitions/V1Secret" } }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "type": "string" }, "metadata": { "description": "Standard list metadata.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\n+optional", "allOf": [ { "$ref": "#/definitions/V1ListMeta" } ] } } }, "V1SecretProjection": { "type": "object", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1KeyToPath" } }, "name": { "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional\n+default=\"\"\n+kubebuilder:default=\"\"\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.", "type": "string" }, "optional": { "description": "optional field specify whether the Secret or its key must be defined\n+optional", "type": "boolean" } } }, "V1SecretVolumeSource": { "type": "object", "properties": { "defaultMode": { "description": "defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.\n+optional", "type": "integer" }, "items": { "description": "items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.\n+optional\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1KeyToPath" } }, "optional": { "description": "optional field specify whether the Secret or its keys must be defined\n+optional", "type": "boolean" }, "secretName": { "description": "secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional", "type": "string" } } }, "V1SecurityContext": { "type": "object", "properties": { "allowPrivilegeEscalation": { "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "boolean" }, "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/V1AppArmorProfile" } ] }, "capabilities": { "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/V1Capabilities" } ] }, "privileged": { "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "boolean" }, "procMount": { "description": "procMount denotes the type of proc mount to use for the containers.\nThe default value is Default which uses the container runtime defaults for\nreadonly paths and masked paths.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "string" }, "readOnlyRootFilesystem": { "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "boolean" }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "integer" }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "boolean" }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "type": "integer" }, "seLinuxOptions": { "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/V1SELinuxOptions" } ] }, "seccompProfile": { "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.\n+optional", "allOf": [ { "$ref": "#/definitions/V1SeccompProfile" } ] }, "windowsOptions": { "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.\n+optional", "allOf": [ { "$ref": "#/definitions/V1WindowsSecurityContextOptions" } ] } } }, "V1ServiceAccountTokenProjection": { "type": "object", "properties": { "audience": { "description": "audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.\n+optional", "type": "string" }, "expirationSeconds": { "description": "expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.\n+optional", "type": "integer" }, "path": { "description": "path is the path relative to the mount point of the file to project the\ntoken into.", "type": "string" } } }, "V1ShardInfo": { "type": "object", "properties": { "selector": { "description": "selector is the shard selector string from the request, echoed back so clients\ncan verify which shard they received and merge responses from multiple shards.\n+required", "type": "string" } } }, "V1SleepAction": { "type": "object", "properties": { "seconds": { "description": "Seconds is the number of seconds to sleep.", "type": "integer" } } }, "V1StorageOSVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "type": "string" }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\n+optional", "type": "boolean" }, "secretRef": { "description": "secretRef specifies the secret to use for obtaining the StorageOS API\ncredentials. If not specified, default values will be attempted.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LocalObjectReference" } ] }, "volumeName": { "description": "volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace.", "type": "string" }, "volumeNamespace": { "description": "volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.\n+optional", "type": "string" } } }, "V1SuccessPolicy": { "type": "object", "properties": { "rules": { "description": "rules represents the list of alternative rules for the declaring the Jobs\nas successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met,\nthe \"SuccessCriteriaMet\" condition is added, and the lingering pods are removed.\nThe terminal state for such a Job has the \"Complete\" condition.\nAdditionally, these rules are evaluated in order; Once the Job meets one of the rules,\nother rules are ignored. At most 20 elements are allowed.\n+listType=atomic", "type": "array", "items": { "$ref": "#/definitions/V1SuccessPolicyRule" } } } }, "V1SuccessPolicyRule": { "type": "object", "properties": { "succeededCount": { "description": "succeededCount specifies the minimal required size of the actual set of the succeeded indexes\nfor the Job. When succeededCount is used along with succeededIndexes, the check is\nconstrained only to the set of indexes specified by succeededIndexes.\nFor example, given that succeededIndexes is \"1-4\", succeededCount is \"3\",\nand completed indexes are \"1\", \"3\", and \"5\", the Job isn't declared as succeeded\nbecause only \"1\" and \"3\" indexes are considered in that rules.\nWhen this field is null, this doesn't default to any value and\nis never evaluated at any time.\nWhen specified it needs to be a positive integer.\n\n+optional", "type": "integer" }, "succeededIndexes": { "description": "succeededIndexes specifies the set of indexes\nwhich need to be contained in the actual set of the succeeded indexes for the Job.\nThe list of indexes must be within 0 to \".spec.completions-1\" and\nmust not contain duplicates. At least one element is required.\nThe indexes are represented as intervals separated by commas.\nThe intervals can be a decimal integer or a pair of decimal integers separated by a hyphen.\nThe number are listed in represented by the first and last element of the series,\nseparated by a hyphen.\nFor example, if the completed indexes are 1, 3, 4, 5 and 7, they are\nrepresented as \"1,3-5,7\".\nWhen this field is null, this field doesn't default to any value\nand is never evaluated at any time.\n\n+optional", "type": "string" } } }, "V1Sysctl": { "type": "object", "properties": { "name": { "description": "Name of a property to set", "type": "string" }, "value": { "description": "Value of a property to set", "type": "string" } } }, "V1TCPSocketAction": { "type": "object", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.\n+optional", "type": "string" }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." } } }, "V1Toleration": { "type": "object", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\n+optional", "type": "string" }, "key": { "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.\n+optional", "type": "string" }, "operator": { "description": "Operator represents a key's relationship to the value.\nValid operators are Exists, Equal, Lt, and Gt. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.\nLt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).\n+optional", "type": "string" }, "tolerationSeconds": { "description": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.\n+optional", "type": "integer" }, "value": { "description": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.\n+optional", "type": "string" } } }, "V1TopologySpreadConstraint": { "type": "object", "properties": { "labelSelector": { "description": "LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain.\n+optional", "allOf": [ { "$ref": "#/definitions/V1LabelSelector" } ] }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\n+listType=atomic\n+optional", "type": "array", "items": { "type": "string" } }, "maxSkew": { "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P | P P | P |\n+-------+-------+-------+\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\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.", "type": "integer" }, "minDomains": { "description": "MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n+-------+-------+-------+\n| zone1 | zone2 | zone3 |\n+-------+-------+-------+\n| P P | P P | P P |\n+-------+-------+-------+\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew.\n+optional", "type": "integer" }, "nodeAffinityPolicy": { "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy.\n+optional", "type": "string" }, "nodeTaintsPolicy": { "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.\n+optional", "type": "string" }, "topologyKey": { "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field.", "type": "string" }, "whenUnsatisfiable": { "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 assignment 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.", "type": "string" } } }, "V1TypedLocalObjectReference": { "type": "object", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" } } }, "V1TypedObjectReference": { "type": "object", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.\n+optional", "type": "string" }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" }, "namespace": { "description": "Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\n+featureGate=CrossNamespaceVolumeDataSource\n+optional", "type": "string" } } }, "V1Volume": { "type": "object", "properties": { "awsElasticBlockStore": { "description": "awsElasticBlockStore represents an AWS Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nDeprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree\nawsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\n+optional", "allOf": [ { "$ref": "#/definitions/V1AWSElasticBlockStoreVolumeSource" } ] }, "azureDisk": { "description": "azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.\nDeprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type\nare redirected to the disk.csi.azure.com CSI driver.\n+optional", "allOf": [ { "$ref": "#/definitions/V1AzureDiskVolumeSource" } ] }, "azureFile": { "description": "azureFile represents an Azure File Service mount on the host and bind mount to the pod.\nDeprecated: AzureFile is deprecated. All operations for the in-tree azureFile type\nare redirected to the file.csi.azure.com CSI driver.\n+optional", "allOf": [ { "$ref": "#/definitions/V1AzureFileVolumeSource" } ] }, "cephfs": { "description": "cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.\nDeprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1CephFSVolumeSource" } ] }, "cinder": { "description": "cinder represents a cinder volume attached and mounted on kubelets host machine.\nDeprecated: Cinder is deprecated. All operations for the in-tree cinder type\nare redirected to the cinder.csi.openstack.org CSI driver.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md\n+optional", "allOf": [ { "$ref": "#/definitions/V1CinderVolumeSource" } ] }, "configMap": { "description": "configMap represents a configMap that should populate this volume\n+optional", "allOf": [ { "$ref": "#/definitions/V1ConfigMapVolumeSource" } ] }, "csi": { "description": "csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.\n+optional", "allOf": [ { "$ref": "#/definitions/V1CSIVolumeSource" } ] }, "downwardAPI": { "description": "downwardAPI represents downward API about the pod that should populate this volume\n+optional", "allOf": [ { "$ref": "#/definitions/V1DownwardAPIVolumeSource" } ] }, "emptyDir": { "description": "emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\n+optional", "allOf": [ { "$ref": "#/definitions/V1EmptyDirVolumeSource" } ] }, "ephemeral": { "description": "ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time.\n\n+optional", "allOf": [ { "$ref": "#/definitions/V1EphemeralVolumeSource" } ] }, "fc": { "description": "fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\n+optional", "allOf": [ { "$ref": "#/definitions/V1FCVolumeSource" } ] }, "flexVolume": { "description": "flexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.\nDeprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.\n+optional", "allOf": [ { "$ref": "#/definitions/V1FlexVolumeSource" } ] }, "flocker": { "description": "flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.\nDeprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1FlockerVolumeSource" } ] }, "gcePersistentDisk": { "description": "gcePersistentDisk represents a GCE Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nDeprecated: GCEPersistentDisk is deprecated. All operations for the in-tree\ngcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\n+optional", "allOf": [ { "$ref": "#/definitions/V1GCEPersistentDiskVolumeSource" } ] }, "gitRepo": { "description": "gitRepo represents a git repository at a particular revision.\nDeprecated: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container.\n+optional", "allOf": [ { "$ref": "#/definitions/V1GitRepoVolumeSource" } ] }, "glusterfs": { "description": "glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nDeprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1GlusterfsVolumeSource" } ] }, "hostPath": { "description": "hostPath represents a pre-existing file or directory on the host\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write.\n+optional", "allOf": [ { "$ref": "#/definitions/V1HostPathVolumeSource" } ] }, "image": { "description": "image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.\nThe volume is resolved at pod startup depending on which PullPolicy value is provided:\n\n- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.\n- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.\n- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\n\nThe volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.\nA failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.\nThe types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.\nThe OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.\nThe volume will be mounted read-only (ro).\nSub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.\nThe field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ImageVolumeSource" } ] }, "iscsi": { "description": "iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi\n+optional", "allOf": [ { "$ref": "#/definitions/V1ISCSIVolumeSource" } ] }, "name": { "description": "name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "nfs": { "description": "nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\n+optional", "allOf": [ { "$ref": "#/definitions/V1NFSVolumeSource" } ] }, "persistentVolumeClaim": { "description": "persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional", "allOf": [ { "$ref": "#/definitions/V1PersistentVolumeClaimVolumeSource" } ] }, "photonPersistentDisk": { "description": "photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.\nDeprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.", "allOf": [ { "$ref": "#/definitions/V1PhotonPersistentDiskVolumeSource" } ] }, "portworxVolume": { "description": "portworxVolume represents a portworx volume attached and mounted on kubelets host machine.\nDeprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type\nare redirected to the pxd.portworx.com CSI driver.\n+optional", "allOf": [ { "$ref": "#/definitions/V1PortworxVolumeSource" } ] }, "projected": { "description": "projected items for all in one resources secrets, configmaps, and downward API", "allOf": [ { "$ref": "#/definitions/V1ProjectedVolumeSource" } ] }, "quobyte": { "description": "quobyte represents a Quobyte mount on the host that shares a pod's lifetime.\nDeprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1QuobyteVolumeSource" } ] }, "rbd": { "description": "rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\nDeprecated: RBD is deprecated and the in-tree rbd type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1RBDVolumeSource" } ] }, "scaleIO": { "description": "scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.\nDeprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1ScaleIOVolumeSource" } ] }, "secret": { "description": "secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\n+optional", "allOf": [ { "$ref": "#/definitions/V1SecretVolumeSource" } ] }, "storageos": { "description": "storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.\nDeprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.\n+optional", "allOf": [ { "$ref": "#/definitions/V1StorageOSVolumeSource" } ] }, "vsphereVolume": { "description": "vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.\nDeprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type\nare redirected to the csi.vsphere.vmware.com CSI driver.\n+optional", "allOf": [ { "$ref": "#/definitions/V1VsphereVirtualDiskVolumeSource" } ] } } }, "V1VolumeDevice": { "type": "object", "properties": { "devicePath": { "description": "devicePath is the path inside of the container that the device will be mapped to.", "type": "string" }, "name": { "description": "name must match the name of a persistentVolumeClaim in the pod", "type": "string" } } }, "V1VolumeMount": { "type": "object", "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None).\n+optional", "type": "string" }, "name": { "description": "This must match the Name of a Volume.", "type": "string" }, "readOnly": { "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.\n+optional", "type": "boolean" }, "recursiveReadOnly": { "description": "RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.\n+optional", "type": "string" }, "subPath": { "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).\n+optional", "type": "string" }, "subPathExpr": { "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.\n+optional", "type": "string" } } }, "V1VolumeProjection": { "type": "object", "properties": { "clusterTrustBundle": { "description": "ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time.\n\n+featureGate=ClusterTrustBundleProjection\n+optional", "allOf": [ { "$ref": "#/definitions/V1ClusterTrustBundleProjection" } ] }, "configMap": { "description": "configMap information about the configMap data to project\n+optional", "allOf": [ { "$ref": "#/definitions/V1ConfigMapProjection" } ] }, "downwardAPI": { "description": "downwardAPI information about the downwardAPI data to project\n+optional", "allOf": [ { "$ref": "#/definitions/V1DownwardAPIProjection" } ] }, "podCertificate": { "description": "Projects an auto-rotating credential bundle (private key and certificate\nchain) that the pod can use either as a TLS client or server.\n\nKubelet generates a private key and uses it to send a\nPodCertificateRequest to the named signer. Once the signer approves the\nrequest and issues a certificate chain, Kubelet writes the key and\ncertificate chain to the pod filesystem. The pod does not start until\ncertificates have been issued for each podCertificate projected volume\nsource in its spec.\n\nKubelet will begin trying to rotate the certificate at the time indicated\nby the signer using the PodCertificateRequest.Status.BeginRefreshAt\ntimestamp.\n\nKubelet can write a single file, indicated by the credentialBundlePath\nfield, or separate files, indicated by the keyPath and\ncertificateChainPath fields.\n\nThe credential bundle is a single file in PEM format. The first PEM\nentry is the private key (in PKCS#8 format), and the remaining PEM\nentries are the certificate chain issued by the signer (typically,\nsigners will return their certificate chain in leaf-to-root order).\n\nPrefer using the credential bundle format, since your application code\ncan read it atomically. If you use keyPath and certificateChainPath,\nyour application must make two separate file reads. If these coincide\nwith a certificate rotation, it is possible that the private key and leaf\ncertificate you read may not correspond to each other. Your application\nwill need to check for this condition, and re-read until they are\nconsistent.\n\nThe named signer controls chooses the format of the certificate it\nissues; consult the signer implementation's documentation to learn how to\nuse the certificates it issues.\n\n+featureGate=PodCertificateProjection\n+optional", "allOf": [ { "$ref": "#/definitions/V1PodCertificateProjection" } ] }, "secret": { "description": "secret information about the secret data to project\n+optional", "allOf": [ { "$ref": "#/definitions/V1SecretProjection" } ] }, "serviceAccountToken": { "description": "serviceAccountToken is information about the serviceAccountToken data to project\n+optional", "allOf": [ { "$ref": "#/definitions/V1ServiceAccountTokenProjection" } ] } } }, "V1VolumeResourceRequirements": { "type": "object", "properties": { "limits": { "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceList" } ] }, "requests": { "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n+optional", "allOf": [ { "$ref": "#/definitions/V1ResourceList" } ] } } }, "V1VsphereVirtualDiskVolumeSource": { "type": "object", "properties": { "fsType": { "description": "fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\n+optional", "type": "string" }, "storagePolicyID": { "description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.\n+optional", "type": "string" }, "storagePolicyName": { "description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.\n+optional", "type": "string" }, "volumePath": { "description": "volumePath is the path that identifies vSphere volume vmdk", "type": "string" } } }, "V1WeightedPodAffinityTerm": { "type": "object", "properties": { "podAffinityTerm": { "description": "Required. A pod affinity term, associated with the corresponding weight.", "allOf": [ { "$ref": "#/definitions/V1PodAffinityTerm" } ] }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "type": "integer" } } }, "V1WindowsSecurityContextOptions": { "type": "object", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.\n+optional", "type": "string" }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.\n+optional", "type": "string" }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\n+optional", "type": "boolean" }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\n+optional", "type": "string" } } } }, "securityDefinitions": { "BearerAuth": { "description": "Bearer token authentication. Obtain token via OIDC/PKCE flow with your identity provider.", "type": "apiKey", "name": "Authorization", "in": "header" } }, "tags": [ { "description": "Manage the primary Kargo resources that make up a promotion pipeline: Projects (tenancy boundaries), Warehouses (artifact sources), Freight (versioned artifact bundles), Stages (promotion targets), and Promotions (records of a Freight moving through a Stage).", "name": "Core" }, { "description": "Cluster-wide administrative operations for Kargo operators: retrieving server and API version info, authenticating as the built-in admin user, and reading or modifying cluster-level server configuration.", "name": "System" }, { "description": "Manage Kargo's role-based access control model. Kargo Roles are named collections of Kubernetes RBAC rules scoped to a project; API tokens are service-account-backed credentials that can be bound to a Role for non-human access.", "name": "Rbac" }, { "description": "Top-level grouping for all credential types that Kargo uses to authenticate with external systems. See the Repo Credentials and Generic Credentials sub-tags for the specific credential kinds.", "name": "Credentials" }, { "description": "Interact with Argo Rollouts AnalysisRun and AnalysisTemplate resources used to verify Stage health after a promotion. Includes triggering, aborting, and re-running analysis, as well as reading run logs.", "name": "Verifications" }, { "description": "Low-level operations for creating, updating, and deleting arbitrary Kargo Kubernetes resources by raw manifest. Useful for tooling that needs to manage resource types not covered by dedicated endpoints.", "name": "Resources" }, { "description": "Read Kubernetes Events emitted by Kargo controllers. Events record notable state transitions (e.g. a Promotion starting, completing, or failing) and are useful for auditing and debugging.", "name": "Events" }, { "description": "Manage structured configuration resources: ProjectConfig holds per-project promotion policy settings; ClusterConfig holds cluster-wide defaults and feature flags applied by the Kargo operator.", "name": "Config" }, { "description": "Manage free-form ConfigMap-backed configuration that Kargo promotion steps can read at runtime. Supports project-scoped, system-scoped, and shared ConfigMaps, allowing pipelines to consume environment-specific values without embedding them in Git.", "name": "Generic Config" }, { "description": "Credentials for authenticating with artifact repositories: Git repositories, Helm chart registries, and container image registries. Kargo uses these when polling for new artifacts and when running promotion steps that read from or write to a repository.", "name": "Repo Credentials" }, { "description": "Arbitrary key-value secrets that promotion steps can consume at runtime for any purpose not covered by repository credentials — for example, API tokens, signing keys, or connection strings for external services.", "name": "Generic Credentials" }, { "description": "The resource or operation is scoped to a single Kargo project (Kubernetes namespace). Access is governed by the requesting user's permissions within that project.", "name": "Project-Level" }, { "description": "The resource or operation lives in the Kargo system namespace and applies across all projects. Typically restricted to cluster administrators.", "name": "System-Level" }, { "description": "The resource is a Kubernetes cluster-scoped object (not namespaced), such as a Project or ClusterAnalysisTemplate. These exist at the cluster level and are accessible to users with appropriate cluster-wide permissions.", "name": "Cluster-Scoped Resource" }, { "description": "The resource is defined once and shared across multiple projects or scopes. For example, a shared ConfigMap or credential can be referenced by any project without being duplicated per namespace.", "name": "Shared" }, { "description": "At most, one instance of this resource kind exists per scope. For example, each project has, at most, one ProjectConfig and each cluster has, at most, one ClusterConfig.", "name": "Singleton" } ] }