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 |
|---|---|---|---|---|---|---|---|---|
backstage/charts | b1d86d306a066282ceba5206ba8267f78fbbb464 | 2023-06-09T09:41:10 | charts/backstage/values.schema.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": "object"
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container",
"title": "Security settings for a Container."
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"debug": {
"default": false,
"title": "Set to true if you would like to see extra information on logs",
"type": "boolean"
},
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Liveness probe"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "The security settings that you specify for a Pod apply to all Containers in the Pod. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod",
"title": "Security settings for a Pod."
},
"readinessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 30,
"periodSeconds": 10,
"successThreshold": 2,
"timeoutSeconds": 2
}
],
"title": "Readiness probe"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container",
"examples": [
{
"limits": {
"cpu": "1000m",
"memory": "1Gi"
},
"requests": {
"cpu": "100m",
"memory": "250Mi"
}
}
],
"title": "Resource requests/limits"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"description": "Not used in any template. Ref. https://kubernetes.io/docs/concepts/services-networking/network-policies/",
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
},
"title": "",
"type": "array"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"externalAccess": {
"title": "Probably custom ingress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$ref": "https://raw.githubusercontent.com/bitnami/charts/main/bitnami/postgresql/values.schema.json",
"description": "Ref. https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml",
"title": "PostgreSQL chart configuration"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | b0e4aafb4478c9fe28037ea0ccec3800d4d09393 | 2023-10-24T20:24:13 | charts/backstage/values.schema.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container",
"title": "Security settings for a Container."
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"debug": {
"default": false,
"title": "Set to true if you would like to see extra information on logs",
"type": "boolean"
},
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Liveness probe"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "The security settings that you specify for a Pod apply to all Containers in the Pod. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod",
"title": "Security settings for a Pod."
},
"readinessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 30,
"periodSeconds": 10,
"successThreshold": 2,
"timeoutSeconds": 2
}
],
"title": "Readiness probe"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container",
"examples": [
{
"limits": {
"cpu": "1000m",
"memory": "1Gi"
},
"requests": {
"cpu": "100m",
"memory": "250Mi"
}
}
],
"title": "Resource requests/limits"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Startup probe"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
},
"title": "",
"type": "array"
},
"denyConnectionsToExternal": {
"default": false,
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"ingressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyIngressRule"
},
"title": "",
"type": "array"
},
"namespaceSelector": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {},
"description": "Selects Namespaces using cluster scoped-labels.",
"title": "Namespace Selector."
},
"podSelector": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {},
"description": "Selects selects Pods in this namespace.",
"title": "Pod Selector."
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$ref": "https://raw.githubusercontent.com/bitnami/charts/main/bitnami/postgresql/values.schema.json",
"description": "Ref. https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml",
"title": "PostgreSQL chart configuration"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | e122dc571b03d0898ed2bf9fe1fd134d5e3b0642 | 2024-01-09T13:54:00 | charts/backstage/values.schema.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The container 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 container 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": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"description": "Container 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": {
"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": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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. 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. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.",
"items": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resizePolicy": {
"description": "Resources resize policy for the container.",
"items": {
"description": "ContainerResizePolicy represents resource resize policy for the container.",
"properties": {
"resourceName": {
"description": "Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.",
"type": "string"
},
"restartPolicy": {
"description": "Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.",
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"restartPolicy": {
"description": "RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.",
"type": "string"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"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"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsCM": {
"default": [],
"description": "Translates into array of `envFrom.[].configMapRef.name`",
"examples": [
[
"my-backstage-configmap"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from existing ConfigMaps",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from existing Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"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"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.",
"properties": {
"awsElasticBlockStore": {
"description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
},
"partition": {
"description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "boolean"
},
"volumeID": {
"description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"azureDisk": {
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.",
"type": "string"
},
"diskName": {
"description": "diskName is the Name of the data disk in the blob storage",
"type": "string"
},
"diskURI": {
"description": "diskURI is the URI of data disk in the blob storage",
"type": "string"
},
"fsType": {
"description": "fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"kind": {
"description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": "string"
},
"readOnly": {
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"azureFile": {
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"properties": {
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretName": {
"description": "secretName is the name of secret that contains Azure Storage Account Name and Key",
"type": "string"
},
"shareName": {
"description": "shareName is the azure share Name",
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"cephfs": {
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"monitors": {
"description": "monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"type": "string"
},
"readOnly": {
"description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "boolean"
},
"secretFile": {
"description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"user": {
"description": "user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"cinder": {
"description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"volumeID": {
"description": "volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"configMap": {
"description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"csi": {
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"properties": {
"driver": {
"description": "driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.",
"type": "string"
},
"fsType": {
"description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.",
"type": "string"
},
"nodePublishSecretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"readOnly": {
"description": "readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).",
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"description": "volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"downwardAPI": {
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "Items is a list of downward API volume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"emptyDir": {
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"properties": {
"medium": {
"description": "medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"type": "string"
},
"sizeLimit": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"ephemeral": {
"description": "Represents an ephemeral volume that is handled by a normal storage driver.",
"properties": {
"volumeClaimTemplate": {
"description": "PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.",
"properties": {
"metadata": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations",
"type": "object"
},
"creationTimestamp": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
},
"deletionGracePeriodSeconds": {
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"format": "int64",
"type": "integer"
},
"deletionTimestamp": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"format": "int64",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"subresource": {
"description": "Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.",
"type": "string"
},
"time": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
},
"type": "object"
},
"spec": {
"description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes",
"properties": {
"accessModes": {
"description": "accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"type": "string"
},
"kind": {
"description": "Kind is the type of resource being referenced",
"type": "string"
},
"name": {
"description": "Name is the name of resource being referenced",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"dataSourceRef": {
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"type": "string"
},
"kind": {
"description": "Kind is the type of resource being referenced",
"type": "string"
},
"name": {
"description": "Name is the name of resource being referenced",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"resources": {
"description": "VolumeResourceRequirements describes the storage resource requirements for a volume.",
"properties": {
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"selector": {
"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": {
"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"
},
"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"
},
"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"
},
"storageClassName": {
"description": "storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1",
"type": "string"
},
"volumeAttributesClassName": {
"description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.",
"type": "string"
},
"volumeMode": {
"description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.",
"type": "string"
},
"volumeName": {
"description": "volumeName is the binding reference to the PersistentVolume backing this claim.",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"spec"
],
"type": "object"
}
},
"type": "object"
},
"fc": {
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"lun": {
"description": "lun is Optional: FC target lun number",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"targetWWNs": {
"description": "targetWWNs is Optional: FC target worldwide names (WWNs)",
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"description": "wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"flexVolume": {
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"properties": {
"driver": {
"description": "driver is the name of the driver to use for this volume.",
"type": "string"
},
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "options is Optional: this field holds extra command options if any.",
"type": "object"
},
"readOnly": {
"description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"driver"
],
"type": "object"
},
"flocker": {
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"properties": {
"datasetName": {
"description": "datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"type": "string"
},
"datasetUUID": {
"description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset",
"type": "string"
}
},
"type": "object"
},
"gcePersistentDisk": {
"description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"partition": {
"description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"format": "int32",
"type": "integer"
},
"pdName": {
"description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"gitRepo": {
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.",
"properties": {
"directory": {
"description": "directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.",
"type": "string"
},
"repository": {
"description": "repository is the URL",
"type": "string"
},
"revision": {
"description": "revision is the commit hash for the specified revision.",
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"glusterfs": {
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"endpoints": {
"description": "endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"path": {
"description": "path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"hostPath": {
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
},
"type": {
"description": "type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"iscsi": {
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"properties": {
"chapAuthDiscovery": {
"description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication",
"type": "boolean"
},
"chapAuthSession": {
"description": "chapAuthSession defines whether support iSCSI Session CHAP authentication",
"type": "boolean"
},
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi",
"type": "string"
},
"initiatorName": {
"description": "initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"type": "string"
},
"iqn": {
"description": "iqn is the target iSCSI Qualified Name.",
"type": "string"
},
"iscsiInterface": {
"description": "iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"type": "string"
},
"lun": {
"description": "lun represents iSCSI Target Lun number.",
"format": "int32",
"type": "integer"
},
"portals": {
"description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"targetPortal": {
"description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"name": {
"description": "name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"nfs": {
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "boolean"
},
"server": {
"description": "server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"persistentVolumeClaim": {
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).",
"properties": {
"claimName": {
"description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"type": "string"
},
"readOnly": {
"description": "readOnly Will force the ReadOnly setting in VolumeMounts. Default false.",
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"photonPersistentDisk": {
"description": "Represents a Photon Controller persistent disk resource.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"pdID": {
"description": "pdID is the ID that identifies Photon Controller persistent disk",
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"portworxVolume": {
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"properties": {
"fsType": {
"description": "fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"volumeID": {
"description": "volumeID uniquely identifies a Portworx volume",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"projected": {
"description": "Represents a projected volume source",
"properties": {
"defaultMode": {
"description": "defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"sources": {
"description": "sources is the list of volume projections",
"items": {
"description": "Projection that may be projected along with other supported volume types",
"properties": {
"clusterTrustBundle": {
"description": "ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.",
"properties": {
"labelSelector": {
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"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"
},
"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"
},
"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"
},
"name": {
"description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.",
"type": "string"
},
"optional": {
"description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.",
"type": "boolean"
},
"path": {
"description": "Relative path from the volume root to write the bundle.",
"type": "string"
},
"signerName": {
"description": "Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"configMap": {
"description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.",
"properties": {
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"downwardAPI": {
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"properties": {
"items": {
"description": "Items is a list of DownwardAPIVolume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"secret": {
"description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.",
"properties": {
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional field specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"type": "object"
},
"serviceAccountToken": {
"description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).",
"properties": {
"audience": {
"description": "audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"type": "string"
},
"expirationSeconds": {
"description": "expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"format": "int64",
"type": "integer"
},
"path": {
"description": "path is the path relative to the mount point of the file to project the token into.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"quobyte": {
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"properties": {
"group": {
"description": "group to map volume access to Default is no group",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"type": "boolean"
},
"registry": {
"description": "registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes",
"type": "string"
},
"tenant": {
"description": "tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"type": "string"
},
"user": {
"description": "user to map volume access to Defaults to serivceaccount user",
"type": "string"
},
"volume": {
"description": "volume is a string that references an already created Quobyte volume by name.",
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"rbd": {
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd",
"type": "string"
},
"image": {
"description": "image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"keyring": {
"description": "keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"monitors": {
"description": "monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"description": "pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"user": {
"description": "user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"scaleIO": {
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\".",
"type": "string"
},
"gateway": {
"description": "gateway is the host address of the ScaleIO API Gateway.",
"type": "string"
},
"protectionDomain": {
"description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.",
"type": "string"
},
"readOnly": {
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"sslEnabled": {
"description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false",
"type": "boolean"
},
"storageMode": {
"description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"type": "string"
},
"storagePool": {
"description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.",
"type": "string"
},
"system": {
"description": "system is the name of the storage system as configured in ScaleIO.",
"type": "string"
},
"volumeName": {
"description": "volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.",
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"secret": {
"description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"optional": {
"description": "optional field specify whether the Secret or its keys must be defined",
"type": "boolean"
},
"secretName": {
"description": "secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"type": "string"
}
},
"type": "object"
},
"storageos": {
"description": "Represents a StorageOS persistent volume resource.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"volumeName": {
"description": "volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"type": "string"
},
"volumeNamespace": {
"description": "volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.",
"type": "string"
}
},
"type": "object"
},
"vsphereVolume": {
"description": "Represents a vSphere volume resource.",
"properties": {
"fsType": {
"description": "fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"storagePolicyID": {
"description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"type": "string"
},
"storagePolicyName": {
"description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.",
"type": "string"
},
"volumePath": {
"description": "volumePath is the path that identifies vSphere volume vmdk",
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The container 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 container 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": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"description": "Container 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": {
"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": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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. 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. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.",
"items": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resizePolicy": {
"description": "Resources resize policy for the container.",
"items": {
"description": "ContainerResizePolicy represents resource resize policy for the container.",
"properties": {
"resourceName": {
"description": "Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.",
"type": "string"
},
"restartPolicy": {
"description": "Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.",
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"restartPolicy": {
"description": "RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.",
"type": "string"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"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"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"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"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
"properties": {
"ports": {
"description": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
},
"to": {
"description": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
}
}
},
"title": "",
"type": "array"
},
"denyConnectionsToExternal": {
"default": false,
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"ingressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
"properties": {
"from": {
"description": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
},
"ports": {
"description": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
}
}
},
"title": "",
"type": "array"
},
"namespaceSelector": {
"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": {
"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"
},
"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"
},
"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"
},
"podSelector": {
"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": {
"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"
},
"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"
},
"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"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$schema": "http://json-schema.org/schema#",
"properties": {
"architecture": {
"description": "Allowed values: `standalone` or `replication`",
"form": true,
"title": "PostgreSQL architecture",
"type": "string"
},
"auth": {
"form": true,
"properties": {
"database": {
"description": "Name of the custom database to be created during the 1st initialization of PostgreSQL",
"form": true,
"title": "PostgreSQL custom database",
"type": "string"
},
"enablePostgresUser": {
"description": "Assign a password to the \"postgres\" admin user. Otherwise, remote access will be blocked for this user",
"form": true,
"title": "Enable \"postgres\" admin user",
"type": "boolean"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the custom user to create",
"type": "string"
},
"postgresPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the \"postgres\" admin user",
"type": "string"
},
"replicationPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "Password for PostgreSQL replication user",
"type": "string"
},
"replicationUsername": {
"description": "Name of user used to manage replication.",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "PostgreSQL replication user",
"type": "string"
},
"username": {
"description": "Name of the custom user to be created during the 1st initialization of PostgreSQL. This user only has permissions on the PostgreSQL custom database",
"form": true,
"title": "PostgreSQL custom user",
"type": "string"
}
},
"title": "Authentication configuration",
"type": "object"
},
"metrics": {
"properties": {
"enabled": {
"form": true,
"title": "Configure metrics exporter",
"type": "boolean"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
}
},
"type": "object"
},
"replication": {
"form": true,
"properties": {
"enabled": {
"form": true,
"title": "Enable Replication",
"type": "boolean"
},
"readReplicas": {
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "read Replicas",
"type": "integer"
}
},
"title": "Replication Details",
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Change the owner of the persist volume mountpoint to RunAsUser:fsGroup",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | 703768c7790eba82a0430c21a9e7403594c9c856 | 2023-10-25T06:47:00 | charts/backstage/values.schema.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"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": {
"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"
},
"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": {
"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"
},
"windowsOptions": {
"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"
},
"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"
}
},
"type": "object"
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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": {
"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 previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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"
}
},
"type": "object"
},
"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": {
"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": {
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
},
"requests": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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-compute-resources-container/",
"type": "object"
}
},
"type": "object"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"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"
},
"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": {
"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"
},
"windowsOptions": {
"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"
},
"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"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"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"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"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 previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"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"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.",
"properties": {
"awsElasticBlockStore": {
"description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
},
"partition": {
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\". If omitted, the default is \"false\". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "boolean"
},
"volumeID": {
"description": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"azureDisk": {
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "Host Caching mode: None, Read Only, Read Write.",
"type": "string"
},
"diskName": {
"description": "The Name of the data disk in the blob storage",
"type": "string"
},
"diskURI": {
"description": "The URI the data disk in the blob storage",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"kind": {
"description": "Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"azureFile": {
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"properties": {
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretName": {
"description": "the name of secret that contains Azure Storage Account Name and Key",
"type": "string"
},
"shareName": {
"description": "Share Name",
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"cephfs": {
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"monitors": {
"description": "Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "boolean"
},
"secretFile": {
"description": "Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"user": {
"description": "Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"cinder": {
"description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"volumeID": {
"description": "volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"configMap": {
"description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "The key to project.",
"type": "string"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"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 keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"csi": {
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"properties": {
"driver": {
"description": "Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.",
"type": "string"
},
"nodePublishSecretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"readOnly": {
"description": "Specifies a read-only configuration for the volume. Defaults to false (read/write).",
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"description": "VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"downwardAPI": {
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "Items is a list of downward API volume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"emptyDir": {
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"properties": {
"medium": {
"description": "What type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"type": "string"
},
"sizeLimit": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"fc": {
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"lun": {
"description": "Optional: FC target lun number",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"targetWWNs": {
"description": "Optional: FC target worldwide names (WWNs)",
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"description": "Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"flexVolume": {
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"properties": {
"driver": {
"description": "Driver is the name of the driver to use for this volume.",
"type": "string"
},
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "Optional: Extra command options if any.",
"type": "object"
},
"readOnly": {
"description": "Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"flocker": {
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"properties": {
"datasetName": {
"description": "Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"type": "string"
},
"datasetUUID": {
"description": "UUID of the dataset. This is unique identifier of a Flocker dataset",
"type": "string"
}
},
"type": "object"
},
"gcePersistentDisk": {
"description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"partition": {
"description": "The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"format": "int32",
"type": "integer"
},
"pdName": {
"description": "Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"gitRepo": {
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.",
"properties": {
"directory": {
"description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.",
"type": "string"
},
"repository": {
"description": "Repository URL",
"type": "string"
},
"revision": {
"description": "Commit hash for the specified revision.",
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"glusterfs": {
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"endpoints": {
"description": "EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"path": {
"description": "Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"hostPath": {
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
},
"type": {
"description": "Type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"iscsi": {
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"properties": {
"chapAuthDiscovery": {
"description": "whether support iSCSI Discovery CHAP authentication",
"type": "boolean"
},
"chapAuthSession": {
"description": "whether support iSCSI Session CHAP authentication",
"type": "boolean"
},
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi",
"type": "string"
},
"initiatorName": {
"description": "Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"type": "string"
},
"iqn": {
"description": "Target iSCSI Qualified Name.",
"type": "string"
},
"iscsiInterface": {
"description": "iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"type": "string"
},
"lun": {
"description": "iSCSI Target Lun number.",
"format": "int32",
"type": "integer"
},
"portals": {
"description": "iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"targetPortal": {
"description": "iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"name": {
"description": "Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"nfs": {
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "boolean"
},
"server": {
"description": "Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"persistentVolumeClaim": {
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).",
"properties": {
"claimName": {
"description": "ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"type": "string"
},
"readOnly": {
"description": "Will force the ReadOnly setting in VolumeMounts. Default false.",
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"photonPersistentDisk": {
"description": "Represents a Photon Controller persistent disk resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"pdID": {
"description": "ID that identifies Photon Controller persistent disk",
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"portworxVolume": {
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"properties": {
"fsType": {
"description": "FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"volumeID": {
"description": "VolumeID uniquely identifies a Portworx volume",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"projected": {
"description": "Represents a projected volume source",
"properties": {
"defaultMode": {
"description": "Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"sources": {
"description": "list of volume projections",
"items": {
"description": "Projection that may be projected along with other supported volume types",
"properties": {
"configMap": {
"description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "The key to project.",
"type": "string"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"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 keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"downwardAPI": {
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"properties": {
"items": {
"description": "Items is a list of DownwardAPIVolume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"secret": {
"description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.",
"properties": {
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "The key to project.",
"type": "string"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"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"
}
},
"type": "object"
},
"serviceAccountToken": {
"description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).",
"properties": {
"audience": {
"description": "Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"type": "string"
},
"expirationSeconds": {
"description": "ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"format": "int64",
"type": "integer"
},
"path": {
"description": "Path is the path relative to the mount point of the file to project the token into.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"sources"
],
"type": "object"
},
"quobyte": {
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"properties": {
"group": {
"description": "Group to map volume access to Default is no group",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"type": "boolean"
},
"registry": {
"description": "Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes",
"type": "string"
},
"tenant": {
"description": "Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"type": "string"
},
"user": {
"description": "User to map volume access to Defaults to serivceaccount user",
"type": "string"
},
"volume": {
"description": "Volume is a string that references an already created Quobyte volume by name.",
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"rbd": {
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd",
"type": "string"
},
"image": {
"description": "The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"keyring": {
"description": "Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"monitors": {
"description": "A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"description": "The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"readOnly": {
"description": "ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"user": {
"description": "The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"scaleIO": {
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\".",
"type": "string"
},
"gateway": {
"description": "The host address of the ScaleIO API Gateway.",
"type": "string"
},
"protectionDomain": {
"description": "The name of the ScaleIO Protection Domain for the configured storage.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"sslEnabled": {
"description": "Flag to enable/disable SSL communication with Gateway, default false",
"type": "boolean"
},
"storageMode": {
"description": "Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"type": "string"
},
"storagePool": {
"description": "The ScaleIO Storage Pool associated with the protection domain.",
"type": "string"
},
"system": {
"description": "The name of the storage system as configured in ScaleIO.",
"type": "string"
},
"volumeName": {
"description": "The name of a volume already created in the ScaleIO system that is associated with this volume source.",
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"secret": {
"description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "The key to project.",
"type": "string"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"optional": {
"description": "Specify whether the Secret or its keys must be defined",
"type": "boolean"
},
"secretName": {
"description": "Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"type": "string"
}
},
"type": "object"
},
"storageos": {
"description": "Represents a StorageOS persistent volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object"
},
"volumeName": {
"description": "VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"type": "string"
},
"volumeNamespace": {
"description": "VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.",
"type": "string"
}
},
"type": "object"
},
"vsphereVolume": {
"description": "Represents a vSphere volume resource.",
"properties": {
"fsType": {
"description": "Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"storagePolicyID": {
"description": "Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"type": "string"
},
"storagePolicyName": {
"description": "Storage Policy Based Management (SPBM) profile name.",
"type": "string"
},
"volumePath": {
"description": "Path that identifies vSphere volume vmdk",
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"debug": {
"default": false,
"title": "Set to true if you would like to see extra information on logs",
"type": "boolean"
},
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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": {
"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 previous 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".",
"type": "string"
},
"valueFrom": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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"
}
},
"type": "object"
},
"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": {
"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": {
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "Handler defines a specific action that should be taken",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
},
"requests": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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-compute-resources-container/",
"type": "object"
}
},
"type": "object"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN",
"type": "boolean"
},
"capabilities": {
"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"
},
"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": {
"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"
},
"windowsOptions": {
"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"
},
"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"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"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"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"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": {
"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"
},
"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": {
"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"
},
"windowsOptions": {
"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"
},
"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"
}
},
"type": "object"
},
"readinessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/",
"type": "object"
},
"requests": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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-compute-resources-container/",
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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": {
"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": {
"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"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"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"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
"properties": {
"ports": {
"description": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
},
"to": {
"description": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
}
}
},
"title": "",
"type": "array"
},
"denyConnectionsToExternal": {
"default": false,
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"ingressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
"properties": {
"from": {
"description": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
},
"ports": {
"description": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
}
}
},
"title": "",
"type": "array"
},
"namespaceSelector": {
"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": {
"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"
},
"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"
},
"podSelector": {
"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": {
"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"
},
"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"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$schema": "http://json-schema.org/schema#",
"properties": {
"architecture": {
"description": "Allowed values: `standalone` or `replication`",
"form": true,
"title": "PostgreSQL architecture",
"type": "string"
},
"auth": {
"form": true,
"properties": {
"database": {
"description": "Name of the custom database to be created during the 1st initialization of PostgreSQL",
"form": true,
"title": "PostgreSQL custom database",
"type": "string"
},
"enablePostgresUser": {
"description": "Assign a password to the \"postgres\" admin user. Otherwise, remote access will be blocked for this user",
"form": true,
"title": "Enable \"postgres\" admin user",
"type": "boolean"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the custom user to create",
"type": "string"
},
"postgresPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the \"postgres\" admin user",
"type": "string"
},
"replicationPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "Password for PostgreSQL replication user",
"type": "string"
},
"replicationUsername": {
"description": "Name of user used to manage replication.",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "PostgreSQL replication user",
"type": "string"
},
"username": {
"description": "Name of the custom user to be created during the 1st initialization of PostgreSQL. This user only has permissions on the PostgreSQL custom database",
"form": true,
"title": "PostgreSQL custom user",
"type": "string"
}
},
"title": "Authentication configuration",
"type": "object"
},
"metrics": {
"properties": {
"enabled": {
"form": true,
"title": "Configure metrics exporter",
"type": "boolean"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
}
},
"type": "object"
},
"replication": {
"form": true,
"properties": {
"enabled": {
"form": true,
"title": "Enable Replication",
"type": "boolean"
},
"readReplicas": {
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "read Replicas",
"type": "integer"
}
},
"title": "Replication Details",
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Change the owner of the persist volume mountpoint to RunAsUser:fsGroup",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | 62c2605e1319e2b9f9e4f289b7858969892f9c05 | 2024-05-22T12:05:44 | charts/backstage/values.schema.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"affinity": {
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity",
"properties": {
"nodeAffinity": {
"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": {
"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": {
"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": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"weight": {
"description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"preference"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"requiredDuringSchedulingIgnoredDuringExecution": {
"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": {
"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": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"matchFields": {
"description": "A list of node selector requirements by node's fields.",
"items": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"nodeSelectorTerms"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"type": "object"
},
"podAffinity": {
"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": {
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"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": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"matchLabelKeys": {
"description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"mismatchLabelKeys": {
"description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"namespaceSelector": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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": {
"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": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"matchLabelKeys": {
"description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"mismatchLabelKeys": {
"description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"namespaceSelector": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"podAntiAffinity": {
"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": {
"description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)",
"properties": {
"podAffinityTerm": {
"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": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"matchLabelKeys": {
"description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"mismatchLabelKeys": {
"description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"namespaceSelector": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"weight": {
"description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.",
"format": "int32",
"type": "integer"
}
},
"required": [
"weight",
"podAffinityTerm"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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": {
"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": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"matchLabelKeys": {
"description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"mismatchLabelKeys": {
"description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"namespaceSelector": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
}
},
"title": "Affinity for pod assignment",
"type": "object"
},
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"appArmorProfile": {
"description": "AppArmorProfile defines a pod or container's AppArmor settings.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of AppArmor profile will be applied. Valid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"capabilities": {
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The container 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",
"x-kubernetes-list-type": "atomic"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The container 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",
"x-kubernetes-list-type": "atomic"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map",
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"image": {
"description": "Container 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": {
"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": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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. 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. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.",
"items": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resizePolicy": {
"description": "Resources resize policy for the container.",
"items": {
"description": "ContainerResizePolicy represents resource resize policy for the container.",
"properties": {
"resourceName": {
"description": "Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.",
"type": "string"
},
"restartPolicy": {
"description": "Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.",
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"restartPolicy": {
"description": "RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.",
"type": "string"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"appArmorProfile": {
"description": "AppArmorProfile defines a pod or container's AppArmor settings.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of AppArmor profile will be applied. Valid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"capabilities": {
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"devicePath"
],
"x-kubernetes-list-type": "map",
"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": {
"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. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).",
"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"
},
"recursiveReadOnly": {
"description": "RecursiveReadOnly specifies whether read-only mounts should be handled recursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.",
"type": "string"
},
"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"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"mountPath"
],
"x-kubernetes-list-type": "map",
"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"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsCM": {
"default": [],
"description": "Translates into array of `envFrom.[].configMapRef.name`",
"examples": [
[
"my-backstage-configmap"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from existing ConfigMaps",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from existing Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"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. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).",
"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"
},
"recursiveReadOnly": {
"description": "RecursiveReadOnly specifies whether read-only mounts should be handled recursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.",
"type": "string"
},
"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"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.",
"properties": {
"awsElasticBlockStore": {
"description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
},
"partition": {
"description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "boolean"
},
"volumeID": {
"description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"azureDisk": {
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.",
"type": "string"
},
"diskName": {
"description": "diskName is the Name of the data disk in the blob storage",
"type": "string"
},
"diskURI": {
"description": "diskURI is the URI of data disk in the blob storage",
"type": "string"
},
"fsType": {
"description": "fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"kind": {
"description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": "string"
},
"readOnly": {
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"azureFile": {
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"properties": {
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretName": {
"description": "secretName is the name of secret that contains Azure Storage Account Name and Key",
"type": "string"
},
"shareName": {
"description": "shareName is the azure share Name",
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"cephfs": {
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"monitors": {
"description": "monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"type": "string"
},
"readOnly": {
"description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "boolean"
},
"secretFile": {
"description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"user": {
"description": "user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"cinder": {
"description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"volumeID": {
"description": "volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"configMap": {
"description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"csi": {
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"properties": {
"driver": {
"description": "driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.",
"type": "string"
},
"fsType": {
"description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.",
"type": "string"
},
"nodePublishSecretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"readOnly": {
"description": "readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).",
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"description": "volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"downwardAPI": {
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "Items is a list of downward API volume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"emptyDir": {
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"properties": {
"medium": {
"description": "medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"type": "string"
},
"sizeLimit": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"ephemeral": {
"description": "Represents an ephemeral volume that is handled by a normal storage driver.",
"properties": {
"volumeClaimTemplate": {
"description": "PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.",
"properties": {
"metadata": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations",
"type": "object"
},
"creationTimestamp": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
},
"deletionGracePeriodSeconds": {
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"format": "int64",
"type": "integer"
},
"deletionTimestamp": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "set",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"format": "int64",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"subresource": {
"description": "Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.",
"type": "string"
},
"time": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"uid"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
},
"type": "object"
},
"spec": {
"description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes",
"properties": {
"accessModes": {
"description": "accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"dataSource": {
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"type": "string"
},
"kind": {
"description": "Kind is the type of resource being referenced",
"type": "string"
},
"name": {
"description": "Name is the name of resource being referenced",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"dataSourceRef": {
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"type": "string"
},
"kind": {
"description": "Kind is the type of resource being referenced",
"type": "string"
},
"name": {
"description": "Name is the name of resource being referenced",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"resources": {
"description": "VolumeResourceRequirements describes the storage resource requirements for a volume.",
"properties": {
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"selector": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"storageClassName": {
"description": "storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1",
"type": "string"
},
"volumeAttributesClassName": {
"description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.",
"type": "string"
},
"volumeMode": {
"description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.",
"type": "string"
},
"volumeName": {
"description": "volumeName is the binding reference to the PersistentVolume backing this claim.",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"spec"
],
"type": "object"
}
},
"type": "object"
},
"fc": {
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"lun": {
"description": "lun is Optional: FC target lun number",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"targetWWNs": {
"description": "targetWWNs is Optional: FC target worldwide names (WWNs)",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"wwids": {
"description": "wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"flexVolume": {
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"properties": {
"driver": {
"description": "driver is the name of the driver to use for this volume.",
"type": "string"
},
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "options is Optional: this field holds extra command options if any.",
"type": "object"
},
"readOnly": {
"description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"driver"
],
"type": "object"
},
"flocker": {
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"properties": {
"datasetName": {
"description": "datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"type": "string"
},
"datasetUUID": {
"description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset",
"type": "string"
}
},
"type": "object"
},
"gcePersistentDisk": {
"description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"partition": {
"description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"format": "int32",
"type": "integer"
},
"pdName": {
"description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"gitRepo": {
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.",
"properties": {
"directory": {
"description": "directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.",
"type": "string"
},
"repository": {
"description": "repository is the URL",
"type": "string"
},
"revision": {
"description": "revision is the commit hash for the specified revision.",
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"glusterfs": {
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"endpoints": {
"description": "endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"path": {
"description": "path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"hostPath": {
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
},
"type": {
"description": "type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"iscsi": {
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"properties": {
"chapAuthDiscovery": {
"description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication",
"type": "boolean"
},
"chapAuthSession": {
"description": "chapAuthSession defines whether support iSCSI Session CHAP authentication",
"type": "boolean"
},
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi",
"type": "string"
},
"initiatorName": {
"description": "initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"type": "string"
},
"iqn": {
"description": "iqn is the target iSCSI Qualified Name.",
"type": "string"
},
"iscsiInterface": {
"description": "iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"type": "string"
},
"lun": {
"description": "lun represents iSCSI Target Lun number.",
"format": "int32",
"type": "integer"
},
"portals": {
"description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"targetPortal": {
"description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"name": {
"description": "name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"nfs": {
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "boolean"
},
"server": {
"description": "server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"persistentVolumeClaim": {
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).",
"properties": {
"claimName": {
"description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"type": "string"
},
"readOnly": {
"description": "readOnly Will force the ReadOnly setting in VolumeMounts. Default false.",
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"photonPersistentDisk": {
"description": "Represents a Photon Controller persistent disk resource.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"pdID": {
"description": "pdID is the ID that identifies Photon Controller persistent disk",
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"portworxVolume": {
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"properties": {
"fsType": {
"description": "fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"volumeID": {
"description": "volumeID uniquely identifies a Portworx volume",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"projected": {
"description": "Represents a projected volume source",
"properties": {
"defaultMode": {
"description": "defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"sources": {
"description": "sources is the list of volume projections",
"items": {
"description": "Projection that may be projected along with other supported volume types",
"properties": {
"clusterTrustBundle": {
"description": "ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.",
"properties": {
"labelSelector": {
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"name": {
"description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.",
"type": "string"
},
"optional": {
"description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.",
"type": "boolean"
},
"path": {
"description": "Relative path from the volume root to write the bundle.",
"type": "string"
},
"signerName": {
"description": "Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"configMap": {
"description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.",
"properties": {
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"downwardAPI": {
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"properties": {
"items": {
"description": "Items is a list of DownwardAPIVolume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"secret": {
"description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.",
"properties": {
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional field specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"type": "object"
},
"serviceAccountToken": {
"description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).",
"properties": {
"audience": {
"description": "audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"type": "string"
},
"expirationSeconds": {
"description": "expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"format": "int64",
"type": "integer"
},
"path": {
"description": "path is the path relative to the mount point of the file to project the token into.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}
},
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"quobyte": {
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"properties": {
"group": {
"description": "group to map volume access to Default is no group",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"type": "boolean"
},
"registry": {
"description": "registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes",
"type": "string"
},
"tenant": {
"description": "tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"type": "string"
},
"user": {
"description": "user to map volume access to Defaults to serivceaccount user",
"type": "string"
},
"volume": {
"description": "volume is a string that references an already created Quobyte volume by name.",
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"rbd": {
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd",
"type": "string"
},
"image": {
"description": "image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"keyring": {
"description": "keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"monitors": {
"description": "monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"pool": {
"description": "pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"user": {
"description": "user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"scaleIO": {
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\".",
"type": "string"
},
"gateway": {
"description": "gateway is the host address of the ScaleIO API Gateway.",
"type": "string"
},
"protectionDomain": {
"description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.",
"type": "string"
},
"readOnly": {
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"sslEnabled": {
"description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false",
"type": "boolean"
},
"storageMode": {
"description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"type": "string"
},
"storagePool": {
"description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.",
"type": "string"
},
"system": {
"description": "system is the name of the storage system as configured in ScaleIO.",
"type": "string"
},
"volumeName": {
"description": "volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.",
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"secret": {
"description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"optional": {
"description": "optional field specify whether the Secret or its keys must be defined",
"type": "boolean"
},
"secretName": {
"description": "secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"type": "string"
}
},
"type": "object"
},
"storageos": {
"description": "Represents a StorageOS persistent volume resource.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"volumeName": {
"description": "volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"type": "string"
},
"volumeNamespace": {
"description": "volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.",
"type": "string"
}
},
"type": "object"
},
"vsphereVolume": {
"description": "Represents a vSphere volume resource.",
"properties": {
"fsType": {
"description": "fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"storagePolicyID": {
"description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"type": "string"
},
"storagePolicyName": {
"description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.",
"type": "string"
},
"volumePath": {
"description": "volumePath is the path that identifies vSphere volume vmdk",
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The container 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",
"x-kubernetes-list-type": "atomic"
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The container 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",
"x-kubernetes-list-type": "atomic"
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"items": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"description": "Selects a key from a ConfigMap.",
"properties": {
"key": {
"description": "The key to select.",
"type": "string"
},
"name": {
"description": "Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map",
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the ConfigMap must be defined",
"type": "boolean"
}
},
"type": "object"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "Specify whether the Secret must be defined",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"image": {
"description": "Container 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": {
"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": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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. 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. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.",
"items": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resizePolicy": {
"description": "Resources resize policy for the container.",
"items": {
"description": "ContainerResizePolicy represents resource resize policy for the container.",
"properties": {
"resourceName": {
"description": "Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.",
"type": "string"
},
"restartPolicy": {
"description": "Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.",
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"restartPolicy": {
"description": "RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.",
"type": "string"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"appArmorProfile": {
"description": "AppArmorProfile defines a pod or container's AppArmor settings.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of AppArmor profile will be applied. Valid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"capabilities": {
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"devicePath"
],
"x-kubernetes-list-type": "map",
"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": {
"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. When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified (which defaults to None).",
"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"
},
"recursiveReadOnly": {
"description": "RecursiveReadOnly specifies whether read-only mounts should be handled recursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made recursively read-only. If this field is set to IfPossible, the mount is made recursively read-only, if it is supported by the container runtime. If this field is set to Enabled, the mount is made recursively read-only if it is supported by the container runtime, otherwise the pod will not be started and an error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to None (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.",
"type": "string"
},
"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"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"mountPath"
],
"x-kubernetes-list-type": "map",
"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"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"appArmorProfile": {
"description": "AppArmorProfile defines a pod or container's AppArmor settings.",
"properties": {
"localhostProfile": {
"description": "localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only if type is \"Localhost\".",
"type": "string"
},
"type": {
"description": "type indicates which kind of AppArmor profile will be applied. Valid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"capabilities": {
"description": "Adds and removes POSIX capabilities from running containers.",
"properties": {
"add": {
"description": "Added capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"drop": {
"description": "Removed capabilities",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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",
"x-kubernetes-list-type": "atomic"
}
},
"type": "object"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"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"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
"properties": {
"ports": {
"description": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
},
"to": {
"description": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
}
}
},
"title": "",
"type": "array"
},
"denyConnectionsToExternal": {
"default": false,
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"ingressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
"properties": {
"from": {
"description": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
},
"ports": {
"description": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
}
}
},
"title": "",
"type": "array"
},
"namespaceSelector": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
},
"podSelector": {
"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": {
"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"
},
"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",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"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"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$schema": "http://json-schema.org/schema#",
"properties": {
"architecture": {
"description": "Allowed values: `standalone` or `replication`",
"form": true,
"title": "PostgreSQL architecture",
"type": "string"
},
"auth": {
"form": true,
"properties": {
"database": {
"description": "Name of the custom database to be created during the 1st initialization of PostgreSQL",
"form": true,
"title": "PostgreSQL custom database",
"type": "string"
},
"enablePostgresUser": {
"description": "Assign a password to the \"postgres\" admin user. Otherwise, remote access will be blocked for this user",
"form": true,
"title": "Enable \"postgres\" admin user",
"type": "boolean"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the custom user to create",
"type": "string"
},
"postgresPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the \"postgres\" admin user",
"type": "string"
},
"replicationPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "Password for PostgreSQL replication user",
"type": "string"
},
"replicationUsername": {
"description": "Name of user used to manage replication.",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "PostgreSQL replication user",
"type": "string"
},
"username": {
"description": "Name of the custom user to be created during the 1st initialization of PostgreSQL. This user only has permissions on the PostgreSQL custom database",
"form": true,
"title": "PostgreSQL custom user",
"type": "string"
}
},
"title": "Authentication configuration",
"type": "object"
},
"metrics": {
"properties": {
"enabled": {
"form": true,
"title": "Configure metrics exporter",
"type": "boolean"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
}
},
"type": "object"
},
"replication": {
"form": true,
"properties": {
"enabled": {
"form": true,
"title": "Enable Replication",
"type": "boolean"
},
"readReplicas": {
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "read Replicas",
"type": "integer"
}
},
"title": "Replication Details",
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Change the owner of the persist volume mountpoint to RunAsUser:fsGroup",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | 00f8d98e251feada0599910367b1412716c3d92d | 2023-11-13T11:59:19 | charts/backstage/values.schema.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The container 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 container 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": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"description": "Container 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": {
"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": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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. 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. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.",
"items": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resizePolicy": {
"description": "Resources resize policy for the container.",
"items": {
"description": "ContainerResizePolicy represents resource resize policy for the container.",
"properties": {
"resourceName": {
"description": "Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.",
"type": "string"
},
"restartPolicy": {
"description": "Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.",
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"restartPolicy": {
"description": "RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.",
"type": "string"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"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"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"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"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.",
"properties": {
"awsElasticBlockStore": {
"description": "Represents a Persistent Disk resource in AWS.\n\nAn AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
},
"partition": {
"description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "boolean"
},
"volumeID": {
"description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"azureDisk": {
"description": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.",
"properties": {
"cachingMode": {
"description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.",
"type": "string"
},
"diskName": {
"description": "diskName is the Name of the data disk in the blob storage",
"type": "string"
},
"diskURI": {
"description": "diskURI is the URI of data disk in the blob storage",
"type": "string"
},
"fsType": {
"description": "fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"kind": {
"description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared",
"type": "string"
},
"readOnly": {
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
}
},
"required": [
"diskName",
"diskURI"
],
"type": "object"
},
"azureFile": {
"description": "AzureFile represents an Azure File Service mount on the host and bind mount to the pod.",
"properties": {
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretName": {
"description": "secretName is the name of secret that contains Azure Storage Account Name and Key",
"type": "string"
},
"shareName": {
"description": "shareName is the azure share Name",
"type": "string"
}
},
"required": [
"secretName",
"shareName"
],
"type": "object"
},
"cephfs": {
"description": "Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"monitors": {
"description": "monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /",
"type": "string"
},
"readOnly": {
"description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "boolean"
},
"secretFile": {
"description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"user": {
"description": "user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"cinder": {
"description": "Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"volumeID": {
"description": "volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"configMap": {
"description": "Adapts a ConfigMap into a volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"csi": {
"description": "Represents a source location of a volume to mount, managed by an external CSI driver",
"properties": {
"driver": {
"description": "driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.",
"type": "string"
},
"fsType": {
"description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.",
"type": "string"
},
"nodePublishSecretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"readOnly": {
"description": "readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).",
"type": "boolean"
},
"volumeAttributes": {
"additionalProperties": {
"type": "string"
},
"description": "volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.",
"type": "object"
}
},
"required": [
"driver"
],
"type": "object"
},
"downwardAPI": {
"description": "DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "Items is a list of downward API volume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"emptyDir": {
"description": "Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.",
"properties": {
"medium": {
"description": "medium represents what type of storage medium should back this directory. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir",
"type": "string"
},
"sizeLimit": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"type": "object"
},
"ephemeral": {
"description": "Represents an ephemeral volume that is handled by a normal storage driver.",
"properties": {
"volumeClaimTemplate": {
"description": "PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.",
"properties": {
"metadata": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations",
"type": "object"
},
"creationTimestamp": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
},
"deletionGracePeriodSeconds": {
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"format": "int64",
"type": "integer"
},
"deletionTimestamp": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-patch-strategy": "merge"
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"format": "int64",
"type": "integer"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels",
"type": "object"
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"items": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
"type": "object"
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"subresource": {
"description": "Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.",
"type": "string"
},
"time": {
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"items": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"type": "array",
"x-kubernetes-patch-merge-key": "uid",
"x-kubernetes-patch-strategy": "merge"
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
"type": "string"
}
},
"type": "object"
},
"spec": {
"description": "PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes",
"properties": {
"accessModes": {
"description": "accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1",
"items": {
"type": "string"
},
"type": "array"
},
"dataSource": {
"description": "TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.",
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"type": "string"
},
"kind": {
"description": "Kind is the type of resource being referenced",
"type": "string"
},
"name": {
"description": "Name is the name of resource being referenced",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"dataSourceRef": {
"properties": {
"apiGroup": {
"description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.",
"type": "string"
},
"kind": {
"description": "Kind is the type of resource being referenced",
"type": "string"
},
"name": {
"description": "Name is the name of resource being referenced",
"type": "string"
},
"namespace": {
"description": "Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"resources": {
"description": "VolumeResourceRequirements describes the storage resource requirements for a volume.",
"properties": {
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"selector": {
"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": {
"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"
},
"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"
},
"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"
},
"storageClassName": {
"description": "storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1",
"type": "string"
},
"volumeAttributesClassName": {
"description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass will be applied to the claim but it's not allowed to reset this field to empty string once it is set. If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass will be set by the persistentvolume controller if it exists. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass (Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.",
"type": "string"
},
"volumeMode": {
"description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.",
"type": "string"
},
"volumeName": {
"description": "volumeName is the binding reference to the PersistentVolume backing this claim.",
"type": "string"
}
},
"type": "object"
}
},
"required": [
"spec"
],
"type": "object"
}
},
"type": "object"
},
"fc": {
"description": "Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"lun": {
"description": "lun is Optional: FC target lun number",
"format": "int32",
"type": "integer"
},
"readOnly": {
"description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"targetWWNs": {
"description": "targetWWNs is Optional: FC target worldwide names (WWNs)",
"items": {
"type": "string"
},
"type": "array"
},
"wwids": {
"description": "wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"flexVolume": {
"description": "FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.",
"properties": {
"driver": {
"description": "driver is the name of the driver to use for this volume.",
"type": "string"
},
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "options is Optional: this field holds extra command options if any.",
"type": "object"
},
"readOnly": {
"description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"driver"
],
"type": "object"
},
"flocker": {
"description": "Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.",
"properties": {
"datasetName": {
"description": "datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated",
"type": "string"
},
"datasetUUID": {
"description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset",
"type": "string"
}
},
"type": "object"
},
"gcePersistentDisk": {
"description": "Represents a Persistent Disk resource in Google Compute Engine.\n\nA GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"partition": {
"description": "partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as \"1\". Similarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"format": "int32",
"type": "integer"
},
"pdName": {
"description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk",
"type": "boolean"
}
},
"required": [
"pdName"
],
"type": "object"
},
"gitRepo": {
"description": "Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.\n\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.",
"properties": {
"directory": {
"description": "directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.",
"type": "string"
},
"repository": {
"description": "repository is the URL",
"type": "string"
},
"revision": {
"description": "revision is the commit hash for the specified revision.",
"type": "string"
}
},
"required": [
"repository"
],
"type": "object"
},
"glusterfs": {
"description": "Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.",
"properties": {
"endpoints": {
"description": "endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"path": {
"description": "path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod",
"type": "boolean"
}
},
"required": [
"endpoints",
"path"
],
"type": "object"
},
"hostPath": {
"description": "Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
},
"type": {
"description": "type for HostPath Volume Defaults to \"\" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"iscsi": {
"description": "Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.",
"properties": {
"chapAuthDiscovery": {
"description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication",
"type": "boolean"
},
"chapAuthSession": {
"description": "chapAuthSession defines whether support iSCSI Session CHAP authentication",
"type": "boolean"
},
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi",
"type": "string"
},
"initiatorName": {
"description": "initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.",
"type": "string"
},
"iqn": {
"description": "iqn is the target iSCSI Qualified Name.",
"type": "string"
},
"iscsiInterface": {
"description": "iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).",
"type": "string"
},
"lun": {
"description": "lun represents iSCSI Target Lun number.",
"format": "int32",
"type": "integer"
},
"portals": {
"description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"items": {
"type": "string"
},
"type": "array"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"targetPortal": {
"description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).",
"type": "string"
}
},
"required": [
"targetPortal",
"iqn",
"lun"
],
"type": "object"
},
"name": {
"description": "name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"nfs": {
"description": "Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.",
"properties": {
"path": {
"description": "path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "boolean"
},
"server": {
"description": "server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs",
"type": "string"
}
},
"required": [
"server",
"path"
],
"type": "object"
},
"persistentVolumeClaim": {
"description": "PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).",
"properties": {
"claimName": {
"description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims",
"type": "string"
},
"readOnly": {
"description": "readOnly Will force the ReadOnly setting in VolumeMounts. Default false.",
"type": "boolean"
}
},
"required": [
"claimName"
],
"type": "object"
},
"photonPersistentDisk": {
"description": "Represents a Photon Controller persistent disk resource.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"pdID": {
"description": "pdID is the ID that identifies Photon Controller persistent disk",
"type": "string"
}
},
"required": [
"pdID"
],
"type": "object"
},
"portworxVolume": {
"description": "PortworxVolumeSource represents a Portworx volume resource.",
"properties": {
"fsType": {
"description": "fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"volumeID": {
"description": "volumeID uniquely identifies a Portworx volume",
"type": "string"
}
},
"required": [
"volumeID"
],
"type": "object"
},
"projected": {
"description": "Represents a projected volume source",
"properties": {
"defaultMode": {
"description": "defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"sources": {
"description": "sources is the list of volume projections",
"items": {
"description": "Projection that may be projected along with other supported volume types",
"properties": {
"clusterTrustBundle": {
"description": "ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.",
"properties": {
"labelSelector": {
"description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"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"
},
"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"
},
"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"
},
"name": {
"description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.",
"type": "string"
},
"optional": {
"description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the combination of signerName and labelSelector is allowed to match zero ClusterTrustBundles.",
"type": "boolean"
},
"path": {
"description": "Relative path from the volume root to write the bundle.",
"type": "string"
},
"signerName": {
"description": "Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"configMap": {
"description": "Adapts a ConfigMap into a projected volume.\n\nThe contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.",
"properties": {
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional specify whether the ConfigMap or its keys must be defined",
"type": "boolean"
}
},
"type": "object"
},
"downwardAPI": {
"description": "Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.",
"properties": {
"items": {
"description": "Items is a list of DownwardAPIVolume file",
"items": {
"description": "DownwardAPIVolumeFile represents information to create the file containing the pod field",
"properties": {
"fieldRef": {
"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"
},
"mode": {
"description": "Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'",
"type": "string"
},
"resourceFieldRef": {
"description": "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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
}
},
"required": [
"path"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"secret": {
"description": "Adapts a secret into a projected volume.\n\nThe contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.",
"properties": {
"items": {
"description": "items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"optional": {
"description": "optional field specify whether the Secret or its key must be defined",
"type": "boolean"
}
},
"type": "object"
},
"serviceAccountToken": {
"description": "ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).",
"properties": {
"audience": {
"description": "audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.",
"type": "string"
},
"expirationSeconds": {
"description": "expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.",
"format": "int64",
"type": "integer"
},
"path": {
"description": "path is the path relative to the mount point of the file to project the token into.",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"quobyte": {
"description": "Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.",
"properties": {
"group": {
"description": "group to map volume access to Default is no group",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.",
"type": "boolean"
},
"registry": {
"description": "registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes",
"type": "string"
},
"tenant": {
"description": "tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin",
"type": "string"
},
"user": {
"description": "user to map volume access to Defaults to serivceaccount user",
"type": "string"
},
"volume": {
"description": "volume is a string that references an already created Quobyte volume by name.",
"type": "string"
}
},
"required": [
"registry",
"volume"
],
"type": "object"
},
"rbd": {
"description": "Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd",
"type": "string"
},
"image": {
"description": "image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"keyring": {
"description": "keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"monitors": {
"description": "monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"items": {
"type": "string"
},
"type": "array"
},
"pool": {
"description": "pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
},
"readOnly": {
"description": "readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"user": {
"description": "user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it",
"type": "string"
}
},
"required": [
"monitors",
"image"
],
"type": "object"
},
"scaleIO": {
"description": "ScaleIOVolumeSource represents a persistent ScaleIO volume",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Default is \"xfs\".",
"type": "string"
},
"gateway": {
"description": "gateway is the host address of the ScaleIO API Gateway.",
"type": "string"
},
"protectionDomain": {
"description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.",
"type": "string"
},
"readOnly": {
"description": "readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"sslEnabled": {
"description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false",
"type": "boolean"
},
"storageMode": {
"description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.",
"type": "string"
},
"storagePool": {
"description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.",
"type": "string"
},
"system": {
"description": "system is the name of the storage system as configured in ScaleIO.",
"type": "string"
},
"volumeName": {
"description": "volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.",
"type": "string"
}
},
"required": [
"gateway",
"system",
"secretRef"
],
"type": "object"
},
"secret": {
"description": "Adapts a Secret into a volume.\n\nThe contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.",
"properties": {
"defaultMode": {
"description": "defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"items": {
"description": "items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.",
"items": {
"description": "Maps a string key to a path within a volume.",
"properties": {
"key": {
"description": "key is the key to project.",
"type": "string"
},
"mode": {
"description": "mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.",
"type": "string"
}
},
"required": [
"key",
"path"
],
"type": "object"
},
"type": "array"
},
"optional": {
"description": "optional field specify whether the Secret or its keys must be defined",
"type": "boolean"
},
"secretName": {
"description": "secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
"type": "string"
}
},
"type": "object"
},
"storageos": {
"description": "Represents a StorageOS persistent volume resource.",
"properties": {
"fsType": {
"description": "fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"readOnly": {
"description": "readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.",
"type": "boolean"
},
"secretRef": {
"description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.",
"properties": {
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"volumeName": {
"description": "volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.",
"type": "string"
},
"volumeNamespace": {
"description": "volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to \"default\" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.",
"type": "string"
}
},
"type": "object"
},
"vsphereVolume": {
"description": "Represents a vSphere volume resource.",
"properties": {
"fsType": {
"description": "fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.",
"type": "string"
},
"storagePolicyID": {
"description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.",
"type": "string"
},
"storagePolicyName": {
"description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.",
"type": "string"
},
"volumePath": {
"description": "volumePath is the path that identifies vSphere volume vmdk",
"type": "string"
}
},
"required": [
"volumePath"
],
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"debug": {
"default": false,
"title": "Set to true if you would like to see extra information on logs",
"type": "boolean"
},
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"description": "A single application container that you want to run within a pod.",
"properties": {
"args": {
"description": "Arguments to the entrypoint. The container 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 container 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": {
"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": {
"description": "EnvVarSource represents a source for the value of an EnvVar.",
"properties": {
"configMapKeyRef": {
"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"
},
"fieldRef": {
"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"
},
"resourceFieldRef": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"resource": {
"description": "Required: resource to select",
"type": "string"
}
},
"required": [
"resource"
],
"type": "object",
"x-kubernetes-map-type": "atomic"
},
"secretKeyRef": {
"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"
}
},
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"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": {
"description": "EnvFromSource represents the source of a set of ConfigMaps",
"properties": {
"configMapRef": {
"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"
},
"prefix": {
"description": "An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.",
"type": "string"
},
"secretRef": {
"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"
}
},
"type": "object"
},
"type": "array"
},
"image": {
"description": "Container 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": {
"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": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
},
"preStop": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": {
"exec": {
"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"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"sleep": {
"description": "SleepAction describes a \"sleep\" action.",
"properties": {
"seconds": {
"description": "Seconds is the number of seconds to sleep.",
"format": "int64",
"type": "integer"
}
},
"required": [
"seconds"
],
"type": "object"
},
"tcpSocket": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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. 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. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.",
"items": {
"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"
},
"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": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"resizePolicy": {
"description": "Resources resize policy for the container.",
"items": {
"description": "ContainerResizePolicy represents resource resize policy for the container.",
"properties": {
"resourceName": {
"description": "Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.",
"type": "string"
},
"restartPolicy": {
"description": "Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.",
"type": "string"
}
},
"required": [
"resourceName",
"restartPolicy"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"restartPolicy": {
"description": "RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is \"Always\". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as \"Always\" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy \"Always\" will be shut down. This lifecycle differs from normal init containers and is often referred to as a \"sidecar\" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.",
"type": "string"
},
"securityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"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": {
"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"
},
"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": {
"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"
},
"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"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.",
"properties": {
"allowPrivilegeEscalation": {
"description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"capabilities": {
"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"
},
"privileged": {
"description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"procMount": {
"description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.",
"type": "string"
},
"readOnlyRootFilesystem": {
"description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.",
"type": "boolean"
},
"runAsGroup": {
"description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.",
"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. Note that this field cannot be set when spec.os.name is windows.",
"format": "int64",
"type": "integer"
},
"seLinuxOptions": {
"description": "SELinuxOptions are the labels to be applied to the container",
"properties": {
"level": {
"description": "Level is SELinux level label that applies to the container.",
"type": "string"
},
"role": {
"description": "Role is a SELinux role label that applies to the container.",
"type": "string"
},
"type": {
"description": "Type is a SELinux type label that applies to the container.",
"type": "string"
},
"user": {
"description": "User is a SELinux user label that applies to the container.",
"type": "string"
}
},
"type": "object"
},
"seccompProfile": {
"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 be set if type is \"Localhost\". Must NOT be set for any other type.",
"type": "string"
},
"type": {
"description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.",
"type": "string"
}
},
"required": [
"type"
],
"type": "object",
"x-kubernetes-unions": [
{
"discriminator": "type",
"fields-to-discriminateBy": {
"localhostProfile": "LocalhostProfile"
}
}
]
},
"windowsOptions": {
"description": "WindowsSecurityContextOptions contain Windows-specific options and credentials.",
"properties": {
"gmsaCredentialSpec": {
"description": "GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.",
"type": "string"
},
"gmsaCredentialSpecName": {
"description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.",
"type": "string"
},
"hostProcess": {
"description": "HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true.",
"type": "boolean"
},
"runAsUserName": {
"description": "The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"readinessProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"description": "ResourceRequirements describes the compute resource requirements.",
"properties": {
"claims": {
"description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.",
"items": {
"description": "ResourceClaim references one entry in PodSpec.ResourceClaims.",
"properties": {
"name": {
"description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
},
"limits": {
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/",
"type": "object"
}
},
"type": "object"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.",
"properties": {
"exec": {
"description": "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"
},
"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"
},
"grpc": {
"properties": {
"port": {
"description": "Port number of the gRPC service. Number must be in the range 1 to 65535.",
"format": "int32",
"type": "integer"
},
"service": {
"description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"httpGet": {
"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": {
"description": "HTTPHeader describes a custom header to be used in HTTP probes",
"properties": {
"name": {
"description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.",
"type": "string"
},
"value": {
"description": "The header field value",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"type": "array"
},
"path": {
"description": "Path to access on the HTTP server.",
"type": "string"
},
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"scheme": {
"description": "Scheme to use for connecting to the host. Defaults to HTTP.",
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
"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": {
"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": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
},
"required": [
"port"
],
"type": "object"
},
"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"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"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"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
"properties": {
"ports": {
"description": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
},
"to": {
"description": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
}
}
},
"title": "",
"type": "array"
},
"denyConnectionsToExternal": {
"default": false,
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"ingressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
"properties": {
"from": {
"description": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.",
"items": {
"description": "NetworkPolicyPeer describes a peer to allow traffic from. Exactly one of its fields must be specified.",
"properties": {
"ipBlock": {
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.1/24\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": {
"cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.1/24\"",
"type": "string"
},
"except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.1/24\" Except values will be rejected if they are outside the CIDR range",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"cidr"
]
},
"namespaceSelector": {
"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": {
"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": "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"
}
}
},
"podSelector": {
"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": {
"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": "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": "array"
},
"ports": {
"description": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": {
"description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": {
"port": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"protocol": {
"description": "The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string"
}
}
},
"type": "array"
}
}
},
"title": "",
"type": "array"
},
"namespaceSelector": {
"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": {
"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"
},
"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"
},
"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"
},
"podSelector": {
"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": {
"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"
},
"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"
},
"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"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$schema": "http://json-schema.org/schema#",
"properties": {
"architecture": {
"description": "Allowed values: `standalone` or `replication`",
"form": true,
"title": "PostgreSQL architecture",
"type": "string"
},
"auth": {
"form": true,
"properties": {
"database": {
"description": "Name of the custom database to be created during the 1st initialization of PostgreSQL",
"form": true,
"title": "PostgreSQL custom database",
"type": "string"
},
"enablePostgresUser": {
"description": "Assign a password to the \"postgres\" admin user. Otherwise, remote access will be blocked for this user",
"form": true,
"title": "Enable \"postgres\" admin user",
"type": "boolean"
},
"password": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the custom user to create",
"type": "string"
},
"postgresPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"title": "Password for the \"postgres\" admin user",
"type": "string"
},
"replicationPassword": {
"description": "Defaults to a random 10-character alphanumeric string if not set",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "Password for PostgreSQL replication user",
"type": "string"
},
"replicationUsername": {
"description": "Name of user used to manage replication.",
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "PostgreSQL replication user",
"type": "string"
},
"username": {
"description": "Name of the custom user to be created during the 1st initialization of PostgreSQL. This user only has permissions on the PostgreSQL custom database",
"form": true,
"title": "PostgreSQL custom user",
"type": "string"
}
},
"title": "Authentication configuration",
"type": "object"
},
"metrics": {
"properties": {
"enabled": {
"form": true,
"title": "Configure metrics exporter",
"type": "boolean"
}
},
"type": "object"
},
"persistence": {
"properties": {
"size": {
"form": true,
"render": "slider",
"sliderMax": 100,
"sliderMin": 1,
"sliderUnit": "Gi",
"title": "Persistent Volume Size",
"type": "string"
}
},
"type": "object"
},
"replication": {
"form": true,
"properties": {
"enabled": {
"form": true,
"title": "Enable Replication",
"type": "boolean"
},
"readReplicas": {
"form": true,
"hidden": {
"path": "architecture",
"value": "standalone"
},
"title": "read Replicas",
"type": "integer"
}
},
"title": "Replication Details",
"type": "object"
},
"resources": {
"description": "Configure resource requests",
"form": true,
"properties": {
"requests": {
"properties": {
"cpu": {
"form": true,
"render": "slider",
"sliderMax": 2000,
"sliderMin": 10,
"sliderUnit": "m",
"title": "CPU Request",
"type": "string"
},
"memory": {
"form": true,
"render": "slider",
"sliderMax": 2048,
"sliderMin": 10,
"sliderUnit": "Mi",
"title": "Memory Request",
"type": "string"
}
},
"type": "object"
}
},
"title": "Required Resources",
"type": "object"
},
"volumePermissions": {
"properties": {
"enabled": {
"description": "Change the owner of the persist volume mountpoint to RunAsUser:fsGroup",
"form": true,
"title": "Enable Init Containers",
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | 462540742db404089a56ceaee6b347b7547db2a5 | 2023-10-20T10:41:33 | charts/backstage/values.schema.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container",
"title": "Security settings for a Container."
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"debug": {
"default": false,
"title": "Set to true if you would like to see extra information on logs",
"type": "boolean"
},
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Liveness probe"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "The security settings that you specify for a Pod apply to all Containers in the Pod. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod",
"title": "Security settings for a Pod."
},
"readinessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 30,
"periodSeconds": 10,
"successThreshold": 2,
"timeoutSeconds": 2
}
],
"title": "Readiness probe"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container",
"examples": [
{
"limits": {
"cpu": "1000m",
"memory": "1Gi"
},
"requests": {
"cpu": "100m",
"memory": "250Mi"
}
}
],
"title": "Resource requests/limits"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Startup probe"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"description": "Not used in any template. Ref. https://kubernetes.io/docs/concepts/services-networking/network-policies/",
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
},
"title": "",
"type": "array"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"externalAccess": {
"title": "Probably custom ingress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$ref": "https://raw.githubusercontent.com/bitnami/charts/main/bitnami/postgresql/values.schema.json",
"description": "Ref. https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml",
"title": "PostgreSQL chart configuration"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | 703768c7790eba82a0430c21a9e7403594c9c856 | 2023-10-25T06:47:00 | charts/backstage/values.schema.tmpl.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container",
"title": "Security settings for a Container."
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"debug": {
"default": false,
"title": "Set to true if you would like to see extra information on logs",
"type": "boolean"
},
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Liveness probe"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "The security settings that you specify for a Pod apply to all Containers in the Pod. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod",
"title": "Security settings for a Pod."
},
"readinessProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 30,
"periodSeconds": 10,
"successThreshold": 2,
"timeoutSeconds": 2
}
],
"title": "Readiness probe"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container",
"examples": [
{
"limits": {
"cpu": "1000m",
"memory": "1Gi"
},
"requests": {
"cpu": "100m",
"memory": "250Mi"
}
}
],
"title": "Resource requests/limits"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Startup probe"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
},
"title": "",
"type": "array"
},
"denyConnectionsToExternal": {
"default": false,
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"ingressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyIngressRule"
},
"title": "",
"type": "array"
},
"namespaceSelector": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {},
"description": "Selects Namespaces using cluster scoped-labels.",
"title": "Namespace Selector."
},
"podSelector": {
"$ref": "https://kubernetesjsonschema.dev/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {},
"description": "Selects selects Pods in this namespace.",
"title": "Pod Selector."
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$ref": "https://raw.githubusercontent.com/bitnami/charts/main/bitnami/postgresql/values.schema.json",
"description": "Ref. https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml",
"title": "PostgreSQL chart configuration"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
backstage/charts | e122dc571b03d0898ed2bf9fe1fd134d5e3b0642 | 2024-01-09T13:54:00 | charts/backstage/values.schema.tmpl.json | 107 | 2024-05-27T06:17:48.295742Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"backstage": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object"
},
"appConfig": {
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
],
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
]
},
"args": {
"default": [],
"items": {
"type": "string"
},
"title": "Backstage container command arguments",
"type": "array"
},
"command": {
"default": [
"node",
"packages/backend"
],
"items": {
"type": "string"
},
"title": "Backstage container command",
"type": "array"
},
"containerPorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage backend port.",
"type": "integer"
}
},
"title": "Container ports on the Deployment",
"type": "object"
},
"containerSecurityContext": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container",
"title": "Security settings for a Container."
},
"extraAppConfig": {
"default": [],
"items": {
"additionalProperties": false,
"properties": {
"configMapRef": {
"type": "string"
},
"filename": {
"type": "string"
}
},
"type": "object"
},
"title": "Extra app configuration files to inline into command arguments",
"type": "array"
},
"extraContainers": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Deployment sidecars.",
"type": "array"
},
"extraEnvVars": {
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
},
"title": "Backstage container environment variables",
"type": "array"
},
"extraEnvVarsCM": {
"default": [],
"description": "Translates into array of `envFrom.[].configMapRef.name`",
"examples": [
[
"my-backstage-configmap"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from existing ConfigMaps",
"type": "array"
},
"extraEnvVarsSecrets": {
"default": [],
"description": "Translates into array of `envFrom.[].secretRef.name`",
"examples": [
[
"my-backstage-secrets"
]
],
"items": {
"type": "string"
},
"title": "Backstage container environment variables from existing Secrets",
"type": "array"
},
"extraVolumeMounts": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"title": "Backstage container additional volume mounts",
"type": "array"
},
"extraVolumes": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
},
"title": "Backstage container additional volumes",
"type": "array"
},
"image": {
"additionalProperties": false,
"properties": {
"pullPolicy": {
"default": "Always",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"enum": [
"Always",
"IfNotPresent"
],
"title": "Specify a imagePullPolicy.",
"type": "string"
},
"pullSecrets": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"examples": [
"myRegistryKeySecretName"
],
"items": {
"type": "string"
},
"title": "Optionally specify an array of imagePullSecrets.",
"type": "array"
},
"registry": {
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
],
"title": "Backstage image registry",
"type": "string"
},
"repository": {
"default": "backstage/backstage",
"title": "Backstage image repository",
"type": "string"
},
"tag": {
"default": "latest",
"description": "Immutable tags are recommended.",
"title": "Backstage image tag",
"type": "string"
}
},
"title": "Image parameters",
"type": "object"
},
"initContainers": {
"default": [],
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"title": "Backstage container init containers",
"type": "array"
},
"installDir": {
"default": "/app",
"title": "Directory containing the backstage installation",
"type": "string"
},
"livenessProbe": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Liveness probe"
},
"nodeSelector": {
"additionalProperties": {
"type": "string"
},
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"title": "Node labels for pod assignment",
"type": "object"
},
"podAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to the backend deployment pods",
"type": "object"
},
"podLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to the backend deployment pods",
"type": "object"
},
"podSecurityContext": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {},
"description": "The security settings that you specify for a Pod apply to all Containers in the Pod. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod",
"title": "Security settings for a Pod."
},
"readinessProbe": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 30,
"periodSeconds": 10,
"successThreshold": 2,
"timeoutSeconds": 2
}
],
"title": "Readiness probe"
},
"replicas": {
"default": 1,
"minimum": 0,
"title": "Number of deployment replicas",
"type": "integer"
},
"resources": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"description": "Ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container",
"examples": [
{
"limits": {
"cpu": "1000m",
"memory": "1Gi"
},
"requests": {
"cpu": "100m",
"memory": "250Mi"
}
}
],
"title": "Resource requests/limits"
},
"revisionHistoryLimit": {
"default": 10,
"minimum": 0,
"title": "The count of deployment revisions",
"type": "integer"
},
"startupProbe": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
],
"title": "Startup probe"
},
"tolerations": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration"
},
"title": "Node tolerations for server scheduling to nodes with taints",
"type": "array"
}
},
"title": "Backstage parameters",
"type": "object"
},
"clusterDomain": {
"default": "cluster.local",
"title": "Default Kubernetes cluster domain",
"type": "string"
},
"commonAnnotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Annotations to add to all deployed objects",
"type": "object"
},
"commonLabels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Labels to add to all deployed objects",
"type": "object"
},
"diagnosticMode": {
"additionalProperties": false,
"properties": {
"args": {
"default": [
"infinity"
],
"items": {
"type": "string"
},
"title": "Args to override all containers in the Deployment",
"type": "array"
},
"command": {
"default": [
"sleep"
],
"items": {
"type": "string"
},
"title": "Command to override all containers in the Deployment",
"type": "array"
},
"enabled": {
"default": false,
"description": "All probes will be disabled and the command will be overridden",
"title": "Enable diagnostic mode",
"type": "boolean"
}
},
"title": "Enable diagnostic mode in the Deployment",
"type": "object"
},
"extraDeploy": {
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"title": "Array of extra objects to deploy with the release",
"type": "array",
"uniqueItems": true
},
"fullnameOverride": {
"default": "",
"title": "String to fully override common.names.fullname",
"type": "string"
},
"global": {
"properties": {
"imagePullSecrets": {
"default": [],
"examples": [
[
"myRegistryKeySecretName"
]
],
"items": {
"type": "string"
},
"title": "Global Docker registry secret names as an array",
"type": "array",
"uniqueItems": true
},
"imageRegistry": {
"default": "",
"title": "Global Docker image registry",
"type": "string"
}
},
"title": "Global parameters.",
"type": "object"
},
"ingress": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional annotations for the Ingress resource",
"type": "object"
},
"className": {
"default": "",
"examples": [
"nginx"
],
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string"
},
"enabled": {
"default": false,
"title": "Enable the creation of the ingress resource",
"type": "boolean"
},
"host": {
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
],
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string"
},
"tls": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "TLS for the host defined at `ingress.host` parameter",
"title": "Enable TLS configuration",
"type": "boolean"
},
"secretName": {
"default": "",
"title": "The name to which the TLS Secret will be called",
"type": "string"
}
},
"title": "Ingress TLS parameters",
"type": "object"
}
},
"title": "Ingress parameters",
"type": "object"
},
"kubeVersion": {
"default": "",
"title": "Override Kubernetes version",
"type": "string"
},
"metrics": {
"additionalProperties": false,
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"properties": {
"serviceMonitor": {
"additionalProperties": false,
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "ServiceMonitor annotations",
"type": "object"
},
"enabled": {
"default": false,
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"type": "boolean"
},
"interval": {
"default": null,
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional ServiceMonitor labels",
"type": "object"
},
"path": {
"default": "/metrics",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"title": "ServiceMonitor endpoint path",
"type": "string"
}
},
"title": "ServiceMonitor configuration",
"type": "object"
}
},
"title": "Metrics configuration",
"type": "object"
},
"nameOverride": {
"default": "",
"title": "String to partially override common.names.fullname",
"type": "string"
},
"networkPolicy": {
"additionalProperties": false,
"properties": {
"egressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
},
"title": "",
"type": "array"
},
"denyConnectionsToExternal": {
"default": false,
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean"
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
},
"enabled": {
"default": false,
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean"
},
"ingressRules": {
"additionalProperties": false,
"properties": {
"customRules": {
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyIngressRule"
},
"title": "",
"type": "array"
},
"namespaceSelector": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {},
"description": "Selects Namespaces using cluster scoped-labels.",
"title": "Namespace Selector."
},
"podSelector": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {},
"description": "Selects selects Pods in this namespace.",
"title": "Pod Selector."
}
},
"title": "Custom egress rules for the network policy",
"type": "object"
}
},
"title": "Network policies",
"type": "object"
},
"postgresql": {
"$ref": "https://raw.githubusercontent.com/bitnami/charts/main/bitnami/postgresql/values.schema.json",
"description": "Ref. https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml",
"title": "PostgreSQL chart configuration"
},
"service": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for Backstage service",
"type": "object"
},
"clusterIP": {
"default": "",
"title": "Backstage service Cluster IP",
"type": "string"
},
"externalTrafficPolicy": {
"default": "Cluster",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"enum": [
"Cluster",
"Local"
],
"title": "Backstage service external traffic policy",
"type": "string"
},
"extraPorts": {
"default": [],
"items": {
"type": "object"
},
"title": "Extra ports to expose in the Backstage service",
"type": "array"
},
"loadBalancerIP": {
"default": "",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"title": "Backstage service Load Balancer IP",
"type": "string"
},
"loadBalancerSourceRanges": {
"default": [],
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"examples": [
"10.10.10.0/24"
],
"items": {
"type": "string"
},
"title": "Load Balancer sources",
"type": "array"
},
"nodePorts": {
"additionalProperties": false,
"properties": {
"backend": {
"default": "",
"maximum": 32767,
"minimum": 30000,
"title": "Node port for backend",
"type": [
"string",
"integer"
]
}
},
"title": "Node port for the Backstage client connections",
"type": "object"
},
"ports": {
"additionalProperties": false,
"properties": {
"backend": {
"default": 7007,
"title": "Backstage svc port number",
"type": "integer"
},
"name": {
"default": "http-backend",
"title": "Backstage svc port name",
"type": "string"
},
"targetPort": {
"default": "backend",
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string"
}
},
"title": "Backstage svc port for client connections",
"type": "object"
},
"sessionAffinity": {
"default": "None",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"enum": [
"None",
"ClientIP"
],
"title": "Control where client requests go, to the same pod or round-robin",
"type": "string"
},
"type": {
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
],
"title": "Kubernetes Service type",
"type": "string"
}
},
"title": "Service parameters",
"type": "object"
},
"serviceAccount": {
"additionalProperties": false,
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object"
},
"automountServiceAccountToken": {
"default": true,
"title": "Auto-mount the service account token in the pod",
"type": "boolean"
},
"create": {
"default": false,
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"default": {},
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object"
},
"name": {
"default": "",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"title": "Name of the ServiceAccount to use",
"type": "string"
}
},
"title": "Service Account Configuration",
"type": "object"
}
},
"title": "Backstage chart schema",
"type": "object"
} | Apache-2.0 | en |
kubecolor/kubecolor | fd8839c8c3b190826394dae49073ef544baa87f6 | 2024-05-27T14:05:35 | config-schema.json | 420 | 2024-05-27T08:22:36.347267Z | {
"$defs": {
"color": {
"default": "none",
"description": "A single color style, optionally setting foreground (text) color, background color, and/or modifier such as 'bold'.",
"examples": [
"none",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"black",
"240",
"aaff00",
"#aaff00",
"rgb(192, 255, 238)",
"raw(4;53)",
"gray:italic",
"fg=white:bold:underline",
"fg=yellow:bg=red:bold"
],
"title": "Color",
"type": "string"
},
"colorSlice": {
"description": "Allows multiple separate colors to be applied, separated by slash.",
"examples": [
"red/green/blue",
"bg=red:underline/bg=green:italic/bg=blue:bold"
],
"title": "Multiple colors",
"type": "string"
},
"duration": {
"default": "0",
"description": "A string value representing a time span, formatted as a Go time duration.",
"examples": [
"30s",
"5m",
"10m",
"1h30m",
"5h"
],
"title": "Time duration",
"type": "string"
},
"paging": {
"default": "auto",
"description": "Whether to pipe supported subcommands to a pager (\"auto\" or \"never\")",
"enum": [
"auto",
"never"
],
"title": "Paging mode preference",
"type": "string"
},
"preset": {
"default": "dark",
"description": "Preset is a set of defaults for the color theme.",
"enum": [
"none",
"dark",
"light",
"protanopia-dark",
"protanopia-light",
"deuteranopia-dark",
"deuteranopia-light",
"tritanopia-dark",
"tritanopia-light",
"pre-0.3.0-dark",
"pre-0.3.0-light",
"pre-0.0.21-dark",
"pre-0.0.21-light"
],
"title": "Color theme preset",
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Theme is the root theme config.",
"properties": {
"apply": {
"$ref": "#/$defs/themeApply",
"description": "used in \"kubectl apply\""
},
"base": {
"$ref": "#/$defs/themeBase",
"description": "Base colors must be first so they're applied first"
},
"data": {
"$ref": "#/$defs/themeData",
"description": "colors for representing data"
},
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the command"
},
"describe": {
"$ref": "#/$defs/themeDescribe",
"description": "used in \"kubectl describe\""
},
"explain": {
"$ref": "#/$defs/themeExplain",
"description": "used in \"kubectl explain\""
},
"help": {
"$ref": "#/$defs/themeHelp",
"description": "used in \"kubectl --help\""
},
"options": {
"$ref": "#/$defs/themeOptions",
"description": "used in \"kubectl options\""
},
"shell": {
"$ref": "#/$defs/themeShell",
"description": "colors for representing shells (e.g bash, zsh, etc)"
},
"status": {
"$ref": "#/$defs/themeStatus",
"description": "generic status coloring (e.g \"Ready\", \"Terminating\")"
},
"stderr": {
"$ref": "#/$defs/themeStderr",
"description": "used in kubectl's stderr output"
},
"table": {
"$ref": "#/$defs/themeTable",
"description": "used in table output, e.g \"kubectl get\" and parts of \"kubectl describe\""
},
"version": {
"$ref": "#/$defs/themeVersion",
"description": "used in \"kubectl version\""
}
},
"type": "object"
},
"themeApply": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"configured": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/bar configured\""
},
"created": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/foo created\""
},
"dryRun": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux created (dry-run)\""
},
"fallback": {
"$ref": "#/$defs/color",
"description": "used when \"kubectl apply\" outputs unknown format"
},
"unchanged": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux unchanged\""
}
},
"type": "object"
},
"themeBase": {
"additionalProperties": false,
"description": "ThemeBase contains base colors that other theme fields can default to, just to make overriding themes easier.",
"properties": {
"danger": {
"$ref": "#/$defs/color",
"description": "general color for when things are bad"
},
"info": {
"$ref": "#/$defs/color",
"description": "general color for when things are informational"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "general color for keys"
},
"muted": {
"$ref": "#/$defs/color",
"description": "general color for when things are less relevant"
},
"primary": {
"$ref": "#/$defs/color",
"description": "general color for when things are focus"
},
"secondary": {
"$ref": "#/$defs/color",
"description": "general color for when things are secondary focus"
},
"success": {
"$ref": "#/$defs/color",
"description": "general color for when things are good"
},
"warning": {
"$ref": "#/$defs/color",
"description": "general color for when things are wrong"
}
},
"type": "object"
},
"themeData": {
"additionalProperties": false,
"description": "ThemeData holds colors for when representing parsed data.",
"properties": {
"duration": {
"$ref": "#/$defs/color",
"description": "used when the value is a duration, e.g \"12m\" or \"1d12h\""
},
"durationFresh": {
"$ref": "#/$defs/color",
"description": "color used when the time value is under a certain delay"
},
"false": {
"$ref": "#/$defs/color",
"description": "used when value is false"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used for the key"
},
"null": {
"$ref": "#/$defs/color",
"description": "used when the value is null, nil, or none"
},
"number": {
"$ref": "#/$defs/color",
"description": "used when the value is a number"
},
"quantity": {
"$ref": "#/$defs/color",
"description": "used when the value is a quantity, e.g \"100m\" or \"5Gi\""
},
"ratio": {
"$ref": "#/$defs/themeDataRatio"
},
"string": {
"$ref": "#/$defs/color",
"description": "used when value is a string"
},
"true": {
"$ref": "#/$defs/color",
"description": "used when value is true"
}
},
"type": "object"
},
"themeDataRatio": {
"additionalProperties": false,
"properties": {
"equal": {
"$ref": "#/$defs/color",
"description": "used for \"n/n\", e.g \"1/1\""
},
"unequal": {
"$ref": "#/$defs/color",
"description": "used for \"n/m\", e.g \"0/1\""
},
"zero": {
"$ref": "#/$defs/color",
"description": "used for \"0/0\""
}
},
"type": "object"
},
"themeDescribe": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
}
},
"type": "object"
},
"themeExplain": {
"additionalProperties": false,
"description": "ThemeExplain holds colors for the \"kubectl explain\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
},
"required": {
"$ref": "#/$defs/color",
"description": "used on the trailing \"-required-\" string"
}
},
"type": "object"
},
"themeHelp": {
"additionalProperties": false,
"description": "ThemeHelp holds colors for the \"kubectl --help\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
},
"flagDesc": {
"$ref": "#/$defs/color",
"description": "Flag descripion under \"Options:\" heading"
},
"header": {
"$ref": "#/$defs/color",
"description": "e.g \"Examples:\" or \"Options:\""
},
"text": {
"$ref": "#/$defs/color",
"description": "Fallback text color"
},
"url": {
"$ref": "#/$defs/color",
"description": "e.g `[https://example.com]`"
}
},
"type": "object"
},
"themeOptions": {
"additionalProperties": false,
"description": "ThemeOptions holds colors for the \"kubectl options\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
}
},
"type": "object"
},
"themeShell": {
"additionalProperties": false,
"description": "ThemeShell holds colors for when representing shell commands (bash, zsh, etc)",
"properties": {
"arg": {
"$ref": "#/$defs/color",
"description": "used on arguments, e.g `get pods` in `kubectl get pods`"
},
"command": {
"$ref": "#/$defs/color",
"description": "used on commands, e.g `kubectl` or `echo`"
},
"comment": {
"$ref": "#/$defs/color",
"description": "used on comments, e.g `# this is a comment`"
},
"flag": {
"$ref": "#/$defs/color",
"description": "used on flags, e.g `--watch` in `kubectl get pods --watch`"
}
},
"type": "object"
},
"themeStatus": {
"additionalProperties": false,
"description": "ThemeStatus holds colors for status texts, used in for example the \"kubectl get\" status column",
"properties": {
"error": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Failed\", \"Unhealthy\""
},
"success": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Running\", \"Ready\""
},
"warning": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Terminating\""
}
},
"type": "object"
},
"themeStderr": {
"additionalProperties": false,
"description": "ThemeStderr holds generic colors for kubectl's stderr output.",
"properties": {
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the output line"
},
"error": {
"$ref": "#/$defs/color",
"description": "e.g when text contains \"error\""
}
},
"type": "object"
},
"themeTable": {
"additionalProperties": false,
"description": "ThemeTable holds colors for table output",
"properties": {
"columns": {
"$ref": "#/$defs/colorSlice",
"description": "used on table columns when no other coloring applies such as status or duration coloring. The multiple colors are cycled based on column ID, from left to right."
},
"header": {
"$ref": "#/$defs/color",
"description": "used on table headers"
}
},
"type": "object"
},
"themeVersion": {
"additionalProperties": false,
"description": "ThemeVersion holds colors for the \"kubectl version\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on the key"
}
},
"type": "object"
}
},
"$id": "https://github.com/kubecolor/kubecolor/raw/main/config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kubectl": {
"default": "kubectl",
"description": "Which kubectl executable to use",
"examples": [
"kubectl1.19",
"oc"
],
"type": "string"
},
"objFreshThreshold": {
"$ref": "#/$defs/duration",
"description": "Ages below this uses theme.data.durationfresh coloring"
},
"pager": {
"description": "Command to use as pager",
"examples": [
"less -RF",
"more"
],
"type": "string"
},
"paging": {
"$ref": "#/$defs/paging",
"description": "Whether to enable paging: \"auto\" or \"never\""
},
"preset": {
"$ref": "#/$defs/preset",
"description": "Color theme preset"
},
"theme": {
"$ref": "#/$defs/theme"
}
},
"type": "object"
} | MIT | en |
kubecolor/kubecolor | e49db730934731e06462f9e777de735368a54fb6 | 2024-03-17T21:43:25 | config-schema.json | 420 | 2024-05-27T08:22:36.347267Z | {
"$defs": {
"color": {
"default": "none",
"description": "A single color style, optionally setting foreground (text) color, background color, and/or modifier such as 'bold'.",
"examples": [
"none",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"black",
"240",
"aaff00",
"#aaff00",
"rgb(192, 255, 238)",
"raw(4;53)",
"gray:italic",
"fg=white:bold:underline",
"fg=yellow:bg=red:bold"
],
"title": "Color",
"type": "string"
},
"colorSlice": {
"description": "Allows multiple separate colors to be applied, separated by slash.",
"examples": [
"red/green/blue",
"bg=red:underline/bg=green:italic/bg=blue:bold"
],
"title": "Multiple colors",
"type": "string"
},
"preset": {
"default": "dark",
"description": "Preset is a set of defaults for the color theme.",
"enum": [
"dark",
"light",
"pre-0.0.21-dark",
"pre-0.0.21-light"
],
"title": "Color theme preset",
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Theme is the root theme config.",
"properties": {
"apply": {
"$ref": "#/$defs/themeApply",
"description": "used in \"kubectl apply\""
},
"base": {
"$ref": "#/$defs/themeBase",
"description": "Base colors must be first so they're applied first"
},
"data": {
"$ref": "#/$defs/themeData",
"description": "colors for representing data"
},
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the command"
},
"describe": {
"$ref": "#/$defs/themeDescribe",
"description": "used in \"kubectl describe\""
},
"explain": {
"$ref": "#/$defs/themeExplain",
"description": "used in \"kubectl explain\""
},
"options": {
"$ref": "#/$defs/themeOptions",
"description": "used in \"kubectl options\""
},
"status": {
"$ref": "#/$defs/themeStatus",
"description": "generic status coloring (e.g \"Ready\", \"Terminating\")"
},
"stderr": {
"$ref": "#/$defs/themeStderr",
"description": "used in kubectl's stderr output"
},
"table": {
"$ref": "#/$defs/themeTable",
"description": "used in table output, e.g \"kubectl get\" and parts of \"kubectl describe\""
},
"version": {
"$ref": "#/$defs/themeVersion",
"description": "used in \"kubectl version\""
}
},
"type": "object"
},
"themeApply": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"configured": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/bar configured\""
},
"created": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/foo created\""
},
"dryRun": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux created (dry-run)\""
},
"fallback": {
"$ref": "#/$defs/color",
"description": "used when \"kubectl apply\" outputs unknown format"
},
"unchanged": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux unchanged\""
}
},
"type": "object"
},
"themeBase": {
"additionalProperties": false,
"description": "ThemeBase contains base colors that other theme fields can default to, just to make overriding themes easier.",
"properties": {
"danger": {
"$ref": "#/$defs/color",
"description": "general color for when things are bad"
},
"info": {
"$ref": "#/$defs/color",
"description": "general color for when things are informational"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "general color for keys"
},
"muted": {
"$ref": "#/$defs/color",
"description": "general color for when things are less relevant"
},
"primary": {
"$ref": "#/$defs/color",
"description": "general color for when things are focus"
},
"secondary": {
"$ref": "#/$defs/color",
"description": "general color for when things are secondary focus"
},
"success": {
"$ref": "#/$defs/color",
"description": "general color for when things are good"
},
"warning": {
"$ref": "#/$defs/color",
"description": "general color for when things are wrong"
}
},
"type": "object"
},
"themeData": {
"additionalProperties": false,
"description": "ThemeData holds colors for when representing parsed data.",
"properties": {
"duration": {
"$ref": "#/$defs/color",
"description": "used when the value is a duration, e.g \"12m\""
},
"durationFresh": {
"$ref": "#/$defs/color",
"description": "color used when the time value is under a certain delay"
},
"false": {
"$ref": "#/$defs/color",
"description": "used when value is false"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used for the key"
},
"null": {
"$ref": "#/$defs/color",
"description": "used when the value is null, nil, or none"
},
"number": {
"$ref": "#/$defs/color",
"description": "used when the value is a number"
},
"ratio": {
"$ref": "#/$defs/themeDataRatio"
},
"string": {
"$ref": "#/$defs/color",
"description": "used when value is a string"
},
"true": {
"$ref": "#/$defs/color",
"description": "used when value is true"
}
},
"type": "object"
},
"themeDataRatio": {
"additionalProperties": false,
"properties": {
"equal": {
"$ref": "#/$defs/color",
"description": "used for \"n/n\", e.g \"1/1\""
},
"unequal": {
"$ref": "#/$defs/color",
"description": "used for \"n/m\", e.g \"0/1\""
},
"zero": {
"$ref": "#/$defs/color",
"description": "used for \"0/0\""
}
},
"type": "object"
},
"themeDescribe": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
}
},
"type": "object"
},
"themeExplain": {
"additionalProperties": false,
"description": "ThemeExplain holds colors for the \"kubectl explain\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
},
"required": {
"$ref": "#/$defs/color",
"description": "used on the trailing \"-required-\" string"
}
},
"type": "object"
},
"themeOptions": {
"additionalProperties": false,
"description": "ThemeOptions holds colors for the \"kubectl options\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
}
},
"type": "object"
},
"themeStatus": {
"additionalProperties": false,
"description": "ThemeStatus holds colors for status texts, used in for example the \"kubectl get\" status column",
"properties": {
"error": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Failed\", \"Unhealthy\""
},
"success": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Running\", \"Ready\""
},
"warning": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Terminating\""
}
},
"type": "object"
},
"themeStderr": {
"additionalProperties": false,
"description": "ThemeStderr holds generic colors for kubectl's stderr output.",
"properties": {
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the output line"
},
"error": {
"$ref": "#/$defs/color",
"description": "e.g when text contains \"error\""
}
},
"type": "object"
},
"themeTable": {
"additionalProperties": false,
"description": "ThemeTable holds colors for table output",
"properties": {
"columns": {
"$ref": "#/$defs/colorSlice",
"description": "used on table columns when no other coloring applies such as status or duration coloring. The multiple colors are cycled based on column ID, from left to right."
},
"header": {
"$ref": "#/$defs/color",
"description": "used on table headers"
}
},
"type": "object"
},
"themeVersion": {
"additionalProperties": false,
"description": "ThemeVersion holds colors for the \"kubectl version\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on the key"
}
},
"type": "object"
}
},
"$id": "https://github.com/kubecolor/kubecolor/raw/main/config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kubectl": {
"default": "kubectl",
"description": "Which kubectl executable to use",
"examples": [
"kubectl1.19",
"oc"
],
"type": "string"
},
"objFreshThreshold": {
"description": "Ages below this uses theme.data.durationfresh coloring",
"type": "integer"
},
"preset": {
"$ref": "#/$defs/preset",
"description": "Color theme preset"
},
"theme": {
"$ref": "#/$defs/theme"
}
},
"type": "object"
} | MIT | en |
kubecolor/kubecolor | 044d58032e1fd5099b482b993b6905747f73f7f3 | 2024-04-05T22:21:46 | config-schema.json | 420 | 2024-05-27T08:22:36.347267Z | {
"$defs": {
"color": {
"default": "none",
"description": "A single color style, optionally setting foreground (text) color, background color, and/or modifier such as 'bold'.",
"examples": [
"none",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"black",
"240",
"aaff00",
"#aaff00",
"rgb(192, 255, 238)",
"raw(4;53)",
"gray:italic",
"fg=white:bold:underline",
"fg=yellow:bg=red:bold"
],
"title": "Color",
"type": "string"
},
"colorSlice": {
"description": "Allows multiple separate colors to be applied, separated by slash.",
"examples": [
"red/green/blue",
"bg=red:underline/bg=green:italic/bg=blue:bold"
],
"title": "Multiple colors",
"type": "string"
},
"duration": {
"default": "0",
"description": "A string value representing a time span, formatted as a Go time duration.",
"examples": [
"30s",
"5m",
"10m",
"1h30m",
"5h"
],
"title": "Time duration",
"type": "string"
},
"preset": {
"default": "dark",
"description": "Preset is a set of defaults for the color theme.",
"enum": [
"dark",
"light",
"pre-0.0.21-dark",
"pre-0.0.21-light"
],
"title": "Color theme preset",
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Theme is the root theme config.",
"properties": {
"apply": {
"$ref": "#/$defs/themeApply",
"description": "used in \"kubectl apply\""
},
"base": {
"$ref": "#/$defs/themeBase",
"description": "Base colors must be first so they're applied first"
},
"data": {
"$ref": "#/$defs/themeData",
"description": "colors for representing data"
},
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the command"
},
"describe": {
"$ref": "#/$defs/themeDescribe",
"description": "used in \"kubectl describe\""
},
"explain": {
"$ref": "#/$defs/themeExplain",
"description": "used in \"kubectl explain\""
},
"options": {
"$ref": "#/$defs/themeOptions",
"description": "used in \"kubectl options\""
},
"status": {
"$ref": "#/$defs/themeStatus",
"description": "generic status coloring (e.g \"Ready\", \"Terminating\")"
},
"stderr": {
"$ref": "#/$defs/themeStderr",
"description": "used in kubectl's stderr output"
},
"table": {
"$ref": "#/$defs/themeTable",
"description": "used in table output, e.g \"kubectl get\" and parts of \"kubectl describe\""
},
"version": {
"$ref": "#/$defs/themeVersion",
"description": "used in \"kubectl version\""
}
},
"type": "object"
},
"themeApply": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"configured": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/bar configured\""
},
"created": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/foo created\""
},
"dryRun": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux created (dry-run)\""
},
"fallback": {
"$ref": "#/$defs/color",
"description": "used when \"kubectl apply\" outputs unknown format"
},
"unchanged": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux unchanged\""
}
},
"type": "object"
},
"themeBase": {
"additionalProperties": false,
"description": "ThemeBase contains base colors that other theme fields can default to, just to make overriding themes easier.",
"properties": {
"danger": {
"$ref": "#/$defs/color",
"description": "general color for when things are bad"
},
"info": {
"$ref": "#/$defs/color",
"description": "general color for when things are informational"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "general color for keys"
},
"muted": {
"$ref": "#/$defs/color",
"description": "general color for when things are less relevant"
},
"primary": {
"$ref": "#/$defs/color",
"description": "general color for when things are focus"
},
"secondary": {
"$ref": "#/$defs/color",
"description": "general color for when things are secondary focus"
},
"success": {
"$ref": "#/$defs/color",
"description": "general color for when things are good"
},
"warning": {
"$ref": "#/$defs/color",
"description": "general color for when things are wrong"
}
},
"type": "object"
},
"themeData": {
"additionalProperties": false,
"description": "ThemeData holds colors for when representing parsed data.",
"properties": {
"duration": {
"$ref": "#/$defs/color",
"description": "used when the value is a duration, e.g \"12m\" or \"1d12h\""
},
"durationFresh": {
"$ref": "#/$defs/color",
"description": "color used when the time value is under a certain delay"
},
"false": {
"$ref": "#/$defs/color",
"description": "used when value is false"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used for the key"
},
"null": {
"$ref": "#/$defs/color",
"description": "used when the value is null, nil, or none"
},
"number": {
"$ref": "#/$defs/color",
"description": "used when the value is a number"
},
"quantity": {
"$ref": "#/$defs/color",
"description": "used when the value is a quantity, e.g \"100m\" or \"5Gi\""
},
"ratio": {
"$ref": "#/$defs/themeDataRatio"
},
"string": {
"$ref": "#/$defs/color",
"description": "used when value is a string"
},
"true": {
"$ref": "#/$defs/color",
"description": "used when value is true"
}
},
"type": "object"
},
"themeDataRatio": {
"additionalProperties": false,
"properties": {
"equal": {
"$ref": "#/$defs/color",
"description": "used for \"n/n\", e.g \"1/1\""
},
"unequal": {
"$ref": "#/$defs/color",
"description": "used for \"n/m\", e.g \"0/1\""
},
"zero": {
"$ref": "#/$defs/color",
"description": "used for \"0/0\""
}
},
"type": "object"
},
"themeDescribe": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
}
},
"type": "object"
},
"themeExplain": {
"additionalProperties": false,
"description": "ThemeExplain holds colors for the \"kubectl explain\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
},
"required": {
"$ref": "#/$defs/color",
"description": "used on the trailing \"-required-\" string"
}
},
"type": "object"
},
"themeOptions": {
"additionalProperties": false,
"description": "ThemeOptions holds colors for the \"kubectl options\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
}
},
"type": "object"
},
"themeStatus": {
"additionalProperties": false,
"description": "ThemeStatus holds colors for status texts, used in for example the \"kubectl get\" status column",
"properties": {
"error": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Failed\", \"Unhealthy\""
},
"success": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Running\", \"Ready\""
},
"warning": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Terminating\""
}
},
"type": "object"
},
"themeStderr": {
"additionalProperties": false,
"description": "ThemeStderr holds generic colors for kubectl's stderr output.",
"properties": {
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the output line"
},
"error": {
"$ref": "#/$defs/color",
"description": "e.g when text contains \"error\""
}
},
"type": "object"
},
"themeTable": {
"additionalProperties": false,
"description": "ThemeTable holds colors for table output",
"properties": {
"columns": {
"$ref": "#/$defs/colorSlice",
"description": "used on table columns when no other coloring applies such as status or duration coloring. The multiple colors are cycled based on column ID, from left to right."
},
"header": {
"$ref": "#/$defs/color",
"description": "used on table headers"
}
},
"type": "object"
},
"themeVersion": {
"additionalProperties": false,
"description": "ThemeVersion holds colors for the \"kubectl version\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on the key"
}
},
"type": "object"
}
},
"$id": "https://github.com/kubecolor/kubecolor/raw/main/config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kubectl": {
"default": "kubectl",
"description": "Which kubectl executable to use",
"examples": [
"kubectl1.19",
"oc"
],
"type": "string"
},
"objFreshThreshold": {
"$ref": "#/$defs/duration",
"description": "Ages below this uses theme.data.durationfresh coloring"
},
"preset": {
"$ref": "#/$defs/preset",
"description": "Color theme preset"
},
"theme": {
"$ref": "#/$defs/theme"
}
},
"type": "object"
} | MIT | en |
kubecolor/kubecolor | c46f2225de64ea147e08dc748cd834103f4165fb | 2024-05-27T14:47:50 | config-schema.json | 420 | 2024-05-27T08:22:36.347267Z | {
"$defs": {
"color": {
"default": "none",
"description": "A single color style, optionally setting foreground (text) color, background color, and/or modifier such as 'bold'.",
"examples": [
"none",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"black",
"240",
"aaff00",
"#aaff00",
"rgb(192, 255, 238)",
"raw(4;53)",
"gray:italic",
"fg=white:bold:underline",
"fg=yellow:bg=red:bold"
],
"title": "Color",
"type": "string"
},
"colorSlice": {
"description": "Allows multiple separate colors to be applied, separated by slash.",
"examples": [
"red/green/blue",
"bg=red:underline/bg=green:italic/bg=blue:bold"
],
"title": "Multiple colors",
"type": "string"
},
"duration": {
"default": "0",
"description": "A string value representing a time span, formatted as a Go time duration.",
"examples": [
"30s",
"5m",
"10m",
"1h30m",
"5h"
],
"title": "Time duration",
"type": "string"
},
"paging": {
"default": "never",
"description": "Whether to pipe supported subcommands to a pager (\"auto\" or \"never\")",
"enum": [
"auto",
"never"
],
"title": "Paging mode preference",
"type": "string"
},
"preset": {
"default": "dark",
"description": "Preset is a set of defaults for the color theme.",
"enum": [
"none",
"dark",
"light",
"protanopia-dark",
"protanopia-light",
"deuteranopia-dark",
"deuteranopia-light",
"tritanopia-dark",
"tritanopia-light",
"pre-0.3.0-dark",
"pre-0.3.0-light",
"pre-0.0.21-dark",
"pre-0.0.21-light"
],
"title": "Color theme preset",
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Theme is the root theme config.",
"properties": {
"apply": {
"$ref": "#/$defs/themeApply",
"description": "used in \"kubectl apply\""
},
"base": {
"$ref": "#/$defs/themeBase",
"description": "Base colors must be first so they're applied first"
},
"data": {
"$ref": "#/$defs/themeData",
"description": "colors for representing data"
},
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the command"
},
"describe": {
"$ref": "#/$defs/themeDescribe",
"description": "used in \"kubectl describe\""
},
"explain": {
"$ref": "#/$defs/themeExplain",
"description": "used in \"kubectl explain\""
},
"help": {
"$ref": "#/$defs/themeHelp",
"description": "used in \"kubectl --help\""
},
"options": {
"$ref": "#/$defs/themeOptions",
"description": "used in \"kubectl options\""
},
"shell": {
"$ref": "#/$defs/themeShell",
"description": "colors for representing shells (e.g bash, zsh, etc)"
},
"status": {
"$ref": "#/$defs/themeStatus",
"description": "generic status coloring (e.g \"Ready\", \"Terminating\")"
},
"stderr": {
"$ref": "#/$defs/themeStderr",
"description": "used in kubectl's stderr output"
},
"table": {
"$ref": "#/$defs/themeTable",
"description": "used in table output, e.g \"kubectl get\" and parts of \"kubectl describe\""
},
"version": {
"$ref": "#/$defs/themeVersion",
"description": "used in \"kubectl version\""
}
},
"type": "object"
},
"themeApply": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"configured": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/bar configured\""
},
"created": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/foo created\""
},
"dryRun": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux created (dry-run)\""
},
"fallback": {
"$ref": "#/$defs/color",
"description": "used when \"kubectl apply\" outputs unknown format"
},
"unchanged": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux unchanged\""
}
},
"type": "object"
},
"themeBase": {
"additionalProperties": false,
"description": "ThemeBase contains base colors that other theme fields can default to, just to make overriding themes easier.",
"properties": {
"danger": {
"$ref": "#/$defs/color",
"description": "general color for when things are bad"
},
"info": {
"$ref": "#/$defs/color",
"description": "general color for when things are informational"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "general color for keys"
},
"muted": {
"$ref": "#/$defs/color",
"description": "general color for when things are less relevant"
},
"primary": {
"$ref": "#/$defs/color",
"description": "general color for when things are focus"
},
"secondary": {
"$ref": "#/$defs/color",
"description": "general color for when things are secondary focus"
},
"success": {
"$ref": "#/$defs/color",
"description": "general color for when things are good"
},
"warning": {
"$ref": "#/$defs/color",
"description": "general color for when things are wrong"
}
},
"type": "object"
},
"themeData": {
"additionalProperties": false,
"description": "ThemeData holds colors for when representing parsed data.",
"properties": {
"duration": {
"$ref": "#/$defs/color",
"description": "used when the value is a duration, e.g \"12m\" or \"1d12h\""
},
"durationFresh": {
"$ref": "#/$defs/color",
"description": "color used when the time value is under a certain delay"
},
"false": {
"$ref": "#/$defs/color",
"description": "used when value is false"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used for the key"
},
"null": {
"$ref": "#/$defs/color",
"description": "used when the value is null, nil, or none"
},
"number": {
"$ref": "#/$defs/color",
"description": "used when the value is a number"
},
"quantity": {
"$ref": "#/$defs/color",
"description": "used when the value is a quantity, e.g \"100m\" or \"5Gi\""
},
"ratio": {
"$ref": "#/$defs/themeDataRatio"
},
"string": {
"$ref": "#/$defs/color",
"description": "used when value is a string"
},
"true": {
"$ref": "#/$defs/color",
"description": "used when value is true"
}
},
"type": "object"
},
"themeDataRatio": {
"additionalProperties": false,
"properties": {
"equal": {
"$ref": "#/$defs/color",
"description": "used for \"n/n\", e.g \"1/1\""
},
"unequal": {
"$ref": "#/$defs/color",
"description": "used for \"n/m\", e.g \"0/1\""
},
"zero": {
"$ref": "#/$defs/color",
"description": "used for \"0/0\""
}
},
"type": "object"
},
"themeDescribe": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
}
},
"type": "object"
},
"themeExplain": {
"additionalProperties": false,
"description": "ThemeExplain holds colors for the \"kubectl explain\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
},
"required": {
"$ref": "#/$defs/color",
"description": "used on the trailing \"-required-\" string"
}
},
"type": "object"
},
"themeHelp": {
"additionalProperties": false,
"description": "ThemeHelp holds colors for the \"kubectl --help\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
},
"flagDesc": {
"$ref": "#/$defs/color",
"description": "Flag descripion under \"Options:\" heading"
},
"header": {
"$ref": "#/$defs/color",
"description": "e.g \"Examples:\" or \"Options:\""
},
"text": {
"$ref": "#/$defs/color",
"description": "Fallback text color"
},
"url": {
"$ref": "#/$defs/color",
"description": "e.g `[https://example.com]`"
}
},
"type": "object"
},
"themeOptions": {
"additionalProperties": false,
"description": "ThemeOptions holds colors for the \"kubectl options\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
}
},
"type": "object"
},
"themeShell": {
"additionalProperties": false,
"description": "ThemeShell holds colors for when representing shell commands (bash, zsh, etc)",
"properties": {
"arg": {
"$ref": "#/$defs/color",
"description": "used on arguments, e.g `get pods` in `kubectl get pods`"
},
"command": {
"$ref": "#/$defs/color",
"description": "used on commands, e.g `kubectl` or `echo`"
},
"comment": {
"$ref": "#/$defs/color",
"description": "used on comments, e.g `# this is a comment`"
},
"flag": {
"$ref": "#/$defs/color",
"description": "used on flags, e.g `--watch` in `kubectl get pods --watch`"
}
},
"type": "object"
},
"themeStatus": {
"additionalProperties": false,
"description": "ThemeStatus holds colors for status texts, used in for example the \"kubectl get\" status column",
"properties": {
"error": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Failed\", \"Unhealthy\""
},
"success": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Running\", \"Ready\""
},
"warning": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Terminating\""
}
},
"type": "object"
},
"themeStderr": {
"additionalProperties": false,
"description": "ThemeStderr holds generic colors for kubectl's stderr output.",
"properties": {
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the output line"
},
"error": {
"$ref": "#/$defs/color",
"description": "e.g when text contains \"error\""
}
},
"type": "object"
},
"themeTable": {
"additionalProperties": false,
"description": "ThemeTable holds colors for table output",
"properties": {
"columns": {
"$ref": "#/$defs/colorSlice",
"description": "used on table columns when no other coloring applies such as status or duration coloring. The multiple colors are cycled based on column ID, from left to right."
},
"header": {
"$ref": "#/$defs/color",
"description": "used on table headers"
}
},
"type": "object"
},
"themeVersion": {
"additionalProperties": false,
"description": "ThemeVersion holds colors for the \"kubectl version\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on the key"
}
},
"type": "object"
}
},
"$id": "https://github.com/kubecolor/kubecolor/raw/main/config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kubectl": {
"default": "kubectl",
"description": "Which kubectl executable to use",
"examples": [
"kubectl1.19",
"oc"
],
"type": "string"
},
"objFreshThreshold": {
"$ref": "#/$defs/duration",
"description": "Ages below this uses theme.data.durationfresh coloring"
},
"pager": {
"description": "Command to use as pager",
"examples": [
"less -RF",
"more"
],
"type": "string"
},
"paging": {
"$ref": "#/$defs/paging",
"description": "Whether to enable paging: \"auto\" or \"never\""
},
"preset": {
"$ref": "#/$defs/preset",
"description": "Color theme preset"
},
"theme": {
"$ref": "#/$defs/theme"
}
},
"type": "object"
} | MIT | en |
kubecolor/kubecolor | 6f8effff569f68deee932853c78ddf2dae7cfc26 | 2024-05-26T16:04:58 | config-schema.json | 420 | 2024-05-27T08:22:36.347267Z | {
"$defs": {
"color": {
"default": "none",
"description": "A single color style, optionally setting foreground (text) color, background color, and/or modifier such as 'bold'.",
"examples": [
"none",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"black",
"240",
"aaff00",
"#aaff00",
"rgb(192, 255, 238)",
"raw(4;53)",
"gray:italic",
"fg=white:bold:underline",
"fg=yellow:bg=red:bold"
],
"title": "Color",
"type": "string"
},
"colorSlice": {
"description": "Allows multiple separate colors to be applied, separated by slash.",
"examples": [
"red/green/blue",
"bg=red:underline/bg=green:italic/bg=blue:bold"
],
"title": "Multiple colors",
"type": "string"
},
"duration": {
"default": "0",
"description": "A string value representing a time span, formatted as a Go time duration.",
"examples": [
"30s",
"5m",
"10m",
"1h30m",
"5h"
],
"title": "Time duration",
"type": "string"
},
"paging": {
"default": "auto",
"description": "Whether to pipe supported subcommands to a pager (\"auto\" or \"never\")",
"enum": [
"auto",
"never"
],
"title": "Paging mode preference",
"type": "string"
},
"preset": {
"default": "dark",
"description": "Preset is a set of defaults for the color theme.",
"enum": [
"none",
"dark",
"light",
"protanopia-dark",
"protanopia-light",
"deuteranopia-dark",
"deuteranopia-light",
"tritanopia-dark",
"tritanopia-light",
"pre-0.3.0-dark",
"pre-0.3.0-light",
"pre-0.0.21-dark",
"pre-0.0.21-light"
],
"title": "Color theme preset",
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Theme is the root theme config.",
"properties": {
"apply": {
"$ref": "#/$defs/themeApply",
"description": "used in \"kubectl apply\""
},
"base": {
"$ref": "#/$defs/themeBase",
"description": "Base colors must be first so they're applied first"
},
"data": {
"$ref": "#/$defs/themeData",
"description": "colors for representing data"
},
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the command"
},
"describe": {
"$ref": "#/$defs/themeDescribe",
"description": "used in \"kubectl describe\""
},
"explain": {
"$ref": "#/$defs/themeExplain",
"description": "used in \"kubectl explain\""
},
"options": {
"$ref": "#/$defs/themeOptions",
"description": "used in \"kubectl options\""
},
"status": {
"$ref": "#/$defs/themeStatus",
"description": "generic status coloring (e.g \"Ready\", \"Terminating\")"
},
"stderr": {
"$ref": "#/$defs/themeStderr",
"description": "used in kubectl's stderr output"
},
"table": {
"$ref": "#/$defs/themeTable",
"description": "used in table output, e.g \"kubectl get\" and parts of \"kubectl describe\""
},
"version": {
"$ref": "#/$defs/themeVersion",
"description": "used in \"kubectl version\""
}
},
"type": "object"
},
"themeApply": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"configured": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/bar configured\""
},
"created": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/foo created\""
},
"dryRun": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux created (dry-run)\""
},
"fallback": {
"$ref": "#/$defs/color",
"description": "used when \"kubectl apply\" outputs unknown format"
},
"unchanged": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux unchanged\""
}
},
"type": "object"
},
"themeBase": {
"additionalProperties": false,
"description": "ThemeBase contains base colors that other theme fields can default to, just to make overriding themes easier.",
"properties": {
"danger": {
"$ref": "#/$defs/color",
"description": "general color for when things are bad"
},
"info": {
"$ref": "#/$defs/color",
"description": "general color for when things are informational"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "general color for keys"
},
"muted": {
"$ref": "#/$defs/color",
"description": "general color for when things are less relevant"
},
"primary": {
"$ref": "#/$defs/color",
"description": "general color for when things are focus"
},
"secondary": {
"$ref": "#/$defs/color",
"description": "general color for when things are secondary focus"
},
"success": {
"$ref": "#/$defs/color",
"description": "general color for when things are good"
},
"warning": {
"$ref": "#/$defs/color",
"description": "general color for when things are wrong"
}
},
"type": "object"
},
"themeData": {
"additionalProperties": false,
"description": "ThemeData holds colors for when representing parsed data.",
"properties": {
"duration": {
"$ref": "#/$defs/color",
"description": "used when the value is a duration, e.g \"12m\" or \"1d12h\""
},
"durationFresh": {
"$ref": "#/$defs/color",
"description": "color used when the time value is under a certain delay"
},
"false": {
"$ref": "#/$defs/color",
"description": "used when value is false"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used for the key"
},
"null": {
"$ref": "#/$defs/color",
"description": "used when the value is null, nil, or none"
},
"number": {
"$ref": "#/$defs/color",
"description": "used when the value is a number"
},
"quantity": {
"$ref": "#/$defs/color",
"description": "used when the value is a quantity, e.g \"100m\" or \"5Gi\""
},
"ratio": {
"$ref": "#/$defs/themeDataRatio"
},
"string": {
"$ref": "#/$defs/color",
"description": "used when value is a string"
},
"true": {
"$ref": "#/$defs/color",
"description": "used when value is true"
}
},
"type": "object"
},
"themeDataRatio": {
"additionalProperties": false,
"properties": {
"equal": {
"$ref": "#/$defs/color",
"description": "used for \"n/n\", e.g \"1/1\""
},
"unequal": {
"$ref": "#/$defs/color",
"description": "used for \"n/m\", e.g \"0/1\""
},
"zero": {
"$ref": "#/$defs/color",
"description": "used for \"0/0\""
}
},
"type": "object"
},
"themeDescribe": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
}
},
"type": "object"
},
"themeExplain": {
"additionalProperties": false,
"description": "ThemeExplain holds colors for the \"kubectl explain\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
},
"required": {
"$ref": "#/$defs/color",
"description": "used on the trailing \"-required-\" string"
}
},
"type": "object"
},
"themeOptions": {
"additionalProperties": false,
"description": "ThemeOptions holds colors for the \"kubectl options\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
}
},
"type": "object"
},
"themeStatus": {
"additionalProperties": false,
"description": "ThemeStatus holds colors for status texts, used in for example the \"kubectl get\" status column",
"properties": {
"error": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Failed\", \"Unhealthy\""
},
"success": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Running\", \"Ready\""
},
"warning": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Terminating\""
}
},
"type": "object"
},
"themeStderr": {
"additionalProperties": false,
"description": "ThemeStderr holds generic colors for kubectl's stderr output.",
"properties": {
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the output line"
},
"error": {
"$ref": "#/$defs/color",
"description": "e.g when text contains \"error\""
}
},
"type": "object"
},
"themeTable": {
"additionalProperties": false,
"description": "ThemeTable holds colors for table output",
"properties": {
"columns": {
"$ref": "#/$defs/colorSlice",
"description": "used on table columns when no other coloring applies such as status or duration coloring. The multiple colors are cycled based on column ID, from left to right."
},
"header": {
"$ref": "#/$defs/color",
"description": "used on table headers"
}
},
"type": "object"
},
"themeVersion": {
"additionalProperties": false,
"description": "ThemeVersion holds colors for the \"kubectl version\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on the key"
}
},
"type": "object"
}
},
"$id": "https://github.com/kubecolor/kubecolor/raw/main/config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kubectl": {
"default": "kubectl",
"description": "Which kubectl executable to use",
"examples": [
"kubectl1.19",
"oc"
],
"type": "string"
},
"objFreshThreshold": {
"$ref": "#/$defs/duration",
"description": "Ages below this uses theme.data.durationfresh coloring"
},
"pager": {
"description": "Command to use as pager",
"examples": [
"less -RF",
"more"
],
"type": "string"
},
"paging": {
"$ref": "#/$defs/paging",
"description": "Whether to enable paging: \"auto\" or \"never\""
},
"preset": {
"$ref": "#/$defs/preset",
"description": "Color theme preset"
},
"theme": {
"$ref": "#/$defs/theme"
}
},
"type": "object"
} | MIT | en |
kubecolor/kubecolor | 2a391262edbd3cd2c87666a8e215a4d4fc316ef4 | 2024-03-27T19:12:38 | config-schema.json | 420 | 2024-05-27T08:22:36.347267Z | {
"$defs": {
"color": {
"default": "none",
"description": "A single color style, optionally setting foreground (text) color, background color, and/or modifier such as 'bold'.",
"examples": [
"none",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"black",
"240",
"aaff00",
"#aaff00",
"rgb(192, 255, 238)",
"raw(4;53)",
"gray:italic",
"fg=white:bold:underline",
"fg=yellow:bg=red:bold"
],
"title": "Color",
"type": "string"
},
"colorSlice": {
"description": "Allows multiple separate colors to be applied, separated by slash.",
"examples": [
"red/green/blue",
"bg=red:underline/bg=green:italic/bg=blue:bold"
],
"title": "Multiple colors",
"type": "string"
},
"preset": {
"default": "dark",
"description": "Preset is a set of defaults for the color theme.",
"enum": [
"dark",
"light",
"pre-0.0.21-dark",
"pre-0.0.21-light"
],
"title": "Color theme preset",
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Theme is the root theme config.",
"properties": {
"apply": {
"$ref": "#/$defs/themeApply",
"description": "used in \"kubectl apply\""
},
"base": {
"$ref": "#/$defs/themeBase",
"description": "Base colors must be first so they're applied first"
},
"data": {
"$ref": "#/$defs/themeData",
"description": "colors for representing data"
},
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the command"
},
"describe": {
"$ref": "#/$defs/themeDescribe",
"description": "used in \"kubectl describe\""
},
"explain": {
"$ref": "#/$defs/themeExplain",
"description": "used in \"kubectl explain\""
},
"options": {
"$ref": "#/$defs/themeOptions",
"description": "used in \"kubectl options\""
},
"status": {
"$ref": "#/$defs/themeStatus",
"description": "generic status coloring (e.g \"Ready\", \"Terminating\")"
},
"stderr": {
"$ref": "#/$defs/themeStderr",
"description": "used in kubectl's stderr output"
},
"table": {
"$ref": "#/$defs/themeTable",
"description": "used in table output, e.g \"kubectl get\" and parts of \"kubectl describe\""
},
"version": {
"$ref": "#/$defs/themeVersion",
"description": "used in \"kubectl version\""
}
},
"type": "object"
},
"themeApply": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"configured": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/bar configured\""
},
"created": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/foo created\""
},
"dryRun": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux created (dry-run)\""
},
"fallback": {
"$ref": "#/$defs/color",
"description": "used when \"kubectl apply\" outputs unknown format"
},
"unchanged": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux unchanged\""
}
},
"type": "object"
},
"themeBase": {
"additionalProperties": false,
"description": "ThemeBase contains base colors that other theme fields can default to, just to make overriding themes easier.",
"properties": {
"danger": {
"$ref": "#/$defs/color",
"description": "general color for when things are bad"
},
"info": {
"$ref": "#/$defs/color",
"description": "general color for when things are informational"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "general color for keys"
},
"muted": {
"$ref": "#/$defs/color",
"description": "general color for when things are less relevant"
},
"primary": {
"$ref": "#/$defs/color",
"description": "general color for when things are focus"
},
"secondary": {
"$ref": "#/$defs/color",
"description": "general color for when things are secondary focus"
},
"success": {
"$ref": "#/$defs/color",
"description": "general color for when things are good"
},
"warning": {
"$ref": "#/$defs/color",
"description": "general color for when things are wrong"
}
},
"type": "object"
},
"themeData": {
"additionalProperties": false,
"description": "ThemeData holds colors for when representing parsed data.",
"properties": {
"duration": {
"$ref": "#/$defs/color",
"description": "used when the value is a duration, e.g \"12m\" or \"1d12h\""
},
"durationFresh": {
"$ref": "#/$defs/color",
"description": "color used when the time value is under a certain delay"
},
"false": {
"$ref": "#/$defs/color",
"description": "used when value is false"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used for the key"
},
"null": {
"$ref": "#/$defs/color",
"description": "used when the value is null, nil, or none"
},
"number": {
"$ref": "#/$defs/color",
"description": "used when the value is a number"
},
"quantity": {
"$ref": "#/$defs/color",
"description": "used when the value is a quantity, e.g \"100m\" or \"5Gi\""
},
"ratio": {
"$ref": "#/$defs/themeDataRatio"
},
"string": {
"$ref": "#/$defs/color",
"description": "used when value is a string"
},
"true": {
"$ref": "#/$defs/color",
"description": "used when value is true"
}
},
"type": "object"
},
"themeDataRatio": {
"additionalProperties": false,
"properties": {
"equal": {
"$ref": "#/$defs/color",
"description": "used for \"n/n\", e.g \"1/1\""
},
"unequal": {
"$ref": "#/$defs/color",
"description": "used for \"n/m\", e.g \"0/1\""
},
"zero": {
"$ref": "#/$defs/color",
"description": "used for \"0/0\""
}
},
"type": "object"
},
"themeDescribe": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
}
},
"type": "object"
},
"themeExplain": {
"additionalProperties": false,
"description": "ThemeExplain holds colors for the \"kubectl explain\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
},
"required": {
"$ref": "#/$defs/color",
"description": "used on the trailing \"-required-\" string"
}
},
"type": "object"
},
"themeOptions": {
"additionalProperties": false,
"description": "ThemeOptions holds colors for the \"kubectl options\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
}
},
"type": "object"
},
"themeStatus": {
"additionalProperties": false,
"description": "ThemeStatus holds colors for status texts, used in for example the \"kubectl get\" status column",
"properties": {
"error": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Failed\", \"Unhealthy\""
},
"success": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Running\", \"Ready\""
},
"warning": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Terminating\""
}
},
"type": "object"
},
"themeStderr": {
"additionalProperties": false,
"description": "ThemeStderr holds generic colors for kubectl's stderr output.",
"properties": {
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the output line"
},
"error": {
"$ref": "#/$defs/color",
"description": "e.g when text contains \"error\""
}
},
"type": "object"
},
"themeTable": {
"additionalProperties": false,
"description": "ThemeTable holds colors for table output",
"properties": {
"columns": {
"$ref": "#/$defs/colorSlice",
"description": "used on table columns when no other coloring applies such as status or duration coloring. The multiple colors are cycled based on column ID, from left to right."
},
"header": {
"$ref": "#/$defs/color",
"description": "used on table headers"
}
},
"type": "object"
},
"themeVersion": {
"additionalProperties": false,
"description": "ThemeVersion holds colors for the \"kubectl version\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on the key"
}
},
"type": "object"
}
},
"$id": "https://github.com/kubecolor/kubecolor/raw/main/config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kubectl": {
"default": "kubectl",
"description": "Which kubectl executable to use",
"examples": [
"kubectl1.19",
"oc"
],
"type": "string"
},
"objFreshThreshold": {
"description": "Ages below this uses theme.data.durationfresh coloring",
"type": "integer"
},
"preset": {
"$ref": "#/$defs/preset",
"description": "Color theme preset"
},
"theme": {
"$ref": "#/$defs/theme"
}
},
"type": "object"
} | MIT | en |
kubecolor/kubecolor | bc07e7b1a9629a7b144641e207859cf8afeebf04 | 2024-04-05T23:55:39 | config-schema.json | 420 | 2024-05-27T08:22:36.347267Z | {
"$defs": {
"color": {
"default": "none",
"description": "A single color style, optionally setting foreground (text) color, background color, and/or modifier such as 'bold'.",
"examples": [
"none",
"red",
"green",
"yellow",
"blue",
"magenta",
"cyan",
"white",
"black",
"240",
"aaff00",
"#aaff00",
"rgb(192, 255, 238)",
"raw(4;53)",
"gray:italic",
"fg=white:bold:underline",
"fg=yellow:bg=red:bold"
],
"title": "Color",
"type": "string"
},
"colorSlice": {
"description": "Allows multiple separate colors to be applied, separated by slash.",
"examples": [
"red/green/blue",
"bg=red:underline/bg=green:italic/bg=blue:bold"
],
"title": "Multiple colors",
"type": "string"
},
"duration": {
"default": "0",
"description": "A string value representing a time span, formatted as a Go time duration.",
"examples": [
"30s",
"5m",
"10m",
"1h30m",
"5h"
],
"title": "Time duration",
"type": "string"
},
"preset": {
"default": "dark",
"description": "Preset is a set of defaults for the color theme.",
"enum": [
"none",
"dark",
"light",
"protanopia-dark",
"protanopia-light",
"deuteranopia-dark",
"deuteranopia-light",
"tritanopia-dark",
"tritanopia-light",
"pre-0.3.0-dark",
"pre-0.3.0-light",
"pre-0.0.21-dark",
"pre-0.0.21-light"
],
"title": "Color theme preset",
"type": "string"
},
"theme": {
"additionalProperties": false,
"description": "Theme is the root theme config.",
"properties": {
"apply": {
"$ref": "#/$defs/themeApply",
"description": "used in \"kubectl apply\""
},
"base": {
"$ref": "#/$defs/themeBase",
"description": "Base colors must be first so they're applied first"
},
"data": {
"$ref": "#/$defs/themeData",
"description": "colors for representing data"
},
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the command"
},
"describe": {
"$ref": "#/$defs/themeDescribe",
"description": "used in \"kubectl describe\""
},
"explain": {
"$ref": "#/$defs/themeExplain",
"description": "used in \"kubectl explain\""
},
"options": {
"$ref": "#/$defs/themeOptions",
"description": "used in \"kubectl options\""
},
"status": {
"$ref": "#/$defs/themeStatus",
"description": "generic status coloring (e.g \"Ready\", \"Terminating\")"
},
"stderr": {
"$ref": "#/$defs/themeStderr",
"description": "used in kubectl's stderr output"
},
"table": {
"$ref": "#/$defs/themeTable",
"description": "used in table output, e.g \"kubectl get\" and parts of \"kubectl describe\""
},
"version": {
"$ref": "#/$defs/themeVersion",
"description": "used in \"kubectl version\""
}
},
"type": "object"
},
"themeApply": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"configured": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/bar configured\""
},
"created": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/foo created\""
},
"dryRun": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux created (dry-run)\""
},
"fallback": {
"$ref": "#/$defs/color",
"description": "used when \"kubectl apply\" outputs unknown format"
},
"unchanged": {
"$ref": "#/$defs/color",
"description": "used on \"deployment.apps/quux unchanged\""
}
},
"type": "object"
},
"themeBase": {
"additionalProperties": false,
"description": "ThemeBase contains base colors that other theme fields can default to, just to make overriding themes easier.",
"properties": {
"danger": {
"$ref": "#/$defs/color",
"description": "general color for when things are bad"
},
"info": {
"$ref": "#/$defs/color",
"description": "general color for when things are informational"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "general color for keys"
},
"muted": {
"$ref": "#/$defs/color",
"description": "general color for when things are less relevant"
},
"primary": {
"$ref": "#/$defs/color",
"description": "general color for when things are focus"
},
"secondary": {
"$ref": "#/$defs/color",
"description": "general color for when things are secondary focus"
},
"success": {
"$ref": "#/$defs/color",
"description": "general color for when things are good"
},
"warning": {
"$ref": "#/$defs/color",
"description": "general color for when things are wrong"
}
},
"type": "object"
},
"themeData": {
"additionalProperties": false,
"description": "ThemeData holds colors for when representing parsed data.",
"properties": {
"duration": {
"$ref": "#/$defs/color",
"description": "used when the value is a duration, e.g \"12m\" or \"1d12h\""
},
"durationFresh": {
"$ref": "#/$defs/color",
"description": "color used when the time value is under a certain delay"
},
"false": {
"$ref": "#/$defs/color",
"description": "used when value is false"
},
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used for the key"
},
"null": {
"$ref": "#/$defs/color",
"description": "used when the value is null, nil, or none"
},
"number": {
"$ref": "#/$defs/color",
"description": "used when the value is a number"
},
"quantity": {
"$ref": "#/$defs/color",
"description": "used when the value is a quantity, e.g \"100m\" or \"5Gi\""
},
"ratio": {
"$ref": "#/$defs/themeDataRatio"
},
"string": {
"$ref": "#/$defs/color",
"description": "used when value is a string"
},
"true": {
"$ref": "#/$defs/color",
"description": "used when value is true"
}
},
"type": "object"
},
"themeDataRatio": {
"additionalProperties": false,
"properties": {
"equal": {
"$ref": "#/$defs/color",
"description": "used for \"n/n\", e.g \"1/1\""
},
"unequal": {
"$ref": "#/$defs/color",
"description": "used for \"n/m\", e.g \"0/1\""
},
"zero": {
"$ref": "#/$defs/color",
"description": "used for \"0/0\""
}
},
"type": "object"
},
"themeDescribe": {
"additionalProperties": false,
"description": "ThemeApply holds colors for the \"kubectl apply\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
}
},
"type": "object"
},
"themeExplain": {
"additionalProperties": false,
"description": "ThemeExplain holds colors for the \"kubectl explain\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on keys. The multiple colors are cycled based on indentation."
},
"required": {
"$ref": "#/$defs/color",
"description": "used on the trailing \"-required-\" string"
}
},
"type": "object"
},
"themeOptions": {
"additionalProperties": false,
"description": "ThemeOptions holds colors for the \"kubectl options\" output.",
"properties": {
"flag": {
"$ref": "#/$defs/color",
"description": "e.g \"--kubeconfig\""
}
},
"type": "object"
},
"themeStatus": {
"additionalProperties": false,
"description": "ThemeStatus holds colors for status texts, used in for example the \"kubectl get\" status column",
"properties": {
"error": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Failed\", \"Unhealthy\""
},
"success": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Running\", \"Ready\""
},
"warning": {
"$ref": "#/$defs/color",
"description": "used in status keywords, e.g \"Terminating\""
}
},
"type": "object"
},
"themeStderr": {
"additionalProperties": false,
"description": "ThemeStderr holds generic colors for kubectl's stderr output.",
"properties": {
"default": {
"$ref": "#/$defs/color",
"description": "default when no specific mapping is found for the output line"
},
"error": {
"$ref": "#/$defs/color",
"description": "e.g when text contains \"error\""
}
},
"type": "object"
},
"themeTable": {
"additionalProperties": false,
"description": "ThemeTable holds colors for table output",
"properties": {
"columns": {
"$ref": "#/$defs/colorSlice",
"description": "used on table columns when no other coloring applies such as status or duration coloring. The multiple colors are cycled based on column ID, from left to right."
},
"header": {
"$ref": "#/$defs/color",
"description": "used on table headers"
}
},
"type": "object"
},
"themeVersion": {
"additionalProperties": false,
"description": "ThemeVersion holds colors for the \"kubectl version\" output.",
"properties": {
"key": {
"$ref": "#/$defs/colorSlice",
"description": "used on the key"
}
},
"type": "object"
}
},
"$id": "https://github.com/kubecolor/kubecolor/raw/main/config-schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"kubectl": {
"default": "kubectl",
"description": "Which kubectl executable to use",
"examples": [
"kubectl1.19",
"oc"
],
"type": "string"
},
"objFreshThreshold": {
"$ref": "#/$defs/duration",
"description": "Ages below this uses theme.data.durationfresh coloring"
},
"preset": {
"$ref": "#/$defs/preset",
"description": "Color theme preset"
},
"theme": {
"$ref": "#/$defs/theme"
}
},
"type": "object"
} | MIT | en |
prebid/prebid-server-java | 8d598e0f1280c5ddac7e793bee8f222903ae460b | 2019-02-22T14:23:20 | src/main/resources/static/bidder-params/eplanning.json | 57 | 2024-05-27T06:04:13.032841Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A schema which validates params accepted by the EPlanning adapter",
"properties": {
"adunit_code": {
"description": "Adunit Code.",
"type": [
"string"
]
},
"ci": {
"description": "Client ID to use.",
"type": [
"string"
]
}
},
"required": [
"ci"
],
"title": "EPlanning Adapter Params",
"type": "object"
} | Apache-2.0 | en |
prebid/prebid-server-java | b781e717eb7fff46f61fe674ffc3e7d205d1ad14 | 2020-02-05T11:16:02 | src/main/resources/static/bidder-params/eplanning.json | 57 | 2024-05-27T06:04:13.032841Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"description": "A schema which validates params accepted by the EPlanning adapter",
"properties": {
"adunit_code": {
"description": "Adunit Code.",
"type": [
"string"
]
},
"ci": {
"description": "Client ID to use.",
"type": [
"string"
]
}
},
"required": [
"ci"
],
"title": "EPlanning Adapter Params",
"type": "object"
} | Apache-2.0 | en |
defenseunicorns/zarf | f59b154ec905155b2ae537c2b417370f9a655160 | 2023-08-29T00:13:45 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 355235c572506d30e97833d46e3eeb5d8ade5a69 | 2023-07-27T21:01:57 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | d2abf4e9a640dddf517659239a34fae64223f98c | 2024-04-25T16:58:42 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$defs": {
"BigBang": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"Constant": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"InteractiveVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Shell": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"Variable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"differentialPackageVersion": {
"description": "Version of a previously built package used as the basis for creating this differential package",
"type": "string"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"additionalProperties": {
"type": "string"
},
"description": "Any registry domains that were overridden on package create when pulling images",
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"variables": {
"description": "[alpha] List of variables to set in the Helm chart",
"items": {
"$ref": "#/$defs/ZarfChartVariable"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfChartVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"description": "A brief description of what the variable controls",
"type": "string"
},
"name": {
"description": "The name of the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"path": {
"description": "The path within the Helm chart values where this variable applies",
"type": "string"
}
},
"required": [
"name",
"description",
"path"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"actions": {
"$ref": "#/$defs/ZarfComponentActions",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/$defs/ZarfChart"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/$defs/ZarfDataInjection"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/$defs/ZarfComponentExtensions",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/$defs/ZarfFile"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/$defs/ZarfComponentImport",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/$defs/ZarfManifest"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/$defs/ZarfComponentOnlyTarget",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/$defs/DeprecatedZarfComponentScripts",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/$defs/Variable"
},
"type": "array"
},
"shell": {
"$ref": "#/$defs/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/$defs/ZarfComponentActionWait",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/$defs/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array"
},
"defaults": {
"$ref": "#/$defs/ZarfComponentActionDefaults",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/$defs/ZarfComponentActionWaitCluster",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/$defs/ZarfComponentActionWaitNetwork",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"onCreate": {
"$ref": "#/$defs/ZarfComponentActionSet",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/$defs/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/$defs/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bigbang": {
"$ref": "#/$defs/BigBang",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"examples": [
"k3s",
"eks"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/$defs/ZarfComponentOnlyCluster",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/$defs/ZarfContainerTarget",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
},
"$id": "https://github.com/defenseunicorns/zarf/src/types/zarf-package",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"build": {
"$ref": "#/$defs/ZarfBuildData",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/$defs/ZarfComponent"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/$defs/Constant"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ZarfMetadata",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/$defs/InteractiveVariable"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
} | Apache-2.0 | en |
defenseunicorns/zarf | 68238ab55823ca9eab2c3f66ac707e05ecd9e430 | 2023-11-29T21:49:16 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | adee149734f992cf0e923de3872333b4d1dbf215 | 2023-05-19T17:21:28 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "List of package authors (including contact info)",
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 899bf8f98a2521f69f77c3ad3f7af67036eaf0ce | 2023-09-26T21:55:43 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 1ec88490121cf8ec1ae0ce402691fc3c8f663681 | 2024-03-13T16:02:54 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"differentialPackageVersion": {
"description": "Version of a previously built package used as the basis for creating this differential package",
"type": "string"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 08660001ec836d5d3a644919764c8ac8ec387b98 | 2024-01-10T21:44:41 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | d0bcc20440145285d5a52da8a47d522a1ec7f5b7 | 2024-03-15T18:18:21 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"Shell": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"differentialPackageVersion": {
"description": "Version of a previously built package used as the basis for creating this differential package",
"type": "string"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/Shell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | e255baae814e57a094c0af03fd632c9c7cdc9a1c | 2023-11-01T05:51:55 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 4d06e16ef266ec0c248587f4edeb33029d1ff984 | 2023-08-27T03:58:54 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 587c695e6234fa0350dedb1317e1ccaf4081492a | 2023-11-29T20:14:21 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 7216446b7ad60f6b31e1e15dabaf5b63ebe27e99 | 2023-09-16T20:49:21 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 575cdefcf85dbe06fe837c0aa1316bf104cbfdd9 | 2023-08-15T19:35:20 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | ff70c6a617cb162038b3cb3e42fe7b29d690657b | 2023-11-01T04:36:55 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | d4a750e2a0894839916465c19c1d017c99bd0b7e | 2024-04-09T14:25:35 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"Shell": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"differentialPackageVersion": {
"description": "Version of a previously built package used as the basis for creating this differential package",
"type": "string"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"variables": {
"description": "[alpha] List of variables to set in the Helm chart",
"items": {
"$ref": "#/definitions/ZarfChartVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfChartVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"description": "A brief description of what the variable controls",
"type": "string"
},
"name": {
"description": "The name of the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"path": {
"description": "The path within the Helm chart values where this variable applies",
"type": "string"
}
},
"required": [
"name",
"description",
"path"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/Shell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 66b600686d4b09e6962dddb0fd0dfdbee05ea32e | 2023-12-06T20:03:55 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 32d13a58bc3dbccd91eec3bd22ff198d474bb9e0 | 2023-06-22T23:06:37 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 73e998a5d62d96f7bc25fd9926d26a4cbfb41bcf | 2023-05-19T20:14:40 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "List of package authors (including contact info)",
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 26a76698459f57783a31c1acb365ca6f3a4705b7 | 2023-12-18T22:34:04 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 91d2186cd4a8aad1ec0aea59527158750f0177c1 | 2023-07-19T21:19:03 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 677a95b74315541bc48a9b3e0e5a9500ae3cf31f | 2023-06-22T18:40:15 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 08c95e3f8308bf5fb9ecc6ac341b7c4b429f889f | 2023-05-17T19:58:46 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "List of package authors (including contact info)",
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | fcfd9baf0387af68a8218b424dce14b929e7d5be | 2023-12-18T21:51:20 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | dae4961ad07114333c4343af6a8ec806130d0206 | 2023-07-06T21:37:08 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 308e8035ada76f927ee9d4080165969c98a4f0ed | 2023-07-19T23:03:20 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | b6611b3e804393dfd92c45bfbf4da98150de74b1 | 2023-08-02T03:17:08 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version",
"migrations",
"differential",
"registryOverrides"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package.",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | b73f5814d011c55ec6b37209827c26ceeb980ddf | 2023-08-15T22:07:01 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"properties": {
"OCIImportedComponents": {
"description": "Map of components that were imported via OCI. The keys are OCI Package URLs and values are the component names",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"oneOf": [
{
"required": [
"url"
],
"title": "url"
},
{
"required": [
"localPath"
],
"title": "localPath"
}
],
"properties": {
"gitPath": {
"description": "The path to the chart in the repo if using a git repo instead of a helm repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to the chart folder",
"type": "string"
},
"name": {
"description": "The name of the chart to deploy; this should be the name of the chart as it is installed in the helm repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the release to create; defaults to the name of the chart",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo",
"type": "string"
}
},
"required": [
"name",
"version",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "Create a user selector field based on all components in the same group",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/ZarfComponentActionShell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionShell": {
"additionalProperties": false,
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"pattern": "^(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://(?!.*###ZARF_PKG_TMPL_).*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]+$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | 95c42ffff467ee6a53b6cd0f581a72bdf2890ec8 | 2024-03-21T19:15:15 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"Shell": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"differentialPackageVersion": {
"description": "Version of a previously built package used as the basis for creating this differential package",
"type": "string"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/ZarfComponentActionSetVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/Shell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionSetVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageConstant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/ZarfPackageVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
},
"ZarfPackageConstant": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"ZarfPackageVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package can be deployed.",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the Zarf log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
}
} | Apache-2.0 | en |
defenseunicorns/zarf | cd9adb7121832d6de8ed3144af4b0860b3808eb9 | 2024-04-22T21:23:38 | zarf.schema.json | 1,229 | 2024-05-28T05:55:37.383019Z | {
"$ref": "#/definitions/ZarfPackage",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"BigBang": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"fluxPatchFiles": {
"description": "Optional paths to Flux kustomize strategic merge patch files",
"items": {
"type": "string"
},
"type": "array"
},
"repo": {
"description": "Override repo to pull Big Bang from instead of Repo One",
"type": "string"
},
"skipFlux": {
"description": "Whether to skip deploying flux; Defaults to false",
"type": "boolean"
},
"valuesFiles": {
"description": "The list of values files to pass to Big Bang; these will be merged together",
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"description": "The version of Big Bang to use",
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
},
"Constant": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_.",
"type": "boolean"
},
"description": {
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts",
"type": "string"
},
"name": {
"description": "The name to be used for the constant",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a constant value must match before a package can be created.",
"type": "string"
},
"value": {
"description": "The value to set for the constant during deploy",
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"DeprecatedZarfComponentScripts": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Scripts to run after the component successfully deploys",
"items": {
"type": "string"
},
"type": "array"
},
"before": {
"description": "Scripts to run before the component is deployed",
"items": {
"type": "string"
},
"type": "array"
},
"prepare": {
"description": "Scripts to run before the component is added during package create",
"items": {
"type": "string"
},
"type": "array"
},
"retry": {
"description": "Retry the script if it fails",
"type": "boolean"
},
"showOutput": {
"description": "Show the output of the script during package deployment",
"type": "boolean"
},
"timeoutSeconds": {
"description": "Timeout in seconds for the script",
"type": "integer"
}
},
"type": "object"
},
"InteractiveVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"Variable": {
"$ref": "#/definitions/Variable"
},
"default": {
"description": "The default value to use for the variable",
"type": "string"
},
"description": {
"description": "A description of the variable to be used when prompting the user a value",
"type": "string"
},
"prompt": {
"description": "Whether to prompt the user for input for this variable",
"type": "boolean"
}
},
"required": [
"Variable"
],
"type": "object"
},
"Shell": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"darwin": {
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"linux": {
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
],
"type": "string"
},
"windows": {
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
],
"type": "string"
}
},
"type": "object"
},
"Variable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"autoIndent": {
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_.",
"type": "boolean"
},
"name": {
"description": "The name to be used for the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"pattern": {
"description": "An optional regex pattern that a variable value must match before a package deployment can continue.",
"type": "string"
},
"sensitive": {
"description": "Whether to mark this variable as sensitive to not print it in the log",
"type": "boolean"
},
"type": {
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)",
"enum": [
"raw",
"file"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfBuildData": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "The architecture this package was created on",
"type": "string"
},
"differential": {
"description": "Whether this package was created with differential components",
"type": "boolean"
},
"differentialMissing": {
"description": "List of components that were not included in this package due to differential packaging",
"items": {
"type": "string"
},
"type": "array"
},
"differentialPackageVersion": {
"description": "Version of a previously built package used as the basis for creating this differential package",
"type": "string"
},
"flavor": {
"description": "The flavor of Zarf used to build this package",
"type": "string"
},
"lastNonBreakingVersion": {
"description": "The minimum version of Zarf that does not have breaking package structure changes",
"type": "string"
},
"migrations": {
"description": "Any migrations that have been run on this package",
"items": {
"type": "string"
},
"type": "array"
},
"registryOverrides": {
"description": "Any registry domains that were overridden on package create when pulling images",
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"terminal": {
"description": "The machine name that created this package",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this package was created",
"type": "string"
},
"user": {
"description": "The username who created this package",
"type": "string"
},
"version": {
"description": "The version of Zarf used to build this package",
"type": "string"
}
},
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"type": "object"
},
"ZarfChart": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"gitPath": {
"description": "(git repo only) The sub directory to the chart within a git repo",
"examples": [
"charts/your-chart"
],
"type": "string"
},
"localPath": {
"description": "The path to a local chart's folder or .tgz archive",
"type": "string"
},
"name": {
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the chart to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for chart resources to be ready before continuing",
"type": "boolean"
},
"releaseName": {
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)",
"type": "string"
},
"repoName": {
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)",
"type": "string"
},
"url": {
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
],
"type": "string"
},
"valuesFiles": {
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed",
"items": {
"type": "string"
},
"type": "array"
},
"variables": {
"description": "[alpha] List of variables to set in the Helm chart",
"items": {
"$ref": "#/definitions/ZarfChartVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"version": {
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')",
"type": "string"
}
},
"required": [
"name",
"namespace"
],
"type": "object"
},
"ZarfChartVariable": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"description": {
"description": "A brief description of what the variable controls",
"type": "string"
},
"name": {
"description": "The name of the variable",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"path": {
"description": "The path within the Helm chart values where this variable applies",
"type": "string"
}
},
"required": [
"name",
"description",
"path"
],
"type": "object"
},
"ZarfComponent": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"actions": {
"$ref": "#/definitions/ZarfComponentActions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Custom commands to run at various stages of a package lifecycle"
},
"charts": {
"description": "Helm charts to install during package deploy",
"items": {
"$ref": "#/definitions/ZarfChart",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"cosignKeyPath": {
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0.",
"type": "string"
},
"dataInjections": {
"description": "Datasets to inject into a container in the target cluster",
"items": {
"$ref": "#/definitions/ZarfDataInjection",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"default": {
"description": "Determines the default Y/N state for installing this component on package deploy",
"type": "boolean"
},
"description": {
"description": "Message to include during package deploy describing the purpose of this component",
"type": "string"
},
"extensions": {
"$ref": "#/definitions/ZarfComponentExtensions",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Extend component functionality with additional features"
},
"files": {
"description": "Files or folders to place on disk during package deployment",
"items": {
"$ref": "#/definitions/ZarfFile",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"group": {
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead.",
"type": "string"
},
"images": {
"description": "List of OCI images to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"import": {
"$ref": "#/definitions/ZarfComponentImport",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Import a component from another Zarf package"
},
"manifests": {
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy",
"items": {
"$ref": "#/definitions/ZarfManifest",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"name": {
"description": "The name of the component",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"only": {
"$ref": "#/definitions/ZarfComponentOnlyTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Filter when this component is included in package creation or deployment"
},
"repos": {
"description": "List of git repos to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"required": {
"description": "Do not prompt user to install this component",
"type": "boolean"
},
"scripts": {
"$ref": "#/definitions/DeprecatedZarfComponentScripts",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfComponentAction": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cmd": {
"description": "The command to run. Must specify either cmd or wait for the action to do anything.",
"type": "string"
},
"description": {
"description": "Description of the action to be displayed during package execution instead of the command",
"type": "string"
},
"dir": {
"description": "The working directory to run the command in (default is CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables to set for the command",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry the command if it fails up to given number of times (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Timeout in seconds for the command (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of the command during package deployment (default false)",
"type": "boolean"
},
"setVariable": {
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0",
"pattern": "^[A-Z0-9_]+$",
"type": "string"
},
"setVariables": {
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package.",
"items": {
"$ref": "#/definitions/Variable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"shell": {
"$ref": "#/definitions/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"wait": {
"$ref": "#/definitions/ZarfComponentActionWait",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"type": "object"
},
"ZarfComponentActionDefaults": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"dir": {
"description": "Working directory for commands (default CWD)",
"type": "string"
},
"env": {
"description": "Additional environment variables for commands",
"items": {
"type": "string"
},
"type": "array"
},
"maxRetries": {
"description": "Retry commands given number of times if they fail (default 0)",
"type": "integer"
},
"maxTotalSeconds": {
"description": "Default timeout in seconds for commands (default to 0",
"type": "integer"
},
"mute": {
"description": "Hide the output of commands during execution (default false)",
"type": "boolean"
},
"shell": {
"$ref": "#/definitions/Shell",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
}
},
"type": "object"
},
"ZarfComponentActionSet": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"after": {
"description": "Actions to run at the end of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"before": {
"description": "Actions to run at the start of an operation",
"items": {
"$ref": "#/definitions/ZarfComponentAction",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"defaults": {
"$ref": "#/definitions/ZarfComponentActionDefaults",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Default configuration for all actions in this set"
},
"onFailure": {
"description": "Actions to run if all operations fail",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
},
"onSuccess": {
"description": "Actions to run if all operations succeed",
"items": {
"$ref": "#/definitions/ZarfComponentAction"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentActionWait": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"type": "object"
},
"ZarfComponentActionWaitCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"condition": {
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
],
"type": "string"
},
"kind": {
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
],
"type": "string"
},
"name": {
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
],
"type": "string"
},
"namespace": {
"description": "The namespace of the resource to wait for",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ZarfComponentActionWaitNetwork": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"address": {
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
],
"type": "string"
},
"code": {
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
],
"type": "integer"
},
"protocol": {
"description": "The protocol to wait for",
"enum": [
"tcp",
"http",
"https"
],
"type": "string"
}
},
"required": [
"protocol",
"address"
],
"type": "object"
},
"ZarfComponentActions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"onCreate": {
"$ref": "#/definitions/ZarfComponentActionSet",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Actions to run during package creation"
},
"onDeploy": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package deployment"
},
"onRemove": {
"$ref": "#/definitions/ZarfComponentActionSet",
"description": "Actions to run during package removal"
}
},
"type": "object"
},
"ZarfComponentExtensions": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"bigbang": {
"$ref": "#/definitions/BigBang",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Configurations for installing Big Bang and Flux in the cluster"
}
},
"type": "object"
},
"ZarfComponentImport": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"name": {
"description": "The name of the component to import from the referenced zarf.yaml",
"type": "string"
},
"path": {
"description": "The relative path to a directory containing a zarf.yaml to import from",
"type": "string"
},
"url": {
"description": "[beta] The URL to a Zarf package to import via OCI",
"pattern": "^oci://.*$",
"type": "string"
}
},
"type": "object"
},
"ZarfComponentOnlyCluster": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"architecture": {
"description": "Only create and deploy to clusters of the given architecture",
"enum": [
"amd64",
"arm64"
],
"type": "string"
},
"distros": {
"description": "A list of kubernetes distros this package works with (Reserved for future use)",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ZarfComponentOnlyTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"cluster": {
"$ref": "#/definitions/ZarfComponentOnlyCluster",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Only deploy component to specified clusters"
},
"flavor": {
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'",
"type": "string"
},
"localOS": {
"description": "Only deploy component to specified OS",
"enum": [
"linux",
"darwin",
"windows"
],
"type": "string"
}
},
"type": "object"
},
"ZarfContainerTarget": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"container": {
"description": "The container name to target for data injection",
"type": "string"
},
"namespace": {
"description": "The namespace to target for data injection",
"type": "string"
},
"path": {
"description": "The path within the container to copy the data into",
"type": "string"
},
"selector": {
"description": "The K8s selector to target for data injection",
"examples": [
"app=data-injection"
],
"type": "string"
}
},
"required": [
"namespace",
"selector",
"container",
"path"
],
"type": "object"
},
"ZarfDataInjection": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"compress": {
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image.",
"type": "boolean"
},
"source": {
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container",
"type": "string"
},
"target": {
"$ref": "#/definitions/ZarfContainerTarget",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "The target pod + container to inject the data into"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfFile": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"executable": {
"description": "(files only) Determines if the file should be made executable during package deploy",
"type": "boolean"
},
"extractPath": {
"description": "Local folder or file to be extracted from a 'source' archive",
"type": "string"
},
"shasum": {
"description": "(files only) Optional SHA256 checksum of the file",
"type": "string"
},
"source": {
"description": "Local folder or file path or remote URL to pull into the package",
"type": "string"
},
"symlinks": {
"description": "List of symlinks to create during package deploy",
"items": {
"type": "string"
},
"type": "array"
},
"target": {
"description": "The absolute or relative path where the file or folder should be copied to during package deploy",
"type": "string"
}
},
"required": [
"source",
"target"
],
"type": "object"
},
"ZarfManifest": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"files": {
"description": "List of local K8s YAML files or remote URLs to deploy (in order)",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizations": {
"description": "List of local kustomization paths or remote URLs to include in the package",
"items": {
"type": "string"
},
"type": "array"
},
"kustomizeAllowAnyDirectory": {
"description": "Allow traversing directory above the current directory if needed for kustomization",
"type": "boolean"
},
"name": {
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart",
"type": "string"
},
"namespace": {
"description": "The namespace to deploy the manifests to",
"type": "string"
},
"noWait": {
"description": "Whether to not wait for manifest resources to be ready before continuing",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfMetadata": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"aggregateChecksum": {
"description": "Checksum of a checksums.txt file that contains checksums all the layers within the package.",
"type": "string"
},
"architecture": {
"description": "The target cluster architecture for this package",
"examples": [
"arm64",
"amd64"
],
"type": "string"
},
"authors": {
"description": "Comma-separated list of package authors (including contact info)",
"examples": [
"Doug <[email protected]>, Pepr <[email protected]>"
],
"type": "string"
},
"description": {
"description": "Additional information about this package",
"type": "string"
},
"documentation": {
"description": "Link to package documentation when online",
"type": "string"
},
"image": {
"description": "An image URL to embed in this package (Reserved for future use in Zarf UI)",
"type": "string"
},
"name": {
"description": "Name to identify this Zarf package",
"pattern": "^[a-z0-9\\-]*[a-z0-9]$",
"type": "string"
},
"source": {
"description": "Link to package source code when online",
"type": "string"
},
"uncompressed": {
"description": "Disable compression of this package",
"type": "boolean"
},
"url": {
"description": "Link to package information when online",
"type": "string"
},
"vendor": {
"description": "Name of the distributing entity, organization or individual.",
"type": "string"
},
"version": {
"description": "Generic string set by a package author to track the package version (Note: ZarfInitConfigs will always be versioned to the CLIVersion they were created with)",
"type": "string"
},
"yolo": {
"description": "Yaml OnLy Online (YOLO): True enables deploying a Zarf package without first running zarf init against the cluster. This is ideal for connected environments where you want to use existing VCS and container registries.",
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ZarfPackage": {
"additionalProperties": false,
"patternProperties": {
"^x-": {}
},
"properties": {
"build": {
"$ref": "#/definitions/ZarfBuildData",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Zarf-generated package build data"
},
"components": {
"description": "List of components to deploy in this package",
"items": {
"$ref": "#/definitions/ZarfComponent",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"constants": {
"description": "Constant template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/Constant",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
},
"kind": {
"default": "ZarfPackageConfig",
"description": "The kind of Zarf package",
"enum": [
"ZarfInitConfig",
"ZarfPackageConfig"
],
"type": "string"
},
"metadata": {
"$ref": "#/definitions/ZarfMetadata",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Package metadata"
},
"variables": {
"description": "Variable template values applied on deploy for K8s resources",
"items": {
"$ref": "#/definitions/InteractiveVariable",
"$schema": "http://json-schema.org/draft-04/schema#"
},
"type": "array"
}
},
"required": [
"kind",
"components"
],
"type": "object"
}
}
} | Apache-2.0 | en |
zeta-group/ZDCode | 1a6ba66ca7528b04587cc579b0d1c8c1b9ec10c5 | 2023-08-17T01:21:17 | changelog.schema.json | 15 | 2024-05-28T01:03:32.597924Z | {
"$id": "https://github.com/zeta-group/ZDCode/raw/master/changelog.schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"description": "A machine readable changelog in JSON format. Think of this like a computer-courtesy. Draft 1. Authored by Gustavo Rehermann ([email protected]).",
"properties": {
"versions": {
"description": "List of release versions, in ascending order. Includes the currently in-development version.",
"items": {
"description": "Defines a single release version. Its presence here only implies that it has already been finished and released if this is the last item in the list.",
"properties": {
"changes": {
"description": "A list of changes in this version. Must be relative to the last version/release in the list.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The version number. For instance: 2.13.5",
"type": "string"
}
},
"required": [
"name",
"changes"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"versions"
],
"type": "object"
} | MIT | en |
messari/substreams | d9b723bda5f0b3aa640e46ba2dd5a570c3c40f61 | 2023-06-23T12:51:17 | config/schemas/params.schema.json | 49 | 2024-05-27T06:08:50.552361Z | {
"$defs": {
"substream": {
"properties": {
"deployments": {
"$ref": "#/$defs/substreamDeployments"
},
"name": {
"type": "string"
},
"outputModules": {
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"type": "string"
},
"subgraphModule": {
"type": "string"
}
},
"required": [
"name",
"path",
"outputModules",
"deployments"
]
},
"substreamDeployment": {
"properties": {
"name": {
"type": "string"
},
"network": {
"type": "string"
},
"params": {
"type": "object"
},
"startBlocks": {
"type": "object"
}
},
"required": [
"name",
"network",
"startBlocks"
]
},
"substreamDeployments": {
"items": {
"$ref": "#/$defs/substreamDeployment"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/messari/substreams/master/config/schemas/params.schema.json",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"description": "A given substream can potentially be run with multiple different inputs, networks, and start blocks. This schema defines how we define all the supported deployments for the substreams in this repository.",
"items": {
"$ref": "#/$defs/substream"
},
"title": "Schema for the definition of substream parameters",
"type": "array"
} | MIT | en |
cph-cachet/carp.core-kotlin | e3c8f46fe0ea8793db5daad5025f1504ca9c70fc | 2022-03-07T16:05:41 | rpc/schemas/common/devices/Smartphone.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"DeviceRegistration": {
"$anchor": "DeviceRegistration",
"$ref": "DefaultDeviceRegistration.json"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "PrimaryDeviceConfiguration.json#PrimaryDeviceConfiguration"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.devices.Smartphone"
}
},
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 7b9f0006e17a90fdcbc435a3a944877dd94185bc | 2022-10-14T09:25:20 | rpc/schemas/common/data/StepCount.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "Data.json#SensorData"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.stepcount"
},
"steps": {
"type": "integer"
}
},
"required": [
"__type",
"steps"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 7ea6ba7386abefcd3c8badf7fb9a6427f3de2b91 | 2022-02-01T13:04:22 | rpc/schemas/data/Measurement.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"data": {
"$ref": "../common/data/Data.json"
},
"sensorEndTime": {
"description": "If set, sensorEndTime needs to lie after sensorStartTime.",
"type": [
"integer",
"null"
]
},
"sensorStartTime": {
"type": "integer"
}
},
"required": [
"sensorStartTime",
"data"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 080dbdcae16e46ff7c558b8cea9400136991d095 | 2022-02-28T18:14:01 | rpc/schemas/common/tasks/TaskConfiguration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"TaskConfiguration": {
"properties": {
"__type": true,
"description": {
"type": [
"string",
"null"
]
},
"measures": {
"items": {
"$ref": "Measure.json"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"__type",
"name"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "#/$defs/TaskConfiguration"
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.tasks.BackgroundTask"
}
}
},
"then": {
"$ref": "BackgroundTask.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.tasks.CustomProtocolTask"
}
}
},
"then": {
"$ref": "CustomProtocolTask.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.tasks.WebTask"
}
}
},
"then": {
"$ref": "WebTask.json"
}
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 647b4583561f86893baafd78d498fc2c55a8f800 | 2022-02-01T13:04:22 | rpc/schemas/common/tasks/BackgroundTask.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "TaskDescriptor.json#/$defs/TaskDescriptor"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.tasks.BackgroundTask"
},
"duration": {
"format": "duration",
"type": "string"
}
},
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 647b4583561f86893baafd78d498fc2c55a8f800 | 2022-02-01T13:04:22 | rpc/schemas/common/sampling/NoOptionsSamplingConfiguration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "SamplingConfiguration.json#/$defs/SamplingConfiguration"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.sampling.NoOptionsSamplingConfiguration"
}
},
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 647b4583561f86893baafd78d498fc2c55a8f800 | 2022-02-01T13:04:22 | rpc/schemas/common/triggers/ElapsedTimeTrigger.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "Trigger.json#/$defs/Trigger"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.triggers.ElapsedTimeTrigger"
},
"elapsedTime": {
"format": "duration",
"type": "string"
}
},
"required": [
"elapsedTime"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/common/data/input/Sex.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.input.sex"
},
"value": {
"enum": [
"Male",
"Female",
"Intersex"
]
}
},
"required": [
"__type",
"value"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 080dbdcae16e46ff7c558b8cea9400136991d095 | 2022-02-28T18:14:01 | rpc/schemas/protocols/StudyProtocolSnapshot.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"DeviceConnection": {
"additionalProperties": false,
"properties": {
"connectedToRoleName": {
"type": "string"
},
"roleName": {
"type": "string"
}
},
"required": [
"roleName",
"connectedToRoleName"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"applicationData": {
"$ref": "../common/ApplicationData.json"
},
"connectedDevices": {
"items": {
"$ref": "../common/devices/DeviceConfiguration.json"
},
"type": "array"
},
"connections": {
"items": {
"$ref": "#/$defs/DeviceConnection"
},
"type": "array"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"expectedParticipantData": {
"items": {
"$ref": "../common/users/ParticipantAttribute.json"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string"
},
"primaryDevices": {
"items": {
"$ref": "../common/devices/PrimaryDeviceConfiguration.json"
},
"type": "array"
},
"taskControls": {
"items": {
"$ref": "../common/triggers/TaskControl.json"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "../common/tasks/TaskConfiguration.json"
},
"type": "array"
},
"triggers": {
"additionalProperties": {
"$ref": "../common/triggers/Trigger.json"
},
"propertyNames": {
"pattern": "^\\d$"
},
"type": "object"
}
},
"required": [
"id",
"createdOn",
"ownerId",
"name"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | e3c8f46fe0ea8793db5daad5025f1504ca9c70fc | 2022-03-07T16:05:41 | rpc/schemas/common/sampling/GranularitySamplingConfiguration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "SamplingConfiguration.json#SamplingConfiguration"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.sampling.GranularitySamplingConfiguration"
},
"granularity": {
"enum": [
"Detailed",
"Balanced",
"Coarse"
]
}
},
"required": [
"granularity"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/common/devices/DeviceRegistration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"DeviceRegistration": {
"properties": {
"__type": true,
"deviceDisplayName": {
"type": [
"string",
"null"
]
},
"deviceId": {
"type": "string"
},
"registrationCreatedOn": {
"format": "date-time",
"type": "string"
}
},
"required": [
"__type",
"deviceId",
"deviceDisplayName",
"registrationCreatedOn"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "#/$defs/DeviceRegistration"
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.devices.AltBeaconDeviceRegistration"
}
}
},
"then": {
"$ref": "AltBeacon.json#/$defs/DeviceRegistration"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.devices.BLESerialNumberDeviceRegistration"
}
}
},
"then": {
"$ref": "BLESerialNumberDeviceRegistration.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.devices.DefaultDeviceRegistration"
}
}
},
"then": {
"$ref": "DefaultDeviceRegistration.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.devices.MACAddressDeviceRegistration"
}
}
},
"then": {
"$ref": "MACAddressDeviceRegistration.json"
}
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 7ea6ba7386abefcd3c8badf7fb9a6427f3de2b91 | 2022-02-01T13:04:22 | rpc/schemas/data/DataStreamBatch.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"items": {
"$ref": "DataStreamSequence.json"
},
"type": "array"
} | MIT | en |
cph-cachet/carp.core-kotlin | 7d6b495188dc7d135b667f7bedbd5ede9a8bea73 | 2022-03-01T14:39:21 | rpc/schemas/common/triggers/TriggerConfiguration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"TriggerConfiguration": {
"properties": {
"__type": true,
"sourceDeviceRoleName": {
"type": "string"
}
},
"required": [
"__type",
"sourceDeviceRoleName"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "#/$defs/TriggerConfiguration"
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.triggers.ElapsedTimeTrigger"
}
}
},
"then": {
"$ref": "ElapsedTimeTrigger.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.triggers.ManualTrigger"
}
}
},
"then": {
"$ref": "ManualTrigger.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.triggers.ScheduledTrigger"
}
}
},
"then": {
"$ref": "ScheduledTrigger.json"
}
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | e3c8f46fe0ea8793db5daad5025f1504ca9c70fc | 2022-03-07T16:05:41 | rpc/schemas/common/triggers/ManualTrigger.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "TriggerConfiguration.json#TriggerConfiguration"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.triggers.ManualTrigger"
},
"description": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
}
},
"required": [
"label"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 7b9f0006e17a90fdcbc435a3a944877dd94185bc | 2022-10-14T09:25:20 | rpc/schemas/common/data/AngularVelocity.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "Data.json#SensorData"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.angularvelocity"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"__type",
"x",
"y",
"z"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | de9c1e79146d5cfa493c361e373121f11a70eb21 | 2022-02-11T22:23:59 | rpc/schemas/data/DataStreamService/DataStreamServiceRequest.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"ApiVersion": {
"const": "1.0"
},
"AppendToDataStreams": {
"$anchor": "AppendToDataStreams",
"Response": {
"$anchor": "AppendToDataStreams-Response",
"$ref": "../../common/Unit.json"
},
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.data.infrastructure.DataStreamServiceRequest.AppendToDataStreams"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"batch": {
"$ref": "../DataStreamBatch.json"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"$type",
"apiVersion",
"studyDeploymentId",
"batch"
],
"type": "object"
},
"CloseDataStreams": {
"$anchor": "CloseDataStreams",
"Response": {
"$anchor": "CloseDataStreams-Response",
"$ref": "../../common/Unit.json"
},
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.data.infrastructure.DataStreamServiceRequest.CloseDataStreams"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"$type",
"apiVersion",
"studyDeploymentIds"
],
"type": "object"
},
"GetDataStream": {
"$anchor": "GetDataStream",
"Response": {
"$anchor": "GetDataStream-Response",
"$ref": "../DataStreamBatch.json"
},
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.data.infrastructure.DataStreamServiceRequest.GetDataStream"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"dataStream": {
"$ref": "../DataStreamId.json"
},
"fromSequenceId": {
"type": "integer"
},
"toSequenceIdInclusive": {
"type": [
"integer",
"null"
]
}
},
"required": [
"$type",
"apiVersion",
"dataStream",
"fromSequenceId"
],
"type": "object"
},
"OpenDataStreams": {
"$anchor": "OpenDataStreams",
"Response": {
"$anchor": "OpenDataStreams-Response",
"$ref": "../../common/Unit.json"
},
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.data.infrastructure.DataStreamServiceRequest.OpenDataStreams"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"configuration": {
"$ref": "../DataStreamsConfiguration.json"
}
},
"required": [
"$type",
"apiVersion",
"configuration"
],
"type": "object"
},
"RemoveDataStreams": {
"Response": {
"$anchor": "RemoveDataStreams-Response",
"type": "boolean"
},
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.data.infrastructure.DataStreamServiceRequest.RemoveDataStreams"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"$type",
"apiVersion",
"studyDeploymentIds"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/OpenDataStreams"
},
{
"$ref": "#/$defs/AppendToDataStreams"
},
{
"$ref": "#/$defs/GetDataStream"
},
{
"$ref": "#/$defs/CloseDataStreams"
},
{
"$ref": "#/$defs/RemoveDataStreams"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | a8e97a57a14ddc09a00697baf882eff3b349b9cd | 2022-02-01T13:04:22 | rpc/schemas/protocols/ProtocolFactoryService/ProtocolFactoryServiceRequest.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"CreateCustomProtocol": {
"$anchor": "CreateCustomProtocol",
"Response": {
"$anchor": "CreateCustomProtocol-Response",
"$ref": "../StudyProtocolSnapshot.json"
},
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.protocols.infrastructure.ProtocolFactoryServiceRequest.CreateCustomProtocol"
},
"customProtocol": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"$type",
"ownerId",
"name",
"customProtocol",
"description"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/CreateCustomProtocol"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | a062c66690492fe0f477582d4bb4def4ea084f72 | 2022-02-01T13:04:22 | rpc/schemas/protocols/ProtocolVersion.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"date": {
"format": "date-time",
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"tag",
"date"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 5d3ee7c78c1bc7e6ccd172e16c3eb33ef5d5ae49 | 2024-03-16T17:13:12 | rpc/schemas/common/users/AccountIdentity.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"EmailAccountIdentity": {
"$anchor": "EmailAccountIdentity",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.users.EmailAccountIdentity"
},
"emailAddress": {
"format": "email",
"type": "string"
}
},
"required": [
"__type",
"emailAddress"
],
"type": "object"
},
"UsernameAccountIdentity": {
"$anchor": "UsernameAccountIdentity",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.users.UsernameAccountIdentity"
},
"username": {
"type": "string"
}
},
"required": [
"__type",
"username"
]
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/EmailAccountIdentity"
},
{
"$ref": "#/$defs/UsernameAccountIdentity"
}
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 4a7fe521b7dda62181c6e1a8acaadc11bb581934 | 2022-10-05T13:15:55 | rpc/schemas/deployments/DeploymentService/DeploymentServiceRequest.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"ApiVersion": {
"const": "1.1"
},
"CreateStudyDeployment": {
"$anchor": "CreateStudyDeployment",
"Response": {
"$anchor": "CreateStudyDeployment-Response",
"$ref": "../StudyDeploymentStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.CreateStudyDeployment"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"connectedDevicePreregistrations": {
"additionalProperties": {
"$ref": "../../common/devices/DeviceRegistration.json"
},
"type": "object"
},
"id": {
"format": "uuid",
"type": "string"
},
"invitations": {
"items": {
"$ref": "../users/ParticipantInvitation.json"
},
"type": "array"
},
"protocol": {
"$ref": "../../protocols/StudyProtocolSnapshot.json"
}
},
"required": [
"__type",
"apiVersion",
"id",
"protocol",
"invitations",
"connectedDevicePreregistrations"
],
"type": "object"
},
"DeviceDeployed": {
"$anchor": "DeviceDeployed",
"Response": {
"$anchor": "DeviceDeployed-Response",
"$ref": "../StudyDeploymentStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.DeviceDeployed"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"deviceDeploymentLastUpdatedOn": {
"format": "date-time",
"type": "string"
},
"primaryDeviceRoleName": {
"type": "string"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId",
"primaryDeviceRoleName",
"deviceDeploymentLastUpdatedOn"
],
"type": "object"
},
"GetDeviceDeploymentFor": {
"$anchor": "GetDeviceDeploymentFor",
"Response": {
"$anchor": "GetDeviceDeploymentFor-Response",
"$ref": "../PrimaryDeviceDeployment.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.GetDeviceDeploymentFor"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"primaryDeviceRoleName": {
"type": "string"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId",
"primaryDeviceRoleName"
],
"type": "object"
},
"GetStudyDeploymentStatus": {
"$anchor": "GetStudyDeploymentStatus",
"Response": {
"$anchor": "GetStudyDeploymentStatus-Response",
"$ref": "../StudyDeploymentStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.GetStudyDeploymentStatus"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId"
],
"type": "object"
},
"GetStudyDeploymentStatusList": {
"$anchor": "GetStudyDeploymentStatusList",
"Response": {
"$anchor": "GetStudyDeploymentStatusList-Response",
"items": {
"$ref": "../StudyDeploymentStatus.json"
},
"type": "array"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.GetStudyDeploymentStatusList"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentIds"
],
"type": "object"
},
"RegisterDevice": {
"$anchor": "RegisterDevice",
"Response": {
"$anchor": "RegisterDevice-Response",
"$ref": "../StudyDeploymentStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.RegisterDevice"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"deviceRoleName": {
"type": "string"
},
"registration": {
"$ref": "../../common/devices/DeviceRegistration.json"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId",
"deviceRoleName",
"registration"
],
"type": "object"
},
"RemoveStudyDeployments": {
"$anchor": "RemoveStudyDeployments",
"Response": {
"$anchor": "RemoveStudyDeployments-Response",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.RemoveStudyDeployments"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentIds"
],
"type": "object"
},
"Stop": {
"$anchor": "Stop",
"Response": {
"$anchor": "Stop-Response",
"$ref": "../StudyDeploymentStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.Stop"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId"
],
"type": "object"
},
"UnregisterDevice": {
"$anchor": "UnregisterDevice",
"Response": {
"$anchor": "UnregisterDevice-Response",
"$ref": "../StudyDeploymentStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.DeploymentServiceRequest.UnregisterDevice"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"deviceRoleName": {
"type": "string"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId",
"deviceRoleName"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/CreateStudyDeployment"
},
{
"$ref": "#/$defs/RemoveStudyDeployments"
},
{
"$ref": "#/$defs/GetStudyDeploymentStatus"
},
{
"$ref": "#/$defs/GetStudyDeploymentStatusList"
},
{
"$ref": "#/$defs/RegisterDevice"
},
{
"$ref": "#/$defs/UnregisterDevice"
},
{
"$ref": "#/$defs/GetDeviceDeploymentFor"
},
{
"$ref": "#/$defs/DeviceDeployed"
},
{
"$ref": "#/$defs/Stop"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 92a71ba31152faef091e017dcd66990584f61ce2 | 2022-02-01T13:04:22 | rpc/schemas/common/data/TriggeredTask.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.triggeredtask"
},
"control": {
"$ref": "../triggers/TaskControl.json#/$defs/Control"
},
"destinationDeviceRoleName": {
"type": "string"
},
"taskName": {
"type": "string"
},
"triggerData": {
"oneOf": [
{
"$ref": "Data.json"
},
{
"type": "null"
}
]
},
"triggerId": {
"type": "integer"
}
},
"required": [
"$type",
"triggerId",
"taskName",
"destinationDeviceRoleName",
"control"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 676925e9723857faeb828fdab576b1ff6ed02f73 | 2022-02-01T13:04:22 | rpc/schemas/studies/StudyDetails.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"createdOn": {
"format": "date-time",
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"invitation": {
"$ref": "../deployments/users/StudyInvitation.json"
},
"name": {
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string"
},
"protocolSnapshot": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "../protocols/StudyProtocolSnapshot.json"
}
]
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"studyId",
"ownerId",
"name",
"createdOn",
"description",
"invitation",
"protocolSnapshot"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 17153775ef281124fa73f312dfe73f8a92c8b040 | 2022-02-01T13:04:22 | rpc/schemas/common/devices/DeviceRegistration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 62918eccff5578579d1d07db744635d33102ef04 | 2022-02-01T13:04:22 | rpc/schemas/common/Short.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"maximum": 32767,
"minimum": -32768,
"type": "integer"
} | MIT | en |
cph-cachet/carp.core-kotlin | 1741142df84715c6730605d7fa667286b8d23ea3 | 2022-04-03T18:15:36 | rpc/schemas/common/data/Data.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"properties": {
"__type": {
"$ref": "../NamespacedId.json"
}
},
"required": [
"__type"
],
"type": "object"
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.geolocation"
}
}
},
"then": {
"$ref": "Geolocation.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.stepcount"
}
}
},
"then": {
"$ref": "StepCount.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.ecg"
}
}
},
"then": {
"$ref": "ECG.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.heartrate"
}
}
},
"then": {
"$ref": "HeartRate.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.rrinterval"
}
}
},
"then": {
"$ref": "RRInterval.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.sensorskincontact"
}
}
},
"then": {
"$ref": "SensorSkinContact.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.nongravitationalacceleration"
}
}
},
"then": {
"$ref": "NonGravitationalAcceleration.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.acceleration"
}
}
},
"then": {
"$ref": "Acceleration.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.angularvelocity"
}
}
},
"then": {
"$ref": "AngularVelocity.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.signalstrength"
}
}
},
"then": {
"$ref": "SignalStrength.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.triggeredtask"
}
}
},
"then": {
"$ref": "TriggeredTask.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.completedtask"
}
}
},
"then": {
"$ref": "CompletedTask.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.input.custom"
}
}
},
"then": {
"$ref": "input/CustomInput.json"
}
},
{
"if": {
"properties": {
"__type": {
"const": "dk.cachet.carp.input.sex"
}
}
},
"then": {
"$ref": "input/Sex.json"
}
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 58b889b65b6e2494791d0adbc2a5d2ae572f06ee | 2022-04-04T10:00:19 | rpc/schemas/protocols/StudyProtocolSnapshot.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"DeviceConnection": {
"additionalProperties": false,
"properties": {
"connectedToRoleName": {
"type": "string"
},
"roleName": {
"type": "string"
}
},
"required": [
"roleName",
"connectedToRoleName"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"applicationData": {
"$ref": "../common/ApplicationData.json"
},
"connectedDevices": {
"items": {
"$ref": "../common/devices/DeviceConfiguration.json"
},
"type": "array"
},
"connections": {
"items": {
"$ref": "#/$defs/DeviceConnection"
},
"type": "array"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"expectedParticipantData": {
"items": {
"$ref": "../common/users/ExpectedParticipantData.json"
},
"type": "array"
},
"id": {
"format": "uuid",
"type": "string"
},
"name": {
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string"
},
"participantRoles": {
"items": {
"$ref": "../common/users/ParticipantRole.json"
},
"type": "array"
},
"primaryDevices": {
"items": {
"$ref": "../common/devices/PrimaryDeviceConfiguration.json"
},
"type": "array"
},
"taskControls": {
"items": {
"$ref": "../common/triggers/TaskControl.json"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "../common/tasks/TaskConfiguration.json"
},
"type": "array"
},
"triggers": {
"additionalProperties": {
"$ref": "../common/triggers/TriggerConfiguration.json"
},
"propertyNames": {
"pattern": "^\\d$"
},
"type": "object"
}
},
"required": [
"id",
"createdOn",
"ownerId",
"name"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 080dbdcae16e46ff7c558b8cea9400136991d095 | 2022-02-28T18:14:01 | rpc/schemas/common/tasks/WebTask.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "TaskConfiguration.json#/$defs/TaskConfiguration"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.tasks.WebTask"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 5d3ee7c78c1bc7e6ccd172e16c3eb33ef5d5ae49 | 2024-03-16T17:13:12 | rpc/schemas/studies/RecruitmentService/RecruitmentServiceRequest.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"AddParticipantByEmailAddress": {
"$anchor": "AddParticipantByEmailAddress",
"Response": {
"$anchor": "AddParticipantByEmailAddress-Response",
"$ref": "../users/Participant.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.RecruitmentServiceRequest.AddParticipantByEmailAddress"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"email": {
"format": "email",
"type": "string"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"email"
],
"type": "object"
},
"AddParticipantByUsername": {
"$anchor": "AddParticipantByUsername",
"Response": {
"$anchor": "AddParticipantByUsername-Response",
"$ref": "../users/Participant.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.RecruitmentServiceRequest.AddParticipantByUsername"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"username"
],
"type": "object"
},
"ApiVersion": {
"const": "1.2"
},
"GetParticipant": {
"$anchor": "GetParticipant",
"Response": {
"$anchor": "GetParticipant-Response",
"$ref": "../users/Participant.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.RecruitmentServiceRequest.GetParticipant"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"participantId": {
"format": "uuid",
"type": "string"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"participantId"
],
"type": "object"
},
"GetParticipantGroupStatusList": {
"$anchor": "GetParticipantGroupStatusList",
"Response": {
"$anchor": "GetParticipantGroupStatusList-Response",
"items": {
"$ref": "../users/ParticipantGroupStatus.json"
},
"type": "array"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.RecruitmentServiceRequest.GetParticipantGroupStatusList"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId"
],
"type": "object"
},
"GetParticipants": {
"$anchor": "GetParticipants",
"Response": {
"$anchor": "GetParticipants-Response",
"items": {
"$ref": "../users/Participant.json"
},
"type": "array"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.RecruitmentServiceRequest.GetParticipants"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId"
],
"type": "object"
},
"InviteNewParticipantGroup": {
"$anchor": "InviteNewParticipantGroup",
"Response": {
"$anchor": "InviteNewParticipantGroup-Response",
"$ref": "../users/ParticipantGroupStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.RecruitmentServiceRequest.InviteNewParticipantGroup"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"group": {
"items": {
"$ref": "../users/AssignedParticipantRoles.json"
},
"type": "array"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"group"
],
"type": "object"
},
"StopParticipantGroup": {
"$anchor": "StopParticipantGroup",
"Response": {
"$anchor": "StopParticipantGroup-Response",
"$ref": "../users/ParticipantGroupStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.RecruitmentServiceRequest.StopParticipantGroup"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"groupId": {
"format": "uuid",
"type": "string"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"groupId"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/AddParticipantByEmailAddress"
},
{
"$ref": "#/$defs/AddParticipantByUsername"
},
{
"$ref": "#/$defs/GetParticipant"
},
{
"$ref": "#/$defs/GetParticipants"
},
{
"$ref": "#/$defs/InviteNewParticipantGroup"
},
{
"$ref": "#/$defs/GetParticipantGroupStatusList"
},
{
"$ref": "#/$defs/StopParticipantGroup"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | b194b814525d96fb33748ffe85be746625c99e80 | 2022-02-01T13:04:22 | rpc/schemas/deployments/users/Participation.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"participantId": {
"format": "uuid",
"type": "string"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"studyDeploymentId",
"participantId"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 647b4583561f86893baafd78d498fc2c55a8f800 | 2022-02-01T13:04:22 | rpc/schemas/common/sampling/SamplingConfiguration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"SamplingConfiguration": {
"properties": {
"$type": true
},
"required": [
"$type"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "#/$defs/SamplingConfiguration"
},
{
"if": {
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.sampling.BatteryAwareSamplingConfiguration"
}
}
},
"then": {
"$ref": "BatteryAwareSamplingConfiguration.json"
}
},
{
"if": {
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.sampling.GranularitySamplingConfiguration"
}
}
},
"then": {
"$ref": "GranularitySamplingConfiguration.json"
}
},
{
"if": {
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.sampling.IntervalSamplingConfiguration"
}
}
},
"then": {
"$ref": "IntervalSamplingConfiguration.json"
}
},
{
"if": {
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.sampling.NoOptionsSamplingConfiguration"
}
}
},
"then": {
"$ref": "NoOptionsSamplingConfiguration.json"
}
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 215bf8cd80dc6ff8f2b0c4c20e2226e268ec9015 | 2022-10-12T13:33:52 | rpc/schemas/common/data/PPG.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.ppg"
},
"lightSources": {
"additionalProperties": {
"type": "number"
},
"minProperties": 1,
"type": "object"
}
},
"required": [
"__type",
"lightSources"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/common/data/AngularVelocity.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.angularvelocity"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"__type",
"x",
"y",
"z"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 664cd714e09c6edb0cc97d6b8368d76f4d0e8de3 | 2022-02-01T13:04:22 | rpc/schemas/studies/users/ParticipantGroupStatus.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"InDeployment": {
"allOf": [
{
"$ref": "#/$defs/ParticipantGroupStatus"
}
],
"properties": {
"invitedOn": {
"format": "date-time",
"type": "string"
},
"studyDeploymentStatus": {
"$ref": "../../deployments/StudyDeploymentStatus.json"
}
},
"required": [
"invitedOn",
"studyDeploymentStatus"
]
},
"Invited": {
"$anchor": "Invited",
"allOf": [
{
"$ref": "#/$defs/InDeployment"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.studies.application.users.ParticipantGroupStatus.Invited"
}
},
"unevaluatedProperties": false
},
"ParticipantGroupStatus": {
"properties": {
"id": {
"format": "uuid",
"type": "string"
},
"participants": {
"items": {
"$ref": "../users/Participant.json"
},
"type": "array"
}
},
"required": [
"$type",
"id",
"participants"
],
"type": "object"
},
"Running": {
"$anchor": "DeployingDevices",
"allOf": [
{
"$ref": "#/$defs/InDeployment"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.studies.application.users.ParticipantGroupStatus.Running"
},
"startedOn": {
"format": "date-time",
"type": "string"
}
},
"required": [
"startedOn"
],
"unevaluatedProperties": false
},
"Staged": {
"$anchor": "Staged",
"allOf": [
{
"$ref": "#/$defs/ParticipantGroupStatus"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.studies.application.users.ParticipantGroupStatus.Staged"
}
},
"unevaluatedProperties": false
},
"Stopped": {
"$anchor": "Running",
"allOf": [
{
"$ref": "#/$defs/InDeployment"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.studies.application.users.ParticipantGroupStatus.Stopped"
},
"startedOn": {
"oneOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"stoppedOn": {
"format": "date-time",
"type": "string"
}
},
"required": [
"startedOn",
"stoppedOn"
],
"unevaluatedProperties": false
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/Staged"
},
{
"$ref": "#/$defs/Invited"
},
{
"$ref": "#/$defs/Running"
},
{
"$ref": "#/$defs/Stopped"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/common/triggers/ManualTrigger.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "Trigger.json#/$defs/Trigger"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.triggers.ManualTrigger"
},
"description": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
}
},
"required": [
"label"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 81d66834601a124061b453d68a09f34f1dce7b77 | 2022-04-04T10:58:46 | rpc/schemas/common/users/AccountIdentity.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"EmailAccountIdentity": {
"$anchor": "EmailAccountIdentity",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.users.EmailAccountIdentity"
},
"emailAddress": {
"format": "email",
"type": "string"
}
},
"required": [
"__type",
"emailAddress"
],
"type": "object"
},
"UsernameAccountIdentity": {
"$anchor": "UsernameAccountIdentity",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.users.UsernameAccountIdentity"
},
"username": {
"type": "string"
}
},
"required": [
"__type"
]
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/EmailAccountIdentity"
},
{
"$ref": "#/$defs/UsernameAccountIdentity"
}
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 40e85f92393ef5fec2e015db604cc6b476f6ad58 | 2022-04-04T10:00:19 | rpc/schemas/deployments/PrimaryDeviceDeployment.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"applicationData": {
"$ref": "../common/ApplicationData.json"
},
"connectedDeviceRegistrations": {
"additionalProperties": {
"$ref": "../common/devices/DeviceRegistration.json"
},
"type": "object"
},
"connectedDevices": {
"items": {
"$ref": "../common/devices/DeviceConfiguration.json"
},
"type": "array"
},
"deviceConfiguration": {
"$ref": "../common/devices/PrimaryDeviceConfiguration.json"
},
"expectedParticipantData": {
"items": {
"$ref": "../common/users/ExpectedParticipantData.json"
},
"type": "array"
},
"registration": {
"$ref": "../common/devices/DeviceRegistration.json"
},
"taskControls": {
"items": {
"$ref": "../common/triggers/TaskControl.json"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "../common/tasks/TaskConfiguration.json"
},
"type": "array"
},
"triggers": {
"additionalProperties": {
"$ref": "../common/triggers/TriggerConfiguration.json"
},
"propertyNames": {
"pattern": "^\\d$"
},
"type": "object"
}
},
"required": [
"deviceConfiguration",
"registration"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 647b4583561f86893baafd78d498fc2c55a8f800 | 2022-02-01T13:04:22 | rpc/schemas/studies/StudyStatus.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"Configuring": {
"$anchor": "Configuring",
"allOf": [
{
"$ref": "#/$defs/StudyStatus"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.studies.application.StudyStatus.Configuring"
},
"canGoLive": {
"type": "boolean"
}
},
"required": [
"canGoLive"
],
"unevaluatedProperties": false
},
"Live": {
"$anchor": "Live",
"allOf": [
{
"$ref": "#/$defs/StudyStatus"
}
],
"properties": {
"$type": {
"const": "dk.cachet.carp.studies.application.StudyStatus.Live"
}
},
"unevaluatedProperties": false
},
"StudyStatus": {
"properties": {
"$type": true,
"canDeployToParticipants": {
"type": "boolean"
},
"canSetInvitation": {
"type": "boolean"
},
"canSetStudyProtocol": {
"type": "boolean"
},
"createdOn": {
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"$type",
"studyId",
"name",
"createdOn",
"canSetInvitation",
"canSetStudyProtocol",
"canDeployToParticipants"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/Configuring"
},
{
"$ref": "#/$defs/Live"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 080dbdcae16e46ff7c558b8cea9400136991d095 | 2022-02-28T18:14:01 | rpc/schemas/common/tasks/BackgroundTask.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "TaskConfiguration.json#/$defs/TaskConfiguration"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.tasks.BackgroundTask"
},
"duration": {
"format": "duration",
"type": "string"
}
},
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 647b4583561f86893baafd78d498fc2c55a8f800 | 2022-02-01T13:04:22 | rpc/schemas/common/devices/BLESerialNumberDeviceRegistration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "DeviceRegistration.json#/$defs/DeviceRegistration"
}
],
"properties": {
"serialNumber": {
"type": "string"
}
},
"required": [
"serialNumber"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 55284d12439fc74b89e80301dd245877f7024c0b | 2022-02-12T03:15:16 | rpc/schemas/deployments/users/AssignedPrimaryDevice.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"device": {
"$ref": "../../common/devices/DeviceConfiguration.json"
},
"registration": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "../../common/devices/DeviceRegistration.json"
}
]
}
},
"required": [
"device"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 7b9f0006e17a90fdcbc435a3a944877dd94185bc | 2022-10-14T09:25:20 | rpc/schemas/common/data/SensorSkinContact.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "Data.json#SensorData"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.sensorskincontact"
},
"contact": {
"type": "boolean"
}
},
"required": [
"__type",
"contact"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 55284d12439fc74b89e80301dd245877f7024c0b | 2022-02-12T03:15:16 | rpc/schemas/deployments/PrimaryDeviceDeployment.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"applicationData": {
"$ref": "../common/ApplicationData.json"
},
"connectedDeviceRegistrations": {
"additionalProperties": {
"$ref": "../common/devices/DeviceRegistration.json"
},
"type": "object"
},
"connectedDevices": {
"items": {
"$ref": "../common/devices/DeviceConfiguration.json"
},
"type": "array"
},
"deviceConfiguration": {
"$ref": "../common/devices/PrimaryDeviceConfiguration.json"
},
"registration": {
"$ref": "../common/devices/DeviceRegistration.json"
},
"taskControls": {
"items": {
"$ref": "../common/triggers/TaskControl.json"
},
"type": "array"
},
"tasks": {
"items": {
"$ref": "../common/tasks/TaskDescriptor.json"
},
"type": "array"
},
"triggers": {
"additionalProperties": {
"$ref": "../common/triggers/Trigger.json"
},
"propertyNames": {
"pattern": "^\\d$"
},
"type": "object"
}
},
"required": [
"deviceConfiguration",
"registration"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | b7c726ef65bb046f3a975012fbd03ae6665ba564 | 2024-03-16T21:19:31 | rpc/schemas/common/devices/WebsiteDeviceRegistration.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "DeviceRegistration.json#DeviceRegistration"
}
],
"properties": {
"url": {
"format": "uri",
"type": "string"
},
"userAgent": {
"type": "string"
}
},
"required": [
"url",
"userAgent"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | 4a7fe521b7dda62181c6e1a8acaadc11bb581934 | 2022-10-05T13:15:55 | rpc/schemas/studies/StudyService/StudyServiceRequest.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"ApiVersion": {
"const": "1.1"
},
"CreateStudy": {
"$anchor": "CreateStudy",
"Response": {
"$anchor": "CreateStudy-Response",
"$ref": "../StudyStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.CreateStudy"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"description": {
"type": [
"string",
"null"
]
},
"invitation": {
"oneOff": [
{
"type": "null"
},
{
"$ref": "../../deployments/users/StudyInvitation.json"
}
]
},
"name": {
"type": "string"
},
"ownerId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"ownerId",
"name"
],
"type": "object"
},
"GetStudiesOverview": {
"$anchor": "GetStudiesOverview",
"Response": {
"$anchor": "GetStudiesOverview-Response",
"items": {
"$ref": "../StudyStatus.json"
},
"type": "array"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.GetStudiesOverview"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"ownerId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"ownerId"
],
"type": "object"
},
"GetStudyDetails": {
"$anchor": "GetStudyDetails",
"Response": {
"$anchor": "GetStudyDetails-Response",
"$ref": "../StudyDetails.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.GetStudyDetails"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId"
],
"type": "object"
},
"GetStudyStatus": {
"$anchor": "GetStudyStatus",
"Response": {
"$anchor": "GetStudyStatus-Response",
"$ref": "../StudyStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.GetStudyStatus"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId"
],
"type": "object"
},
"GoLive": {
"$anchor": "GoLive",
"Response": {
"$anchor": "GoLive-Response",
"$ref": "../StudyStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.GoLive"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId"
],
"type": "object"
},
"Remove": {
"$anchor": "Remove",
"Response": {
"$anchor": "Remove-Response",
"type": "boolean"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.Remove"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId"
],
"type": "object"
},
"RemoveProtocol": {
"$anchor": "RemoveProtocol",
"Response": {
"$anchor": "RemoveProtocol-Response",
"$ref": "../StudyStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.RemoveProtocol"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId"
],
"type": "object"
},
"SetInternalDescription": {
"$anchor": "SetInternalDescription",
"Response": {
"$anchor": "SetInternalDescription-Response",
"$ref": "../StudyStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.SetInternalDescription"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"name",
"description"
],
"type": "object"
},
"SetInvitation": {
"$anchor": "SetInvitation",
"Response": {
"$anchor": "SetInvitation-Response",
"$ref": "../StudyStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.SetInvitation"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"invitation": {
"$ref": "../../deployments/users/StudyInvitation.json"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"invitation"
],
"type": "object"
},
"SetProtocol": {
"$anchor": "SetProtocol",
"Response": {
"$anchor": "SetProtocol-Response",
"$ref": "../StudyStatus.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.studies.infrastructure.StudyServiceRequest.SetProtocol"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"protocol": {
"$ref": "../../protocols/StudyProtocolSnapshot.json"
},
"studyId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyId",
"protocol"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/CreateStudy"
},
{
"$ref": "#/$defs/SetInternalDescription"
},
{
"$ref": "#/$defs/GetStudyDetails"
},
{
"$ref": "#/$defs/GetStudyStatus"
},
{
"$ref": "#/$defs/GetStudiesOverview"
},
{
"$ref": "#/$defs/SetInvitation"
},
{
"$ref": "#/$defs/SetProtocol"
},
{
"$ref": "#/$defs/RemoveProtocol"
},
{
"$ref": "#/$defs/GoLive"
},
{
"$ref": "#/$defs/Remove"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | a062c66690492fe0f477582d4bb4def4ea084f72 | 2022-02-01T13:04:22 | rpc/schemas/common/users/ParticipantAttribute.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"CustomParticipantAttribute": {
"$anchor": "CustomParticipantAttribute",
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.users.ParticipantAttribute.CustomParticipantAttribute"
},
"input": {
"$ref": "../../common/data/input/elements/InputElement.json"
},
"inputDataType": {
"$ref": "../../common/NamespacedId.json"
}
},
"required": [
"$type",
"inputDataType",
"input"
]
},
"DefaultParticipantAttribute": {
"$anchor": "DefaultParticipantAttribute",
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.users.ParticipantAttribute.DefaultParticipantAttribute"
},
"inputDataType": {
"$ref": "../../common/NamespacedId.json"
}
},
"required": [
"$type",
"inputDataType"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/DefaultParticipantAttribute"
},
{
"$ref": "#/$defs/CustomParticipantAttribute"
}
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/deployments/ParticipationService/ParticipationServiceRequest.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"ApiVersion": {
"const": "1.0"
},
"GetActiveParticipationInvitations": {
"$anchor": "GetActiveParticipationInvitations",
"Response": {
"$anchor": "GetActiveParticipationInvitations-Response",
"items": {
"$ref": "../users/ActiveParticipationInvitation.json"
},
"type": "array"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.ParticipationServiceRequest.GetActiveParticipationInvitations"
},
"accountId": {
"format": "uuid",
"type": "string"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
}
},
"required": [
"__type",
"apiVersion",
"accountId"
],
"type": "object"
},
"GetParticipantData": {
"$anchor": "GetParticipantData",
"Response": {
"$anchor": "GetParticipantData-Response",
"$ref": "../users/ParticipantData.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.ParticipationServiceRequest.GetParticipantData"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId"
],
"type": "object"
},
"GetParticipantDataList": {
"$anchor": "GetParticipantDataList",
"Response": {
"$anchor": "GetParticipantDataList-Response",
"items": {
"$ref": "../users/ParticipantData.json"
},
"type": "array"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.ParticipationServiceRequest.GetParticipantDataList"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"studyDeploymentIds": {
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentIds"
],
"type": "object"
},
"SetParticipantData": {
"$anchor": "SetParticipantData",
"Response": {
"$anchor": "SetParticipantData-Response",
"$ref": "../users/ParticipantData.json"
},
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.deployments.infrastructure.ParticipationServiceRequest.SetParticipantData"
},
"apiVersion": {
"$ref": "#/$defs/ApiVersion"
},
"data": {
"$ref": "../users/ParticipantDataMap.json"
},
"studyDeploymentId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"__type",
"apiVersion",
"studyDeploymentId",
"data"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/GetActiveParticipationInvitations"
},
{
"$ref": "#/$defs/GetParticipantData"
},
{
"$ref": "#/$defs/GetParticipantDataList"
},
{
"$ref": "#/$defs/SetParticipantData"
}
]
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/common/data/StepCount.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.stepcount"
},
"steps": {
"type": "integer"
}
},
"required": [
"__type",
"steps"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/common/data/SensorSkinContact.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"additionalProperties": false,
"properties": {
"__type": {
"const": "dk.cachet.carp.sensorskincontact"
},
"contact": {
"type": "boolean"
}
},
"required": [
"__type",
"contact"
],
"type": "object"
} | MIT | en |
cph-cachet/carp.core-kotlin | 863b82628f6f7e8e25aead40ed844c119eb8e52a | 2022-02-11T23:02:59 | rpc/schemas/common/triggers/ScheduledTrigger.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "Trigger.json#/$defs/Trigger"
}
],
"properties": {
"__type": {
"const": "dk.cachet.carp.common.application.triggers.ScheduledTrigger"
},
"recurrenceRule": {
"$ref": "../RecurrenceRule.json"
},
"time": {
"$ref": "../TimeOfDay.json"
}
},
"required": [
"time",
"recurrenceRule"
],
"type": "object",
"unevaluatedProperties": false
} | MIT | en |
cph-cachet/carp.core-kotlin | a062c66690492fe0f477582d4bb4def4ea084f72 | 2022-02-01T13:04:22 | rpc/schemas/common/data/input/elements/InputElement.json | 20 | 2024-05-28T05:19:53.327709Z | {
"$defs": {
"SelectOne": {
"$anchor": "SelectOne",
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.data.input.elements.SelectOne"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"prompt": {
"type": "string"
}
},
"required": [
"$type",
"prompt",
"options"
],
"type": "object"
},
"Text": {
"$anchor": "Text",
"additionalProperties": false,
"properties": {
"$type": {
"const": "dk.cachet.carp.common.application.data.input.elements.Text"
},
"prompt": {
"type": "string"
}
},
"required": [
"$type",
"prompt"
]
}
},
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/SelectOne"
},
{
"$ref": "#/$defs/Text"
}
],
"type": "object"
} | MIT | en |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.