repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
cloudfoundry/korifi | 72adfa4e6911eb813804fe5a3c7d3a38f8f26053 | 2023-07-20T21:22:13 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 6a338300180be1a25fb0333b6faa64679bc6f6b0 | 2023-03-20T17:15:45 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 13f83e7143b184657364e66a25e6cfb5be5196e4 | 2022-12-20T12:55:54 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 39421958aea0ec097957d6a0eb1b8953bc2eff6c | 2024-03-12T17:30:07 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"temporarySetPodSeccompProfile": {
"description": "Sets the pod .spec.securityContext.seccompProfile to RuntimeDefault. Setting this flag to true will cause a restart of all previously running pods.",
"type": "boolean"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"networking": {
"description": "Networking configuration",
"properties": {
"gatewayClass": {
"description": "The name of the GatewayClass Korifi Gateway references",
"type": "string"
}
},
"required": [
"gatewayClass"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"temporarySetPodSeccompProfile": {
"description": "Sets the pod .spec.securityContext.seccompProfile to RuntimeDefault. Setting this flag to true will cause a restart of all previously running pods.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"systemImagePullSecrets": {
"description": "List of `Secret` names to be used when pulling Korifi system images from private registries",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"adminUserName",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace",
"stagingRequirements",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | f2084440297dc0519b85189e03a19294939d9874 | 2023-03-09T16:35:24 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 94352e6b957fef811706496d0f58e17e01e7bb0f | 2023-03-21T17:20:49 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | a3c92f6ed21c3d258d22c510558f5fa3b17f3af1 | 2024-05-16T10:58:48 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"infoConfig": {
"description": "The /v3/info endpoint configuration.",
"properties": {
"custom": {
"description": "`custom` attribute in the /v3/info endpoint",
"properties": {},
"type": "object"
},
"description": {
"description": "`description` attribute in the /v3/info endpoint",
"type": "string"
},
"minCLIVersion": {
"description": "`minimum` CLI version attribute in the /v3/info endpoint",
"type": "string"
},
"name": {
"description": "`name` attribute in the /v3/info endpoint",
"type": "string"
},
"recommendedCLIVersion": {
"description": "`recommended` CLI version attribute in the /v3/info endpoint",
"type": "string"
},
"supportAddress": {
"description": "`support` attribute in the /v3/info endpoint",
"type": "string"
}
},
"required": [
"description",
"name",
"minCLIVersion",
"recommendedCLIVersion",
"custom",
"supportAddress"
],
"type": "object"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"temporarySetPodSeccompProfile": {
"description": "Sets the pod .spec.securityContext.seccompProfile to RuntimeDefault. Setting this flag to true will cause a restart of all previously running pods.",
"type": "boolean"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"networking": {
"description": "Networking configuration",
"properties": {
"gatewayClass": {
"description": "The name of the GatewayClass Korifi Gateway references",
"type": "string"
}
},
"required": [
"gatewayClass"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"temporarySetPodSeccompProfile": {
"description": "Sets the pod .spec.securityContext.seccompProfile to RuntimeDefault. Setting this flag to true will cause a restart of all previously running pods.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"systemImagePullSecrets": {
"description": "List of `Secret` names to be used when pulling Korifi system images from private registries",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"adminUserName",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace",
"stagingRequirements",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 99282acd53d801f85008e1bbc0ac4c3badd2a20a | 2023-07-20T10:55:31 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"jobs": {
"properties": {
"image": {
"description": "The image for the jobs containing kubectl",
"type": "string"
}
},
"type": "object"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | d0248c68bb9aa8f45f1b282d6fddea77f43c7f3b | 2023-07-07T15:48:52 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk limit in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | eff54bfb21bacf53420639c27d5b9dae43abc9e8 | 2023-01-12T11:44:35 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"namespaceLabels": {
"description": "Key value pairs that are going to be set as labels in the workload namespaces created by Korifi",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | c4c05d6dbda1d9c5b6f7d10166317b61b1c811ad | 2023-07-20T10:55:31 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 498fefcb4a9077e517f150d4fe1a1d86e3e4b5c3 | 2022-12-16T16:56:26 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistryBase": {
"description": "The part of the container registry image reference identifying the registry used for package and droplet images.",
"type": "string"
},
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The repository prefix of the image repository where package and droplet images are pushed to. This is added to the containerRegistryBase, and is suffixed with appGUID and `-packages` or `-droplets`.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRegistryBase",
"defaultAppDomainName"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 34c04ed49c355ad1bbc667efab9e7a8a3998b4d7 | 2023-04-28T17:23:24 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 9599d3188ccde5288a1d8fe299d09b48a783866a | 2023-08-15T09:20:22 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"stagingRequirements",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 01bfef3810269abe97ced558b74ab70ae91fda67 | 2023-01-11T10:54:41 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"controllers": {
"properties": {
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"namespaceLabels": {
"description": "Key value pairs that are going to be set as labels in the workload namespaces created by Korifi",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 9effe05036bd32c47b3287f511bafb169812294e | 2023-03-21T14:41:21 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | d2d9b23925f31336515d76adf4a81cf713570c50 | 2023-08-15T09:20:22 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace"
],
"type": "object"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | f58281f17a097e6f3aa66959f844a5b3ca68b6e0 | 2023-04-21T12:28:43 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"builderName": {
"description": "ID of the builder used to build apps. Defaults to `kpack-image-builder`.",
"type": "string"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"diskMB": {
"description": "Disk in MB for staging.",
"type": "integer"
},
"memoryMB": {
"description": "Memory in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB"
],
"type": "object"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack",
"stagingRequirements"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"builderName",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Has to match `api.builderName`. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"app"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"reconcilers",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"global": {
"description": "Global values that are shared between Korifi and its subcharts.",
"properties": {
"containerRegistrySecret": {
"description": "Name of the `Secret` to use when pushing or pulling from package, droplet and kpack-build repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"type": "string"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"type": "string"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
}
},
"required": [
"rootNamespace",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel"
],
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `kpack-image-builder` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
}
},
"required": [
"global",
"adminUserName",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
cloudfoundry/korifi | 8a55c8c3bc52cde25b9b0acf401a877eb88b9ec6 | 2023-10-09T16:02:53 | helm/korifi/values.schema.json | 286 | 2024-05-29T12:39:42.052Z | {
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"adminUserName": {
"description": "Name of the admin user that will be bound to the Cloud Foundry Admin role.",
"type": "string"
},
"api": {
"properties": {
"apiServer": {
"properties": {
"internalPort": {
"description": "Port used internally by the API container.",
"type": "integer"
},
"port": {
"description": "API external port. Defaults to `443`.",
"type": "integer"
},
"timeouts": {
"description": "HTTP timeouts.",
"properties": {
"idle": {
"description": "Idle timeout.",
"type": "integer"
},
"read": {
"description": "Read timeout.",
"type": "integer"
},
"readHeader": {
"description": "Read header timeout.",
"type": "integer"
},
"write": {
"description": "Write timeout.",
"type": "integer"
}
},
"required": [
"read",
"write",
"idle",
"readHeader"
],
"type": "object"
},
"url": {
"description": "API URL.",
"type": "string"
}
},
"required": [
"url",
"port",
"internalPort",
"timeouts"
],
"type": "object"
},
"authProxy": {
"description": "Needed if using a cluster authentication proxy, e.g. [Pinniped](https://pinniped.dev/).",
"properties": {
"caCert": {
"description": "Proxy's PEM-encoded CA certificate (*not* as Base64).",
"type": "string"
},
"host": {
"description": "Must be a host string, a host:port pair, or a URL to the base of the apiserver.",
"type": "string"
}
},
"type": "object"
},
"expose": {
"description": "Expose the API component via Contour. Set to false if you want to expose the API using other means.",
"type": "boolean"
},
"image": {
"description": "Reference to the API container image.",
"type": "string"
},
"include": {
"description": "Deploy the API component.",
"type": "boolean"
},
"lifecycle": {
"description": "Default lifecycle for apps.",
"properties": {
"stack": {
"description": "Stack.",
"type": "string"
},
"type": {
"description": "Lifecycle type (only `buildpack` accepted currently).",
"enum": [
"buildpack"
],
"type": "string"
}
},
"required": [
"type",
"stack"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"userCertificateExpirationWarningDuration": {
"description": "Issue a warning if the user certificate provided for login has a long expiry. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format.",
"type": "string"
}
},
"required": [
"include",
"expose",
"apiServer",
"image",
"lifecycle",
"userCertificateExpirationWarningDuration"
],
"type": "object"
},
"containerRegistrySecret": {
"deprecated": true,
"description": "Deprecated in favor of containerRegistrySecrets.",
"type": "string"
},
"containerRegistrySecrets": {
"description": "List of `Secret` names to use when pushing or pulling from package, droplet and kpack builder repositories. Required if eksContainerRegistryRoleARN not set. Ignored if eksContainerRegistryRoleARN is set.",
"items": {
"type": "string"
},
"type": "array"
},
"containerRepositoryPrefix": {
"description": "The prefix of the container repository where package and droplet images will be pushed. This is suffixed with the app GUID and `-packages` or `-droplets`. For example, a value of `index.docker.io/korifi/` will result in `index.docker.io/korifi/<appGUID>-packages` and `index.docker.io/korifi/<appGUID>-droplets` being pushed.",
"pattern": "^[a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*/?$",
"type": "string"
},
"contourRouter": {
"properties": {
"include": {
"description": "Deploy the `contour-router` component.",
"type": "boolean"
}
},
"required": [
"include"
],
"type": "object"
},
"controllers": {
"properties": {
"extraVCAPApplicationValues": {
"description": "Key-value pairs that are going to be set in the VCAP_APPLICATION env var on apps. Nested values are not supported.",
"properties": {},
"type": "object"
},
"image": {
"description": "Reference to the controllers container image.",
"type": "string"
},
"maxRetainedBuildsPerApp": {
"description": "How many staged builds to keep, excluding the app's current droplet. Older staged builds will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"maxRetainedPackagesPerApp": {
"description": "How many 'ready' packages to keep, excluding the package associated with the app's current droplet. Older 'ready' packages will be deleted, along with their corresponding container images.",
"minimum": 1,
"type": "integer"
},
"namespaceLabels": {
"description": "Key-value pairs that are going to be set as labels on the namespaces created by Korifi.",
"properties": {},
"type": "object"
},
"processDefaults": {
"properties": {
"diskQuotaMB": {
"description": "Default disk quota for the `web` process.",
"type": "integer"
},
"memoryMB": {
"description": "Default memory limit for the `web` process.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskQuotaMB"
],
"type": "object"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"taskTTL": {
"description": "How long before the `CFTask` object is deleted after the task has completed. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"workloadsTLSSecret": {
"description": "TLS secret used when setting up an app routes.",
"type": "string"
}
},
"required": [
"image",
"taskTTL",
"workloadsTLSSecret"
],
"type": "object"
},
"debug": {
"description": "Enables remote debugging with [Delve](https://github.com/go-delve/delve).",
"type": "boolean"
},
"defaultAppDomainName": {
"description": "Base domain name for application URLs.",
"type": "string"
},
"eksContainerRegistryRoleARN": {
"description": "Amazon Resource Name (ARN) of the IAM role to use to access the ECR registry from an EKS deployed Korifi. Required if containerRegistrySecret not set.",
"type": "string"
},
"generateIngressCertificates": {
"description": "Use `cert-manager` to generate self-signed certificates for the API and app endpoints.",
"type": "boolean"
},
"helm": {
"properties": {
"hooksImage": {
"description": "Image for the helm hooks containing kubectl",
"type": "string"
}
},
"type": "object"
},
"jobTaskRunner": {
"properties": {
"include": {
"description": "Deploy the `job-task-runner` component.",
"type": "boolean"
},
"jobTTL": {
"description": "How long before the `Job` backing up a task is deleted after completion. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"jobTTL"
],
"type": "object"
},
"kpackImageBuilder": {
"properties": {
"builderReadinessTimeout": {
"description": "The time that the kpack Builder will be waited for if not in ready state, berfore the build workload fails. See [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) for details on the format, an additional `d` suffix for days is supported.",
"type": "string"
},
"builderRepository": {
"description": "Container image repository to store the `ClusterBuilder` image. Required when `clusterBuilderName` is not provided.",
"pattern": "^([a-z0-9]+([._-][a-z0-9]+)*(:[0-9]+)?(/[a-z0-9]+([._-][a-z0-9]+)*)*)?$",
"type": "string"
},
"clusterBuilderName": {
"description": "The name of the `ClusterBuilder` Kpack has been configured with. Leave blank to let `kpack-image-builder` create an example `ClusterBuilder`.",
"type": "string"
},
"clusterStackBuildImage": {
"description": "The image to use for building defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackID": {
"description": "The ID of the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"clusterStackRunImage": {
"description": "The image to use for running defined in the `ClusterStack`. Used when `clusterBuilderName` is blank.",
"type": "string"
},
"include": {
"description": "Deploy the `kpack-image-builder` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include",
"builderReadinessTimeout"
],
"type": "object"
},
"logLevel": {
"description": "Sets level of logging for api and controllers components. Can be 'info' or 'debug'.",
"enum": [
"info",
"debug"
],
"type": "string"
},
"reconcilers": {
"properties": {
"app": {
"description": "ID of the workload runner to set on all `AppWorkload` objects. Defaults to `statefulset-runner`.",
"type": "string"
},
"build": {
"description": "ID of the image builder to set on all `BuildWorkload` objects. Defaults to `kpack-image-builder`.",
"type": "string"
}
},
"required": [
"build",
"run"
],
"type": "object"
},
"rootNamespace": {
"description": "Root of the Cloud Foundry namespace hierarchy.",
"type": "string"
},
"stagingRequirements": {
"properties": {
"buildCacheMB": {
"description": "Persistent disk in MB for caching staging artifacts across builds.",
"type": "integer"
},
"diskMB": {
"description": "Ephemeral Disk request in MB for staging apps.",
"type": "integer"
},
"memoryMB": {
"description": "Memory request in MB for staging.",
"type": "integer"
}
},
"required": [
"memoryMB",
"diskMB",
"buildCacheMB"
],
"type": "object"
},
"statefulsetRunner": {
"properties": {
"include": {
"description": "Deploy the `statefulset-runner` component.",
"type": "boolean"
},
"replicas": {
"description": "Number of replicas.",
"type": "integer"
},
"resources": {
"description": "[`ResourceRequirements`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for the API.",
"properties": {
"limits": {
"description": "Resource limits.",
"properties": {
"cpu": {
"description": "CPU limit.",
"type": "string"
},
"memory": {
"description": "Memory limit.",
"type": "string"
}
},
"type": "object"
},
"requests": {
"description": "Resource requests.",
"properties": {
"cpu": {
"description": "CPU request.",
"type": "string"
},
"memory": {
"description": "Memory request.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"include"
],
"type": "object"
},
"systemImagePullSecrets": {
"description": "List of `Secret` names to be used when pulling Korifi system images from private registries",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"adminUserName",
"containerRepositoryPrefix",
"defaultAppDomainName",
"logLevel",
"reconcilers",
"rootNamespace",
"stagingRequirements",
"api",
"controllers",
"kpackImageBuilder",
"statefulsetRunner",
"jobTaskRunner"
],
"title": "Values",
"type": "object"
} | Apache-2.0 | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/identity/v0/stateTransition/identityCreditWithdrawal.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"amount": {
"description": "The amount to be withdrawn",
"minimum": 1000,
"type": "integer"
},
"coreFeePerByte": {
"description": "This is the fee that you are willing to spend for this transaction in Duffs/Byte",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"identityId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"outputScript": {
"byteArray": true,
"maxItems": 25,
"minItems": 23,
"type": "array"
},
"pooling": {
"description": "This indicated the level at which Platform should try to pool this transaction",
"enum": [
0,
1,
2
],
"type": "integer"
},
"protocolVersion": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
},
"revision": {
"description": "Target identity revision",
"minimum": 0,
"type": "integer"
},
"signature": {
"byteArray": true,
"maxItems": 65,
"minItems": 65,
"type": "array"
},
"signaturePublicKeyId": {
"minimum": 0,
"type": "integer"
},
"type": {
"const": 6,
"type": "integer"
}
},
"required": [
"protocolVersion",
"type",
"identityId",
"amount",
"coreFeePerByte",
"pooling",
"outputScript",
"signature",
"signaturePublicKeyId",
"revision"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/identity/v0/stateTransition/identityCreditTransfer.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"amount": {
"description": "The amount to be transferred",
"minimum": 1000,
"type": "integer"
},
"identityId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"protocolVersion": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
},
"recipientId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"signature": {
"byteArray": true,
"maxItems": 65,
"minItems": 65,
"type": "array"
},
"signaturePublicKeyId": {
"minimum": 0,
"type": "integer"
},
"type": {
"const": 7,
"type": "integer"
}
},
"required": [
"protocolVersion",
"type",
"identityId",
"recipientId",
"amount",
"signature",
"signaturePublicKeyId"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/identity/v0/stateTransition/assetLockProof/instantAssetLockProof.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"instantLock": {
"byteArray": true,
"maxItems": 100000,
"minItems": 165,
"type": "array"
},
"outputIndex": {
"minimum": 0,
"type": "integer"
},
"transaction": {
"byteArray": true,
"maxItems": 100000,
"minItems": 1,
"type": "array"
},
"type": {
"const": 0,
"type": "integer"
}
},
"required": [
"type",
"instantLock",
"transaction",
"outputIndex"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/document/v0/documentBase.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$createdAt": {
"minimum": 0,
"type": "integer"
},
"$dataContractId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$id": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$ownerId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$protocolVersion": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
},
"$revision": {
"minimum": 1,
"type": "integer"
},
"$type": {
"type": "string"
},
"$updatedAt": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"$protocolVersion",
"$id",
"$type",
"$revision",
"$dataContractId",
"$ownerId"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$defs": {
"documentProperties": {
"maxProperties": 100,
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9-_]{1,64}$": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
}
},
"propertyNames": {
"pattern": "^[a-zA-Z0-9-_]{1,64}$"
},
"type": "object"
},
"documentSchema": {
"allOf": [
{
"$comment": "array must contain items",
"if": {
"not": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
},
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"items": true
},
"required": [
"items"
]
}
},
{
"$comment": "array without prefixItems must contain items sub schema",
"if": {
"not": {
"properties": {
"prefixItems": true
},
"required": [
"prefixItems"
]
}
},
"then": {
"properties": {
"items": {
"$ref": "#/$defs/documentSchema"
}
}
}
},
{
"$comment": "all object properties must be defined",
"if": {
"not": {
"properties": {
"$ref": true
},
"required": [
"$ref"
]
},
"properties": {
"type": {
"const": "object"
}
}
},
"then": {
"properties": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema/properties/additionalProperties"
},
"properties": {
"$ref": "#/$defs/documentProperties"
}
},
"required": [
"properties",
"additionalProperties"
]
}
}
],
"dependentSchemas": {
"byteArray": {
"description": "should be used only with array type",
"not": {
"properties": {
"items": {
"type": "array"
}
},
"required": [
"items"
]
},
"properties": {
"type": {
"const": "array",
"type": "string"
}
}
},
"contentMediaType": {
"if": {
"properties": {
"contentMediaType": {
"const": "application/x.dash.dpp.identifier"
}
}
},
"then": {
"properties": {
"byteArray": {
"const": true
},
"maxItems": {
"const": 32
},
"minItems": {
"const": 32
}
},
"required": [
"byteArray",
"minItems",
"maxItems"
]
}
},
"format": {
"description": "prevent slow format validation of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"pattern": {
"description": "prevent slow pattern matching of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"prefixItems": {
"$comment": "array must not contain undefined item sub schemas",
"properties": {
"items": {
"const": false,
"type": "boolean"
}
},
"required": [
"items"
]
},
"uniqueItems": {
"description": "prevent slow validation of large non-scalar arrays",
"if": {
"properties": {
"items": {
"properties": {
"type": {
"anyOf": [
{
"enum": [
"object",
"array"
],
"type": "string"
},
{
"contains": {
"enum": [
"object",
"array"
]
},
"type": "array"
}
]
}
},
"type": "object"
},
"uniqueItems": {
"const": true
}
}
},
"then": {
"properties": {
"maxItems": {
"maximum": 100000,
"type": "number"
}
},
"required": [
"maxItems"
]
}
}
},
"properties": {
"$comment": {
"$ref": "https://json-schema.org/draft/2020-12/meta/core#/properties/$comment"
},
"$id": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"$ref": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"byteArray": {
"const": true,
"type": "boolean"
},
"const": true,
"contains": {
"$ref": "https://json-schema.org/draft/2020-12/meta/applicator#/properties/contains"
},
"contentMediaType": {
"$ref": "https://json-schema.org/draft/2020-12/meta/content#/properties/contentMediaType"
},
"dependentRequired": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/$defs/stringArray"
},
"minProperties": 1,
"type": "object"
},
"dependentSchemas": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema"
},
"minProperties": 1,
"type": "object"
},
"description": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/description"
},
"enum": {
"items": true,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"examples": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/examples"
},
"exclusiveMaximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMaximum"
},
"exclusiveMinimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMinimum"
},
"format": {
"$ref": "https://json-schema.org/draft/2020-12/meta/format-annotation#/properties/format"
},
"items": true,
"maxItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxItems"
},
"maxLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxLength"
},
"maxProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxProperties"
},
"maximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maximum"
},
"minItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minItems"
},
"minLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minLength"
},
"minProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minProperties"
},
"minimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minimum"
},
"multipleOf": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/multipleOf"
},
"pattern": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/pattern"
},
"prefixItems": {
"$ref": "#/$defs/documentSchemaArray"
},
"properties": {
"$ref": "#/$defs/documentProperties"
},
"required": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/required"
},
"type": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/type"
},
"uniqueItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/uniqueItems"
}
},
"type": "object"
},
"documentSchemaArray": {
"items": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"minItems": 1,
"type": "array"
}
},
"$id": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$defs": {
"$ref": "#/$defs/documentProperties"
},
"$schema": {
"const": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"indices": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"properties": {
"items": {
"additionalProperties": {
"enum": [
"asc"
],
"type": "string"
},
"maxProperties": 1,
"minProperties": 1,
"propertyNames": {
"maxLength": 256
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"unique": {
"type": "boolean"
}
},
"required": [
"properties",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"properties": {
"additionalProperties": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"maxProperties": 100,
"minProperties": 1,
"properties": {
"$createdAt": true,
"$id": true,
"$ownerId": true,
"$revision": true,
"$updatedAt": true
},
"propertyNames": {
"oneOf": [
{
"pattern": "^[a-zA-Z0-9-_]{1,64}$",
"type": "string"
},
{
"enum": [
"$id",
"$ownerId",
"$revision",
"$createdAt",
"$updatedAt"
],
"type": "string"
}
]
},
"type": "object"
},
"signatureSecurityLevelRequirement": {
"description": "Public key security level. 0 - Master, 1 - Critical, 2 - High, 3 - Medium. If none specified, High level is used",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"type": {
"const": "object",
"type": "string"
}
},
"required": [
"$schema",
"type",
"properties",
"additionalProperties"
],
"type": "object"
} | MIT | en |
dashpay/platform | e71f92c230024eff5f7b68ecc064b59e5fc9018c | 2024-04-22T14:25:24 | packages/rs-dpp/src/schema/document/v0/documentBase.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$createdAt": {
"minimum": 0,
"type": "integer"
},
"$createdAtBlockHeight": {
"minimum": 0,
"type": "integer"
},
"$createdAtCoreBlockHeight": {
"minimum": 0,
"type": "integer"
},
"$dataContractId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$id": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$ownerId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$protocolVersion": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
},
"$revision": {
"minimum": 1,
"type": "integer"
},
"$transferredAt": {
"minimum": 0,
"type": "integer"
},
"$transferredAtBlockHeight": {
"minimum": 0,
"type": "integer"
},
"$transferredAtCoreBlockHeight": {
"minimum": 0,
"type": "integer"
},
"$type": {
"type": "string"
},
"$updatedAt": {
"minimum": 0,
"type": "integer"
},
"$updatedAtBlockHeight": {
"minimum": 0,
"type": "integer"
},
"$updatedAtCoreBlockHeight": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"$protocolVersion",
"$id",
"$type",
"$revision",
"$dataContractId",
"$ownerId"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/document/v0/stateTransition/documentTransition/create.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$createdAt": {
"minimum": 0,
"type": "integer"
},
"$entropy": {
"byteArray": true,
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$updatedAt": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"$entropy"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/identity/v0/stateTransition/assetLockProof/chainAssetLockProof.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"coreChainLockedHeight": {
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"outPoint": {
"byteArray": true,
"maxItems": 36,
"minItems": 36,
"type": "array"
},
"type": {
"const": 1,
"type": "integer"
}
},
"required": [
"type",
"coreChainLockedHeight",
"outPoint"
],
"type": "object"
} | MIT | en |
dashpay/platform | dbf618c26df4559b779ae5a3e8bc8ad65f7871d7 | 2023-10-09T12:08:55 | packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$defs": {
"documentProperties": {
"maxProperties": 100,
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9-_]{1,64}$": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
}
},
"propertyNames": {
"pattern": "^[a-zA-Z0-9-_]{1,64}$"
},
"type": "object"
},
"documentSchema": {
"allOf": [
{
"$comment": "allow only byte arrays",
"if": {
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
}
},
{
"$comment": "array must contain items",
"if": {
"not": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
},
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"items": true
},
"required": [
"items"
]
}
},
{
"$comment": "array without prefixItems must contain items sub schema",
"if": {
"not": {
"properties": {
"prefixItems": true
},
"required": [
"prefixItems"
]
}
},
"then": {
"properties": {
"items": {
"$ref": "#/$defs/documentSchema"
}
}
}
},
{
"$comment": "all object properties must be defined",
"if": {
"not": {
"properties": {
"$ref": true
},
"required": [
"$ref"
]
},
"properties": {
"type": {
"const": "object"
}
}
},
"then": {
"properties": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema/properties/additionalProperties"
},
"properties": {
"$ref": "#/$defs/documentProperties"
}
},
"required": [
"properties",
"additionalProperties"
]
}
}
],
"dependentSchemas": {
"byteArray": {
"description": "should be used only with array type",
"not": {
"properties": {
"items": {
"type": "array"
}
},
"required": [
"items"
]
},
"properties": {
"type": {
"const": "array",
"type": "string"
}
}
},
"contentMediaType": {
"if": {
"properties": {
"contentMediaType": {
"const": "application/x.dash.dpp.identifier"
}
}
},
"then": {
"properties": {
"byteArray": {
"const": true
},
"maxItems": {
"const": 32
},
"minItems": {
"const": 32
}
},
"required": [
"byteArray",
"minItems",
"maxItems"
]
}
},
"format": {
"description": "prevent slow format validation of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"pattern": {
"description": "prevent slow pattern matching of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"prefixItems": {
"$comment": "array must not contain undefined item sub schemas",
"properties": {
"items": {
"const": false,
"type": "boolean"
}
},
"required": [
"items"
]
},
"uniqueItems": {
"description": "prevent slow validation of large non-scalar arrays",
"if": {
"properties": {
"items": {
"properties": {
"type": {
"anyOf": [
{
"enum": [
"object",
"array"
],
"type": "string"
},
{
"contains": {
"enum": [
"object",
"array"
]
},
"type": "array"
}
]
}
},
"type": "object"
},
"uniqueItems": {
"const": true
}
}
},
"then": {
"properties": {
"maxItems": {
"maximum": 100000,
"type": "number"
}
},
"required": [
"maxItems"
]
}
}
},
"properties": {
"$comment": {
"$ref": "https://json-schema.org/draft/2020-12/meta/core#/properties/$comment"
},
"$id": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"$ref": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"byteArray": {
"const": true,
"type": "boolean"
},
"const": true,
"contains": {
"$ref": "https://json-schema.org/draft/2020-12/meta/applicator#/properties/contains"
},
"contentMediaType": {
"$ref": "https://json-schema.org/draft/2020-12/meta/content#/properties/contentMediaType"
},
"dependentRequired": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/$defs/stringArray"
},
"minProperties": 1,
"type": "object"
},
"dependentSchemas": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema"
},
"minProperties": 1,
"type": "object"
},
"description": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/description"
},
"enum": {
"items": true,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"examples": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/examples"
},
"exclusiveMaximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMaximum"
},
"exclusiveMinimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMinimum"
},
"format": {
"$ref": "https://json-schema.org/draft/2020-12/meta/format-annotation#/properties/format"
},
"items": true,
"maxItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxItems"
},
"maxLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxLength"
},
"maxProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxProperties"
},
"maximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maximum"
},
"minItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minItems"
},
"minLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minLength"
},
"minProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minProperties"
},
"minimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minimum"
},
"multipleOf": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/multipleOf"
},
"pattern": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/pattern"
},
"prefixItems": {
"$ref": "#/$defs/documentSchemaArray"
},
"properties": {
"$ref": "#/$defs/documentProperties"
},
"required": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/required"
},
"type": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/type"
},
"uniqueItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/uniqueItems"
}
},
"type": "object"
},
"documentSchemaArray": {
"items": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"minItems": 1,
"type": "array"
}
},
"$id": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$defs": {
"$ref": "#/$defs/documentProperties"
},
"$schema": {
"const": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"indices": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"properties": {
"items": {
"additionalProperties": {
"enum": [
"asc"
],
"type": "string"
},
"maxProperties": 1,
"minProperties": 1,
"propertyNames": {
"maxLength": 256
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"unique": {
"type": "boolean"
}
},
"required": [
"properties",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"properties": {
"additionalProperties": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"maxProperties": 100,
"minProperties": 1,
"properties": {
"$createdAt": true,
"$id": true,
"$ownerId": true,
"$revision": true,
"$updatedAt": true
},
"propertyNames": {
"oneOf": [
{
"pattern": "^[a-zA-Z0-9-_]{1,64}$",
"type": "string"
},
{
"enum": [
"$id",
"$ownerId",
"$revision",
"$createdAt",
"$updatedAt"
],
"type": "string"
}
]
},
"type": "object"
},
"requiresIdentityDecryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"requiresIdentityEncryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"signatureSecurityLevelRequirement": {
"description": "Public key security level. 0 - Master, 1 - Critical, 2 - High, 3 - Medium. If none specified, High level is used",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"type": {
"const": "object",
"type": "string"
}
},
"required": [
"$schema",
"type",
"properties",
"additionalProperties"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/data_contract/v0/stateTransition/dataContractUpdate.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"dataContract": {
"type": "object"
},
"signature": {
"byteArray": true,
"maxItems": 96,
"minItems": 65,
"type": "array"
},
"signaturePublicKeyId": {
"minimum": 0,
"type": "integer"
},
"type": {
"const": 4,
"type": "integer"
},
"version": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
}
},
"required": [
"version",
"type",
"dataContract",
"signaturePublicKeyId",
"signature"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/document/v0/stateTransition/documentTransition/base.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$action": {
"enum": [
0,
1,
3
],
"type": "integer"
},
"$dataContractId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$id": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"$type": {
"type": "string"
}
},
"required": [
"$id",
"$type",
"$action",
"$dataContractId"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/data_contract/v0/stateTransition/dataContractCreate.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"dataContract": {
"type": "object"
},
"entropy": {
"byteArray": true,
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"signature": {
"byteArray": true,
"maxItems": 96,
"minItems": 65,
"type": "array"
},
"signaturePublicKeyId": {
"minimum": 0,
"type": "integer"
},
"type": {
"const": 0,
"type": "integer"
},
"version": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
}
},
"required": [
"version",
"type",
"dataContract",
"entropy",
"signaturePublicKeyId",
"signature"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/identity/v0/stateTransition/identityCreate.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"assetLockProof": {
"type": "object"
},
"protocolVersion": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
},
"publicKeys": {
"maxItems": 10,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"signature": {
"byteArray": true,
"description": "Signature made by AssetLock one time ECDSA key",
"maxItems": 65,
"minItems": 65,
"type": "array"
},
"type": {
"const": 2,
"type": "integer"
}
},
"required": [
"protocolVersion",
"type",
"assetLockProof",
"publicKeys",
"signature"
],
"type": "object"
} | MIT | en |
dashpay/platform | e71f92c230024eff5f7b68ecc064b59e5fc9018c | 2024-04-22T14:25:24 | packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$defs": {
"documentProperties": {
"maxProperties": 100,
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9-_]{1,64}$": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
}
},
"propertyNames": {
"pattern": "^[a-zA-Z0-9-_]{1,64}$"
},
"type": "object"
},
"documentSchema": {
"allOf": [
{
"$comment": "require index for object properties",
"if": {
"properties": {
"type": {
"const": "object"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"properties": {
"additionalProperties": {
"properties": {
"position": true
},
"required": [
"position"
],
"type": "object"
},
"type": "object"
}
}
}
},
{
"$comment": "allow only byte arrays",
"if": {
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
}
},
{
"$comment": "array must contain items",
"if": {
"not": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
},
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"items": true
},
"required": [
"items"
]
}
},
{
"$comment": "array without prefixItems must contain items sub schema",
"if": {
"not": {
"properties": {
"prefixItems": true
},
"required": [
"prefixItems"
]
}
},
"then": {
"properties": {
"items": {
"$ref": "#/$defs/documentSchema"
}
}
}
},
{
"$comment": "all object properties must be defined",
"if": {
"not": {
"properties": {
"$ref": true
},
"required": [
"$ref"
]
},
"properties": {
"type": {
"const": "object"
}
}
},
"then": {
"properties": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema/properties/additionalProperties"
},
"properties": {
"$ref": "#/$defs/documentProperties"
}
},
"required": [
"properties",
"additionalProperties"
]
}
}
],
"dependentSchemas": {
"byteArray": {
"description": "should be used only with array type",
"not": {
"properties": {
"items": {
"type": "array"
}
},
"required": [
"items"
]
},
"properties": {
"type": {
"const": "array",
"type": "string"
}
}
},
"contentMediaType": {
"if": {
"properties": {
"contentMediaType": {
"const": "application/x.dash.dpp.identifier"
}
}
},
"then": {
"properties": {
"byteArray": {
"const": true
},
"maxItems": {
"const": 32
},
"minItems": {
"const": 32
}
},
"required": [
"byteArray",
"minItems",
"maxItems"
]
}
},
"format": {
"description": "prevent slow format validation of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"pattern": {
"description": "prevent slow pattern matching of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"prefixItems": {
"$comment": "array must not contain undefined item sub schemas",
"properties": {
"items": {
"const": false,
"type": "boolean"
}
},
"required": [
"items"
]
},
"uniqueItems": {
"description": "prevent slow validation of large non-scalar arrays",
"if": {
"properties": {
"items": {
"properties": {
"type": {
"anyOf": [
{
"enum": [
"object",
"array"
],
"type": "string"
},
{
"contains": {
"enum": [
"object",
"array"
]
},
"type": "array"
}
]
}
},
"type": "object"
},
"uniqueItems": {
"const": true
}
}
},
"then": {
"properties": {
"maxItems": {
"maximum": 100000,
"type": "number"
}
},
"required": [
"maxItems"
]
}
}
},
"properties": {
"$comment": {
"$ref": "https://json-schema.org/draft/2020-12/meta/core#/properties/$comment"
},
"$id": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"$ref": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"byteArray": {
"const": true,
"type": "boolean"
},
"const": true,
"contains": {
"$ref": "https://json-schema.org/draft/2020-12/meta/applicator#/properties/contains"
},
"contentMediaType": {
"$ref": "https://json-schema.org/draft/2020-12/meta/content#/properties/contentMediaType"
},
"dependentRequired": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/$defs/stringArray"
},
"minProperties": 1,
"type": "object"
},
"dependentSchemas": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema"
},
"minProperties": 1,
"type": "object"
},
"description": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/description"
},
"enum": {
"items": true,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"examples": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/examples"
},
"exclusiveMaximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMaximum"
},
"exclusiveMinimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMinimum"
},
"format": {
"$ref": "https://json-schema.org/draft/2020-12/meta/format-annotation#/properties/format"
},
"items": true,
"maxItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxItems"
},
"maxLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxLength"
},
"maxProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxProperties"
},
"maximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maximum"
},
"minItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minItems"
},
"minLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minLength"
},
"minProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minProperties"
},
"minimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minimum"
},
"multipleOf": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/multipleOf"
},
"pattern": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/pattern"
},
"position": {
"minimum": 0,
"type": "integer"
},
"prefixItems": {
"$ref": "#/$defs/documentSchemaArray"
},
"properties": {
"$ref": "#/$defs/documentProperties"
},
"required": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/required"
},
"type": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/type"
},
"uniqueItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/uniqueItems"
}
},
"type": "object"
},
"documentSchemaArray": {
"items": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"minItems": 1,
"type": "array"
}
},
"$id": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$defs": {
"$ref": "#/$defs/documentProperties"
},
"$schema": {
"const": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"indices": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"properties": {
"items": {
"additionalProperties": {
"enum": [
"asc"
],
"type": "string"
},
"maxProperties": 1,
"minProperties": 1,
"propertyNames": {
"maxLength": 256
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"unique": {
"type": "boolean"
}
},
"required": [
"properties",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"properties": {
"additionalProperties": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"maxProperties": 100,
"minProperties": 1,
"properties": {
"$createdAt": true,
"$createdAtBlockHeight": true,
"$createdAtCoreBlockHeight": true,
"$id": true,
"$ownerId": true,
"$revision": true,
"$transferredAt": true,
"$transferredAtBlockHeight": true,
"$transferredAtCoreBlockHeight": true,
"$updatedAt": true,
"$updatedAtBlockHeight": true,
"$updatedAtCoreBlockHeight": true
},
"propertyNames": {
"oneOf": [
{
"pattern": "^[a-zA-Z0-9-_]{1,64}$",
"type": "string"
},
{
"enum": [
"$id",
"$ownerId",
"$revision",
"$createdAt",
"$updatedAt",
"$transferredAt",
"$createdAtBlockHeight",
"$updatedAtBlockHeight",
"$transferredAtBlockHeight",
"$createdAtCoreBlockHeight",
"$updatedAtCoreBlockHeight",
"$transferredAtCoreBlockHeight"
],
"type": "string"
}
]
},
"type": "object"
},
"requiresIdentityDecryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"requiresIdentityEncryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"signatureSecurityLevelRequirement": {
"description": "Public key security level. 0 - Master, 1 - Critical, 2 - High, 3 - Medium. If none specified, High level is used",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"transferable": {
"description": "Transferable without a marketplace sell. 0 - Never, 1 - Always",
"enum": [
0,
1
],
"type": "integer"
},
"type": {
"const": "object",
"type": "string"
}
},
"required": [
"$schema",
"type",
"properties",
"additionalProperties"
],
"type": "object"
} | MIT | en |
dashpay/platform | fadd5220ca03cd414dc57df54d7e750405d481e9 | 2023-11-23T23:45:02 | packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$defs": {
"documentProperties": {
"maxProperties": 100,
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9-_]{1,64}$": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
}
},
"propertyNames": {
"pattern": "^[a-zA-Z0-9-_]{1,64}$"
},
"type": "object"
},
"documentSchema": {
"allOf": [
{
"$comment": "require index for object properties",
"if": {
"properties": {
"type": {
"const": "object"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"properties": {
"additionalProperties": {
"properties": {
"position": true
},
"required": [
"position"
],
"type": "object"
},
"type": "object"
}
}
}
},
{
"$comment": "allow only byte arrays",
"if": {
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
}
},
{
"$comment": "array must contain items",
"if": {
"not": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
},
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"items": true
},
"required": [
"items"
]
}
},
{
"$comment": "array without prefixItems must contain items sub schema",
"if": {
"not": {
"properties": {
"prefixItems": true
},
"required": [
"prefixItems"
]
}
},
"then": {
"properties": {
"items": {
"$ref": "#/$defs/documentSchema"
}
}
}
},
{
"$comment": "all object properties must be defined",
"if": {
"not": {
"properties": {
"$ref": true
},
"required": [
"$ref"
]
},
"properties": {
"type": {
"const": "object"
}
}
},
"then": {
"properties": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema/properties/additionalProperties"
},
"properties": {
"$ref": "#/$defs/documentProperties"
}
},
"required": [
"properties",
"additionalProperties"
]
}
}
],
"dependentSchemas": {
"byteArray": {
"description": "should be used only with array type",
"not": {
"properties": {
"items": {
"type": "array"
}
},
"required": [
"items"
]
},
"properties": {
"type": {
"const": "array",
"type": "string"
}
}
},
"contentMediaType": {
"if": {
"properties": {
"contentMediaType": {
"const": "application/x.dash.dpp.identifier"
}
}
},
"then": {
"properties": {
"byteArray": {
"const": true
},
"maxItems": {
"const": 32
},
"minItems": {
"const": 32
}
},
"required": [
"byteArray",
"minItems",
"maxItems"
]
}
},
"format": {
"description": "prevent slow format validation of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"pattern": {
"description": "prevent slow pattern matching of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"prefixItems": {
"$comment": "array must not contain undefined item sub schemas",
"properties": {
"items": {
"const": false,
"type": "boolean"
}
},
"required": [
"items"
]
},
"uniqueItems": {
"description": "prevent slow validation of large non-scalar arrays",
"if": {
"properties": {
"items": {
"properties": {
"type": {
"anyOf": [
{
"enum": [
"object",
"array"
],
"type": "string"
},
{
"contains": {
"enum": [
"object",
"array"
]
},
"type": "array"
}
]
}
},
"type": "object"
},
"uniqueItems": {
"const": true
}
}
},
"then": {
"properties": {
"maxItems": {
"maximum": 100000,
"type": "number"
}
},
"required": [
"maxItems"
]
}
}
},
"properties": {
"$comment": {
"$ref": "https://json-schema.org/draft/2020-12/meta/core#/properties/$comment"
},
"$id": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"$ref": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"byteArray": {
"const": true,
"type": "boolean"
},
"const": true,
"contains": {
"$ref": "https://json-schema.org/draft/2020-12/meta/applicator#/properties/contains"
},
"contentMediaType": {
"$ref": "https://json-schema.org/draft/2020-12/meta/content#/properties/contentMediaType"
},
"dependentRequired": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/$defs/stringArray"
},
"minProperties": 1,
"type": "object"
},
"dependentSchemas": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema"
},
"minProperties": 1,
"type": "object"
},
"description": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/description"
},
"enum": {
"items": true,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"examples": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/examples"
},
"exclusiveMaximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMaximum"
},
"exclusiveMinimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMinimum"
},
"format": {
"$ref": "https://json-schema.org/draft/2020-12/meta/format-annotation#/properties/format"
},
"items": true,
"maxItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxItems"
},
"maxLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxLength"
},
"maxProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxProperties"
},
"maximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maximum"
},
"minItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minItems"
},
"minLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minLength"
},
"minProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minProperties"
},
"minimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minimum"
},
"multipleOf": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/multipleOf"
},
"pattern": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/pattern"
},
"position": {
"minimum": 0,
"type": "integer"
},
"prefixItems": {
"$ref": "#/$defs/documentSchemaArray"
},
"properties": {
"$ref": "#/$defs/documentProperties"
},
"required": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/required"
},
"type": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/type"
},
"uniqueItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/uniqueItems"
}
},
"type": "object"
},
"documentSchemaArray": {
"items": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"minItems": 1,
"type": "array"
}
},
"$id": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$defs": {
"$ref": "#/$defs/documentProperties"
},
"$schema": {
"const": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"indices": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"properties": {
"items": {
"additionalProperties": {
"enum": [
"asc"
],
"type": "string"
},
"maxProperties": 1,
"minProperties": 1,
"propertyNames": {
"maxLength": 256
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"unique": {
"type": "boolean"
}
},
"required": [
"properties",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"properties": {
"additionalProperties": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"maxProperties": 100,
"minProperties": 1,
"properties": {
"$createdAt": true,
"$id": true,
"$ownerId": true,
"$revision": true,
"$updatedAt": true
},
"propertyNames": {
"oneOf": [
{
"pattern": "^[a-zA-Z0-9-_]{1,64}$",
"type": "string"
},
{
"enum": [
"$id",
"$ownerId",
"$revision",
"$createdAt",
"$updatedAt"
],
"type": "string"
}
]
},
"type": "object"
},
"requiresIdentityDecryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"requiresIdentityEncryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"signatureSecurityLevelRequirement": {
"description": "Public key security level. 0 - Master, 1 - Critical, 2 - High, 3 - Medium. If none specified, High level is used",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"type": {
"const": "object",
"type": "string"
}
},
"required": [
"$schema",
"type",
"properties",
"additionalProperties"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/document/v0/stateTransition/documentsBatch.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"ownerId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"protocolVersion": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
},
"signature": {
"byteArray": true,
"maxItems": 96,
"minItems": 65,
"type": "array"
},
"signaturePublicKeyId": {
"minimum": 0,
"type": "integer"
},
"transitions": {
"items": {
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"type": {
"const": 1,
"type": "integer"
}
},
"required": [
"protocolVersion",
"type",
"ownerId",
"transitions",
"signaturePublicKeyId",
"signature"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/identity/v0/stateTransition/identityTopUp.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"assetLockProof": {
"type": "object"
},
"identityId": {
"byteArray": true,
"contentMediaType": "application/x.dash.dpp.identifier",
"maxItems": 32,
"minItems": 32,
"type": "array"
},
"protocolVersion": {
"$comment": "Maximum is the latest protocol version",
"type": "integer"
},
"signature": {
"byteArray": true,
"description": "Signature made by AssetLock one time ECDSA key",
"maxItems": 65,
"minItems": 65,
"type": "array"
},
"type": {
"const": 3,
"type": "integer"
}
},
"required": [
"protocolVersion",
"type",
"assetLockProof",
"identityId",
"signature"
],
"type": "object"
} | MIT | en |
dashpay/platform | c284f76c7b419db961b59e2e706e2c0a211c1fa6 | 2023-09-04T01:12:20 | packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$defs": {
"documentProperties": {
"maxProperties": 100,
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9-_]{1,64}$": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
}
},
"propertyNames": {
"pattern": "^[a-zA-Z0-9-_]{1,64}$"
},
"type": "object"
},
"documentSchema": {
"allOf": [
{
"$comment": "array must contain items",
"if": {
"not": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
},
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"items": true
},
"required": [
"items"
]
}
},
{
"$comment": "array without prefixItems must contain items sub schema",
"if": {
"not": {
"properties": {
"prefixItems": true
},
"required": [
"prefixItems"
]
}
},
"then": {
"properties": {
"items": {
"$ref": "#/$defs/documentSchema"
}
}
}
},
{
"$comment": "all object properties must be defined",
"if": {
"not": {
"properties": {
"$ref": true
},
"required": [
"$ref"
]
},
"properties": {
"type": {
"const": "object"
}
}
},
"then": {
"properties": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema/properties/additionalProperties"
},
"properties": {
"$ref": "#/$defs/documentProperties"
}
},
"required": [
"properties",
"additionalProperties"
]
}
}
],
"dependentSchemas": {
"byteArray": {
"description": "should be used only with array type",
"not": {
"properties": {
"items": {
"type": "array"
}
},
"required": [
"items"
]
},
"properties": {
"type": {
"const": "array",
"type": "string"
}
}
},
"contentMediaType": {
"if": {
"properties": {
"contentMediaType": {
"const": "application/x.dash.dpp.identifier"
}
}
},
"then": {
"properties": {
"byteArray": {
"const": true
},
"maxItems": {
"const": 32
},
"minItems": {
"const": 32
}
},
"required": [
"byteArray",
"minItems",
"maxItems"
]
}
},
"format": {
"description": "prevent slow format validation of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"pattern": {
"description": "prevent slow pattern matching of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"prefixItems": {
"$comment": "array must not contain undefined item sub schemas",
"properties": {
"items": {
"const": false,
"type": "boolean"
}
},
"required": [
"items"
]
},
"uniqueItems": {
"description": "prevent slow validation of large non-scalar arrays",
"if": {
"properties": {
"items": {
"properties": {
"type": {
"anyOf": [
{
"enum": [
"object",
"array"
],
"type": "string"
},
{
"contains": {
"enum": [
"object",
"array"
]
},
"type": "array"
}
]
}
},
"type": "object"
},
"uniqueItems": {
"const": true
}
}
},
"then": {
"properties": {
"maxItems": {
"maximum": 100000,
"type": "number"
}
},
"required": [
"maxItems"
]
}
}
},
"properties": {
"$comment": {
"$ref": "https://json-schema.org/draft/2020-12/meta/core#/properties/$comment"
},
"$id": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"$ref": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"byteArray": {
"const": true,
"type": "boolean"
},
"const": true,
"contains": {
"$ref": "https://json-schema.org/draft/2020-12/meta/applicator#/properties/contains"
},
"contentMediaType": {
"$ref": "https://json-schema.org/draft/2020-12/meta/content#/properties/contentMediaType"
},
"dependentRequired": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/$defs/stringArray"
},
"minProperties": 1,
"type": "object"
},
"dependentSchemas": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema"
},
"minProperties": 1,
"type": "object"
},
"description": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/description"
},
"enum": {
"items": true,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"examples": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/examples"
},
"exclusiveMaximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMaximum"
},
"exclusiveMinimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMinimum"
},
"format": {
"$ref": "https://json-schema.org/draft/2020-12/meta/format-annotation#/properties/format"
},
"items": true,
"maxItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxItems"
},
"maxLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxLength"
},
"maxProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxProperties"
},
"maximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maximum"
},
"minItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minItems"
},
"minLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minLength"
},
"minProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minProperties"
},
"minimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minimum"
},
"multipleOf": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/multipleOf"
},
"pattern": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/pattern"
},
"prefixItems": {
"$ref": "#/$defs/documentSchemaArray"
},
"properties": {
"$ref": "#/$defs/documentProperties"
},
"required": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/required"
},
"type": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/type"
},
"uniqueItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/uniqueItems"
}
},
"type": "object"
},
"documentSchemaArray": {
"items": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"minItems": 1,
"type": "array"
}
},
"$id": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$defs": {
"$ref": "#/$defs/documentProperties"
},
"$schema": {
"const": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"indices": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"properties": {
"items": {
"additionalProperties": {
"enum": [
"asc"
],
"type": "string"
},
"maxProperties": 1,
"minProperties": 1,
"propertyNames": {
"maxLength": 256
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"unique": {
"type": "boolean"
}
},
"required": [
"properties",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"properties": {
"additionalProperties": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"maxProperties": 100,
"minProperties": 1,
"properties": {
"$createdAt": true,
"$id": true,
"$ownerId": true,
"$revision": true,
"$updatedAt": true
},
"propertyNames": {
"oneOf": [
{
"pattern": "^[a-zA-Z0-9-_]{1,64}$",
"type": "string"
},
{
"enum": [
"$id",
"$ownerId",
"$revision",
"$createdAt",
"$updatedAt"
],
"type": "string"
}
]
},
"type": "object"
},
"requiresIdentityDecryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"requiresIdentityEncryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"signatureSecurityLevelRequirement": {
"description": "Public key security level. 0 - Master, 1 - Critical, 2 - High, 3 - Medium. If none specified, High level is used",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"type": {
"const": "object",
"type": "string"
}
},
"required": [
"$schema",
"type",
"properties",
"additionalProperties"
],
"type": "object"
} | MIT | en |
dashpay/platform | 377087b0218b9ccf599ce1524e063f406c13418d | 2024-04-25T12:35:18 | packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$defs": {
"documentProperties": {
"maxProperties": 100,
"minProperties": 1,
"patternProperties": {
"^[a-zA-Z0-9-_]{1,64}$": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
}
},
"propertyNames": {
"pattern": "^[a-zA-Z0-9-_]{1,64}$"
},
"type": "object"
},
"documentSchema": {
"allOf": [
{
"$comment": "require index for object properties",
"if": {
"properties": {
"type": {
"const": "object"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"properties": {
"additionalProperties": {
"properties": {
"position": true
},
"required": [
"position"
],
"type": "object"
},
"type": "object"
}
}
}
},
{
"$comment": "allow only byte arrays",
"if": {
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
}
},
{
"$comment": "array must contain items",
"if": {
"not": {
"properties": {
"byteArray": true
},
"required": [
"byteArray"
]
},
"properties": {
"type": {
"const": "array"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"items": true
},
"required": [
"items"
]
}
},
{
"$comment": "array without prefixItems must contain items sub schema",
"if": {
"not": {
"properties": {
"prefixItems": true
},
"required": [
"prefixItems"
]
}
},
"then": {
"properties": {
"items": {
"$ref": "#/$defs/documentSchema"
}
}
}
},
{
"$comment": "all object properties must be defined",
"if": {
"not": {
"properties": {
"$ref": true
},
"required": [
"$ref"
]
},
"properties": {
"type": {
"const": "object"
}
}
},
"then": {
"properties": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema/properties/additionalProperties"
},
"properties": {
"$ref": "#/$defs/documentProperties"
}
},
"required": [
"properties",
"additionalProperties"
]
}
}
],
"dependentSchemas": {
"byteArray": {
"description": "should be used only with array type",
"not": {
"properties": {
"items": {
"type": "array"
}
},
"required": [
"items"
]
},
"properties": {
"type": {
"const": "array",
"type": "string"
}
}
},
"contentMediaType": {
"if": {
"properties": {
"contentMediaType": {
"const": "application/x.dash.dpp.identifier"
}
}
},
"then": {
"properties": {
"byteArray": {
"const": true
},
"maxItems": {
"const": 32
},
"minItems": {
"const": 32
}
},
"required": [
"byteArray",
"minItems",
"maxItems"
]
}
},
"format": {
"description": "prevent slow format validation of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"pattern": {
"description": "prevent slow pattern matching of large strings",
"properties": {
"maxLength": {
"maximum": 50000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"maxLength"
]
},
"prefixItems": {
"$comment": "array must not contain undefined item sub schemas",
"properties": {
"items": {
"const": false,
"type": "boolean"
}
},
"required": [
"items"
]
},
"uniqueItems": {
"description": "prevent slow validation of large non-scalar arrays",
"if": {
"properties": {
"items": {
"properties": {
"type": {
"anyOf": [
{
"enum": [
"object",
"array"
],
"type": "string"
},
{
"contains": {
"enum": [
"object",
"array"
]
},
"type": "array"
}
]
}
},
"type": "object"
},
"uniqueItems": {
"const": true
}
}
},
"then": {
"properties": {
"maxItems": {
"maximum": 100000,
"type": "number"
}
},
"required": [
"maxItems"
]
}
}
},
"properties": {
"$comment": {
"$ref": "https://json-schema.org/draft/2020-12/meta/core#/properties/$comment"
},
"$id": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"$ref": {
"minLength": 1,
"pattern": "^#",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"byteArray": {
"const": true,
"type": "boolean"
},
"const": true,
"contains": {
"$ref": "https://json-schema.org/draft/2020-12/meta/applicator#/properties/contains"
},
"contentMediaType": {
"$ref": "https://json-schema.org/draft/2020-12/meta/content#/properties/contentMediaType"
},
"dependentRequired": {
"additionalProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/$defs/stringArray"
},
"minProperties": 1,
"type": "object"
},
"dependentSchemas": {
"additionalProperties": {
"$ref": "#/$defs/documentSchema"
},
"minProperties": 1,
"type": "object"
},
"description": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/description"
},
"enum": {
"items": true,
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"examples": {
"$ref": "https://json-schema.org/draft/2020-12/meta/meta-data#/properties/examples"
},
"exclusiveMaximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMaximum"
},
"exclusiveMinimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/exclusiveMinimum"
},
"format": {
"$ref": "https://json-schema.org/draft/2020-12/meta/format-annotation#/properties/format"
},
"items": true,
"maxItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxItems"
},
"maxLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxLength"
},
"maxProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maxProperties"
},
"maximum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/maximum"
},
"minItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minItems"
},
"minLength": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minLength"
},
"minProperties": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minProperties"
},
"minimum": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/minimum"
},
"multipleOf": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/multipleOf"
},
"pattern": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/pattern"
},
"position": {
"minimum": 0,
"type": "integer"
},
"prefixItems": {
"$ref": "#/$defs/documentSchemaArray"
},
"properties": {
"$ref": "#/$defs/documentProperties"
},
"required": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/required"
},
"type": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/type"
},
"uniqueItems": {
"$ref": "https://json-schema.org/draft/2020-12/meta/validation#/properties/uniqueItems"
}
},
"type": "object"
},
"documentSchemaArray": {
"items": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"minItems": 1,
"type": "array"
}
},
"$id": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"$defs": {
"$ref": "#/$defs/documentProperties"
},
"$schema": {
"const": "https://github.com/dashpay/platform/blob/master/packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json",
"type": "string"
},
"additionalProperties": {
"const": false,
"type": "boolean"
},
"canBeDeleted": {
"description": "True if the documents can be deleted, default is true",
"type": "boolean"
},
"creationRestrictionMode": {
"description": "Restrictions of document creation. 0 - No restrictions, 1 - Owner only, 2 - No creation (System Only)",
"enum": [
0,
1,
2
],
"type": "integer"
},
"documentsKeepHistory": {
"description": "True if the documents keep all their history, default is false",
"type": "boolean"
},
"documentsMutable": {
"description": "True if the documents are mutable, default is true",
"type": "boolean"
},
"indices": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"type": "string"
},
"properties": {
"items": {
"additionalProperties": {
"enum": [
"asc"
],
"type": "string"
},
"maxProperties": 1,
"minProperties": 1,
"propertyNames": {
"maxLength": 256
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"unique": {
"type": "boolean"
}
},
"required": [
"properties",
"name"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"properties": {
"additionalProperties": {
"allOf": [
{
"$ref": "#/$defs/documentSchema"
}
],
"type": "object",
"unevaluatedProperties": false
},
"maxProperties": 100,
"minProperties": 1,
"properties": {
"$createdAt": true,
"$createdAtBlockHeight": true,
"$createdAtCoreBlockHeight": true,
"$id": true,
"$ownerId": true,
"$revision": true,
"$transferredAt": true,
"$transferredAtBlockHeight": true,
"$transferredAtCoreBlockHeight": true,
"$updatedAt": true,
"$updatedAtBlockHeight": true,
"$updatedAtCoreBlockHeight": true
},
"propertyNames": {
"oneOf": [
{
"pattern": "^[a-zA-Z0-9-_]{1,64}$",
"type": "string"
},
{
"enum": [
"$id",
"$ownerId",
"$revision",
"$createdAt",
"$updatedAt",
"$transferredAt",
"$createdAtBlockHeight",
"$updatedAtBlockHeight",
"$transferredAtBlockHeight",
"$createdAtCoreBlockHeight",
"$updatedAtCoreBlockHeight",
"$transferredAtCoreBlockHeight"
],
"type": "string"
}
]
},
"type": "object"
},
"requiresIdentityDecryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"requiresIdentityEncryptionBoundedKey": {
"description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key.",
"enum": [
0,
1,
2
],
"type": "integer"
},
"signatureSecurityLevelRequirement": {
"description": "Public key security level. 0 - Master, 1 - Critical, 2 - High, 3 - Medium. If none specified, High level is used",
"enum": [
0,
1,
2,
3
],
"type": "integer"
},
"tradeMode": {
"description": "Built in marketplace system. 0 - None, 1 - Direct purchase (The user can buy the item without the need for an approval)",
"enum": [
0,
1
],
"type": "integer"
},
"transferable": {
"description": "Transferable without a marketplace sell. 0 - Never, 1 - Always",
"enum": [
0,
1
],
"type": "integer"
},
"type": {
"const": "object",
"type": "string"
}
},
"required": [
"$schema",
"type",
"properties",
"additionalProperties"
],
"type": "object"
} | MIT | en |
dashpay/platform | 36f1d7324ecca5292b0abaf99c9027e44bd10396 | 2023-08-20T15:47:27 | packages/rs-dpp/src/schema/document/v0/stateTransition/documentTransition/replace.json | 39 | 2024-05-27T10:21:19.637981Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"$revision": {
"minimum": 1,
"type": "integer"
},
"$updatedAt": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"$revision"
],
"type": "object"
} | MIT | en |
pawamoy/markdown-exec | 861dad010b29818d975cbb14e202144f7f461f51 | 2022-12-11T18:31:15 | docs/schema.json | 78 | 2024-05-27T05:08:49.122986Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"markdown-exec"
],
"markdownDescription": "https://pawamoy.github.io/markdown-exec"
},
{
"additionalProperties": false,
"properties": {
"markdown-exec": {
"additionalProperties": false,
"markdownDescription": "https://pawamoy.github.io/markdown-exec",
"properties": {
"languages": {
"items": {
"type": "string"
},
"title": "The languages to enabled execution for.",
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "Utilities to execute code blocks in Markdown files.nto your site."
} | ISC | en |
pawamoy/mkdocs-coverage | 02e03fee64eeb30de0341099974f075da6150e27 | 2022-12-11T18:24:17 | docs/schema.json | 16 | 2024-05-28T01:01:33.013999Z | {
"$schema": "https://json-schema.org/draft-07/schema",
"oneOf": [
{
"enum": [
"coverage"
],
"markdownDescription": "https://pawamoy.github.io/mkdocs-coverage"
},
{
"additionalProperties": false,
"properties": {
"coverage": {
"additionalProperties": false,
"markdownDescription": "https://pawamoy.github.io/mkdocs-coverage",
"properties": {
"html_report_dir": {
"default": "htmlcov",
"format": "path",
"title": "The path to the HTML report directory generated by coverage.",
"type": "string"
},
"page_name": {
"default": "coverage",
"title": "The name of the page (file) where the coverage report is integrated.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
],
"title": "MkDocs plugin to integrate your coverage HTML report into your site."
} | ISC | en |
polyphene/holium-rs | e3249cbd674c6b0a4f47a87e1594f8bd34cbf4e5 | 2021-11-12T14:07:10 | src/utils/local/helpers/selector/assets/schema.json | 6 | 2024-05-28T02:17:20.237264Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"exploreIndex": {
"additionalProperties": false,
"description": "ExploreIndex traverses a specific index in a list, and applies a next selector to the reached node.",
"properties": {
"i": {
"additionalProperties": false,
"properties": {
">": {
"$ref": "#",
"title": "next"
},
"i": {
"title": "index",
"type": "number"
}
},
"required": [
"i",
">"
],
"type": "object"
}
},
"required": [
"i"
],
"type": "object"
},
"exploreRange": {
"additionalProperties": false,
"description": "ExploreRange traverses a list, and for each element in the range specified, will apply a next selector to those reached nodes.",
"properties": {
"r": {
"additionalProperties": false,
"properties": {
"$": {
"title": "end",
"type": "number"
},
">": {
"$ref": "#",
"title": "next"
},
"^": {
"title": "start",
"type": "number"
}
},
"required": [
"^",
"$",
">"
],
"type": "object"
}
},
"required": [
"r"
],
"type": "object"
},
"exploreUnion": {
"additionalProperties": false,
"description": "ExploreUnion allows selection to continue with two or more distinct selectors while exploring the same tree of data.",
"properties": {
"|": {
"items": {
"$ref": "#"
},
"type": "array"
}
},
"required": [
"|"
],
"type": "object"
},
"matcher": {
"additionalProperties": false,
"description": "Matcher marks a node to be included in the \"result\" set.",
"properties": {
".": {
"additionalProperties": false,
"properties": {
"label": {
"description": "labels can be used to match multiple different structures in one selection.",
"type": "string"
}
},
"required": [],
"type": "object"
}
},
"required": [
"."
],
"type": "object"
}
},
"description": "Holium selectors are expressions that describe a traversal over indexes of Holium data objects. The Holium selector schema effectively is a sub-schema of IPLD selectors. Reference: https://ipld.io/specs/selectors/",
"oneOf": [
{
"$ref": "#/definitions/matcher"
},
{
"$ref": "#/definitions/exploreIndex"
},
{
"$ref": "#/definitions/exploreRange"
},
{
"$ref": "#/definitions/exploreUnion"
}
],
"title": "Holium selector schema"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/hgvs/gene_hgvs.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "base_hgvs.schema.json"
},
{
"properties": {
"hgvs": {
"pattern": "^[cg]"
}
}
}
],
"description": "Schema to validate JSON files describing a gene HGVS variant.",
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/edge.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"description": "Top-level schema to validate JSON files containing an edge.",
"properties": {
"annotations": {
"type": "object"
},
"citation": {
"properties": {
"db": {
"type": "string"
},
"db_id": {
"type": "string"
}
},
"type": "object"
},
"evidence": {
"type": "string"
},
"relation": {
"type": "string"
},
"source": {
"$ref": "modifier.schema.json"
},
"target": {
"$ref": "modifier.schema.json"
}
},
"required": [
"source",
"relation",
"target"
],
"title": "BEL Edge",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/gene_mod.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "base_variant.schema.json"
},
{
"properties": {
"kind": {
"const": "gmod"
}
}
}
],
"description": "Schema to validate JSON files describing a gene modification variant.",
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/entity.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"anyOf": [
{
"required": [
"namespace"
]
},
{
"required": [
"name"
]
},
{
"required": [
"identifier"
]
}
],
"description": "Schema to validate a named entity with a namespace and a name/identifier",
"properties": {
"identifier": {
"type": "string"
},
"name": {
"description": "Name of the node, e.g. ACE2",
"type": "string"
},
"namespace": {
"description": "Namespace of the node, e.g. ChemBL",
"type": "string"
}
},
"title": "BEL Entity",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/protein_mod.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "base_variant.schema.json"
},
{
"properties": {
"kind": {
"const": "pmod"
}
}
}
],
"description": "Schema to validate JSON files describing a protein modification variant.",
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/reaction.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"description": "Schema to validate JSON files containing a Reaction node.",
"properties": {
"function": {
"const": "Reaction"
},
"products": {
"items": {
"$ref": "base_abundance.schema.json"
},
"type": "array"
},
"reactants": {
"items": {
"$ref": "base_abundance.schema.json"
},
"type": "array"
}
},
"required": [
"function",
"reactants",
"products"
],
"title": "BEL Reaction Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/modifier.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "base_node.schema.json"
},
{
"properties": {
"effect": {
"oneOf": [
{
"$comment": "Generally, the effect entry will be a pybel.dsl.Entity.",
"$ref": "entity.schema.json"
},
{
"$comment": "However, translocations have a slightly different format.",
"properties": {
"fromLoc": {
"$ref": "entity.schema.json"
},
"toLoc": {
"$ref": "entity.schema.json"
}
},
"required": [
"fromLoc",
"toLoc"
]
}
],
"type": "object"
},
"location": {
"$ref": "entity.schema.json"
},
"modifier": {
"type": "string"
}
}
}
],
"description": "Schema to validate JSON files containing a modifier for a subject/object node in an edge.",
"title": "BEL Subject/Object Modifier",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/fusion.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"description": "Basic schema to validate JSON files describing a BEL fusion object",
"properties": {
"fusion": {
"properties": {
"partner_3p": {
"$ref": "base_abundance.schema.json",
"description": "3-prime fusion partner"
},
"partner_5p": {
"$ref": "base_abundance.schema.json",
"description": "5-prime fusion partner"
},
"range_3p": {
"$ref": "fusion_range.schema.json",
"description": "Fusion range for the 3-prime partner"
},
"range_5p": {
"$ref": "fusion_range.schema.json",
"description": "Fusion range for the 5-prime partner"
}
},
"type": "object"
}
},
"required": [
"function",
"fusion"
],
"title": "BEL Fusion Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/fragment.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "base_variant.schema.json"
},
{
"properties": {
"kind": {
"const": "frag"
}
}
}
],
"description": "Schema to validate JSON files describing a protein fragment variant.",
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/fusion_range.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"description": "Schema to validate JSON files describing a BEL FusionRange object",
"oneOf": [
{
"required": [
"reference",
"left",
"right"
]
},
{
"required": [
"missing"
]
}
],
"properties": {
"left": {
"description": "The start position",
"type": [
"string",
"integer"
]
},
"missing": {
"const": "?"
},
"reference": {
"description": "The reference code",
"type": "string"
},
"right": {
"description": "The stop position",
"type": [
"string",
"integer"
]
}
},
"title": "BEL FusionRange Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/base_abundance.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"if": {
"properties": {
"function": {
"const": "Protein"
}
}
},
"then": {
"properties": {
"variants": {
"items": {
"anyOf": [
{
"$ref": "variants/protein_mod.schema.json"
},
{
"$ref": "variants/hgvs/base_hgvs.schema.json"
},
{
"$ref": "variants/fragment.schema.json"
}
]
},
"type": "array"
}
}
}
},
{
"if": {
"properties": {
"function": {
"const": "Gene"
}
}
},
"then": {
"properties": {
"variants": {
"items": {
"$ref": "variants/gene_mod.schema.json"
},
"type": "array"
}
}
}
},
{
"if": {
"not": {
"properties": {
"function": {
"enum": [
"Protein",
"Gene"
]
}
}
}
},
"then": {
"properties": {
"variants": {
"items": {
"$ref": "variants/base_variant.schema.json"
},
"type": "array"
}
}
}
}
],
"description": "Schema to validate JSON files containing a BaseAbundance (or subclass) node.",
"properties": {
"concept": {
"$ref": "../entity.schema.json"
},
"function": {
"description": "The function of the node."
},
"xrefs": {
"description": "An optional list of extra identifiers for the node.",
"items": {
"$ref": "../entity.schema.json"
},
"type": "array"
}
},
"required": [
"function"
],
"title": "BEL BaseAbundance Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/list_abundance.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"description": "Schema to validate JSON files containing a ListAbundance (ComplexAbundance or CompositeAbundance) node.",
"else": {
"required": [
"function"
]
},
"if": {
"properties": {
"function": {
"const": "Complex"
}
}
},
"properties": {
"concept": {
"$ref": "../entity.schema.json"
},
"function": {
"enum": [
"Complex",
"Composite"
]
},
"members": {
"items": {
"$ref": "base_abundance.schema.json"
},
"type": "array"
},
"variants": {
"items": {
"$ref": "variants/base_variant.schema.json"
},
"type": "array"
},
"xrefs": {
"description": "An optional list of extra identifiers for the node.",
"items": {
"$ref": "../entity.schema.json"
},
"type": "array"
}
},
"then": {
"required": [
"function",
"concept"
]
},
"title": "BEL ListAbundance Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/hgvs/base_hgvs.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "../base_variant.schema.json"
},
{
"properties": {
"kind": {
"const": "hgvs"
}
}
},
{
"required": [
"hgvs"
]
}
],
"description": "Schema to validate JSON files describing a HGVS variant.",
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/hgvs/rna_hgvs.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "base_hgvs.schema.json"
},
{
"properties": {
"hgvs": {
"pattern": "^r"
}
}
}
],
"description": "Schema to validate JSON files describing a RNA HGVS variant.",
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/base_variant.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"description": "Basic schema to validate JSON files describing a BEL variant object",
"properties": {
"code": {
"description": "Amino acid code for the affected residue in a protein modification",
"enum": [
"Ala",
"Arg",
"Asn",
"Asp",
"Cys",
"Glu",
"Gln",
"Gly",
"His",
"Ile",
"Leu",
"Lys",
"Met",
"Phe",
"Pro",
"Ser",
"Thr",
"Trp",
"Tyr",
"Val"
]
},
"concept": {
"$ref": "../../entity.schema.json",
"description": "Entity description if the variant is a protein or gene modification"
},
"hgvs": {
"description": "HGVS variant string",
"type": "string"
},
"pos": {
"description": "Position of the affected residue in a protein modification",
"type": "number"
},
"start": {
"description": "Starting position of a protein fragment",
"type": [
"number",
"string"
]
},
"stop": {
"description": "Stopping position of a protein fragment",
"type": [
"number",
"string"
]
}
},
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/node_types/variants/hgvs/protein_hgvs.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$ref": "base_hgvs.schema.json"
},
{
"properties": {
"hgvs": {
"pattern": "^p"
}
}
}
],
"description": "Schema to validate JSON files describing a protein HGVS variant.",
"title": "BEL Variant Node",
"type": "object"
} | MIT | en |
pybel/pybel | ce49543787b37e6a702c006482c0c31d42a22d04 | 2020-07-08T14:43:01 | src/pybel/schema/base_node.schema.json | 130 | 2024-05-28T06:11:58.842365Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema#",
"allOf": [
{
"$comment": "Check if the key 'fusion' is present. If so, validate based on the fusion schema.",
"if": {
"required": [
"fusion"
]
},
"then": {
"$ref": "node_types/fusion.schema.json"
}
},
{
"$comment": "Check whether the node is a Reaction. If so, validate accordingly.",
"if": {
"properties": {
"function": {
"const": "Reaction"
}
}
},
"then": {
"$ref": "node_types/reaction.schema.json"
}
},
{
"$comment": "Check whether the node is a Complex or Composite. If so, validate as a ListAbundance; if not, validate as a BaseAbundance.",
"else": {
"$ref": "node_types/base_abundance.schema.json"
},
"if": {
"properties": {
"function": {
"enum": [
"Complex",
"Composite"
]
}
}
},
"then": {
"$ref": "node_types/list_abundance.schema.json"
}
}
],
"description": "Top-level schema to validate JSON files containing any node.",
"title": "BEL Node",
"type": "object"
} | MIT | en |
runatlantis/helm-charts | 4cdb7909600431f6f956af2bb5f79e2b77e8419e | 2024-03-06T08:52:42 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"command": {
"description": "Override the command field of the Atlantis container",
"type": "array"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext configuration for atlantis containers.",
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": [
"string",
"integer",
"boolean"
]
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"default": "",
"description": "Provide a name to substitute for the full names of resources",
"type": "string"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"global": {
"additionalProperties": true,
"description": "Global values applied to all charts",
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initConfig": {
"description": "Init container used to install plugins/providers shared with Atlantis pods",
"properties": {
"enabled": {
"description": "Enable creation of init config",
"type": "boolean"
},
"image": {
"description": "Container image to use on init configs",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"script": {
"description": "Script to install tools/providers required by the atlantis pod",
"type": "string"
},
"sharedDir": {
"description": "sharedDir is set as env var INIT_SHARED_DIR",
"type": "string"
},
"sizeLimit": {
"description": "Size for the init-shared-path emptyDir volume",
"type": "string"
},
"workDir": {
"description": "Starting directory for the script",
"type": "string"
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"nameOverride": {
"default": "",
"description": "Override the name of the chart",
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"loadBalancerSourceRanges": {
"description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.",
"type": [
"array",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"accessModes": {
"description": "Array of requested access modes for the volume.",
"items": {
"description": "The access mode to be requested.",
"type": "string"
},
"type": "array"
},
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
runatlantis/helm-charts | de42379018e7ba36f215e3b40120e9d91f34f269 | 2023-11-16T23:36:03 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"command": {
"description": "Override the command field of the Atlantis container",
"type": "array"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext configuration for atlantis containers.",
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": [
"string",
"integer",
"boolean"
]
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"default": "",
"description": "Provide a name to substitute for the full names of resources",
"type": "string"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"global": {
"additionalProperties": true,
"description": "Global values applied to all charts",
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initConfig": {
"description": "Init container used to install plugins/providers shared with Atlantis pods",
"properties": {
"enabled": {
"description": "Enable creation of init config",
"type": "boolean"
},
"image": {
"description": "Container image to use on init configs",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"script": {
"description": "Script to install tools/providers required by the atlantis pod",
"type": "string"
},
"sharedDir": {
"description": "sharedDir is set as env var INIT_SHARED_DIR",
"type": "string"
},
"sizeLimit": {
"description": "Size for the init-shared-path emptyDir volume",
"type": "string"
},
"workDir": {
"description": "Starting directory for the script",
"type": "string"
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"nameOverride": {
"default": "",
"description": "Override the name of the chart",
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"loadBalancerSourceRanges": {
"description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.",
"type": [
"array",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
runatlantis/helm-charts | c86eab114b0ec1f8d0bce812d5bbc9f7baacc30b | 2023-11-15T20:54:05 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"command": {
"description": "Override the command field of the Atlantis container",
"type": "array"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"additionalProperties": false,
"description": "SecurityContext configuration for atlantis containers.",
"properties": {
"allowPrivilegeEscalation": {
"description": "Whether to enable privilege escalation",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"description": "Whether the root file system should be read-only",
"type": "boolean"
}
},
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"default": "",
"description": "Provide a name to substitute for the full names of resources",
"type": "string"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"global": {
"additionalProperties": true,
"description": "Global values applied to all charts",
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"nameOverride": {
"default": "",
"description": "Override the name of the chart",
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"loadBalancerSourceRanges": {
"description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.",
"type": [
"array",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
runatlantis/helm-charts | 24e58d0efe303d433081a9939180dd830810bab3 | 2023-11-09T21:14:32 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"additionalProperties": false,
"description": "SecurityContext configuration for atlantis containers.",
"properties": {
"allowPrivilegeEscalation": {
"description": "Whether to enable privilege escalation",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"description": "Whether the root file system should be read-only",
"type": "boolean"
}
},
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
runatlantis/helm-charts | cb8bed03315e23ffef78fff1f6d9cca8f419c784 | 2023-11-16T16:04:04 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"command": {
"description": "Override the command field of the Atlantis container",
"type": "array"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"additionalProperties": false,
"description": "SecurityContext configuration for atlantis containers.",
"properties": {
"allowPrivilegeEscalation": {
"description": "Whether to enable privilege escalation",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"description": "Whether the root file system should be read-only",
"type": "boolean"
}
},
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": [
"string",
"integer",
"boolean"
]
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"default": "",
"description": "Provide a name to substitute for the full names of resources",
"type": "string"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"global": {
"additionalProperties": true,
"description": "Global values applied to all charts",
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"nameOverride": {
"default": "",
"description": "Override the name of the chart",
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"loadBalancerSourceRanges": {
"description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.",
"type": [
"array",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
runatlantis/helm-charts | 592bff71ee24f723692699d873aae3b5590d04b8 | 2023-11-15T17:02:30 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"additionalProperties": false,
"description": "SecurityContext configuration for atlantis containers.",
"properties": {
"allowPrivilegeEscalation": {
"description": "Whether to enable privilege escalation",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"description": "Whether the root file system should be read-only",
"type": "boolean"
}
},
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"default": "",
"description": "Provide a name to substitute for the full names of resources",
"type": "string"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"global": {
"additionalProperties": true,
"description": "Global values applied to all charts",
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"nameOverride": {
"default": "",
"description": "Override the name of the chart",
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"loadBalancerSourceRanges": {
"description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.",
"type": [
"array",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
runatlantis/helm-charts | b6fe4af745c9cb61dc784bc26d25dfc7d5d38cc0 | 2023-11-14T20:18:44 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"additionalProperties": false,
"description": "SecurityContext configuration for atlantis containers.",
"properties": {
"allowPrivilegeEscalation": {
"description": "Whether to enable privilege escalation",
"type": "boolean"
},
"readOnlyRootFilesystem": {
"description": "Whether the root file system should be read-only",
"type": "boolean"
}
},
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": "string"
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"default": "",
"description": "Provide a name to substitute for the full names of resources",
"type": "string"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"global": {
"additionalProperties": true,
"description": "Global values applied to all charts",
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"nameOverride": {
"default": "",
"description": "Override the name of the chart",
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
runatlantis/helm-charts | 7b09cc369830e5123003a3639f42ef724cb5511a | 2023-11-16T17:57:59 | charts/atlantis/values.schema.json | 108 | 2024-05-28T04:49:11.307596Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"definitions": {
"io.k8s.api.apps.v1.StatefulSetUpdateStrategy": {
"additionalProperties": false,
"description": "StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.",
"properties": {
"rollingUpdate": {
"additionalProperties": false,
"description": "RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.",
"properties": {
"maxUnavailable": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": [
"integer",
"null"
]
}
]
},
"partition": {
"description": "Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.",
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"io.k8s.api.core.v1.Affinity": {
"additionalProperties": false,
"description": "Affinity is a group of affinity scheduling rules.",
"properties": {
"nodeAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeAffinity",
"description": "Describes node affinity scheduling rules for the pod."
},
"podAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinity",
"description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."
},
"podAntiAffinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.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))."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Capabilities": {
"additionalProperties": false,
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapEnvSource": {
"additionalProperties": false,
"description": "ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.\n\nThe contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ConfigMapKeySelector": {
"additionalProperties": false,
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.Container": {
"additionalProperties": false,
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"type": "array",
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
},
"type": "array"
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated."
},
"livenessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"containerPort",
"protocol"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"
},
"startupProbe": {
"$ref": "#/definitions/io.k8s.api.core.v1.Probe",
"description": "StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"type": "array",
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array",
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.ContainerPort": {
"additionalProperties": false,
"description": "ContainerPort represents a network port in a single container.",
"properties": {
"containerPort": {
"description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.",
"format": "int32",
"type": "integer"
},
"hostIP": {
"description": "What host IP to bind the external port to.",
"type": "string"
},
"hostPort": {
"description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.",
"type": "string"
},
"protocol": {
"description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".",
"type": "string"
}
},
"required": [
"containerPort"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvFromSource": {
"additionalProperties": false,
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource",
"description": "The ConfigMap to select from"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretEnvSource",
"description": "The Secret to select from"
}
},
"type": "object"
},
"io.k8s.api.core.v1.EnvVar": {
"additionalProperties": false,
"description": "EnvVar represents an environment variable present in a Container.",
"properties": {
"name": {
"description": "Name of the environment variable. Must be a C_IDENTIFIER.",
"type": "string"
},
"value": {
"description": "Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVarSource",
"description": "Source for the environment variable's value. Cannot be used if value is not empty."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.core.v1.EnvVarSource": {
"additionalProperties": false,
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector",
"description": "Selects a key of a ConfigMap."
},
"fieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ObjectFieldSelector",
"description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs."
},
"resourceFieldRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceFieldSelector",
"description": "Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."
},
"secretKeyRef": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector",
"description": "Selects a key of a secret in the pod's namespace"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ExecAction": {
"additionalProperties": false,
"description": "ExecAction describes a \"run in container\" action.",
"properties": {
"command": {
"description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HTTPGetAction": {
"additionalProperties": false,
"description": "HTTPGetAction describes an action based on HTTP Get requests.",
"properties": {
"host": {
"description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.",
"type": "string"
},
"httpHeaders": {
"description": "Custom headers to set in the request. HTTP allows repeated headers.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPHeader"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.HTTPHeader": {
"additionalProperties": false,
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.Handler": {
"additionalProperties": false,
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
}
},
"type": "object"
},
"io.k8s.api.core.v1.HostAlias": {
"additionalProperties": false,
"description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.",
"properties": {
"hostnames": {
"description": "Hostnames for the above IP address.",
"items": {
"type": "string"
},
"type": "array"
},
"ip": {
"description": "IP address of the host file entry.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.Lifecycle": {
"additionalProperties": false,
"description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"properties": {
"postStart": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
},
"preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.Handler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeAffinity": {
"additionalProperties": false,
"description": "Node affinity is a group of node affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node."
}
},
"type": "object"
},
"io.k8s.api.core.v1.NodeSelector": {
"additionalProperties": false,
"description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.",
"properties": {
"nodeSelectorTerms": {
"description": "Required. A list of node selector terms. The terms are ORed.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm"
},
"type": "array"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.NodeSelectorRequirement": {
"additionalProperties": false,
"description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"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. Valid 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, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.api.core.v1.NodeSelectorTerm": {
"additionalProperties": false,
"description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.",
"properties": {
"matchExpressions": {
"description": "A list of node selector requirements by node's labels.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement"
},
"type": "array"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ObjectFieldSelector": {
"additionalProperties": false,
"description": "ObjectFieldSelector selects an APIVersioned field of an object.",
"properties": {
"apiVersion": {
"description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".",
"type": "string"
},
"fieldPath": {
"description": "Path of the field to select in the specified API version.",
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.PodAffinity": {
"additionalProperties": false,
"description": "Pod affinity is a group of inter pod affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodAffinityTerm": {
"additionalProperties": false,
"description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over a set of resources, in this case pods."
},
"namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled."
},
"namespaces": {
"description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"",
"items": {
"type": "string"
},
"type": "array"
},
"topologyKey": {
"description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.",
"type": "string"
}
},
"required": [
"topologyKey"
],
"type": "object"
},
"io.k8s.api.core.v1.PodAntiAffinity": {
"additionalProperties": false,
"description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.",
"properties": {
"preferredDuringSchedulingIgnoredDuringExecution": {
"description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm"
},
"type": "array"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm"
},
"type": "array"
}
},
"type": "object"
},
"io.k8s.api.core.v1.PodSecurityContext": {
"additionalProperties": false,
"description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.",
"properties": {
"fsGroup": {
"description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.",
"format": "int64",
"type": "integer"
},
"fsGroupChangePolicy": {
"description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.",
"type": "string"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by the containers in this pod."
},
"supplementalGroups": {
"description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"sysctls": {
"description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Sysctl"
},
"type": "array"
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.PreferredSchedulingTerm": {
"additionalProperties": false,
"description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).",
"properties": {
"preference": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelectorTerm",
"description": "A node selector term, associated with the corresponding weight."
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"io.k8s.api.core.v1.Probe": {
"additionalProperties": false,
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take."
},
"failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
"description": "HTTPGet specifies the http request to perform."
},
"initialDelaySeconds": {
"description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
},
"periodSeconds": {
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"successThreshold": {
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.",
"format": "int32",
"type": "integer"
},
"tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported"
},
"terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",
"format": "int64",
"type": "integer"
},
"timeoutSeconds": {
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.core.v1.ResourceFieldSelector": {
"additionalProperties": false,
"description": "ResourceFieldSelector represents container resources (cpu, memory) and their output format",
"properties": {
"containerName": {
"description": "Container name: required for volumes, optional for env vars",
"type": "string"
},
"divisor": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity",
"description": "Specifies the output format of the exposed resources, defaults to \"1\""
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.ResourceRequirements": {
"additionalProperties": false,
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
},
"requests": {
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SELinuxOptions": {
"additionalProperties": false,
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SeccompProfile": {
"additionalProperties": false,
"description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"io.k8s.api.core.v1.SecretEnvSource": {
"additionalProperties": false,
"description": "SecretEnvSource selects a Secret to populate the environment variables with.\n\nThe contents of the target Secret's Data field will represent the key-value pairs as environment variables.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
},
"io.k8s.api.core.v1.SecretKeySelector": {
"additionalProperties": false,
"description": "SecretKeySelector selects a key of a Secret.",
"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. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.api.core.v1.SecurityContext": {
"additionalProperties": false,
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"$ref": "#/definitions/io.k8s.api.core.v1.Capabilities",
"description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime."
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"runAsNonRoot": {
"description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "boolean"
},
"runAsUser": {
"description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.SELinuxOptions",
"description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
},
"seccompProfile": {
"$ref": "#/definitions/io.k8s.api.core.v1.SeccompProfile",
"description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options."
},
"windowsOptions": {
"$ref": "#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions",
"description": "The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence."
}
},
"type": "object"
},
"io.k8s.api.core.v1.Sysctl": {
"additionalProperties": false,
"description": "Sysctl defines a kernel parameter to be set",
"properties": {
"name": {
"description": "Name of a property to set",
"type": "string"
},
"value": {
"description": "Value of a property to set",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"io.k8s.api.core.v1.TCPSocketAction": {
"additionalProperties": false,
"description": "TCPSocketAction describes an action based on opening a socket",
"properties": {
"host": {
"description": "Optional: Host name to connect to, defaults to the pod IP.",
"type": "string"
},
"port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."
}
},
"required": [
"port"
],
"type": "object"
},
"io.k8s.api.core.v1.Toleration": {
"additionalProperties": false,
"description": "The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.",
"properties": {
"effect": {
"description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.",
"type": "string"
},
"key": {
"description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.",
"type": "string"
},
"operator": {
"description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.",
"type": "string"
},
"tolerationSeconds": {
"description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.",
"format": "int64",
"type": "integer"
},
"value": {
"description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.api.core.v1.TopologySpreadConstraint": {
"additionalProperties": false,
"description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain."
},
"maxSkew": {
"description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.",
"format": "int32",
"type": "integer"
},
"topologyKey": {
"description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. It's a required field.",
"type": "string"
},
"whenUnsatisfiable": {
"description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assigment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.",
"type": "string"
}
},
"required": [
"maxSkew",
"topologyKey",
"whenUnsatisfiable"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeDevice": {
"additionalProperties": false,
"description": "volumeDevice describes a mapping of a raw block device within a container.",
"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"
}
},
"required": [
"name",
"devicePath"
],
"type": "object"
},
"io.k8s.api.core.v1.VolumeMount": {
"additionalProperties": false,
"description": "VolumeMount describes a mounting of a Volume within a container.",
"properties": {
"mountPath": {
"description": "Path within the container at which the volume should be mounted. Must not contain ':'.",
"type": "string"
},
"mountPropagation": {
"description": "mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.",
"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). Defaults to false.",
"type": "boolean"
},
"subPath": {
"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).",
"type": "string"
},
"subPathExpr": {
"description": "Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to \"\" (volume's root). SubPathExpr and SubPath are mutually exclusive.",
"type": "string"
}
},
"required": [
"name",
"mountPath"
],
"type": "object"
},
"io.k8s.api.core.v1.WeightedPodAffinityTerm": {
"additionalProperties": false,
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodAffinityTerm",
"description": "Required. A pod affinity term, associated with the corresponding weight."
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"io.k8s.api.core.v1.WindowsSecurityContextOptions": {
"additionalProperties": false,
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector": {
"additionalProperties": false,
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement"
},
"type": "array"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement": {
"additionalProperties": false,
"description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string",
"x-kubernetes-patch-merge-key": "key",
"x-kubernetes-patch-strategy": "merge"
},
"operator": {
"description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"description": "Default values for atlantis. Declare variables to be passed into your templates.",
"properties": {
"affinity": {
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
"default": "{}",
"description": "Specify Affinity for all pods.",
"type": "object"
},
"allowDraftPRs": {
"default": false,
"description": "Allow atlantis to run on draft Pull Requests",
"type": "boolean"
},
"allowForkPRs": {
"default": false,
"description": "Allow atlantis to run on fork Pull Requests",
"type": "boolean"
},
"api": {
"additionalProperties": false,
"description": "API settings",
"properties": {
"secret": {
"description": "API secret to enable API endpoints",
"type": "string"
}
},
"type": "object"
},
"apiSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `apisecret` key. Use this instead of `api.secret`",
"type": "string"
},
"atlantisDataDirectory": {
"default": "/atlantis-data",
"description": "Directory to store atlantis data.",
"type": "string"
},
"atlantisUrl": {
"default": "",
"description": "The URL at which Atlantis will be available. This is used to set the webhook URL in GitHub.",
"examples": [
"https://atlantis.example.com"
],
"type": "string"
},
"aws": {
"additionalProperties": false,
"description": "AWS settings",
"properties": {
"config": {
"description": "Contents of a file to be mounted to `~/.aws/config` or `aws.directory/config`.",
"type": "string"
},
"credentials": {
"description": "Contents of a file to be mounted to `~/.aws/credentials` `aws.directory/credentials`.",
"type": "string"
},
"directory": {
"description": "If set, will mount AWS credentials to the specified path and set `AWS_SHARED_CREDENTIALS_FILE` and `AWS_CONFIG_FILE` variables. If not set, default path `/home/atlantis/.aws` will be used.",
"type": "string"
}
},
"type": "object"
},
"awsSecretName": {
"description": "Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on `$HOME/.aws` or `aws.directory`, so it needs a `credentials` key. The key `config` is optional. See the file `templates/secret-aws.yml` for more info on the Secret contents.",
"type": "string"
},
"azuredevops": {
"additionalProperties": false,
"description": "Azure DevOps settings",
"properties": {
"token": {
"description": "Personal access token for the Atlantis Azure DevOps user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Azure DevOps user.",
"type": "string"
},
"webhookPassword": {
"description": "Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"webhookUser": {
"description": "Webhook user for the Atlantis Azure DevOps integration.",
"type": "string"
}
},
"type": "object"
},
"basicAuth": {
"additionalProperties": false,
"description": "Basic auth settings",
"properties": {
"password": {
"description": "Password for basic authentication",
"type": "string"
},
"username": {
"description": "Username for basic authentication",
"type": "string"
}
},
"required": [
"username",
"password"
],
"type": "object"
},
"basicAuthSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `username` and `password` keys for basic auth credentials. Use this instead of `basicAuth.username`/`basicAuth.password`",
"type": "string"
},
"bitbucket": {
"additionalProperties": false,
"description": "Bitbucket settings",
"properties": {
"baseURL": {
"description": "Base URL of Bitbucket Server installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for Bitbucket repositories (Bitbucket Server only).",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis Bitbucket user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis Bitbucket user.",
"type": "string"
}
},
"type": "object"
},
"command": {
"description": "Override the command field of the Atlantis container",
"type": "array"
},
"commonLabels": {
"additionalProperties": true,
"description": "Add Common Labels to all resources",
"type": "object"
},
"config": {
"description": "Override atlantis main configuration by config map. It's allow some additional functionality like slack notifications.",
"type": "string"
},
"containerSecurityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext",
"description": "SecurityContext configuration for atlantis containers.",
"type": "object"
},
"customPem": {
"description": "SecretName of the custom `ca-certificates.cert` to override the `/etc/ssl/certs/ca-certificates.crt` with your custom one (self-signed certificates)<br>Secret has to be created manually and shall contain `ca-certificates.crt: PEM`",
"type": "string"
},
"dataStorage": {
"description": "DEPRECATED - Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).",
"type": "string"
},
"defaultTFVersion": {
"description": "Default Terraform version to be used by atlantis server",
"type": "string"
},
"disableApply": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableApplyAll": {
"default": false,
"description": "Disables running `atlantis apply` regardless of what options are specified",
"type": "boolean"
},
"disableRepoLocking": {
"default": false,
"description": "Stops atlantis locking projects and or workspaces when running terraform",
"type": "boolean"
},
"enableDiffMarkdownFormat": {
"default": false,
"description": "Enable Atlantis to format Terraform plan output into a markdown-diff friendly format for color-coding purposes.",
"type": "boolean"
},
"enableKubernetesBackend": {
"default": false,
"description": "Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend",
"type": "boolean"
},
"environment": {
"additionalProperties": {
"type": [
"string",
"integer",
"boolean"
]
},
"description": "Map of environment variables for the container.",
"type": "object"
},
"environmentRaw": {
"description": "Array environment variables in plain Kubernetes yaml format. See `values.yaml` for example.",
"items": {
"type": "object"
},
"type": "array"
},
"environmentSecrets": {
"description": "Array of Kubernetes secrets that can be used to set environment variables. See `values.yaml` for example.",
"items": {
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"secretKeyRef": {
"properties": {
"key": {
"description": "The key of the value in the Kubernetes secret that should be used to populate the environment variable.",
"type": "string"
},
"name": {
"description": "The name of the Kubernetes secret.",
"type": "string"
}
},
"required": [
"name",
"key"
],
"type": "object"
}
},
"required": [
"name",
"secretKeyRef"
],
"type": "object"
},
"type": "array"
},
"extraArgs": {
"description": "Add additional arguments to the atlantis server",
"examples": [
[
"--disable-autoplan",
"--disable-repo-locking"
]
],
"items": {
"type": "string"
},
"type": "array"
},
"extraContainers": {
"default": [],
"description": "Additional containers to use and depends of use cases.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"extraManifests": {
"description": "Add additional manifests to deploy",
"items": {
"type": "object"
},
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"description": "List of additional volumes mounted to the container.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"type": "array"
},
"extraVolumes": {
"default": [],
"description": "List of additional volumes available to the pod.",
"items": {
"type": "object"
},
"type": "array"
},
"fullnameOverride": {
"default": "",
"description": "Provide a name to substitute for the full names of resources",
"type": "string"
},
"gitconfig": {
"description": "Contents of a file to be mounted to `~/.gitconfig`. Use to allow redirection for Terraform modules in private git repositories.",
"type": "string"
},
"gitconfigSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `gitconfig` key. Use this instead of `gitconfig` (optional)",
"type": "string"
},
"github": {
"additionalProperties": false,
"description": "GitHub settings",
"properties": {
"hostname": {
"description": "Hostname of your GitHub Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitHub user.",
"type": "string"
}
},
"type": "object"
},
"githubApp": {
"additionalProperties": false,
"description": "GitHub App settings",
"properties": {
"id": {
"description": "GitHub app ID. If set, GitHub authentication will be performed as an [installation](https://developer.github.com/v3/apps/installations/).",
"type": [
"integer",
"string"
]
},
"key": {
"description": "A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an [installation]((https://developer.github.com/v3/apps/installations/)).",
"type": "string"
},
"secret": {
"description": "Secret used to validate GitHub webhooks (see [Securing your webhooks](https://developer.github.com/webhooks/securing/)).",
"type": "string"
},
"slug": {
"description": "A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as `hidePrevPlanComments`.",
"type": "string"
}
},
"type": "object"
},
"gitlab": {
"additionalProperties": false,
"description": "GitLab settings",
"properties": {
"hostname": {
"description": "Hostname of your GitLab Enterprise installation.",
"type": "string"
},
"secret": {
"description": "Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value.",
"type": "string"
},
"token": {
"description": "Personal access token for the Atlantis GitLab user.",
"type": "string"
},
"user": {
"description": "Name of the Atlantis GitLab user.",
"type": "string"
}
},
"type": "object"
},
"global": {
"additionalProperties": true,
"description": "Global values applied to all charts",
"type": "object"
},
"googleServiceAccountSecrets": {
"description": "An array of Kubernetes secrets containing Google Service Account credentials. See `values.yaml` for examples and additional documentation.",
"items": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the volume that will mount the secret.",
"type": "string"
},
"secretName": {
"description": "The name of the Kubernetes secret containing the Google service account credentials.",
"type": "string"
}
},
"required": [
"name",
"secretName"
],
"type": "object"
},
"type": "array"
},
"hidePrevPlanComments": {
"default": false,
"description": "Allow atlantis to hide previous plan comments",
"type": "boolean"
},
"hideUnchangedPlanComments": {
"default": false,
"description": "Allow atlantis to hide no-changes plan comments",
"type": "boolean"
},
"hostAliases": {
"default": [],
"description": "Specify HostAliases for Atlantis containers.",
"examples": [
{
"hostnames": [
"test.hostname.one"
],
"ip": "127.0.0.2"
},
{
"hostnames": [
"test.hostname.two"
],
"ip": "127.0.0.3"
}
],
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.HostAlias"
},
"type": "array"
},
"hostNetwork": {
"default": false,
"description": "Use the host's network namespace.",
"type": "boolean"
},
"image": {
"additionalProperties": false,
"description": "Atlantis image configuration.",
"properties": {
"pullPolicy": {
"default": "Always",
"description": "image pull policy.",
"enum": [
"Always",
"Never",
"IfNotPresent"
],
"type": "string"
},
"repository": {
"default": "ghcr.io/runatlantis/atlantis",
"description": "image repository.",
"type": "string"
},
"tag": {
"default": "",
"description": "image tag. if not set appVersion field from Chart.yaml is used",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"imagePullSecrets": {
"description": "List of secrets for pulling images from private registries.",
"items": {
"type": "string"
},
"type": "array"
},
"ingress": {
"description": "Ingress configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for the Ingress.",
"host": {
"default": null,
"description": "Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.",
"type": [
"string",
"null"
]
},
"hosts": {
"description": "An array of hosts to expose (optional)",
"items": {
"properties": {
"host": {
"description": "List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on.",
"type": "string"
},
"paths": {
"description": "List of paths to use in Kubernetes Ingress rules. Should be set to `/*` if using gce-ingress in Google",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for the Ingress.",
"type": "object"
},
"path": {
"default": "/*",
"description": "Path to use in the `Ingress`. Should be set to `/*` if using gce-ingress in Google Cloud.",
"type": "string"
},
"pathType": {
"default": "ImplementationSpecific",
"description": "pathType to use in the `Ingress`. specify how Ingress paths should be matched. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types) for details.",
"type": "string"
},
"paths": {
"description": "collection of paths that map requests to backends.",
"items": {
"properties": {
"path": {
"description": "path is matched against the path of an incoming request",
"type": "string"
},
"port": {
"description": "backend defines the referenced service endpoint to which the traffic will be forwarded to",
"type": [
"integer",
"null"
]
},
"service": {
"description": "service references a service as a backend.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"tls": {
"description": "Kubernetes tls block. See [Kubernetes docs](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls) for details.",
"items": {
"properties": {
"hosts": {
"description": "An array of hosts to use TLS for",
"items": {
"description": "The host to use TLS for",
"type": "string"
},
"type": "array"
},
"secretName": {
"description": "The name of the secret containing the TLS certificate and key",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "object"
},
"apiVersion": {
"default": "",
"description": "The Kubernetes API version used for configuring ingress. If not specified, Helm tries to automatically determine a compatible version based on the cluster's capabilities. The default value is \"\" and is only accepted if it is one of the supported versions: `networking.k8s.io/v1`, `networking.k8s.io/v1beta1`, or `extensions/v1beta1`. In cases where Helm can't determine the cluster's capabilities automatically, this value can be used to override the API version. Setting an unsupported value will result in an error during the Helm chart installation.",
"type": "string"
},
"enabled": {
"default": true,
"description": "Whether to create a Kubernetes Ingress.",
"type": "boolean"
},
"ingressClassName": {
"default": null,
"description": "Name of the ingress class to use for the Ingress.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"initContainers": {
"default": [],
"description": "Containers used to initialize context for Atlantis pods",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"type": "array"
},
"lifecycle": {
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle",
"description": "Configure pod container lifecycle hooks. See [Kubernetes docs](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/) for details.",
"type": "object"
},
"livenessProbe": {
"additionalProperties": false,
"description": "Liveness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable liveness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before liveness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"loadEnvFromConfigMaps": {
"description": "Array of Kubernetes `ConfigMap`s to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"loadEnvFromSecrets": {
"description": "Array of Kubernetes secrets to set all key-value pairs as environment variables. See `values.yaml` for example.",
"items": {
"type": "string"
},
"type": "array"
},
"lockingDbType": {
"default": "postgres",
"description": "Locking DB type for storing plan and apply locks. Allowed values are `boltdb` and `redis`.",
"enum": [
"boltdb",
"redis"
],
"type": "string"
},
"logLevel": {
"description": "Level to use for logging. Either debug, info, warn, or error.",
"enum": [
"debug",
"info",
"warn",
"error"
],
"examples": [
"debug"
],
"type": "string"
},
"nameOverride": {
"default": "",
"description": "Override the name of the chart",
"type": "string"
},
"netrc": {
"description": "Contents of a file to be mounted to `~/.netrc`. Use to authenticate with private registries hosting terraform modules.",
"type": "string"
},
"netrcSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `netrc` key. Use this instead of `netrc` (optional)",
"type": "string"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"description": "NodeSelector configuration for atlantis containers.",
"type": "object"
},
"orgAllowlist": {
"default": "<replace-me>",
"description": "Allowlist of repositories from which Atlantis will accept webhooks",
"examples": [
"github.com/myorg/*"
],
"type": "string"
},
"podMonitor": {
"description": "PodMonitor configuration for atlantis containers. for Google Managed Prometheus",
"properties": {
"enabled": {
"description": "Whether to enable a PodMonitor for Atlantis",
"type": "boolean"
},
"interval": {
"description": "The interval at which to scrape the metrics",
"type": "string"
}
},
"type": "object"
},
"podTemplate": {
"additionalProperties": false,
"description": "Pod template configuration for pods.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for pods.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Additional labels to use for pods.",
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"additionalProperties": false,
"description": "Readiness probe configuration for atlantis containers.",
"properties": {
"enabled": {
"default": true,
"description": "Enable readiness probe.",
"type": "boolean"
},
"failureThreshold": {
"default": 5,
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.",
"type": "integer"
},
"initialDelaySeconds": {
"default": 5,
"description": "Number of seconds after the container has started before readiness probes are initiated.",
"type": "integer"
},
"periodSeconds": {
"default": 60,
"description": "How often (in seconds) to perform the probe. Minimum value is 1.",
"type": "integer"
},
"scheme": {
"default": "HTTP",
"description": "The URI scheme used for the request. The only supported schemes are http and https.",
"enum": [
"HTTP",
"HTTPS"
],
"type": "string"
},
"successThreshold": {
"default": 1,
"description": "Number of consecutive successful probe executions required for the container to be considered healthy again after having failed.",
"type": "integer"
},
"timeoutSeconds": {
"default": 5,
"description": "Number of seconds after which the probe times out. Minimum value is 1 seconds.",
"type": "integer"
}
},
"type": "object"
},
"redis": {
"additionalProperties": false,
"description": "Redis configuration for for Locking DB of type `redis`.",
"properties": {
"db": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "integer"
},
"host": {
"description": "Redis database number for Locking DB of type `redis`.",
"type": "string"
},
"insecureSkipVerify": {
"description": "Whether Redis client should skip verification of Redis server's certificate chain and hostname. Setting to `true` may introduce a security vulnerability.",
"type": "boolean"
},
"password": {
"description": "Redis password for Locking DB of type `redis`.",
"type": "string"
},
"port": {
"description": "Redis port for Locking DB of type `redis`.",
"type": "integer"
},
"tlsEnabled": {
"description": "Whether to enable TLS connection to Redis.",
"type": "boolean"
}
},
"type": "object"
},
"redisSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing a `password` key. Use this instead of `redis.password`.",
"type": "string"
},
"replicaCount": {
"default": 1,
"description": "Number of replicas to run for the Atlantis server.",
"type": "integer"
},
"repoConfig": {
"description": "[Server-side Repository Configuration](https://www.runatlantis.io/docs/server-side-repo-config.html) as a raw YAML string. Configuration is stored in ConfigMap.",
"type": "string"
},
"resources": {
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"description": "Resource configuration for atlantis containers.",
"type": "object"
},
"service": {
"additionalProperties": false,
"description": "Atlantis Service configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to add to the service.",
"type": "object"
},
"loadBalancerIP": {
"description": "IP address to assign to load balancer (if supported).",
"type": [
"string",
"null"
]
},
"loadBalancerSourceRanges": {
"description": "If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.",
"type": [
"array",
"null"
]
},
"nodePort": {
"description": "Port to expose on the node when the service type is NodePort.",
"type": [
"string",
"integer",
"null"
]
},
"port": {
"default": 80,
"description": "Port to expose on the service.",
"type": [
"string",
"integer"
]
},
"targetPort": {
"default": 4141,
"description": "Port on the container to direct traffic to.",
"type": [
"string",
"integer"
]
},
"type": {
"default": "NodePort",
"description": "Service type.",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer"
],
"type": "string"
}
},
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"description": "ServiceAccount configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional Service Account annotations",
"type": "object"
},
"create": {
"description": "Whether to create a Kubernetes ServiceAccount if no account matching `serviceAccount.name` exists.",
"type": "boolean"
},
"mount": {
"description": "Whether to mount the Kubernetes ServiceAccount into the pod",
"type": "boolean"
},
"name": {
"description": "Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and `serviceAccount.create` is `true`, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart's instance, else Atlantis will be run under the `default` ServiceAccount.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"serviceAccountSecrets": {
"description": "Deprecated (see googleServiceAccountSecrets). To be used for mounting credential files (when using google provider).",
"properties": {
"credentials": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
},
"credentials-staging": {
"description": "Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.",
"type": "string"
}
},
"type": "object"
},
"servicemonitor": {
"description": "ServiceMonitor configuration for atlantis containers.",
"properties": {
"auth": {
"description": "Authentication configuration for the ServiceMonitor",
"properties": {
"basicAuth": {
"properties": {
"enabled": {
"description": "Whether to enable basic authentication (default: false)",
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
},
"externalSecret": {
"properties": {
"enabled": {
"description": "Whether to enable external secret authentication (default: false)",
"type": "boolean"
},
"keys": {
"description": "A map of key-value pairs to be used for authentication",
"type": "object"
},
"name": {
"description": "The name of the Kubernetes secret containing the authentication credentials",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enabled": {
"description": "Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"path": {
"description": "HTTP path to scrape for metrics",
"type": "string"
}
},
"type": "object"
},
"statefulSet": {
"additionalProperties": false,
"description": "StatefulSet configuration.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Additional annotations to use for StatefulSet.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Additional labels to use for StatefulSet.",
"type": "object"
},
"priorityClassName": {
"description": "Leverage a PriorityClass to ensure your pods survive resource shortages.",
"type": "string"
},
"securityContext": {
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
"description": "Allow customizing securityContext.",
"type": "object"
},
"shareProcessNamespace": {
"default": false,
"description": "Share the process namespace between all containers in a pod.",
"type": "boolean"
},
"updateStrategy": {
"$ref": "#/definitions/io.k8s.api.apps.v1.StatefulSetUpdateStrategy",
"description": "Configure [updateStrategy](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#update-strategies) of the StatefulSet.",
"type": "object"
}
},
"type": "object"
},
"storageClassName": {
"description": "DEPRECATED - Storage class of the volume mounted for the Atlantis data directory.",
"type": "string"
},
"terminationGracePeriodSeconds": {
"description": "Set terminationGracePeriodSeconds for the StatefulSet.",
"type": "integer"
},
"test": {
"additionalProperties": false,
"description": "Test configuration for atlantis containers.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations to apply to the test pod (optional)",
"type": "object"
},
"enabled": {
"description": "Whether to enable the test",
"type": "boolean"
},
"image": {
"description": "The image to use for testing",
"type": "string"
},
"imageTag": {
"description": "The tag of the image to use for testing",
"type": "string"
}
},
"type": "object"
},
"tlsSecretName": {
"description": "Name of a Secret for Atlantis' HTTPS certificate containing the following data items `tls.crt` with the public certificate and `tls.key` with the private key.",
"type": "string"
},
"tolerations": {
"default": [],
"description": "Specify Tolerations for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration",
"type": "object"
},
"type": "array"
},
"topologySpreadConstraints": {
"default": [],
"description": "Specify topology spread constraints for all pods.",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint",
"type": "object"
},
"type": "array"
},
"vcsSecretName": {
"description": "Name of a pre-existing Kubernetes `Secret` containing `token` and `secret` keys set to your VCS provider's API token and webhook secret, respectively. Use this instead of `github.token`/`github.secret`, etc. (optional)",
"type": "string"
},
"volumeClaim": {
"description": "VolumeClaim configuration for atlantis data.",
"properties": {
"dataStorage": {
"description": "Amount of storage available for embedded Atlantis' data directory",
"type": "string"
},
"enabled": {
"description": "Activate embedded volume claim for Atlantis' data directory (mostly used to check out git repositories).",
"type": "boolean"
},
"storageClassName": {
"description": "Storage class of the embedded volume mounted for the Atlantis data directory.",
"type": "string"
}
},
"type": "object"
},
"webhook_ingress": {
"$ref": "#/properties/ingress"
}
},
"type": "object"
} | Apache-2.0 | en |
pha4ge/primer-schemes | 809231a7861bc35f445809b792475331a30a4556 | 2023-05-07T13:32:41 | schema/manifest.json | 10 | 2024-05-27T06:26:50.326162Z | {
"$id": "https://github.com/pha4ge/primaschema/tree/main/schemas/mainfest_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "A Manifest of Primer Schemes",
"properties": {
"latest_doi": {
"description": "The Digital Object Identifier of the latest version of the manifest",
"type": "string"
},
"license": {
"description": "The license under which the manifest is released. Should be an identifier in the SPDX license list",
"type": "string"
},
"metadata": {
"description": "Description of the contents of the manifest",
"type": "string"
},
"organisms": {
"description": "A list of organisms and their names",
"items": {
"properties": {
"aliases": {
"description": "Aliases for the organism name",
"items": {
"type": "string"
},
"type": "array"
},
"display_name": {
"description": "The human-friendly display name of the scheme to be shown in pick lists (e.g. SARS-CoV-2)",
"type": "string"
},
"organism": {
"description": "The canonical name of the organism (lowercase, e.g. sars-cov-2)",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"repository": {
"description": "A URI describing the location of the live, updatable version of the schema",
"type": "string"
},
"schema_version": {
"description": "The schema version of this manifest. Currently 2-0-0",
"type": "string"
},
"schemes": {
"description": "The list of schemes in this manifest",
"items": {
"properties": {
"aliases": {
"description": "Aliases for the scheme name",
"items": {
"type": "string"
},
"type": "array"
},
"family": {
"description": "The name of the scheme excluding the version",
"type": "string"
},
"organism": {
"description": "The organism that this primer scheme refers to, e.g. SARS-CoV-2",
"type": "string"
},
"organism_aliases": {
"description": "Aliases for organism name",
"items": {
"type": "string"
},
"type": "array"
},
"versions": {
"items": {
"properties": {
"repository": {
"description": "Link to the directory containing the scheme. This directory should follow the PHA4GE standard for schemes",
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"repository"
],
"type": "object"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"family",
"organism",
"versions"
],
"type": "object"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"metadata",
"repository",
"latest_doi",
"license",
"schemes"
],
"title": "Primer Schemes Manifest",
"type": "object"
} | CC-BY-4.0 | en |
lerebear/sizeup-action | 560e98a6067291682d75c05b6465c16c7f6f8bcd | 2024-03-04T18:21:31 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"archiving": {
"description": "Configuration options for persisting the output of this workflow",
"properties": {
"artifactRetention": {
"description": "Retention period (in days) for the artifact created by this workflow. The actual retention period used may be shorter than this in the presence of an overriding repository- or organization- level retention period setting.",
"type": "number"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip creating an artifact for workflow runs on a draft pull request",
"type": "boolean"
},
"persistScoreArtifact": {
"default": false,
"description": "Whether or not to create a workflow artifact that contains details about the score",
"type": "boolean"
}
},
"type": "object"
},
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | b01234832a2e01594238e7cb1d6bbd0e48c852c4 | 2024-03-04T05:58:46 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"archiving": {
"description": "Configuration options for persisting the output of this workflow",
"properties": {
"artifactRetention": {
"description": "Retention period (in days) for the artifact created by this workflow. The actual retention period used may be shorter than this in the presence of an overriding repository- or organization- level retention period setting.",
"type": "number"
},
"persistScoreArtifact": {
"default": false,
"description": "Whether or not to create a workflow artifact that contains details about the score",
"type": "boolean"
}
},
"type": "object"
},
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | eeb5acf1912fa036bedc61fd054bd1cd3435ed26 | 2024-03-03T08:30:09 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | eeb5acf1912fa036bedc61fd054bd1cd3435ed26 | 2024-03-03T08:30:09 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 593c1d74df62dd3099adbc79d832627110bcb858 | 2023-10-10T06:47:34 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 560e98a6067291682d75c05b6465c16c7f6f8bcd | 2024-03-04T18:21:31 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"archiving": {
"description": "Configuration options for persisting the output of this workflow",
"properties": {
"artifactRetention": {
"description": "Retention period (in days) for the artifact created by this workflow. The actual retention period used may be shorter than this in the presence of an overriding repository- or organization- level retention period setting.",
"type": "number"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip creating an artifact for workflow runs on a draft pull request",
"type": "boolean"
},
"persistScoreArtifact": {
"default": false,
"description": "Whether or not to create a workflow artifact that contains details about the score",
"type": "boolean"
}
},
"type": "object"
},
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 406eb01a614502d75b645d52b65d7daac950cbc9 | 2023-10-07T08:00:22 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the score category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"scoreThresholdExceededCommentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 593c1d74df62dd3099adbc79d832627110bcb858 | 2023-10-10T06:47:34 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 4f39161ab444d1ff8d9970313911b2cf8aa7be7d | 2024-03-08T06:21:52 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"artifacts": {
"description": "Configuration options for persisting the output of this workflow.",
"properties": {
"score": {
"description": "Configuration for the workflow artifact that contains details about the score",
"properties": {
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip creating the artifact for workflow runs on a draft pull request",
"type": "boolean"
},
"format": {
"description": "The file format to use for the score artifact",
"enum": [
"csv",
"json"
],
"type": "string"
},
"retention": {
"description": "Retention period (in days) for the score artifact. The actual retention period used may be shorter than this in the presence of an overriding repository- or organization- level retention period setting.",
"type": "number"
}
},
"required": [
"format"
],
"type": "object"
}
},
"required": [
"score"
],
"type": "object"
},
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 83dbb84ace9338e704a87ecbe00139207565ab25 | 2024-03-03T11:46:09 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"persistScoreArtifact": {
"default": false,
"description": "Whether or not to create a workflow artifact that contains details about the score",
"type": "boolean"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 83dbb84ace9338e704a87ecbe00139207565ab25 | 2024-03-03T11:46:09 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"persistScoreArtifact": {
"default": false,
"description": "Whether or not to create a workflow artifact that contains details about the score",
"type": "boolean"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 406eb01a614502d75b645d52b65d7daac950cbc9 | 2023-10-07T08:00:22 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the score category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"scoreThresholdExceededCommentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | b01234832a2e01594238e7cb1d6bbd0e48c852c4 | 2024-03-04T05:58:46 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"archiving": {
"description": "Configuration options for persisting the output of this workflow",
"properties": {
"artifactRetention": {
"description": "Retention period (in days) for the artifact created by this workflow. The actual retention period used may be shorter than this in the presence of an overriding repository- or organization- level retention period setting.",
"type": "number"
},
"persistScoreArtifact": {
"default": false,
"description": "Whether or not to create a workflow artifact that contains details about the score",
"type": "boolean"
}
},
"type": "object"
},
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | b78cb14cee18fb53035976922bd134d82cff4826 | 2023-10-28T06:31:56 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | 4f39161ab444d1ff8d9970313911b2cf8aa7be7d | 2024-03-08T06:21:52 | dist/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"artifacts": {
"description": "Configuration options for persisting the output of this workflow.",
"properties": {
"score": {
"description": "Configuration for the workflow artifact that contains details about the score",
"properties": {
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip creating the artifact for workflow runs on a draft pull request",
"type": "boolean"
},
"format": {
"description": "The file format to use for the score artifact",
"enum": [
"csv",
"json"
],
"type": "string"
},
"retention": {
"description": "Retention period (in days) for the score artifact. The actual retention period used may be shorter than this in the presence of an overriding repository- or organization- level retention period setting.",
"type": "number"
}
},
"required": [
"format"
],
"type": "object"
}
},
"required": [
"score"
],
"type": "object"
},
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"shadowOptOuts": {
"default": false,
"description": "Whether or not to compute a score even for users who have opted out of the workflow",
"type": "boolean"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
lerebear/sizeup-action | b78cb14cee18fb53035976922bd134d82cff4826 | 2023-10-28T06:31:56 | src/config/schema.json | 10 | 2024-05-27T05:59:30.638689Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "YAML configuration accepted by sizeup-action",
"properties": {
"commenting": {
"description": "Configuration that controls how we add comments to assessed pull requests",
"properties": {
"addCommentWhenScoreThresholdHasBeenExceeded": {
"default": true,
"description": "Whether or not to add a comment to each assessed pull request that exceeds the configured score threshold",
"type": "boolean"
},
"commentTemplate": {
"default": "\ud83d\udc4b {{author}} this pull request exceeds the recommended reviewability score threshold of {{threshold}}. Your actual score was {{score}}.\n\n[Research](https://www.cabird.com/static/93aba3256c80506d3948983db34d3ba3/rigby2013convergent.pdf) has shown that this makes it harder for reviewers to provide quality feedback.\n\nWe recommend that you reduce the size of this PR by separating commits into stacked PRs.",
"description": "The template for the comment that should be added to each pull request that exceeds the configured score threshold",
"type": "string"
},
"excludeDraftPullRequests": {
"default": true,
"description": "Whether or not to skip commenting on a draft pull request that exceeds the configured score threshold",
"type": "boolean"
},
"scoreThreshold": {
"default": 100,
"description": "The score above which this tool will post a comment on the pull request.",
"type": "number"
}
},
"type": "object"
},
"labeling": {
"description": "Configuration that controls how we apply score category labels to each assessed pull request",
"properties": {
"applyCategoryLabels": {
"default": true,
"description": "Whether or not to apply the category label to each assessed pull request",
"type": "boolean"
},
"categoryLabelPrefix": {
"default": "sizeup/",
"description": "The prefix to add to each category label that we apply",
"type": "string"
},
"excludeDraftPullRequests": {
"default": false,
"description": "Whether or not to skip applying the category label to a draft pull request",
"type": "boolean"
}
},
"type": "object"
},
"optIns": {
"description": "A list of GitHub handles for users or teams that have opted into this workflow",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"sizeup": {
"$ref": "https://raw.githubusercontent.com/lerebear/sizeup/main/src/config/schema.json"
}
},
"title": "configuration",
"type": "object"
} | MIT | en |
dsrvlabs/czg-keremony | 509e93260bb31ca5f7b8fa3f529055f40700c4b6 | 2023-02-11T13:55:44 | contribution/contributionSchema.json | 13 | 2024-05-27T07:10:07.718217Z | {
"$defs": {
"2^12SubContribution": {
"properties": {
"bls_signature": {
"anyOf": [
{
"$ref": "#/$defs/G1Point"
},
{
"$ref": "#/$defs/emptyString"
}
]
},
"numG1Powers": {
"maximum": 4096,
"minimum": 4096,
"type": "integer"
},
"numG2Powers": {
"maximum": 65,
"minimum": 65,
"type": "integer"
},
"potPubkey": {
"type": "string"
},
"powersOfTau": {
"properties": {
"G1Powers": {
"items": {
"$ref": "#/$defs/G1Point"
},
"maxItems": 4096,
"minItems": 4096,
"type": "array"
},
"G2Powers": {
"items": {
"$ref": "#/$defs/G2Point"
},
"maxItems": 65,
"minItems": 65,
"type": "array"
}
},
"required": [
"G1Powers",
"G2Powers"
],
"type": "object"
}
},
"required": [
"numG1Powers",
"numG2Powers",
"powersOfTau"
],
"type": "object"
},
"2^13SubContribution": {
"properties": {
"bls_signature": {
"anyOf": [
{
"$ref": "#/$defs/G1Point"
},
{
"$ref": "#/$defs/emptyString"
}
]
},
"numG1Powers": {
"maximum": 8192,
"minimum": 8192,
"type": "integer"
},
"numG2Powers": {
"maximum": 65,
"minimum": 65,
"type": "integer"
},
"potPubkey": {
"type": "string"
},
"powersOfTau": {
"properties": {
"G1Powers": {
"items": {
"$ref": "#/$defs/G1Point"
},
"maxItems": 8192,
"minItems": 8192,
"type": "array"
},
"G2Powers": {
"items": {
"$ref": "#/$defs/G2Point"
},
"maxItems": 65,
"minItems": 65,
"type": "array"
}
},
"required": [
"G1Powers",
"G2Powers"
],
"type": "object"
}
},
"required": [
"numG1Powers",
"numG2Powers",
"powersOfTau"
],
"type": "object"
},
"2^14SubContribution": {
"properties": {
"bls_signature": {
"anyOf": [
{
"$ref": "#/$defs/G1Point"
},
{
"$ref": "#/$defs/emptyString"
}
]
},
"numG1Powers": {
"maximum": 16384,
"minimum": 16384,
"type": "integer"
},
"numG2Powers": {
"maximum": 65,
"minimum": 65,
"type": "integer"
},
"potPubkey": {
"type": "string"
},
"powersOfTau": {
"properties": {
"G1Powers": {
"items": {
"$ref": "#/$defs/G1Point"
},
"maxItems": 16384,
"minItems": 16384,
"type": "array"
},
"G2Powers": {
"items": {
"$ref": "#/$defs/G2Point"
},
"maxItems": 65,
"minItems": 65,
"type": "array"
}
},
"required": [
"G1Powers",
"G2Powers"
],
"type": "object"
}
},
"required": [
"numG1Powers",
"numG2Powers",
"powersOfTau"
],
"type": "object"
},
"2^15SubContribution": {
"properties": {
"bls_signature": {
"anyOf": [
{
"$ref": "#/$defs/G1Point"
},
{
"$ref": "#/$defs/emptyString"
}
]
},
"numG1Powers": {
"maximum": 32768,
"minimum": 32768,
"type": "integer"
},
"numG2Powers": {
"maximum": 65,
"minimum": 65,
"type": "integer"
},
"potPubkey": {
"type": "string"
},
"powersOfTau": {
"properties": {
"G1Powers": {
"items": {
"$ref": "#/$defs/G1Point"
},
"maxItems": 32768,
"minItems": 32768,
"type": "array"
},
"G2Powers": {
"items": {
"$ref": "#/$defs/G2Point"
},
"maxItems": 65,
"minItems": 65,
"type": "array"
}
},
"required": [
"G1Powers",
"G2Powers"
],
"type": "object"
}
},
"required": [
"numG1Powers",
"numG2Powers",
"powersOfTau"
],
"type": "object"
},
"G1Point": {
"pattern": "^0x[a-f0-9]{96}$",
"type": "string"
},
"G2Point": {
"pattern": "^0x[a-f0-9]{192}$",
"type": "string"
},
"emptyString": {
"pattern": "^$",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"contributions": {
"items": false,
"prefixItems": [
{
"$ref": "#/$defs/2^12SubContribution"
},
{
"$ref": "#/$defs/2^13SubContribution"
},
{
"$ref": "#/$defs/2^14SubContribution"
},
{
"$ref": "#/$defs/2^15SubContribution"
}
],
"type": "array"
},
"ecdsaSignature": {
"pattern": "^0x[a-f\\d]{130}$|^$",
"type": "string"
}
},
"type": "object"
} | MIT | en |
anyproto/gallery | 3f7e72205f2ddcf0da2826b351fdf6dfb8b16ced | 2023-10-01T14:14:53 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "The experience's current author"
},
"categories": {
"items": {
"$ref": "#/$defs/category"
},
"type": "array"
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "The experience's list of contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "The experience's description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "The experience's download link"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "The experience's license"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "The experience's name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "The list of experience's screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "The human-friendly experience's name",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | 19486841319b007d7ce17411a2326aded065058a | 2023-11-26T15:15:19 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"items": {
"$ref": "#/$defs/category"
},
"type": "array"
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"language": {
"default": "en-US",
"enum": [
"ach-UG",
"aa-ER",
"af-ZA",
"ak-GH",
"tw-TW",
"sq-AL",
"am-ET",
"ar-SA",
"ar-BH",
"ar-EG",
"ar-SA",
"ar-YE",
"an-ES",
"hy-AM",
"frp-IT",
"as-IN",
"ast-ES",
"tay-TW",
"av-DA",
"ae-IR",
"ay-BO",
"az-AZ",
"ban-ID",
"bal-BA",
"bm-ML",
"ba-RU",
"eu-ES",
"be-BY",
"bn-BD",
"bn-IN",
"ber-DZ",
"bh-IN",
"bfo-BF",
"bi-VU",
"bs-BA",
"br-FR",
"bg-BG",
"my-MM",
"ca-ES",
"ceb-PH",
"ch-GU",
"ce-CE",
"chr-US",
"ny-MW",
"zh-CN",
"zh-TW",
"zh-HK",
"zh-MO",
"zh-SG",
"cv-CU",
"kw-GB",
"co-FR",
"cr-NT",
"hr-HR",
"cs-CZ",
"da-DK",
"fa-AF",
"dv-MV",
"nl-NL",
"nl-BE",
"nl-SR",
"dz-BT",
"en-US",
"en-UD",
"en-AR",
"en-AU",
"en-BZ",
"en-CA",
"en-CB",
"en-CN",
"en-DK",
"en-HK",
"en-IN",
"en-ID",
"en-IE",
"en-JM",
"en-JA",
"en-MY",
"en-NZ",
"en-NO",
"en-PH",
"en-PR",
"en-SG",
"en-ZA",
"en-SE",
"en-GB",
"en-US",
"en-ZW",
"eo-UY",
"et-EE",
"ee-GH",
"fo-FO",
"fj-FJ",
"fil-PH",
"fi-FI",
"vls-BE",
"fra-DE",
"fr-FR",
"fr-BE",
"fr-CA",
"fr-LU",
"fr-QC",
"fr-CH",
"fy-NL",
"fur-IT",
"ff-ZA",
"gaa-GH",
"gl-ES",
"ka-GE",
"de-DE",
"de-AT",
"de-BE",
"de-LI",
"de-LU",
"de-CH",
"got-DE",
"el-GR",
"el-CY",
"kl-GL",
"gn-PY",
"gu-IN",
"ht-HT",
"ha-HG",
"haw-US",
"he-IL",
"hz-NA",
"hil-PH",
"hi-IN",
"ho-PG",
"hmn-CN",
"hu-HU",
"is-IS",
"io-EN",
"ig-NG",
"ilo-PH",
"id-ID",
"iu-NU",
"ga-IE",
"it-IT",
"it-CH",
"ja-JP",
"jv-ID",
"quc-GT",
"kab-KAB",
"kn-IN",
"pam-PH",
"ks-IN",
"ks-PK",
"csb-PL",
"kk-KZ",
"km-KH",
"rw-RW",
"tlh-AA",
"kv-KO",
"kg-CG",
"kok-IN",
"ko-KR",
"ku-TR",
"kmr-TR",
"kj-AO",
"ky-KG",
"lol-US",
"lo-LA",
"la-LA",
"lv-LV",
"lij-IT",
"li-LI",
"ln-CD",
"lt-LT",
"jbo-EN",
"nds-DE",
"dsb-DE",
"lg-UG",
"luy-KE",
"lb-LU",
"mk-MK",
"mai-IN",
"mg-MG",
"ms-MY",
"ms-BN",
"ml-IN",
"mt-MT",
"gv-IM",
"mi-NZ",
"arn-CL",
"mr-IN",
"mh-MH",
"moh-CA",
"mn-MN",
"sr-Cyrl-ME",
"me-ME",
"mos-MOS",
"na-NR",
"ng-NA",
"ne-NP",
"ne-IN",
"pcm-NG",
"se-NO",
"ns-ZA",
"no-NO",
"nb-NO",
"nn-NO",
"oc-FR",
"or-IN",
"oj-CA",
"om-ET",
"os-SE",
"pi-IN",
"pap-PAP",
"ps-AF",
"fa-IR",
"en-PT",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-IN",
"pa-PK",
"qu-PE",
"qya-AA",
"ro-RO",
"rm-CH",
"rn-BI",
"ru-RU",
"ru-BY",
"ru-MD",
"ry-UA",
"ru-UA",
"sah-SAH",
"sg-CF",
"sa-IN",
"sat-IN",
"sc-IT",
"sco-GB",
"gd-GB",
"sr-SP",
"sr-CS",
"sh-HR",
"crs-SC",
"sn-ZW",
"ii-CN",
"sd-PK",
"si-LK",
"sk-SK",
"sl-SI",
"so-SO",
"son-ZA",
"ckb-IR",
"nr-ZA",
"sma-NO",
"st-ZA",
"es-ES",
"es-EM",
"es-AR",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-DO",
"es-EC",
"es-SV",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-PR",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-KE",
"sw-KE",
"sw-TZ",
"ss-ZA",
"sv-SE",
"sv-FI",
"syc-SY",
"tl-PH",
"ty-PF",
"tg-TJ",
"tzl-TZL",
"ta-IN",
"tt-RU",
"te-IN",
"kdh-KDH",
"th-TH",
"bo-BT",
"ti-ER",
"ts-ZA",
"tn-ZA",
"tr-TR",
"tr-CY",
"tk-TM",
"uk-UA",
"hsb-DE",
"ur-IN",
"ur-PK",
"ug-CN",
"uz-UZ",
"val-ES",
"ve-ZA",
"vec-IT",
"vi-VN",
"wa-BE",
"cy-GB",
"wo-SN",
"xh-ZA",
"yi-DE",
"yo-NG",
"zea-ZEA",
"zu-ZA"
],
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | a1be5209a5f21876092f7c4d8feec971f3986981 | 2023-10-01T14:11:24 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "The experience's current author"
},
"categories": {
"items": {
"$ref": "#/$defs/category"
},
"type": "array"
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "The experience's list of contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "The experience's description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "The experience's download link"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "The experience's license"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "The experience's name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "The list of experience's screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "The human-friendly experience's name",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | 8844ecdd1524a0618935e3d66d757194cac3623c | 2023-11-28T09:07:29 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"description": "Categories help people find the Experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"language": {
"default": "en-US",
"enum": [
"ach-UG",
"aa-ER",
"af-ZA",
"ak-GH",
"tw-TW",
"sq-AL",
"am-ET",
"ar-SA",
"ar-BH",
"ar-EG",
"ar-SA",
"ar-YE",
"an-ES",
"hy-AM",
"frp-IT",
"as-IN",
"ast-ES",
"tay-TW",
"av-DA",
"ae-IR",
"ay-BO",
"az-AZ",
"ban-ID",
"bal-BA",
"bm-ML",
"ba-RU",
"eu-ES",
"be-BY",
"bn-BD",
"bn-IN",
"ber-DZ",
"bh-IN",
"bfo-BF",
"bi-VU",
"bs-BA",
"br-FR",
"bg-BG",
"my-MM",
"ca-ES",
"ceb-PH",
"ch-GU",
"ce-CE",
"chr-US",
"ny-MW",
"zh-CN",
"zh-TW",
"zh-HK",
"zh-MO",
"zh-SG",
"cv-CU",
"kw-GB",
"co-FR",
"cr-NT",
"hr-HR",
"cs-CZ",
"da-DK",
"fa-AF",
"dv-MV",
"nl-NL",
"nl-BE",
"nl-SR",
"dz-BT",
"en-US",
"en-UD",
"en-AR",
"en-AU",
"en-BZ",
"en-CA",
"en-CB",
"en-CN",
"en-DK",
"en-HK",
"en-IN",
"en-ID",
"en-IE",
"en-JM",
"en-JA",
"en-MY",
"en-NZ",
"en-NO",
"en-PH",
"en-PR",
"en-SG",
"en-ZA",
"en-SE",
"en-GB",
"en-US",
"en-ZW",
"eo-UY",
"et-EE",
"ee-GH",
"fo-FO",
"fj-FJ",
"fil-PH",
"fi-FI",
"vls-BE",
"fra-DE",
"fr-FR",
"fr-BE",
"fr-CA",
"fr-LU",
"fr-QC",
"fr-CH",
"fy-NL",
"fur-IT",
"ff-ZA",
"gaa-GH",
"gl-ES",
"ka-GE",
"de-DE",
"de-AT",
"de-BE",
"de-LI",
"de-LU",
"de-CH",
"got-DE",
"el-GR",
"el-CY",
"kl-GL",
"gn-PY",
"gu-IN",
"ht-HT",
"ha-HG",
"haw-US",
"he-IL",
"hz-NA",
"hil-PH",
"hi-IN",
"ho-PG",
"hmn-CN",
"hu-HU",
"is-IS",
"io-EN",
"ig-NG",
"ilo-PH",
"id-ID",
"iu-NU",
"ga-IE",
"it-IT",
"it-CH",
"ja-JP",
"jv-ID",
"quc-GT",
"kab-KAB",
"kn-IN",
"pam-PH",
"ks-IN",
"ks-PK",
"csb-PL",
"kk-KZ",
"km-KH",
"rw-RW",
"tlh-AA",
"kv-KO",
"kg-CG",
"kok-IN",
"ko-KR",
"ku-TR",
"kmr-TR",
"kj-AO",
"ky-KG",
"lol-US",
"lo-LA",
"la-LA",
"lv-LV",
"lij-IT",
"li-LI",
"ln-CD",
"lt-LT",
"jbo-EN",
"nds-DE",
"dsb-DE",
"lg-UG",
"luy-KE",
"lb-LU",
"mk-MK",
"mai-IN",
"mg-MG",
"ms-MY",
"ms-BN",
"ml-IN",
"mt-MT",
"gv-IM",
"mi-NZ",
"arn-CL",
"mr-IN",
"mh-MH",
"moh-CA",
"mn-MN",
"sr-Cyrl-ME",
"me-ME",
"mos-MOS",
"na-NR",
"ng-NA",
"ne-NP",
"ne-IN",
"pcm-NG",
"se-NO",
"ns-ZA",
"no-NO",
"nb-NO",
"nn-NO",
"oc-FR",
"or-IN",
"oj-CA",
"om-ET",
"os-SE",
"pi-IN",
"pap-PAP",
"ps-AF",
"fa-IR",
"en-PT",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-IN",
"pa-PK",
"qu-PE",
"qya-AA",
"ro-RO",
"rm-CH",
"rn-BI",
"ru-RU",
"ru-BY",
"ru-MD",
"ry-UA",
"ru-UA",
"sah-SAH",
"sg-CF",
"sa-IN",
"sat-IN",
"sc-IT",
"sco-GB",
"gd-GB",
"sr-SP",
"sr-CS",
"sh-HR",
"crs-SC",
"sn-ZW",
"ii-CN",
"sd-PK",
"si-LK",
"sk-SK",
"sl-SI",
"so-SO",
"son-ZA",
"ckb-IR",
"nr-ZA",
"sma-NO",
"st-ZA",
"es-ES",
"es-EM",
"es-AR",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-DO",
"es-EC",
"es-SV",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-PR",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-KE",
"sw-KE",
"sw-TZ",
"ss-ZA",
"sv-SE",
"sv-FI",
"syc-SY",
"tl-PH",
"ty-PF",
"tg-TJ",
"tzl-TZL",
"ta-IN",
"tt-RU",
"te-IN",
"kdh-KDH",
"th-TH",
"bo-BT",
"ti-ER",
"ts-ZA",
"tn-ZA",
"tr-TR",
"tr-CY",
"tk-TM",
"uk-UA",
"hsb-DE",
"ur-IN",
"ur-PK",
"ug-CN",
"uz-UZ",
"val-ES",
"ve-ZA",
"vec-IT",
"vi-VN",
"wa-BE",
"cy-GB",
"wo-SN",
"xh-ZA",
"yi-DE",
"yo-NG",
"zea-ZEA",
"zu-ZA"
],
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink",
"language"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | cbd626989159d092a1fffad5798fcd9e2c44ec2b | 2023-12-07T09:47:31 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://tools.gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"description": "Categories help people find the Experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"language": {
"default": "en-US",
"enum": [
"ach-UG",
"aa-ER",
"af-ZA",
"ak-GH",
"tw-TW",
"sq-AL",
"am-ET",
"ar-SA",
"ar-BH",
"ar-EG",
"ar-YE",
"an-ES",
"hy-AM",
"frp-IT",
"as-IN",
"ast-ES",
"tay-TW",
"av-DA",
"ae-IR",
"ay-BO",
"az-AZ",
"ban-ID",
"bal-BA",
"bm-ML",
"ba-RU",
"eu-ES",
"be-BY",
"bn-BD",
"bn-IN",
"ber-DZ",
"bh-IN",
"bfo-BF",
"bi-VU",
"bs-BA",
"br-FR",
"bg-BG",
"my-MM",
"ca-ES",
"ceb-PH",
"ch-GU",
"ce-CE",
"chr-US",
"ny-MW",
"zh-CN",
"zh-TW",
"zh-HK",
"zh-MO",
"zh-SG",
"cv-CU",
"kw-GB",
"co-FR",
"cr-NT",
"hr-HR",
"cs-CZ",
"da-DK",
"fa-AF",
"dv-MV",
"nl-NL",
"nl-BE",
"nl-SR",
"dz-BT",
"en-US",
"en-UD",
"en-AR",
"en-AU",
"en-BZ",
"en-CA",
"en-CB",
"en-CN",
"en-DK",
"en-HK",
"en-IN",
"en-ID",
"en-IE",
"en-JM",
"en-JA",
"en-MY",
"en-NZ",
"en-NO",
"en-PH",
"en-PR",
"en-SG",
"en-ZA",
"en-SE",
"en-GB",
"en-ZW",
"eo-UY",
"et-EE",
"ee-GH",
"fo-FO",
"fj-FJ",
"fil-PH",
"fi-FI",
"vls-BE",
"fra-DE",
"fr-FR",
"fr-BE",
"fr-CA",
"fr-LU",
"fr-QC",
"fr-CH",
"fy-NL",
"fur-IT",
"ff-ZA",
"gaa-GH",
"gl-ES",
"ka-GE",
"de-DE",
"de-AT",
"de-BE",
"de-LI",
"de-LU",
"de-CH",
"got-DE",
"el-GR",
"el-CY",
"kl-GL",
"gn-PY",
"gu-IN",
"ht-HT",
"ha-HG",
"haw-US",
"he-IL",
"hz-NA",
"hil-PH",
"hi-IN",
"ho-PG",
"hmn-CN",
"hu-HU",
"is-IS",
"io-EN",
"ig-NG",
"ilo-PH",
"id-ID",
"iu-NU",
"ga-IE",
"it-IT",
"it-CH",
"ja-JP",
"jv-ID",
"quc-GT",
"kab-KAB",
"kn-IN",
"pam-PH",
"ks-IN",
"ks-PK",
"csb-PL",
"kk-KZ",
"km-KH",
"rw-RW",
"tlh-AA",
"kv-KO",
"kg-CG",
"kok-IN",
"ko-KR",
"ku-TR",
"kmr-TR",
"kj-AO",
"ky-KG",
"lol-US",
"lo-LA",
"la-LA",
"lv-LV",
"lij-IT",
"li-LI",
"ln-CD",
"lt-LT",
"jbo-EN",
"nds-DE",
"dsb-DE",
"lg-UG",
"luy-KE",
"lb-LU",
"mk-MK",
"mai-IN",
"mg-MG",
"ms-MY",
"ms-BN",
"ml-IN",
"mt-MT",
"gv-IM",
"mi-NZ",
"arn-CL",
"mr-IN",
"mh-MH",
"moh-CA",
"mn-MN",
"sr-Cyrl-ME",
"me-ME",
"mos-MOS",
"na-NR",
"ng-NA",
"ne-NP",
"ne-IN",
"pcm-NG",
"se-NO",
"ns-ZA",
"no-NO",
"nb-NO",
"nn-NO",
"oc-FR",
"or-IN",
"oj-CA",
"om-ET",
"os-SE",
"pi-IN",
"pap-PAP",
"ps-AF",
"fa-IR",
"en-PT",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-IN",
"pa-PK",
"qu-PE",
"qya-AA",
"ro-RO",
"rm-CH",
"rn-BI",
"ru-RU",
"ru-BY",
"ru-MD",
"ry-UA",
"ru-UA",
"sah-SAH",
"sg-CF",
"sa-IN",
"sat-IN",
"sc-IT",
"sco-GB",
"gd-GB",
"sr-SP",
"sr-CS",
"sh-HR",
"crs-SC",
"sn-ZW",
"ii-CN",
"sd-PK",
"si-LK",
"sk-SK",
"sl-SI",
"so-SO",
"son-ZA",
"ckb-IR",
"nr-ZA",
"sma-NO",
"st-ZA",
"es-ES",
"es-EM",
"es-AR",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-DO",
"es-EC",
"es-SV",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-PR",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-KE",
"sw-TZ",
"ss-ZA",
"sv-SE",
"sv-FI",
"syc-SY",
"tl-PH",
"ty-PF",
"tg-TJ",
"tzl-TZL",
"ta-IN",
"tt-RU",
"te-IN",
"kdh-KDH",
"th-TH",
"bo-BT",
"ti-ER",
"ts-ZA",
"tn-ZA",
"tr-TR",
"tr-CY",
"tk-TM",
"uk-UA",
"hsb-DE",
"ur-IN",
"ur-PK",
"ug-CN",
"uz-UZ",
"val-ES",
"ve-ZA",
"vec-IT",
"vi-VN",
"wa-BE",
"cy-GB",
"wo-SN",
"xh-ZA",
"yi-DE",
"yo-NG",
"zea-ZEA",
"zu-ZA"
],
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | aa2e70f4972932aa77d9eb3e806785164ee232a5 | 2023-12-11T12:58:07 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9_-]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://tools.gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"description": "Categories help people find the Experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"language": {
"default": "en-US",
"enum": [
"ach-UG",
"aa-ER",
"af-ZA",
"ak-GH",
"tw-TW",
"sq-AL",
"am-ET",
"ar-SA",
"ar-BH",
"ar-EG",
"ar-YE",
"an-ES",
"hy-AM",
"frp-IT",
"as-IN",
"ast-ES",
"tay-TW",
"av-DA",
"ae-IR",
"ay-BO",
"az-AZ",
"ban-ID",
"bal-BA",
"bm-ML",
"ba-RU",
"eu-ES",
"be-BY",
"bn-BD",
"bn-IN",
"ber-DZ",
"bh-IN",
"bfo-BF",
"bi-VU",
"bs-BA",
"br-FR",
"bg-BG",
"my-MM",
"ca-ES",
"ceb-PH",
"ch-GU",
"ce-CE",
"chr-US",
"ny-MW",
"zh-CN",
"zh-TW",
"zh-HK",
"zh-MO",
"zh-SG",
"cv-CU",
"kw-GB",
"co-FR",
"cr-NT",
"hr-HR",
"cs-CZ",
"da-DK",
"fa-AF",
"dv-MV",
"nl-NL",
"nl-BE",
"nl-SR",
"dz-BT",
"en-US",
"en-UD",
"en-AR",
"en-AU",
"en-BZ",
"en-CA",
"en-CB",
"en-CN",
"en-DK",
"en-HK",
"en-IN",
"en-ID",
"en-IE",
"en-JM",
"en-JA",
"en-MY",
"en-NZ",
"en-NO",
"en-PH",
"en-PR",
"en-SG",
"en-ZA",
"en-SE",
"en-GB",
"en-ZW",
"eo-UY",
"et-EE",
"ee-GH",
"fo-FO",
"fj-FJ",
"fil-PH",
"fi-FI",
"vls-BE",
"fra-DE",
"fr-FR",
"fr-BE",
"fr-CA",
"fr-LU",
"fr-QC",
"fr-CH",
"fy-NL",
"fur-IT",
"ff-ZA",
"gaa-GH",
"gl-ES",
"ka-GE",
"de-DE",
"de-AT",
"de-BE",
"de-LI",
"de-LU",
"de-CH",
"got-DE",
"el-GR",
"el-CY",
"kl-GL",
"gn-PY",
"gu-IN",
"ht-HT",
"ha-HG",
"haw-US",
"he-IL",
"hz-NA",
"hil-PH",
"hi-IN",
"ho-PG",
"hmn-CN",
"hu-HU",
"is-IS",
"io-EN",
"ig-NG",
"ilo-PH",
"id-ID",
"iu-NU",
"ga-IE",
"it-IT",
"it-CH",
"ja-JP",
"jv-ID",
"quc-GT",
"kab-KAB",
"kn-IN",
"pam-PH",
"ks-IN",
"ks-PK",
"csb-PL",
"kk-KZ",
"km-KH",
"rw-RW",
"tlh-AA",
"kv-KO",
"kg-CG",
"kok-IN",
"ko-KR",
"ku-TR",
"kmr-TR",
"kj-AO",
"ky-KG",
"lol-US",
"lo-LA",
"la-LA",
"lv-LV",
"lij-IT",
"li-LI",
"ln-CD",
"lt-LT",
"jbo-EN",
"nds-DE",
"dsb-DE",
"lg-UG",
"luy-KE",
"lb-LU",
"mk-MK",
"mai-IN",
"mg-MG",
"ms-MY",
"ms-BN",
"ml-IN",
"mt-MT",
"gv-IM",
"mi-NZ",
"arn-CL",
"mr-IN",
"mh-MH",
"moh-CA",
"mn-MN",
"sr-Cyrl-ME",
"me-ME",
"mos-MOS",
"na-NR",
"ng-NA",
"ne-NP",
"ne-IN",
"pcm-NG",
"se-NO",
"ns-ZA",
"no-NO",
"nb-NO",
"nn-NO",
"oc-FR",
"or-IN",
"oj-CA",
"om-ET",
"os-SE",
"pi-IN",
"pap-PAP",
"ps-AF",
"fa-IR",
"en-PT",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-IN",
"pa-PK",
"qu-PE",
"qya-AA",
"ro-RO",
"rm-CH",
"rn-BI",
"ru-RU",
"ru-BY",
"ru-MD",
"ry-UA",
"ru-UA",
"sah-SAH",
"sg-CF",
"sa-IN",
"sat-IN",
"sc-IT",
"sco-GB",
"gd-GB",
"sr-SP",
"sr-CS",
"sh-HR",
"crs-SC",
"sn-ZW",
"ii-CN",
"sd-PK",
"si-LK",
"sk-SK",
"sl-SI",
"so-SO",
"son-ZA",
"ckb-IR",
"nr-ZA",
"sma-NO",
"st-ZA",
"es-ES",
"es-EM",
"es-AR",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-DO",
"es-EC",
"es-SV",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-PR",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-KE",
"sw-TZ",
"ss-ZA",
"sv-SE",
"sv-FI",
"syc-SY",
"tl-PH",
"ty-PF",
"tg-TJ",
"tzl-TZL",
"ta-IN",
"tt-RU",
"te-IN",
"kdh-KDH",
"th-TH",
"bo-BT",
"ti-ER",
"ts-ZA",
"tn-ZA",
"tr-TR",
"tr-CY",
"tk-TM",
"uk-UA",
"hsb-DE",
"ur-IN",
"ur-PK",
"ug-CN",
"uz-UZ",
"val-ES",
"ve-ZA",
"vec-IT",
"vi-VN",
"wa-BE",
"cy-GB",
"wo-SN",
"xh-ZA",
"yi-DE",
"yo-NG",
"zea-ZEA",
"zu-ZA"
],
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | 324ebe13c9721ce6d3653b86949d8d44a025eea4 | 2023-11-28T10:09:34 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"description": "Categories help people find the Experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"language": {
"default": "en-US",
"enum": [
"ach-UG",
"aa-ER",
"af-ZA",
"ak-GH",
"tw-TW",
"sq-AL",
"am-ET",
"ar-SA",
"ar-BH",
"ar-EG",
"ar-YE",
"an-ES",
"hy-AM",
"frp-IT",
"as-IN",
"ast-ES",
"tay-TW",
"av-DA",
"ae-IR",
"ay-BO",
"az-AZ",
"ban-ID",
"bal-BA",
"bm-ML",
"ba-RU",
"eu-ES",
"be-BY",
"bn-BD",
"bn-IN",
"ber-DZ",
"bh-IN",
"bfo-BF",
"bi-VU",
"bs-BA",
"br-FR",
"bg-BG",
"my-MM",
"ca-ES",
"ceb-PH",
"ch-GU",
"ce-CE",
"chr-US",
"ny-MW",
"zh-CN",
"zh-TW",
"zh-HK",
"zh-MO",
"zh-SG",
"cv-CU",
"kw-GB",
"co-FR",
"cr-NT",
"hr-HR",
"cs-CZ",
"da-DK",
"fa-AF",
"dv-MV",
"nl-NL",
"nl-BE",
"nl-SR",
"dz-BT",
"en-US",
"en-UD",
"en-AR",
"en-AU",
"en-BZ",
"en-CA",
"en-CB",
"en-CN",
"en-DK",
"en-HK",
"en-IN",
"en-ID",
"en-IE",
"en-JM",
"en-JA",
"en-MY",
"en-NZ",
"en-NO",
"en-PH",
"en-PR",
"en-SG",
"en-ZA",
"en-SE",
"en-GB",
"en-ZW",
"eo-UY",
"et-EE",
"ee-GH",
"fo-FO",
"fj-FJ",
"fil-PH",
"fi-FI",
"vls-BE",
"fra-DE",
"fr-FR",
"fr-BE",
"fr-CA",
"fr-LU",
"fr-QC",
"fr-CH",
"fy-NL",
"fur-IT",
"ff-ZA",
"gaa-GH",
"gl-ES",
"ka-GE",
"de-DE",
"de-AT",
"de-BE",
"de-LI",
"de-LU",
"de-CH",
"got-DE",
"el-GR",
"el-CY",
"kl-GL",
"gn-PY",
"gu-IN",
"ht-HT",
"ha-HG",
"haw-US",
"he-IL",
"hz-NA",
"hil-PH",
"hi-IN",
"ho-PG",
"hmn-CN",
"hu-HU",
"is-IS",
"io-EN",
"ig-NG",
"ilo-PH",
"id-ID",
"iu-NU",
"ga-IE",
"it-IT",
"it-CH",
"ja-JP",
"jv-ID",
"quc-GT",
"kab-KAB",
"kn-IN",
"pam-PH",
"ks-IN",
"ks-PK",
"csb-PL",
"kk-KZ",
"km-KH",
"rw-RW",
"tlh-AA",
"kv-KO",
"kg-CG",
"kok-IN",
"ko-KR",
"ku-TR",
"kmr-TR",
"kj-AO",
"ky-KG",
"lol-US",
"lo-LA",
"la-LA",
"lv-LV",
"lij-IT",
"li-LI",
"ln-CD",
"lt-LT",
"jbo-EN",
"nds-DE",
"dsb-DE",
"lg-UG",
"luy-KE",
"lb-LU",
"mk-MK",
"mai-IN",
"mg-MG",
"ms-MY",
"ms-BN",
"ml-IN",
"mt-MT",
"gv-IM",
"mi-NZ",
"arn-CL",
"mr-IN",
"mh-MH",
"moh-CA",
"mn-MN",
"sr-Cyrl-ME",
"me-ME",
"mos-MOS",
"na-NR",
"ng-NA",
"ne-NP",
"ne-IN",
"pcm-NG",
"se-NO",
"ns-ZA",
"no-NO",
"nb-NO",
"nn-NO",
"oc-FR",
"or-IN",
"oj-CA",
"om-ET",
"os-SE",
"pi-IN",
"pap-PAP",
"ps-AF",
"fa-IR",
"en-PT",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-IN",
"pa-PK",
"qu-PE",
"qya-AA",
"ro-RO",
"rm-CH",
"rn-BI",
"ru-RU",
"ru-BY",
"ru-MD",
"ry-UA",
"ru-UA",
"sah-SAH",
"sg-CF",
"sa-IN",
"sat-IN",
"sc-IT",
"sco-GB",
"gd-GB",
"sr-SP",
"sr-CS",
"sh-HR",
"crs-SC",
"sn-ZW",
"ii-CN",
"sd-PK",
"si-LK",
"sk-SK",
"sl-SI",
"so-SO",
"son-ZA",
"ckb-IR",
"nr-ZA",
"sma-NO",
"st-ZA",
"es-ES",
"es-EM",
"es-AR",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-DO",
"es-EC",
"es-SV",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-PR",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-KE",
"sw-TZ",
"ss-ZA",
"sv-SE",
"sv-FI",
"syc-SY",
"tl-PH",
"ty-PF",
"tg-TJ",
"tzl-TZL",
"ta-IN",
"tt-RU",
"te-IN",
"kdh-KDH",
"th-TH",
"bo-BT",
"ti-ER",
"ts-ZA",
"tn-ZA",
"tr-TR",
"tr-CY",
"tk-TM",
"uk-UA",
"hsb-DE",
"ur-IN",
"ur-PK",
"ug-CN",
"uz-UZ",
"val-ES",
"ve-ZA",
"vec-IT",
"vi-VN",
"wa-BE",
"cy-GB",
"wo-SN",
"xh-ZA",
"yi-DE",
"yo-NG",
"zea-ZEA",
"zu-ZA"
],
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink",
"language"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | a6647a45e54f92b387c6c2b2d817813d3aeb3a8d | 2024-04-16T09:21:47 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Collaboration",
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9_-]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://tools.gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"description": "Categories help people find the Experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"language": {
"default": "en-US",
"enum": [
"ach-UG",
"aa-ER",
"af-ZA",
"ak-GH",
"tw-TW",
"sq-AL",
"am-ET",
"ar-SA",
"ar-BH",
"ar-EG",
"ar-YE",
"an-ES",
"hy-AM",
"frp-IT",
"as-IN",
"ast-ES",
"tay-TW",
"av-DA",
"ae-IR",
"ay-BO",
"az-AZ",
"ban-ID",
"bal-BA",
"bm-ML",
"ba-RU",
"eu-ES",
"be-BY",
"bn-BD",
"bn-IN",
"ber-DZ",
"bh-IN",
"bfo-BF",
"bi-VU",
"bs-BA",
"br-FR",
"bg-BG",
"my-MM",
"ca-ES",
"ceb-PH",
"ch-GU",
"ce-CE",
"chr-US",
"ny-MW",
"zh-CN",
"zh-TW",
"zh-HK",
"zh-MO",
"zh-SG",
"cv-CU",
"kw-GB",
"co-FR",
"cr-NT",
"hr-HR",
"cs-CZ",
"da-DK",
"fa-AF",
"dv-MV",
"nl-NL",
"nl-BE",
"nl-SR",
"dz-BT",
"en-US",
"en-UD",
"en-AR",
"en-AU",
"en-BZ",
"en-CA",
"en-CB",
"en-CN",
"en-DK",
"en-HK",
"en-IN",
"en-ID",
"en-IE",
"en-JM",
"en-JA",
"en-MY",
"en-NZ",
"en-NO",
"en-PH",
"en-PR",
"en-SG",
"en-ZA",
"en-SE",
"en-GB",
"en-ZW",
"eo-UY",
"et-EE",
"ee-GH",
"fo-FO",
"fj-FJ",
"fil-PH",
"fi-FI",
"vls-BE",
"fra-DE",
"fr-FR",
"fr-BE",
"fr-CA",
"fr-LU",
"fr-QC",
"fr-CH",
"fy-NL",
"fur-IT",
"ff-ZA",
"gaa-GH",
"gl-ES",
"ka-GE",
"de-DE",
"de-AT",
"de-BE",
"de-LI",
"de-LU",
"de-CH",
"got-DE",
"el-GR",
"el-CY",
"kl-GL",
"gn-PY",
"gu-IN",
"ht-HT",
"ha-HG",
"haw-US",
"he-IL",
"hz-NA",
"hil-PH",
"hi-IN",
"ho-PG",
"hmn-CN",
"hu-HU",
"is-IS",
"io-EN",
"ig-NG",
"ilo-PH",
"id-ID",
"iu-NU",
"ga-IE",
"it-IT",
"it-CH",
"ja-JP",
"jv-ID",
"quc-GT",
"kab-KAB",
"kn-IN",
"pam-PH",
"ks-IN",
"ks-PK",
"csb-PL",
"kk-KZ",
"km-KH",
"rw-RW",
"tlh-AA",
"kv-KO",
"kg-CG",
"kok-IN",
"ko-KR",
"ku-TR",
"kmr-TR",
"kj-AO",
"ky-KG",
"lol-US",
"lo-LA",
"la-LA",
"lv-LV",
"lij-IT",
"li-LI",
"ln-CD",
"lt-LT",
"jbo-EN",
"nds-DE",
"dsb-DE",
"lg-UG",
"luy-KE",
"lb-LU",
"mk-MK",
"mai-IN",
"mg-MG",
"ms-MY",
"ms-BN",
"ml-IN",
"mt-MT",
"gv-IM",
"mi-NZ",
"arn-CL",
"mr-IN",
"mh-MH",
"moh-CA",
"mn-MN",
"sr-Cyrl-ME",
"me-ME",
"mos-MOS",
"na-NR",
"ng-NA",
"ne-NP",
"ne-IN",
"pcm-NG",
"se-NO",
"ns-ZA",
"no-NO",
"nb-NO",
"nn-NO",
"oc-FR",
"or-IN",
"oj-CA",
"om-ET",
"os-SE",
"pi-IN",
"pap-PAP",
"ps-AF",
"fa-IR",
"en-PT",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-IN",
"pa-PK",
"qu-PE",
"qya-AA",
"ro-RO",
"rm-CH",
"rn-BI",
"ru-RU",
"ru-BY",
"ru-MD",
"ry-UA",
"ru-UA",
"sah-SAH",
"sg-CF",
"sa-IN",
"sat-IN",
"sc-IT",
"sco-GB",
"gd-GB",
"sr-SP",
"sr-CS",
"sh-HR",
"crs-SC",
"sn-ZW",
"ii-CN",
"sd-PK",
"si-LK",
"sk-SK",
"sl-SI",
"so-SO",
"son-ZA",
"ckb-IR",
"nr-ZA",
"sma-NO",
"st-ZA",
"es-ES",
"es-EM",
"es-AR",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-DO",
"es-EC",
"es-SV",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-PR",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-KE",
"sw-TZ",
"ss-ZA",
"sv-SE",
"sv-FI",
"syc-SY",
"tl-PH",
"ty-PF",
"tg-TJ",
"tzl-TZL",
"ta-IN",
"tt-RU",
"te-IN",
"kdh-KDH",
"th-TH",
"bo-BT",
"ti-ER",
"ts-ZA",
"tn-ZA",
"tr-TR",
"tr-CY",
"tk-TM",
"uk-UA",
"hsb-DE",
"ur-IN",
"ur-PK",
"ug-CN",
"uz-UZ",
"val-ES",
"ve-ZA",
"vec-IT",
"vi-VN",
"wa-BE",
"cy-GB",
"wo-SN",
"xh-ZA",
"yi-DE",
"yo-NG",
"zea-ZEA",
"zu-ZA"
],
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | cddfa7756f5d6984e6cf927cf1c4e05b430f0219 | 2023-11-28T10:24:09 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"description": "Categories help people find the Experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/category"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"language": {
"default": "en-US",
"enum": [
"ach-UG",
"aa-ER",
"af-ZA",
"ak-GH",
"tw-TW",
"sq-AL",
"am-ET",
"ar-SA",
"ar-BH",
"ar-EG",
"ar-YE",
"an-ES",
"hy-AM",
"frp-IT",
"as-IN",
"ast-ES",
"tay-TW",
"av-DA",
"ae-IR",
"ay-BO",
"az-AZ",
"ban-ID",
"bal-BA",
"bm-ML",
"ba-RU",
"eu-ES",
"be-BY",
"bn-BD",
"bn-IN",
"ber-DZ",
"bh-IN",
"bfo-BF",
"bi-VU",
"bs-BA",
"br-FR",
"bg-BG",
"my-MM",
"ca-ES",
"ceb-PH",
"ch-GU",
"ce-CE",
"chr-US",
"ny-MW",
"zh-CN",
"zh-TW",
"zh-HK",
"zh-MO",
"zh-SG",
"cv-CU",
"kw-GB",
"co-FR",
"cr-NT",
"hr-HR",
"cs-CZ",
"da-DK",
"fa-AF",
"dv-MV",
"nl-NL",
"nl-BE",
"nl-SR",
"dz-BT",
"en-US",
"en-UD",
"en-AR",
"en-AU",
"en-BZ",
"en-CA",
"en-CB",
"en-CN",
"en-DK",
"en-HK",
"en-IN",
"en-ID",
"en-IE",
"en-JM",
"en-JA",
"en-MY",
"en-NZ",
"en-NO",
"en-PH",
"en-PR",
"en-SG",
"en-ZA",
"en-SE",
"en-GB",
"en-ZW",
"eo-UY",
"et-EE",
"ee-GH",
"fo-FO",
"fj-FJ",
"fil-PH",
"fi-FI",
"vls-BE",
"fra-DE",
"fr-FR",
"fr-BE",
"fr-CA",
"fr-LU",
"fr-QC",
"fr-CH",
"fy-NL",
"fur-IT",
"ff-ZA",
"gaa-GH",
"gl-ES",
"ka-GE",
"de-DE",
"de-AT",
"de-BE",
"de-LI",
"de-LU",
"de-CH",
"got-DE",
"el-GR",
"el-CY",
"kl-GL",
"gn-PY",
"gu-IN",
"ht-HT",
"ha-HG",
"haw-US",
"he-IL",
"hz-NA",
"hil-PH",
"hi-IN",
"ho-PG",
"hmn-CN",
"hu-HU",
"is-IS",
"io-EN",
"ig-NG",
"ilo-PH",
"id-ID",
"iu-NU",
"ga-IE",
"it-IT",
"it-CH",
"ja-JP",
"jv-ID",
"quc-GT",
"kab-KAB",
"kn-IN",
"pam-PH",
"ks-IN",
"ks-PK",
"csb-PL",
"kk-KZ",
"km-KH",
"rw-RW",
"tlh-AA",
"kv-KO",
"kg-CG",
"kok-IN",
"ko-KR",
"ku-TR",
"kmr-TR",
"kj-AO",
"ky-KG",
"lol-US",
"lo-LA",
"la-LA",
"lv-LV",
"lij-IT",
"li-LI",
"ln-CD",
"lt-LT",
"jbo-EN",
"nds-DE",
"dsb-DE",
"lg-UG",
"luy-KE",
"lb-LU",
"mk-MK",
"mai-IN",
"mg-MG",
"ms-MY",
"ms-BN",
"ml-IN",
"mt-MT",
"gv-IM",
"mi-NZ",
"arn-CL",
"mr-IN",
"mh-MH",
"moh-CA",
"mn-MN",
"sr-Cyrl-ME",
"me-ME",
"mos-MOS",
"na-NR",
"ng-NA",
"ne-NP",
"ne-IN",
"pcm-NG",
"se-NO",
"ns-ZA",
"no-NO",
"nb-NO",
"nn-NO",
"oc-FR",
"or-IN",
"oj-CA",
"om-ET",
"os-SE",
"pi-IN",
"pap-PAP",
"ps-AF",
"fa-IR",
"en-PT",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-IN",
"pa-PK",
"qu-PE",
"qya-AA",
"ro-RO",
"rm-CH",
"rn-BI",
"ru-RU",
"ru-BY",
"ru-MD",
"ry-UA",
"ru-UA",
"sah-SAH",
"sg-CF",
"sa-IN",
"sat-IN",
"sc-IT",
"sco-GB",
"gd-GB",
"sr-SP",
"sr-CS",
"sh-HR",
"crs-SC",
"sn-ZW",
"ii-CN",
"sd-PK",
"si-LK",
"sk-SK",
"sl-SI",
"so-SO",
"son-ZA",
"ckb-IR",
"nr-ZA",
"sma-NO",
"st-ZA",
"es-ES",
"es-EM",
"es-AR",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-DO",
"es-EC",
"es-SV",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-PR",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-KE",
"sw-TZ",
"ss-ZA",
"sv-SE",
"sv-FI",
"syc-SY",
"tl-PH",
"ty-PF",
"tg-TJ",
"tzl-TZL",
"ta-IN",
"tt-RU",
"te-IN",
"kdh-KDH",
"th-TH",
"bo-BT",
"ti-ER",
"ts-ZA",
"tn-ZA",
"tr-TR",
"tr-CY",
"tk-TM",
"uk-UA",
"hsb-DE",
"ur-IN",
"ur-PK",
"ug-CN",
"uz-UZ",
"val-ES",
"ve-ZA",
"vec-IT",
"vi-VN",
"wa-BE",
"cy-GB",
"wo-SN",
"xh-ZA",
"yi-DE",
"yo-NG",
"zea-ZEA",
"zu-ZA"
],
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | 5a72b5bd7c06aaf0605fc07ae3de74e0df4b1642 | 2023-11-02T09:08:36 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
},
"link": {
"maxLength": 255,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?[a-z0-9]+([\\-\\.]{1}[a-z0-9]+)*\\.[a-z]{2,5}(:[0-9]{1,5})?(\\/.*)?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "Author"
},
"categories": {
"items": {
"$ref": "#/$defs/category"
},
"type": "array"
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "Contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "Description",
"type": "string"
},
"downloadLink": {
"$ref": "#/$defs/link",
"description": "The link to the experience's download file.",
"title": "Download link"
},
"fileSize": {
"description": "The size of the experience's download file in bytes.",
"title": "File size",
"type": "integer"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "License"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "Name/identifier",
"type": "string"
},
"screenshots": {
"description": "Screenshots of the experience. They will be displayed in the Gallery.",
"items": {
"$ref": "#/$defs/link"
},
"minItems": 1,
"title": "Screenshots",
"type": "array",
"uniqueItems": true
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories",
"screenshots",
"downloadLink"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
anyproto/gallery | f044ae39ec8e0ace961938ad095b35cb50644b6b | 2023-07-30T16:47:15 | tools/experience.schema.json | 21 | 2024-05-27T07:02:11.919908Z | {
"$defs": {
"category": {
"enum": [
"Dashboard",
"Work",
"Education",
"Personal Growth",
"Project tracking",
"Collection",
"Health & Fitness",
"Finance",
"Food & Nutrition",
"Travel",
"Hobbies",
"Home",
"Other"
],
"type": "string"
},
"githubLink": {
"maxLength": 75,
"minLength": 2,
"pattern": "^(http(s?):\\/\\/)?(www\\.)?github\\.([a-z])+\\/([A-Za-z0-9]{1,})+\\/?$",
"type": "string"
}
},
"$id": "https://gallery.any.coop/experience.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Experience shared in Anytype Gallery",
"properties": {
"author": {
"$ref": "#/$defs/githubLink",
"description": "A person currently contributing the most to the experience.",
"title": "The experience's current author"
},
"categories": {
"items": {
"$ref": "#/$defs/category"
},
"type": "array"
},
"contributors": {
"description": "People who have meaningfully contributed to the experience.",
"items": {
"$ref": "#/$defs/githubLink"
},
"minItems": 0,
"title": "The experience's list of contributors",
"type": "array",
"uniqueItems": true
},
"description": {
"description": "It helps people understand what the experience provides. It will be displayed in the Gallery.",
"maxLength": 2048,
"minLength": 16,
"pattern": "^[^\\s]+(\\s+[^\\s]+)*$",
"title": "The experience's description",
"type": "string"
},
"id": {
"description": "The unique identifier for an experience",
"type": "string"
},
"license": {
"const": "MIT",
"description": "Currently only MIT is accepted, although more licenses will be available after alpha.",
"title": "The experience's license"
},
"name": {
"description": "The experience's name will be used internally as a folder name in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[a-z0-9-][a-z0-9-_]*$",
"title": "The experience's name/identifier",
"type": "string"
},
"title": {
"description": "The experience title will be displayed in the Gallery.",
"maxLength": 255,
"minLength": 2,
"pattern": "^[^\\s]+(?: [^\\s]+)*$",
"title": "The human-friendly experience's name",
"type": "string"
}
},
"required": [
"id",
"author",
"license",
"title",
"description",
"categories"
],
"title": "Anytype Experience",
"type": "object"
} | MIT | en |
cdevents/spec | b136a558148f06f8f16bf2f078b5a5fef9661357 | 2022-10-26T11:35:21 | schemas/taskrunstarted.json | 121 | 2024-05-27T05:20:45.824683Z | {
"$id": "https://cdevents.dev/0.1.1/schema/task-run-started-event",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"minLength": 1,
"type": "string"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"type": {
"minLength": 1,
"type": "string"
},
"version": {
"default": "0.1.1",
"enum": [
"0.1.0",
"0.1.1"
],
"type": "string"
}
},
"required": [
"version",
"id",
"source",
"type",
"timestamp"
],
"type": "object"
},
"customData": {
"oneOf": [
{
"type": "object"
},
{
"contentEncoding": "base64",
"type": "string"
}
]
},
"customDataContentType": {
"type": "string"
},
"subject": {
"additionalProperties": false,
"properties": {
"content": {
"additionalProperties": false,
"properties": {
"pipelineRun": {
"additionalProperties": false,
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"taskName": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"type": "string"
},
"type": {
"minLength": 1,
"type": "string"
}
},
"required": [
"id",
"type",
"content"
],
"type": "object"
}
},
"required": [
"context",
"subject"
],
"type": "object"
} | Apache-2.0 | en |
cdevents/spec | f1aafdb54dfa7177fa819ec4b51da0f9d48af132 | 2024-03-04T20:30:09 | schemas/changeabandoned.json | 121 | 2024-05-27T05:20:45.824683Z | {
"$id": "https://cdevents.dev/0.4.0-draft/schema/change-abandoned-event",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"schemaUri": {
"format": "uri",
"minLength": 1,
"type": "string"
},
"source": {
"format": "uri-reference",
"minLength": 1,
"type": "string"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"type": {
"default": "dev.cdevents.change.abandoned.0.2.0-draft",
"enum": [
"dev.cdevents.change.abandoned.0.2.0-draft"
],
"type": "string"
},
"version": {
"minLength": 1,
"type": "string"
}
},
"required": [
"version",
"id",
"source",
"type",
"timestamp"
],
"type": "object"
},
"customData": {
"oneOf": [
{
"type": "object"
},
{
"contentEncoding": "base64",
"type": "string"
}
]
},
"customDataContentType": {
"type": "string"
},
"subject": {
"additionalProperties": false,
"properties": {
"content": {
"additionalProperties": false,
"properties": {
"repository": {
"additionalProperties": false,
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"format": "uri-reference",
"minLength": 1,
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"type": "object"
},
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"format": "uri-reference",
"minLength": 1,
"type": "string"
},
"type": {
"default": "change",
"enum": [
"change"
],
"minLength": 1,
"type": "string"
}
},
"required": [
"id",
"type",
"content"
],
"type": "object"
}
},
"required": [
"context",
"subject"
],
"type": "object"
} | Apache-2.0 | en |
cdevents/spec | 726749c1a6ee9512336f24af9ec61bf564fef331 | 2023-05-03T21:44:22 | schemas/pipelinerunstarted.json | 121 | 2024-05-27T05:20:45.824683Z | {
"$id": "https://cdevents.dev/0.3.0/schema/pipeline-run-started-event",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"format": "uri-reference",
"minLength": 1,
"type": "string"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"type": {
"default": "dev.cdevents.pipelinerun.started.0.1.1",
"enum": [
"dev.cdevents.pipelinerun.started.0.1.1"
],
"type": "string"
},
"version": {
"minLength": 1,
"type": "string"
}
},
"required": [
"version",
"id",
"source",
"type",
"timestamp"
],
"type": "object"
},
"customData": {
"oneOf": [
{
"type": "object"
},
{
"contentEncoding": "base64",
"type": "string"
}
]
},
"customDataContentType": {
"type": "string"
},
"subject": {
"additionalProperties": false,
"properties": {
"content": {
"additionalProperties": false,
"properties": {
"pipelineName": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"pipelineName",
"url"
],
"type": "object"
},
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"format": "uri-reference",
"minLength": 1,
"type": "string"
},
"type": {
"default": "pipelineRun",
"enum": [
"pipelineRun"
],
"minLength": 1,
"type": "string"
}
},
"required": [
"id",
"type",
"content"
],
"type": "object"
}
},
"required": [
"context",
"subject"
],
"type": "object"
} | Apache-2.0 | en |
cdevents/spec | 07d06a8b9cc9ccc4a94dc4cf90c4e6111031fde6 | 2022-10-07T08:55:12 | schemas/changeupdated.json | 121 | 2024-05-27T05:20:45.824683Z | {
"$id": "https://cdevents.dev/0.1.0-draft/schema/change-updated-event",
"$schema": "https://json-schema.org/0.1.0-draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"minLength": 1,
"type": "string"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"type": {
"minLength": 1,
"type": "string"
},
"version": {
"default": "0.1.0-draft",
"enum": [
"0.1.0-draft"
],
"type": "string"
}
},
"required": [
"version",
"id",
"source",
"type",
"timestamp"
],
"type": "object"
},
"customData": {
"contentEncoding": "base64",
"type": "string"
},
"customDataContentType": {
"type": "string"
},
"subject": {
"additionalProperties": false,
"properties": {
"content": {
"additionalProperties": false,
"properties": {
"repository": {
"additionalProperties": false,
"properties": {
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"repository"
],
"type": "object"
},
"id": {
"minLength": 1,
"type": "string"
},
"source": {
"type": "string"
},
"type": {
"minLength": 1,
"type": "string"
}
},
"required": [
"id",
"type",
"content"
],
"type": "object"
}
},
"required": [
"context",
"subject"
],
"type": "object"
} | Apache-2.0 | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.